Merge pull request #227 from mozilla-services/reorganize-test-enginee…

…ring-files

.circleci/config.yml

@@ -34,8 +34,8 @@ workflows:
             tags:
               only: /.+/
 
-      - integration-tests:
-          name: integration-tests
+      - contract-tests:
+          name: contract-tests
           requires:
             - checks
             - build-and-test
@@ -46,7 +46,7 @@ workflows:
             - checks
             - build-and-test
             - docker-image-build
-            - integration-tests
+            - contract-tests
           filters:
             branches:
               only: main
@@ -130,7 +130,7 @@ jobs:
       - store_artifacts:
           path: /tmp/artifacts
 
-  integration-tests:
+  contract-tests:
     machine:
       docker_layer_caching: true
       image: ubuntu-2004:202101-01 # Ubuntu 20.04, Docker v20.10.2, Docker Compose v1.28.2
@@ -144,11 +144,11 @@ jobs:
           name: Load Docker image from workspace
           command: docker load -i workspace/merino.tar.gz
       - run:
-         name: Run Integration tests
+         name: Run contract tests
          command: |
            docker-compose --version
-           docker-compose -f test-engineering/docker-compose.yml build client
-           docker-compose -f test-engineering/docker-compose.yml up --abort-on-container-exit
+           docker-compose -f test-engineering/contract-tests/docker-compose.yml build client
+           docker-compose -f test-engineering/contract-tests/docker-compose.yml up --abort-on-container-exit
 
   docker-image-publish:
     docker:

docs/dev/testing.md

@@ -55,13 +55,17 @@ async fn lbheartbeat_works() {
 
 For more details, see the documentation of the `merino-integration-tests` crate.
 
-## System tests
+## Contract tests
 
-The tests in the `test-engineering` directory are system tests that consume
-Merino's APIs using more opaque techniques. They cannot configure the server per
-test, and are more concerned with external contracts and behavior.
+The tests in the `test-engineering/contract-tests` directory are contract tests
+that consume Merino's APIs using more opaque techniques. These tests run against
+a Docker container of the service, specify settings via environment variables,
+and operate on the HTTP API layer only and as such are more concerned with
+external contracts and behavior. The contract tests cannot configure the server
+per test.
 
-For more details see the README.md file in the `test-engineering` directory.
+For more details see the README.md file in the `test-engineering/contract-tests`
+directory.
 
 ## Load tests
 

test-engineering/client/README.md → test-engineering/contract-tests/client/README.md

@@ -1,6 +1,7 @@
 # client
 
-This directory contains a Python-based test framework for the integration tests.
+This directory contains a Python-based test framework for the contract tests.
+
 The HTTP client used in the framework requests suggestions from Merino and
 performs checks against the responses. The framework implements response models
 for the Merino API.

test-engineering/docker-compose.yml → test-engineering/contract-tests/docker-compose.yml

@@ -3,13 +3,13 @@ services:
   merino:
     # See `docker-image-build` job in `.circleci/config.yml`
     image: app:runtime
-    build: ..
+    build: ../..
     container_name: merino
     environment:
       # The configuration preset to use
       MERINO_ENV: "ci"
     volumes:
-      - ../dev:/tmp/dev
+      - ../../dev:/tmp/dev
 
   client:
     image: client
@@ -19,7 +19,7 @@ services:
       - merino
     volumes:
       - ./volumes/client:/tmp/client
-      - ../dev/wait-for-it.sh:/wait-for-it.sh
+      - ../../dev/wait-for-it.sh:/wait-for-it.sh
     environment:
       MERINO_URL: http://merino:8000
       SCENARIOS_FILE: /tmp/client/scenarios.yml