Merge pull request #25 from NHSDigital/mm-apm-1926-immunisation-history-enhancements

Mm apm 1926 immunisation history enhancements

Author: HenryIwanejko

.gitignore

@@ -11,4 +11,6 @@ newman/
 __pycache__/
 .envrc
 .idea/
-.venv/
+.venv/
+
+smoketest-report.xml

Makefile

@@ -1,20 +1,20 @@
 SHELL=/bin/bash -euo pipefail
 
-install: install-node install-python install-hooks
-
 install-python:
 	poetry install
 
 install-node:
 	npm install
 	cd sandbox && npm install
 
-install-hooks:
+.git/hooks/pre-commit:
 	cp scripts/pre-commit .git/hooks/pre-commit
 
+install: install-node install-python .git/hooks/pre-commit
+
 lint:
 	npm run lint
-	find . -name '*.py' | xargs poetry run flake8
+	find . -name '*.py' -not -path '**/.venv/*' | xargs poetry run flake8
 
 clean:
 	rm -rf build
@@ -40,13 +40,19 @@ start-sandbox:
 build-proxy:
 	scripts/build_proxy.sh
 
+_dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/. tests"
+
 release: clean publish build-proxy
 	mkdir -p dist
-	cp -r build/. dist
-	cp -r tests dist
+	for f in $(_dist_include); do cp -r $$f dist; done
 	cp ecs-proxies-deploy.yml dist/ecs-deploy-sandbox.yml
 	cp ecs-proxies-deploy.yml dist/ecs-deploy-internal-qa-sandbox.yml
 	cp ecs-proxies-deploy.yml dist/ecs-deploy-internal-dev-sandbox.yml
 
 test:
-	poetry run pytest -v
+#	this target should be used for local unit tests ..  runs as part of the build pipeline
+	make --no-print-directory -C sandbox test
+
+smoketest:
+#	this target is for end to end smoketests this would be run 'post deploy' to verify an environment is working
+	poetry run pytest -v --junitxml=smoketest-report.xml -s -m smoketest

azure/azure-pr-pipeline.yml

@@ -39,8 +39,8 @@ extends:
       - environment: internal-dev
         make_spec_visible: true
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml
       - environment: internal-dev-sandbox
         proxy_path: sandbox
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml

azure/azure-release-pipeline.yml

@@ -37,27 +37,27 @@ extends:
       - environment: internal-dev
         make_spec_visible: true  # Off by default. Turn on to allow expose API developers can subscribe their Apps to
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml
       - environment: internal-qa
         make_spec_visible: true
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml
       - environment: internal-qa-sandbox
         proxy_path: sandbox
         make_spec_visible: true
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml
     # make_spec_visible is false for sandbox environment
     # (App subscription make sense for most sandbox implementations)
       - environment: sandbox
         proxy_path: sandbox
         post_deploy:
-          - template: ./templates/run-ping-tests.yml
+          - template: ./templates/run-smoke-tests.yml
     # Enable int environment when ready by uncommenting:
     #   - environment: int
     #     make_spec_visible: true
     #     depends_on:
     #       - internal_qa
     #       - internal_qa_sandbox
     #     post_deploy:
-    #       - template: ./templates/run-ping-tests.yml
+    #       - template: ./templates/run-smoke-tests.yml

azure/templates/run-ping-tests.yml azure/templates/run-smoke-tests.ymlazure/templates/run-ping-tests.yml renamed to azure/templates/run-smoke-tests.yml

@@ -1,19 +1,23 @@
 steps:
-  - bash: poetry install
-    workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/tests
+  - bash: |
+      make install-python
+    workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)
     displayName: Setup pytests
 
   - bash: |
+      export RELEASE_RELEASEID=$(Build.BuildId)
+      export SOURCE_COMMIT_ID=$(Build.SourceVersion)
       export APIGEE_ENVIRONMENT="$(ENVIRONMENT)"
       export SERVICE_BASE_PATH="$(SERVICE_BASE_PATH)"
+      export STATUS_ENDPOINT_API_KEY="$(status-endpoint-api-key)"
 
-      poetry run pytest -v --junitxml=test-report.xml -m ping
-    workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/tests
-    displayName: run ping pytests
+      make smoketest
+    workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)
+    displayName: run smoketests
 
   - task: PublishTestResults@2
-    displayName: 'Publish ping pytest results'
+    displayName: 'Publish smoketest results'
     condition: always()
     inputs:
-      testResultsFiles: '$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/tests/test-report.xml'
+      testResultsFiles: '$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/smoketest-report.xml'
       failTaskOnFailedTests: true

ecs-proxies-deploy.yml

@@ -1,6 +1,13 @@
 docker_service:
   - name: sandbox
     expose: true
+    environment:
+      - name: NODE_ENV
+        value: production
+      - name: LOG_LEVEL
+        value: "{{ 'debug' if APIGEE_ENVIRONMENT == 'internal-dev' else 'info' }}"
+      - name: VERSION_INFO
+        value: "{{ version_info | to_json }}"
     health_check:
       matcher: "200"
-      path: "/_status"
+      path: "/_ping"