The test results microservice is used to capture and persist test results for a Vehicle submitted by the client (VTA/VTM). If the submitted test-result is applicable for test certificate, it triggers the generation of the certificate via dynamo streams of test result table. The test result service also provides you with a view of historical test records.
The project runs on node
18.x with typescript and serverless framework. For further details about project dependencies, please refer to the package.json file.
nvm is used to managed node versions and configuration explicitly done per project using an .npmrc file.
Please install and run the following securiy programs as part of your development process:
- git-secrets
After installing, do a one-time set up with
git secrets --register-aws. Run withgit secrets --scan.
These will be run as part of your projects hooks so you don't accidentally introduce any new security vulnerabilities.
Please refer to the the docs for the API specification and samples of postman requests.
More information about technical designs can be found under the Test Results Microservice section.
Set up your nodejs environment running nvm use and once the dependencies are installed using npm i, you can run the scripts from package.json to build your project.
This code repository uses serverless framework to mock AWS capabilities for local development.
You will also require to install dynamodb serverless to run your project with by running the following command npm run tools-setup in your preferred shell.
Once dynamoDB is installed, you will need a local serverless profile to be created so that you can start developping locally.
The profiles are stored under ~/.aws/credentials.
# ~/.aws/credentials
# Please not only serverless is used to develop locally, not deployment of services are done with this framework
# It might look like this
[default]
aws_access_key_id=<yourDummyAccesskey>
aws_secret_access_key=<yourDummySecret>
Please refer to the local development section to configure your project locally.
The BRANCH environment variable indicates in which environment is this application running. Use BRANCH=local for local deployment. This variable is required when starting the application or running tests.
The real lambda function of this repository can be found under src/handler.ts, and is a middleware function that calls lambda functions created by you according to the mapping declared in the configuration as a proxy integration pattern.
The configuration file can be found under src/config/config.yml.
Environment variable injection is possible with the syntax:
${BRANCH}, or you can specify a default value: ${BRANCH:local}
Before running the start script, please make sure you have changed your dynamoDB to point locally.
Please refer to developping locally section and also make sure you have dynamoDB credentials set up.
Please request the relevant credentials to be added locally to the ~/.aws/credentials file.
- install deps;
npm install - install local dynamo-db:
npm run tools-setup - build: project:
npm run build - start webserver for local development:
npm run start
You won't need to do anything.
However, if you want the database to be populated with mock data on start, in your serverless.yml file, you need to set seed to true. You can find this setting under custom > dynamodb > start.
If you choose to run the DynamoDB instance separately, you can send the seed command with the following command:
sls dynamodb seed --seed=seed_name
Under custom > dynamodb > seed you can define new seed operations with the following config:
custom:
dynamodb:
seed:
seed_name:
sources:
- table: TABLE_TO_SEED
sources: [./path/to/resource.json]You will not require to change the config to run the service locally. The local dynamoDB config will be the following for seeding the table:
migrate: true
seed: true
noStart: falseThe following environmental variables can be given to your serverless scripts to trace and debug your service:
AWS_XRAY_CONTEXT_MISSING = LOG_ERROR
SLS_DEBUG = *
BRANCH = localJest is used for unit testing. Please refer to the Jest documentation for further details.
In order to test, you need to run the following:
npm run test # unit testsIn order to test, you need to run the following, with the service running locally:
npm run test-i # for integration testsinstall and build if not done before
- install deps;
npm install - install local dynamo-db:
npm run tools-setup - build: project:
npm run build
We follow a gitflow approach for development. For the CI/CD and automation please refer to the following pages for further details:
If the record being amended only contains one item in the testTypes array, the default behaviour is to map the test types in the database which were not amended back onto the record. This behaviour was introduced as part of #268.
The projects has multiple hooks configured using husky which will execute the following scripts: commit-msg, pre-commit, and prepush.
The codebase uses typescript clean code standards as well as sonarqube for static analysis.
SonarQube is available locally, please follow the instructions below if you wish to run the service locally (brew is the preferred approach).
SonarQube code coverage analysis has been added as part of the git prepush hook. This is to better align with what happens in the pipeline.
To get it working locally, follow these steps:
- Ensure SonarQube is installed. Running in a container is a great option.
- Within SonarQube, Disable Force user authentication via Administration -> Configuration -> Security.
- Install jq with
sudo apt install jqorbrew install jq. When runninggit push, it will run tests followed by the SonarQube scan. If the scan fails or the unit test coverage is below 80%, the push is cancelled.