Merge pull request #10 from mattpolzin/bugfix/7/hang-with-concurrent-tests

Bugfix/7/hang with concurrent tests

Author: mattpolzin

Dockerfile

@@ -85,8 +85,15 @@ ENV ENVIRONMENT=$env
 # Postgres Database URL. Required.
 # ENV API_TEST_DATABASE_URL
 
+# Redis URL. Required.
+# ENV API_TEST_REDIS_URL
+
+# Jobs Queue runs in process. Optional. If false (or undefined),
+#   a jobs process must be run separately.
+# ENV API_TEST_IN_PROCESS_QUEUES
+
 ##
-## Serve (default command)
+## serve (default command)
 ##
 
 # --env
@@ -97,3 +104,11 @@ ENV ENVIRONMENT=$env
 
 ENTRYPOINT ["./Run"]
 CMD ["serve", "--env", "$ENVIRONMENT", "--hostname", "0.0.0.0", "--port", "80"]
+
+##
+## queues
+##
+
+# Use this command to run the queues service outside of the API server process.
+# This is the recommended way to run the Jobs Queue.
+# CMD ["queues"]

Package.resolved

@@ -18,6 +18,7 @@ let package = Package(
         .package(url: "https://github.com/vapor/fluent-postgres-driver", from: "2.0.0-rc.2"),
         .package(url: "https://github.com/vapor/fluent", from: "4.0.0-rc.2.2"),
         .package(url: "https://github.com/vapor/fluent-kit", from: "1.0.0-rc.1.26"),
+        .package(url: "https://github.com/vapor/queues-redis-driver", .branch("master")),
 
         .package(url: "https://github.com/mattpolzin/VaporTypedRoutes", .upToNextMinor(from: "0.7.0")),
         .package(url: "https://github.com/mattpolzin/VaporOpenAPI", .upToNextMinor(from: "0.0.13")),
@@ -39,6 +40,7 @@ let package = Package(
           .product(name: "Vapor", package: "vapor"), 
           .product(name: "Fluent", package: "fluent"),
           .product(name: "FluentPostgresDriver", package: "fluent-postgres-driver"), 
+          .product(name: "QueuesRedisDriver", package: "queues-redis-driver"),
           .product(name: "VaporTypedRoutes", package: "VaporTypedRoutes"),
           .product(name: "VaporOpenAPI", package: "VaporOpenAPI"),
 

Package.swift

@@ -1,7 +1,7 @@
 # JSON:API/OpenAPI Test Server
 ## Requirements
 ### Server
-The test server requires a Postgres database.
+The test server requires a Postgres database and Redis instace.
 
 ## Usage
 
@@ -73,16 +73,24 @@ docker run --rm --env 'API_TEST_IN_URL=https://website.com/api/documentation' -v
 You will find the dumped files at `./out/api_test_files.zip`.
 
 ### The Test Server
-You can run an API Test server that accepts requests to run tests at HTTP endpoints. This requires the same input file or URL environment variables explained in the above section but you also must provide a Postgres database for the server to use as its persistence layer. You specify this database using a Postgres URL in the `API_TEST_DATABASE_URL` environment variable.
+You can run an API Test server that accepts requests to run tests at HTTP endpoints. This requires the same input file or URL environment variables explained in the above section but you also must provide a Postgres database for the server to use as its persistence layer. You specify this database using a Postgres URL in the `API_TEST_DATABASE_URL` environment variable. A Redis instance is required to queue up the test runs. You specify the Redis URL in the `API_TEST_REDIS_URL` environment variable.
 
 First you need to run the migrator against your Postgres database.
 ```shell
-docker run --env 'API_TEST_IN_URL=https://website.com/api/documentation' --env 'API_TEST_DATABASE_URL=postgres://user:password@host:port/databasename' -p '8080:80' mattpolzin2/api-test-server migrate --yes
+docker run --env 'API_TEST_IN_URL=https://website.com/api/documentation' --env 'API_TEST_DATABASE_URL=postgres://user:password@host:port/databasename' --env 'API_TEST_REDIS_URL=redis://host:port' -p '8080:80' mattpolzin2/api-test-server migrate --yes
 ```
 
 Then you can start the server.
 ```shell
-docker run --env 'API_TEST_IN_URL=https://website.com/api/documentation' --env 'API_TEST_DATABASE_URL=postgres://user:password@host:port/databasename' -p '8080:80' mattpolzin2/api-test-server
+docker run --env 'API_TEST_IN_URL=https://website.com/api/documentation' --env 'API_TEST_DATABASE_URL=postgres://user:password@host:port/databasename' --env 'API_TEST_REDIS_URL=redis://host:port' -p '8080:80' mattpolzin2/api-test-server
+```
+
+#### Jobs Queue
+Testing is run in a jobs queue. That queue can be run in the same process as the API server if you specify `API_TEST_IN_PROCESS_QUEUES=true` as an environment variable but the recommendation is to run the jobs service as its own process.
+
+You start the Jobs Queue using the same docker image as the serve but you specify the `queues` command.
+```shell
+docker run --env 'API_TEST_IN_URL=https://website.com/api/documentation' --env 'API_TEST_DATABASE_URL=postgres://user:password@host:port/databasename' --env 'API_TEST_REDIS_URL=redis://host:port' mattpolzin2/api-test-server queues
 ```
 
 **NOTE** We must explicitly expose the port to the host device. In this example, `http://localhost:8080` will point to the server which is listening on port `80` in the container.