https://github.com/dvsa/cvs-tsk-smc-prohibition
This is for MC Prohibition
https://github.com/dvsa/cvs-tsk-smc-prohibition
Last synced: over 1 year ago
JSON representation
This is for MC Prohibition
- Host: GitHub
- URL: https://github.com/dvsa/cvs-tsk-smc-prohibition
- Owner: dvsa
- License: mit
- Created: 2022-09-16T13:26:46.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-22T15:34:36.000Z (about 2 years ago)
- Last Synced: 2024-05-22T16:33:44.978Z (about 2 years ago)
- Language: TypeScript
- Size: 890 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cvs-svc-mc-prohibitions
Service for feeding test results from DynamoDb to SMC
## Dependencies
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](https://github.com/nvm-sh/nvm/blob/master/README.md) is used to manage node versions and configuration is per project using an `.npmrc` file.
## Running the project
Before running the project, the dependencies need to be installed using `npm install`. Once the dependencies are installed, you will be required to copy the `.env.example` file to `.env.local` in the root of the project. See these for information about [variables](https://www.serverless.com/framework/docs/providers/aws/guide/variables/) and [environment variables](https://www.serverless.com/framework/docs/environment-variables/) with serverless.
Please note that multiple `.env` files can be created, one per environment. Our current development environment is 'local'.
The application runs on port `:3001` by default.
## Packaging the project locally
The `package` npm script takes a ZIP_NAME variable. To set the variable when running manually use `ZIP_NAME=zipName npm run package`. This will produce a file called zipName.zip.
### Environments
We use `NODE_ENV` environment variable to set the stage. `NODE_ENV` is set through npm scripts (package.json) to load the relevant `.env.` file from the root folder into the `serverless.yml`.
If no `NODE_ENV` value is provided when running the scripts, it will default its `NODE_ENV` value to 'local' with the `.env.local` config file.
The defaulted values for 'stage' and 'region' are `'local'`. Please refer to the values provided in the `serverless.yml` file.
The following values can be provided when running the scripts with `NODE_ENV`:
```ts
// ./.env. files
'local'; // used for local development
'development'; // used development staging should we wish to require external services
'test'; // used during test scripts where local services, mocks can be used in conjunction
```
```ts
/** Running serverless offline as an example for a specific stage - 'local'.
* Stage 'local' will be injected in the serverless.yml
**/
NODE_ENV=local serverless offline
```
Further details about environment setup can be found in the provided documentation and `.env.example` file.
All secrets will stored in `AWS Secrets Manager`.
### Scripts
The following scripts are available, for further information please refer to the project `package.json` file:
- start: `npm start` - _launch serverless offline service_
- dev: `npm run dev` - _run in parallel, the service and unit tests in_ `--watch` _mode with live reload_.
- test: `npm t` - _execute the unit test suite_
- build: `npm run build` - _build the project, transpiling typescript to javascript_
- production build: `npm run package` - _generate the project zip file ready for deployment_
### Offline
Serverless-offline is used to run the project locally. Use `npm run start` script to do so. The endpoints below are available.
```
(POST) http://localhost:3002/2015-03-31/functions/cvs-tsk-smc-prohibition-local-smcProhibitionClearance/invocations
(POST) http://localhost:3002/2014-11-13/functions/cvs-tsk-smc-prohibition-local-smcProhibitionClearance/invoke-async/
```
The function expects a DynamoDB stream event.
```json
{
"Records": [
{
"eventID": "mock-id",
"eventName": "MODIFY",
"eventVersion": "1.1",
"eventSource": "aws:dynamodb",
"awsRegion": "eu-west-1",
"dynamodb": {
"ApproximateCreationDateTime": 1641807422,
"Keys": {
"vin": {
"S": "XMGDE02FS0H012303"
},
"testResultId": {
"S": "9"
}
},
"NewImage": {
"testerStaffId": {
"S": "2"
},
"testStartTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"odometerReadingUnits": {
"S": "kilometres"
},
"testEndTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"testStatus": {
"S": "submitted"
},
"testTypes": {
"L": [
{
"M": {
"prohibitionIssued": {
"BOOL": false
},
"testCode": {
"S": "aas"
},
"testNumber": {
"S": "1"
},
"lastUpdatedAt": {
"S": "2019-02-23T08:47:59.269Z"
},
"testAnniversaryDate": {
"S": "2019-12-22T08:47:59.749Z"
},
"testTypeClassification": {
"S": "Annual With Certificate"
},
"customDefects": {
"L": [
{
"M": {
"defectNotes": {
"S": "some defect noe"
},
"referenceNumber": {
"S": "abcd"
},
"defectName": {
"S": "Some custom defect"
}
}
}
]
},
"additionalCommentsForAbandon": {
"S": "none"
},
"numberOfSeatbeltsFitted": {
"N": "2"
},
"testTypeEndTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"reasonForAbandoning": {
"S": "none"
},
"lastSeatbeltInstallationCheckDate": {
"S": "2019-01-14"
},
"deletionFlag": {
"BOOL": true
},
"createdAt": {
"S": "2019-02-22T08:47:59.269Z"
},
"testTypeId": {
"S": "1"
},
"secondaryCertificateNumber": {
"S": "1234"
},
"certificateNumber": {
"S": "1234"
},
"testTypeStartTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"testTypeName": {
"S": "Paid prohibition clearance (full inspection with certificate)"
},
"seatbeltInstallationCheckDate": {
"BOOL": true
},
"additionalNotesRecorded": {
"S": "VEHICLE FRONT REGISTRATION PLATE MISSING"
},
"defects": {
"L": [
{
"M": {
"deficiencyCategory": {
"S": "major"
},
"deficiencyText": {
"S": "missing."
},
"prs": {
"BOOL": false
},
"additionalInformation": {
"M": {
"notes": {
"S": "None"
},
"location": {
"M": {
"axleNumber": {
"NULL": true
},
"horizontal": {
"NULL": true
},
"vertical": {
"NULL": true
},
"longitudinal": {
"S": "front"
},
"rowNumber": {
"NULL": true
},
"lateral": {
"NULL": true
},
"seatNumber": {
"NULL": true
}
}
}
}
},
"itemNumber": {
"N": "1"
},
"deficiencyRef": {
"S": "1.1.a"
},
"stdForProhibition": {
"BOOL": false
},
"deficiencySubId": {
"NULL": true
},
"imDescription": {
"S": "Registration Plate"
},
"deficiencyId": {
"S": "a"
},
"itemDescription": {
"S": "A registration plate:"
},
"imNumber": {
"N": "1"
}
}
}
]
},
"name": {
"S": "Annual test"
},
"certificateLink": {
"S": "http://dvsagov.co.uk"
},
"testResult": {
"S": "prs"
}
}
}
]
},
"systemNumber": {
"S": "1120"
},
"vehicleClass": {
"M": {
"code": {
"S": "2"
},
"description": {
"S": "motorbikes over 200cc or with a sidecar"
}
}
},
"testResultId": {
"S": "9"
},
"vehicleSize": {
"S": "small"
},
"vin": {
"S": "XMGDE02FS0H012303"
},
"noOfAxles": {
"N": "2"
},
"testStationName": {
"S": "Rowe, Wunsch and Wisoky"
},
"vehicleId": {
"S": "JY58FPP"
},
"countryOfRegistration": {
"S": "united kingdom"
},
"vehicleType": {
"S": "hgv"
},
"preparerId": {
"S": "ak4434"
},
"preparerName": {
"S": "Durrell Vehicles Limited"
},
"odometerReading": {
"N": "100000"
},
"vehicleConfiguration": {
"S": "rigid"
},
"testStationType": {
"S": "gvts"
},
"reasonForCancellation": {
"S": "none"
},
"testerName": {
"S": "Dorel"
},
"deletionFlag": {
"BOOL": false
},
"vrm": {
"S": "JY58FPP"
},
"testStationPNumber": {
"S": "P99006"
},
"numberOfSeats": {
"N": "45"
},
"testerEmailAddress": {
"S": "dorel.popescu@dvsagov.uk"
},
"euVehicleCategory": {
"S": "m2"
},
"numberOfWheelsDriven": {
"N": "3"
}
},
"OldImage": {
"testerStaffId": {
"S": "1"
},
"testStartTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"odometerReadingUnits": {
"S": "kilometres"
},
"testEndTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"testStatus": {
"S": "submitted"
},
"testTypes": {
"L": [
{
"M": {
"prohibitionIssued": {
"BOOL": false
},
"testCode": {
"S": "aas"
},
"testNumber": {
"S": "1"
},
"lastUpdatedAt": {
"S": "2019-02-22T08:47:59.269Z"
},
"testAnniversaryDate": {
"S": "2019-12-22T08:47:59.749Z"
},
"testTypeClassification": {
"S": "Annual With Certificate"
},
"customDefects": {
"L": [
{
"M": {
"defectNotes": {
"S": "some defect noe"
},
"referenceNumber": {
"S": "abcd"
},
"defectName": {
"S": "Some custom defect"
}
}
}
]
},
"additionalCommentsForAbandon": {
"S": "none"
},
"numberOfSeatbeltsFitted": {
"N": "2"
},
"testTypeEndTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"reasonForAbandoning": {
"S": "none"
},
"lastSeatbeltInstallationCheckDate": {
"S": "2019-01-14"
},
"deletionFlag": {
"BOOL": true
},
"createdAt": {
"S": "2019-02-22T08:47:59.269Z"
},
"testTypeId": {
"S": "1"
},
"secondaryCertificateNumber": {
"S": "1234"
},
"testTypeStartTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"testTypeName": {
"S": "Paid prohibition clearance (full inspection with certificate)"
},
"seatbeltInstallationCheckDate": {
"BOOL": true
},
"additionalNotesRecorded": {
"S": "VEHICLE FRONT REGISTRATION PLATE MISSING"
},
"defects": {
"L": [
{
"M": {
"deficiencyCategory": {
"S": "major"
},
"deficiencyText": {
"S": "missing."
},
"prs": {
"BOOL": false
},
"additionalInformation": {
"M": {
"notes": {
"S": "None"
},
"location": {
"M": {
"axleNumber": {
"NULL": true
},
"horizontal": {
"NULL": true
},
"vertical": {
"NULL": true
},
"longitudinal": {
"S": "front"
},
"rowNumber": {
"NULL": true
},
"lateral": {
"NULL": true
},
"seatNumber": {
"NULL": true
}
}
}
}
},
"itemNumber": {
"N": "1"
},
"deficiencyRef": {
"S": "1.1.a"
},
"stdForProhibition": {
"BOOL": false
},
"deficiencySubId": {
"NULL": true
},
"imDescription": {
"S": "Registration Plate"
},
"deficiencyId": {
"S": "a"
},
"itemDescription": {
"S": "A registration plate:"
},
"imNumber": {
"N": "1"
}
}
}
]
},
"name": {
"S": "Annual test"
},
"certificateLink": {
"S": "http://dvsagov.co.uk"
},
"testResult": {
"S": "prs"
}
}
},
{
"prohibitionIssued": {
"BOOL": false
},
"testCode": {
"S": "aas"
},
"testNumber": {
"S": "1"
},
"lastUpdatedAt": {
"S": "2019-02-23T08:47:59.269Z"
},
"testAnniversaryDate": {
"S": "2019-12-22T08:47:59.749Z"
},
"testTypeClassification": {
"S": "Annual With Certificate"
},
"customDefects": {
"L": [
{
"M": {
"defectNotes": {
"S": "some defect noe"
},
"referenceNumber": {
"S": "abcd"
},
"defectName": {
"S": "Some custom defect"
}
}
}
]
},
"additionalCommentsForAbandon": {
"S": "none"
},
"numberOfSeatbeltsFitted": {
"N": "2"
},
"testTypeEndTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"reasonForAbandoning": {
"S": "none"
},
"lastSeatbeltInstallationCheckDate": {
"S": "2019-01-14"
},
"deletionFlag": {
"BOOL": true
},
"createdAt": {
"S": "2019-02-22T08:47:59.269Z"
},
"testTypeId": {
"S": "1"
},
"secondaryCertificateNumber": {
"S": "1234"
},
"testTypeStartTimestamp": {
"S": "2019-01-14T10:36:33.987Z"
},
"testTypeName": {
"S": "Paid prohibition clearance (full inspection with certificate)"
},
"seatbeltInstallationCheckDate": {
"BOOL": true
},
"additionalNotesRecorded": {
"S": "VEHICLE FRONT REGISTRATION PLATE MISSING"
},
"defects": {
"L": [
{
"M": {
"deficiencyCategory": {
"S": "major"
},
"deficiencyText": {
"S": "missing."
},
"prs": {
"BOOL": false
},
"additionalInformation": {
"M": {
"notes": {
"S": "None"
},
"location": {
"M": {
"axleNumber": {
"NULL": true
},
"horizontal": {
"NULL": true
},
"vertical": {
"NULL": true
},
"longitudinal": {
"S": "front"
},
"rowNumber": {
"NULL": true
},
"lateral": {
"NULL": true
},
"seatNumber": {
"NULL": true
}
}
}
}
},
"itemNumber": {
"N": "1"
},
"deficiencyRef": {
"S": "1.1.a"
},
"stdForProhibition": {
"BOOL": false
},
"deficiencySubId": {
"NULL": true
},
"imDescription": {
"S": "Registration Plate"
},
"deficiencyId": {
"S": "a"
},
"itemDescription": {
"S": "A registration plate:"
},
"imNumber": {
"N": "1"
}
}
}
]
},
"name": {
"S": "Annual test"
},
"certificateLink": {
"S": "http://dvsagov.co.uk"
},
"testResult": {
"S": "pass"
}
}
]
},
"systemNumber": {
"S": "1120"
},
"vehicleClass": {
"M": {
"code": {
"S": "2"
},
"description": {
"S": "motorbikes over 200cc or with a sidecar"
}
}
},
"testResultId": {
"S": "9"
},
"vehicleSize": {
"S": "small"
},
"vin": {
"S": "XMGDE02FS0H012303"
},
"noOfAxles": {
"N": "2"
},
"testStationName": {
"S": "Rowe, Wunsch and Wisoky"
},
"vehicleId": {
"S": "JY58FPP"
},
"countryOfRegistration": {
"S": "united kingdom"
},
"vehicleType": {
"S": "lgv"
},
"preparerId": {
"S": "ak4434"
},
"preparerName": {
"S": "Durrell Vehicles Limited"
},
"odometerReading": {
"N": "100000"
},
"vehicleConfiguration": {
"S": "rigid"
},
"testStationType": {
"S": "gvts"
},
"reasonForCancellation": {
"S": "none"
},
"testerName": {
"S": "Dorel"
},
"deletionFlag": {
"BOOL": false
},
"vrm": {
"S": "JY58FPP"
},
"testStationPNumber": {
"S": "P99006"
},
"numberOfSeats": {
"N": "45"
},
"testerEmailAddress": {
"S": "dorel.popescu@dvsagov.uk"
},
"euVehicleCategory": {
"S": "m2"
},
"numberOfWheelsDriven": {
"N": "3"
}
},
"SequenceNumber": "123456789",
"SizeBytes": 3701,
"StreamViewType": "NEW_AND_OLD_IMAGES"
},
"eventSourceARN": "mock-arn"
}
]
}
```
Complete examples can be found in the `./tests/unit/data` folder.
### Debugging
Existing configuration to debug the running service has been made available for vscode, please refer to `.vscode/launch.json`. Two jest configurations are also provided which will allow debugging a test or multiple tests.
## Environmental variables
The following variables are supported in the `.env.` file.
- AWS_PROVIDER_PROFILE=default
- AWS_REGION=eu-west-1
- AWS_SERVER_PORT=3009
- AWS_EVENT_BUS_NAME=default
- AWS_EVENT_BUS_SOURCE=eventBusName
## Testing
### Unit
Jest is used for unit testing. Jest mocks have been added for external services and other dependencies when needed. Debugging tests is possible using the two options configured in ./vscode/launch.json `Jest Debug all tests` and `Jest Debug opened file`. Using the Jest vscode extension is also a very good option. Please refer to the [Jest documentation](https://jestjs.io/docs/en/getting-started) for further details.
### Integration
TBC
## Infrastructure
### Release
Releases (tag, release notes, changelog, github release, assets) are automatically managed by [semantic-release](https://semantic-release.gitbook.io/semantic-release/) and when pushing (or merging) to `develop` branch which is protected. [semver](https://semver.org/) convention is followed.
Please be familiar with conventional commit as described in the Contributing section below.
Default preset used is angular for conventional commits, please see the [angular conventions](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum).
The `` `'breaking'` in the commit message will trigger a major version bump as well as any of the following text contained in the commit body: `"BREAKING CHANGE", "BREAKING CHANGES", "BREAKING_CHANGES", "BREAKING", "BREAKING_CHANGE"`. Please refer to the `.releaserc.json` file for the full configuration.
The script `npm run release` will automatically trigger the release in CI. To manually test the release the following flags -`--dry-run --no-ci` - can be passed to the release script.
Publishing and artifacts are managed separately by the pipeline.
## Contributing
To facilitate the standardisation of the code, a few helpers and tools have been adopted for this repository.
### External dependencies
The projects has multiple hooks configured using [husky](https://github.com/typicode/husky#readme) which will execute the following scripts: `audit`, `lint`, `build`, `test` and format your code with [eslint](https://github.com/typescript-eslint/typescript-eslint#readme) and [prettier](https://github.com/prettier/prettier).
You will be required to install [git-secrets](https://github.com/awslabs/git-secrets) (_brew approach is recommended_) and DVSA [repo-security-scanner](https://github.com/UKHomeOffice/repo-security-scanner) that runs against your git log history to find accidentally committed passwords, private keys.
We follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) when we commit code to the repository and follow the [angular convention](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum).
The type is mandatory and must be all lowercase.
The scope of your commit remain is also mandatory, it must include your ticket number and be all lowercase. The format for the ticket number can be set in the commitlint.config.js file.
```js
// Please see /commitlint.config.js for customised format
type(scope?): subject
// examples
'chore(cvsb-1234): my commit msg' // pass
'CHORE(cvsb-1234): my commit msg' // will fail
```
### Code standards
#### Toolings
The code uses [eslint](https://eslint.org/docs/user-guide/getting-started), [typescript clean code standards](https://github.com/labs42io/clean-code-typescript) 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):
- _Brew_:
- Install sonarqube using brew
- Change `sonar.host.url` to point to localhost, by default, sonar runs on `http://localhost:9000`
- run the sonar server `sonar start`, then perform your analysis `npm run sonar-scanner`
- _Manual_:
- Add sonar-scanner in environment variables in your \_profile file add the line: `export PATH=/sonar-scanner-3.3.0.1492-macosx/bin:$PATH`
- Start the SonarQube server: `cd /bin/macosx-universal-64 ./sonar.sh start`
- In the microservice folder run the command: `npm run sonar-scanner`