https://github.com/dvsa/cvs-svc-preparers
Manages authorised vehicle preparers
https://github.com/dvsa/cvs-svc-preparers
app-dev cvs-project
Last synced: about 1 year ago
JSON representation
Manages authorised vehicle preparers
- Host: GitHub
- URL: https://github.com/dvsa/cvs-svc-preparers
- Owner: dvsa
- License: mit
- Created: 2018-11-14T14:56:28.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-24T10:14:33.000Z (over 1 year ago)
- Last Synced: 2024-10-24T23:04:47.962Z (over 1 year ago)
- Topics: app-dev, cvs-project
- Language: TypeScript
- Homepage:
- Size: 1.31 MB
- Stars: 0
- Watchers: 11
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cvs-svc-preparers
## Introduction
The preparers defects microservice contains some reference data to be used for CVS services and [mobile application](https://github.com/dvsa/cvs-app-mobile) for DVSA.
The reference data is used in ... part of the application.
---
## 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 managed node versions and configuration explicitly done per project using an `.npmrc` file.
---
### Prerequisites
Please install and run the following security programs as part of your development process:
- [git-secrets](https://github.com/awslabs/git-secrets)
After installing, do a one-time set up with `git secrets --register-aws`. Run with `git secrets --scan`.
These will be run as part of your projects hooks so you don't accidentally introduce any new security vulnerabilities.
---
## Architecture
Data is used is made available to VTA for searching a vehicle.
Please refer to the the [docs](./docs/README.md) for the API specification and samples of postman requests.
### End to end design
[All in one view](https://wiki.dvsacloud.uk/pages/viewpage.action?pageId=79254695)
### Preparers microservice
More information about technical designs can be found under the [Preparers Microservice](https://wiki.dvsacloud.uk/display/HVT/Preparers+Microservice) section.
---
## Getting started
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](https://www.serverless.com/framework/docs/) to mock AWS capabilities for local development only.
You will also require to install dynamodb serverless to run your project with by running the following command `npm run 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`.
```sh
# ~/.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=
aws_secret_access_key=
```
Please refer to the local development section to [configure your project locally](#developing-locally).
### Environmental variables
The `BRANCH` environment variable indicates in which environment is this application running. Use `BRANCH=local` for local development. This variable is required when starting the application or running tests.
### Scripts
The following scripts are available, however you can refer to the `package.json` to see the details:
- install dependencies: `npm install` or `npm i`
- local development: `npm start`
- build: `npm run build`
- unit tests: `npm test` or `npm t`
- integration tests: `npm run test-i`
### DynamoDB and seeding
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`, however please note that the `start` script will already handle that for you!
If you choose to run the DynamoDB instance separately, you can send the seed command with the following command:
`sls dynamodb seed --seed=preparers`
Under `custom > dynamodb > seed` you can define new seed operations with the following config:
```yml
custom:
dynamodb:
seed:
[SEED NAME HERE]:
sources:
- table: [TABLE TO SEED]
sources: [./path/to/resource.json]
```
### Developing locally
Dynamo should not require further configuration and a local instance with serverless framework will provide a mock you.
Default local configuration in `serverless.yml` file:
```yml
migrate: true
seed: true
noStart: false
```
### Debugging
The following environmental variables can be given to your serverless scripts to trace and debug your service:
```shell
AWS_XRAY_CONTEXT_MISSING = LOG_ERROR
SLS_DEBUG = *
BRANCH = local
```
---
## Testing
Jest is used for unit testing.
Please refer to the [Jest documentation](https://jestjs.io/docs/en/getting-started) for further details.
### Unit test
In order to test, you need to run the following:
```sh
npm run test # unit tests
```
### Integration test
In order to test, you need to run the following, with the service running locally:
```sh
npm run test-i # for integration tests
```
### End to end
- [Automation test repository](https://github.com/dvsa/cvs-auto-svc)
- [Java](https://docs.oracle.com/en/java/javase/11/)
- [Serenity Cucumber with Junit](https://serenity-bdd.github.io/theserenitybook/latest/junit-basic.html)
---
## Infrastructure
We follow a [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) approach for development.
For the CI/CD and automation please refer to the following pages for further details:
- [Development process](https://wiki.dvsacloud.uk/display/HVT/CVS+Pipeline+Infrastructure)
- [Pipeline](https://wiki.dvsacloud.uk/pages/viewpage.action?pageId=36870584)
---
## Contributing
### Hooks and code standards
The projects has multiple hooks configured using [husky](https://github.com/typicode/husky#readme) which will execute the following scripts: `security-checks`, `audit`, `tslint`, `prepush`.
The codebase uses [typescript clean code standards](https://github.com/labs42io/clean-code-typescript), tslint as well as sonarqube for static code analysis.
SonarQube is available locally, please follow the instructions below if you wish to run the service locally (brew is the preferred approach).
### Static code analysis
_Brew_ (recommended):
- 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_:
- [Download sonarqube](https://www.sonarqube.org/downloads/)
- 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