DRAFT: VED-738 refactoring

.github/dependabot.yml

@@ -52,8 +52,8 @@ updates:
       - "/backend"
       - "/batch_processor_filter"
       - "/delta_backend"
-      - "/e2e"
-      - "/e2e_batch"
+      - "/tests/e2e"
+      - "/tests/e2e_batch"
       - "/filenameprocessor"
       - "/mesh_processor"
       - "/recordprocessor"

.github/workflows/create-release-tag.yml

@@ -29,7 +29,7 @@ jobs:
         run: pip install semver
 
       - name: Set SPEC_VERSION env var
-        run: echo ::set-env name=SPEC_VERSION::$(python scripts/calculate_version.py)
+        run: echo ::set-env name=SPEC_VERSION::$(python utilities/scripts/calculate_version.py)
         env:
           ACTIONS_ALLOW_UNSECURE_COMMANDS: true
 

Makefile

@@ -1,7 +1,7 @@
 SHELL=/usr/bin/env bash -euo pipefail
 
 PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS = backend batch_processor_filter delta_backend filenameprocessor mesh_processor recordprocessor lambdas/ack_backend lambdas/redis_sync lambdas/id_sync lambdas/mns_subscription lambdas/shared
-PYTHON_PROJECT_DIRS = e2e e2e_batch $(PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS)
+PYTHON_PROJECT_DIRS = tests/e2e tests/e2e_batch $(PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS)
 
 #Installs dependencies using poetry.
 install-python:
@@ -14,7 +14,7 @@ install-node:
 
 #Configures Git Hooks, which are scripts that run given a specified event.
 .git/hooks/pre-commit:
-	cp scripts/pre-commit .git/hooks/pre-commit
+	cp utilities/scripts/pre-commit .git/hooks/pre-commit
 
 #Condensed Target to run all targets above.
 install: install-node install-python .git/hooks/pre-commit
@@ -33,16 +33,16 @@ clean:
 publish: clean
 	mkdir -p build
 	npm run publish 2> /dev/null
-	cp build/immunisation-fhir-api.json sandbox/
-	cp -r specification sandbox/specification
+	cp build/immunisation-fhir-api.json utilities/sandbox/
+	cp -r utilities/specification utilities/sandbox/specification
 
 #Runs build proxy script
 build-proxy:
-	scripts/build_proxy.sh
+	utilities/scripts/build_proxy.sh
 
 #Files to loop over in release
 # VED-811: remove everything except for proxy related files as we move to Github Actions for backend deployment
-_dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/. specification sandbox terraform scripts"
+_dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/. utilities/specification utilities/sandbox terraform utilities/scripts"
 
 
 #Create /dist/ sub-directory and copy files into directory
@@ -90,7 +90,7 @@ test-prod:
 	--junitxml=test-report.xml \
 
 setup-python-envs:
-	scripts/setup-python-envs.sh
+	utilities/scripts/setup-python-envs.sh
 
 initialise-all-python-venvs:
 	for dir in $(PYTHON_PROJECT_DIRS); do ( \

README.specification.md

@@ -4,9 +4,9 @@
 
 This is a specification for the *immunisation-fhir-api* API.
 
-* `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.
-* `sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.
-* `scripts/` Utilities helpful to developers of this specification.
+* `utilities/specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.
+* `utilities/sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.
+* `utilities/scripts/` Utilities helpful to developers of this specification.
 * `proxies/` Live (connecting to another service) and sandbox (using the sandbox container) Apigee API Proxy definitions.
 
 Consumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer).

azure/templates/build.yml

@@ -2,9 +2,9 @@ steps:
   - bash: |
       mkdir -p build
       npm run publish 2> /dev/null
-      cp build/immunisation-fhir-api.json sandbox/
+      cp build/immunisation-fhir-api.json utilities/sandbox/
 
-        cd sandbox
+        cd utilities/sandbox
       docker build -t sandbox .
     displayName: Build sandbox image
     workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)"

azure/templates/post-deploy.yml

@@ -191,7 +191,7 @@ steps:
         echo "running: $test_cmd -v -c"
         $test_cmd -v -c
       fi
-    workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/e2e"
+    workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/tests/e2e"
     displayName: Run Full Test Suite
 
   - bash: |
@@ -224,7 +224,7 @@ steps:
       fi
 
     displayName: Run full batch test suite
-    workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/e2e_batch"
+    workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/tests/e2e_batch"
 
   - task: PublishTestResults@2
     displayName: 'Publish test results'

ecs-proxies-containers.yml

@@ -1,4 +1,4 @@
 docker_containers:
   - name: sandbox
-    dockerfile: "sandbox/Dockerfile"
-    path: "sandbox"
+    dockerfile: "utilities/sandbox/Dockerfile"
+    path: "utilities/sandbox"

immunisation-fhir-api.code-workspace

@@ -19,10 +19,10 @@
 			"path": "mesh_processor"
 		},
 		{
-			"path": "e2e"
+			"path": "tests/e2e"
 		},
 		{
-			"path": "e2e_batch"
+			"path": "tests/e2e_batch"
 		},
 		{
 			"path": "lambdas/ack_backend"

package.json

@@ -3,8 +3,8 @@
   "version": "0.0.1",
   "description": "OAS (Swagger v3) API Definition for Template API",
   "scripts": {
-    "lint": "redocly lint --skip-rule=security-defined specification/immunisation-fhir-api.yaml",
-    "publish": "redocly bundle specification/immunisation-fhir-api.yaml --remove-unused-components --ext json -o build/immunisation-fhir-api.json",
+    "lint": "redocly lint --skip-rule=security-defined utilities/specification/immunisation-fhir-api.yaml",
+    "publish": "redocly bundle utilities/specification/immunisation-fhir-api.yaml --remove-unused-components --ext json -o build/immunisation-fhir-api.json",
     "check-licenses": "node_modules/.bin/license-checker --failOn GPL --failOn LGPL"
   },
   "author": "NHS Digital",