Adds handling of recurring payment

acceptance-tests/Dockerfile.stripe

@@ -0,0 +1,9 @@
+FROM stripe/stripe-cli
+
+LABEL maintainer="[email protected]"
+
+COPY script/stripe-proxy.sh /proxy.sh
+
+ENTRYPOINT []
+
+CMD ["/proxy.sh"]

acceptance-tests/README.md

@@ -1,6 +1,6 @@
-#Acceptance tests
+# Acceptance tests
 
-PRELIMINARY, EXTREMELY INCOMPLETE DOCUMENTATION, MUST BE IMPROVED!
+_PRELIMINARY, EXTREMELY INCOMPLETE DOCUMENTATION, MUST BE IMPROVED!_
 
 The ostelco system is complex in that it consists of multiple components that
 communicate both with internal components and external components.
@@ -13,46 +13,91 @@ a context where all the external components are also present either as
 externally hosted test instances, or as mocked out-components running
 locally.
 
-The acceptance tests themselves are run using "docker compose", and
-are implemented as a separate docker container that is run in the
-docker compose environment.
+The acceptance tests themselves are run using `docker compose`, and are
+implemented as a separate docker container that is run in the docker
+compose environment.
 
 ## Docker compose files
 
-## The various docker compose files
+### The various docker compose files
+
 There are in fact multiple docker compose  files present in the
 top level directory, and they have different usecases:
 
+ *  `docker-compose.yaml`: The main file.  Will run a set of tests exercising
+    most of the components.
 
- *  docker-compose.yaml: The most commonly used file.  Will 
-    run a set of tests for most of the components.
-
- *  docker-compose.esp.yaml: A test that is simplar to docker-compose.yaml,
+ *  `docker-compose.esp.yaml`: A test that is similar to `docker-compose.yaml`,
     but also includes the google ESP components. We usually don't run this test
     since the complications of running ESP for the most part don't outweigh
     its utility.
 
- *  docker-compose.ocs.yaml:  tbd
- *  docker-compose.seagull.yaml: tbd
+ *  `docker-compose.ocs.yaml`:  tbd
 
-## Structure of the docker compose files
+ *  `docker-compose.seagull.yaml`: tbd
 
-## Components started by docker compose
+### Structure of the docker compose files
 
-... tbd (also a PUML diagram showing call relationships)
+### Components started by docker compose
 
+... tbd (also a PUML diagram showing call relationships)
 
 ## Prerequisites for running the acceptance tests
-
-  ... tbd
 
+... tbd
 
 ## How to run the acceptance tests
 
-  ... tbd, but should include:   Just running them, running them while developing new tests, how to attach  a test being developed to an IDE's debugger.
+For the main Docker compose file:
+
+    $ docker-compose up --build --abort-on-container-exit
+
+To run one of the other Docker compose files, use the `-f` option. Example:
+
+    $ docker-compose -f docker-compose.esp.yaml up --build --abort-on-container-exit
+
+... tbd, how to run them while developing new tests, how to attach  a test
+being developed to an IDE's debugger.
+
+## Running tests that depends on webhooks configured at Stripe
+
+Currently the "recurring payment" tests depends on webhooks being enabled at Stripe
+and the events being proxy forwarded the Prime backend. For enabling proxy forward
+of the events the
+[stripe/stripe-cli](https://hub.docker.com/r/stripe/stripe-cli) Docker image is used.
+
+For the tests to work the following two evnironment variables must be set to their
+correct value.
+
+ - `STRIPE_API_KEY`
+ - `STRIPE_ENDPOINT_SECRET`
+
+For the `STRIPE_API_KEY` variable go to the Stripe console and list the value at
+Developer -> API keys -> Secret key.
+
+To get the correct `STRIPE_ENDPOINT_SECRET` value do as follows:
+
+    $ export STRIPE_API_KEY=<secret value obtained earlier>
+    $ docker run --rm -e STRIPE_API_KEY=$STRIPE_API_KEY stripe/stripe-cli listen
+    Checking for new versions...
+
+    Getting ready...
+    Ready! Your webhook signing secret is whsec_secretvaluesecretvalue0123456789 (^C to quit)
+
+Alternatively download the `stripe` command line program from
+[https://stripe.com/docs/stripe-cli](https://stripe.com/docs/stripe-cli) and run
+the command:
 
+    $ stripe listen
 
+(with the `STRIPE_API_KEY` environment variable set).
 
+Set the `STRIPE_ENDPOINT_SECRET` environment variable to the string starting with
+"`whsec_`".
 
+    $ export STRIPE_ENDPOINT_SECRET=whsec_secretvaluesecretvalue0123456789
 
+This will cause the tests that depends upon Stripe events to run.
 
+To disiable the tests, set the `STRIPE_ENDPOINT_SECRET` to some dummy value that
+don't start with the "`whsec_`" string.

acceptance-tests/build.gradle.kts

@@ -35,6 +35,9 @@ dependencies {
   implementation(kotlin("test-junit"))
 
   implementation("io.dropwizard:dropwizard-testing:${Version.dropwizard}")
+
+  implementation("org.junit.jupiter:junit-jupiter-api:${Version.junit5}")
+  runtimeOnly("org.junit.jupiter:junit-jupiter-engine:${Version.junit5}")
 }
 
 application {

acceptance-tests/script/stripe-proxy.sh

@@ -0,0 +1,20 @@
+#! /bin/sh
+
+# Only start the Stripe CLI tool in proxy forward mode
+# if the STRIPE_ENDPOINT_SECRET environmentvariable is
+# set to what looks like an actual secret.
+#
+# If not set, block until stopped by SIGTERM or similar.
+
+echo $STRIPE_ENDPOINT_SECRET | grep -q ^whsec_
+
+if [ $? -eq 0 ]
+then
+    echo Starting Stripe CLI in proxy forward mode...
+    stripe listen \
+        --forward-to prime:8080/stripe/event \
+        --events customer.subscription.updated,invoice.created,invoice.payment_succeeded,invoice.upcoming
+else
+    echo Not starting Stripe CLI.
+    sleep 2147483647   # block for 2^31-1 seconds
+fi

acceptance-tests/script/wait.sh

@@ -220,7 +220,18 @@ EOF
 echo " ... HLR preactivated rofiles loaded into prime"
 
 
+##
+## Creating pub-sub subscriptions for recurring payments tests (plans).
+## Have to create one subscription per test, as the tests runs in parallel.
+##
+
+echo "Creating pub-sub subscriptions for recurring payment tests"
+curl -X PUT -H "Content-Type: application/json" -d '{"topic":"projects/'${GCP_PROJECT_ID}'/topics/stripe-event","ackDeadlineSeconds":10}' pubsub-emulator:8085/v1/projects/${GCP_PROJECT_ID}/subscriptions/stripe-event-okhttp-purchase-ok-sub
+curl -X PUT -H "Content-Type: application/json" -d '{"topic":"projects/'${GCP_PROJECT_ID}'/topics/stripe-event","ackDeadlineSeconds":10}' pubsub-emulator:8085/v1/projects/${GCP_PROJECT_ID}/subscriptions/stripe-event-okhttp-purchase-fail-sub
+curl -X PUT -H "Content-Type: application/json" -d '{"topic":"projects/'${GCP_PROJECT_ID}'/topics/stripe-event","ackDeadlineSeconds":10}' pubsub-emulator:8085/v1/projects/${GCP_PROJECT_ID}/subscriptions/stripe-event-jersey-purchase-ok-sub
+curl -X PUT -H "Content-Type: application/json" -d '{"topic":"projects/'${GCP_PROJECT_ID}'/topics/stripe-event","ackDeadlineSeconds":10}' pubsub-emulator:8085/v1/projects/${GCP_PROJECT_ID}/subscriptions/stripe-event-jersey-purchase-fail-sub
+
 ##
 ##   Finally run acceptance tests
 ##
-java -cp '/acceptance-tests.jar' org.junit.runner.JUnitCore org.ostelco.at.TestSuite
+java -cp '/acceptance-tests.jar' org.junit.runner.JUnitCore org.ostelco.at.TestSuite

acceptance-tests/src/main/kotlin/org/ostelco/at/TestSuite.kt

@@ -4,7 +4,9 @@ import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import org.junit.Test
 import org.junit.experimental.ParallelComputer
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable
 import org.junit.runner.JUnitCore
+import org.ostelco.at.common.StripePayment
 import org.ostelco.at.common.getLogger
 import kotlin.test.assertTrue
 
@@ -49,6 +51,43 @@ class TestSuite {
         }
     }
 
+    /**
+     * Test of recurring payments requires that:
+     *    1) The webhook-stripe service docker instance is running.
+     *    2) The STRIPE_ENDPOINT_SECRET env. variable set.
+     * If the STRIPE_ENDPOINT_SECRET variable is not set the tests will be skipped.
+     */
+    @Test
+    @EnabledIfEnvironmentVariable(named = "STRIPE_ENDPOINT_SECRET", matches="whsec_\\S+")
+    fun `run recurring payment tests`() {
+
+        /**
+         * TODO: For some reason the '@EnabledIfEnvironmentVariable' annotation
+         *       is not working...
+         *       Remove the check below when this is fixed.
+         */
+        val secret = System.getenv("STRIPE_ENDPOINT_SECRET") ?: "not_set"
+
+        if (!secret.matches(Regex("whsec_\\S+"))) {
+            logger.info("Skipping the 'recurring payment tests' as the STRIPE_ENDPOINT_SECRET environment variable " +
+                    "is not set or set to a value not matching a secret.")
+            return
+        }
+
+        runBlocking {
+
+            launch {
+                checkResult(
+                        JUnitCore.runClasses(
+                                ParallelComputer(true, true),
+                                org.ostelco.at.okhttp.RenewPlanTest::class.java,
+                                org.ostelco.at.jersey.RenewPlanTest::class.java
+                        )
+                )
+            }
+        }
+    }
+
     private fun checkResult(result: org.junit.runner.Result) {
 
         println()
@@ -60,4 +99,4 @@ class TestSuite {
 
         assertTrue(result.wasSuccessful(), "${result.failureCount} tests failed!")
     }
-}
+}

acceptance-tests/src/main/kotlin/org/ostelco/at/common/Products.kt

@@ -14,7 +14,7 @@ fun expectedProducts(): List<Product> {
     )
 }
 
-val expectedPlanProduct: Product = Product()
+val expectedPlanProductSG: Product = Product()
         .sku("PLAN_1000SGD_YEAR")
         .price(Price().amount(1_000_00).currency("SGD"))
         .properties(
@@ -32,6 +32,24 @@ val expectedPlanProduct: Product = Product()
         )
         .presentation(emptyMap<String, String>())
 
+val expectedPlanProductUS: Product = Product()
+        .sku("PLAN_10USD_DAY")
+        .price(Price().amount(10_00).currency("USD"))
+        .properties(
+                mapOf(
+                        "productClass" to "MEMBERSHIP",
+                        "segmentIds" to "country-us"
+                )
+        )
+        .payment(
+                mapOf(
+                        "type" to "SUBSCRIPTION",
+                        "label" to "Daily subscription plan",
+                        "taxRegionId" to "us"
+                )
+        )
+        .presentation(emptyMap<String, String>())
+
 private val dfs = DecimalFormatSymbols().apply {
     groupingSeparator = '_'
 }