Merge pull request #101 from NHSDigital/develop

Develop

Author: nhsd-jack-wainwright

.gitignore

@@ -21,3 +21,5 @@ __pycache__/
 tests/test-report.xml
 tests/functional-test-report.xml
 .orig
+
+.python-version

Makefile

@@ -1,8 +1,8 @@
 SHELL=/bin/bash -euo pipefail
 
-install: install-node install-python install-hooks
+install: install-node install-poetry install-hooks
 
-install-python:
+install-poetry:
 	poetry install
 
 install-node:
@@ -13,8 +13,11 @@ install-hooks:
 	cp scripts/pre-commit .git/hooks/pre-commit
 
 lint: copy-examples
-	npm run lint
+	npm run lint-oas
+	cd sandbox && make lint
+	poetry run python scripts/xml_validator.py
 	poetry run flake8 **/*.py
+	@printf "\nLinting passed.\n\n"
 
 clean:
 	rm -rf build
@@ -35,9 +38,6 @@ check-licenses:
 	npm run check-licenses
 	scripts/check_python_licenses.sh
 
-format:
-	poetry run black **/*.py
-
 sandbox: update-examples
 	cd sandbox && npm run start
 
@@ -53,3 +53,23 @@ release: clean publish build-proxy
 
 test:
 	echo "TODO: add tests"
+
+setup-environment:
+	@if [ -e /usr/bin/yum ]; then \
+		scripts/rhel_setup_environment.sh; \
+	elif [ -e /usr/local/bin/brew ]; then \
+		echo "TODO is Mac"; \
+	else \
+		echo "Environment not Mac or RHEL"; \
+	fi
+
+clean-environment:
+	@if [ -e /usr/bin/yum ]; then \
+		scripts/rhel_clean_environment.sh; \
+	elif [ -e /usr/local/bin/brew ]; then \
+		echo "TODO is Mac"; \
+	else \
+		echo "Environment not Mac or RHEL"; \
+	fi
+
+.PHONY: setup-environment clean-environment

README.md

@@ -26,19 +26,34 @@ The contents of this repository are protected by Crown Copyright (C).
 * nodejs + npm/yarn
 * [poetry](https://github.com/python-poetry/poetry)
 
-### Install
+### Environment setup
+Currently, automation for setting up the right environment is only available for machines based on RedHatEnterpriseLinux (RHEL).
+Running the following will ensure your environment is ready for development.
+It will install [pyenv](https://github.com/pyenv/pyenv), Python 3.8.2 and its dependencies (yum), create a virtual environment (named apigee), and ensure poetry is installed under it.
 ```
-$ make install
+$ make setup-environment
 ```
+>Activating apigee is now done by the file .python-version, so cd'ing into the repository directory will suffice to use the virtual environment.
 
-#### Updating hooks
-You can install some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run
-in CI, but it's useful to run them locally too.
+If you wish to remove all changes made by setup-environment, you can run the following:
+```
+$ make clean-environment
+```
+> This will erase your ~/.pyenv directory, where pyenv stores the different Python versions, and will revert ~/.bashrc and ~./bash_profile. You may want to logout/login for changes to take effect.
 
+### Install
+After setting up and activating the right environment, running make install will set up additional configuration pertaining to node, poetry and githooks.
 ```
-$ make install-hooks
+$ make install
 ```
 
+> #### Updating hooks
+> You can install/update some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run in CI, but it's useful to run them locally too.
+>
+>```
+>$ make install-hooks
+>```
+
 ### Environment Variables
 Various scripts and commands rely on environment variables being set. These are documented with the commands.
 

azure/azure-release-pipeline.yml

@@ -32,7 +32,7 @@ extends:
     service_base_path: ${{ variables.service_base_path }}
     product_display_name: ${{ variables.product_display_name }}
     product_description: ${{ variables.product_description }}
-    enable_status_monitoring: false
+    enable_status_monitoring: true
     manual_approval_env: manual-approval-ptl
     spec_file: ${{ variables.spec_file }}
     apigee_deployments:
@@ -89,6 +89,13 @@ extends:
       make_spec_visible: true
       depends_on:
       - manual_approval_int
+    - environment: manual-approval
+      stage_name: manual_approval_nft2
+    - environment: ref
+      stage_name: ers_nft2_release
+      make_spec_visible: true
+      depends_on:
+      - manual_approval_nft2
     - environment: internal-qa-sandbox
       proxy_path: sandbox
       depends_on:

package.json

@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "description": "OAS (Swagger v3) API Definition for Template API",
   "scripts": {
-    "lint": "node_modules/.bin/speccy lint -s openapi-tags -s operation-tags specification/e-referrals-service-api.yaml --skip default-and-example-are-redundant",
+    "lint-oas": "node_modules/.bin/speccy lint -s openapi-tags -s operation-tags specification/e-referrals-service-api.yaml --skip default-and-example-are-redundant",
     "publish": "mkdir -p build && node_modules/.bin/speccy resolve specification/e-referrals-service-api.yaml -i | poetry run python scripts/yaml2json.py | poetry run python scripts/set_version.py | poetry run python scripts/populate_placeholders.py > build/e-referrals-service-api.json",
     "serve": "node_modules/.bin/speccy serve build/e-referrals-service-api.json",
     "check-licenses": "node_modules/.bin/license-checker --failOn GPL --failOn LGPL"
@@ -15,11 +15,11 @@
     "speccy": "^0.11.0"
   },
   "devDependencies": {
-    "newman": "^4.5.7",
-    "newman-reporter-html": "^1.0.5",
-    "newman-reporter-htmlextra": "^1.11.3",
     "apigeetool": "^0.14.2",
     "license-checker": "^25.0.1",
-    "minimist": "^1.2.2"
+    "minimist": "^1.2.2",
+    "newman": "^4.5.7",
+    "newman-reporter-html": "^1.0.5",
+    "newman-reporter-htmlextra": "^1.11.3"
   }
 }