EXPERIMENTAL vNext Quoting (Agreements) Bounded Context
The Quoting and Agreements Bounded Context provides participants with quotations for undertaking transfers, and records the participant accept/reject responses.
The Quoting BC consists of the following packages;
quoting-svc
Quoting/Agreement Service.
README
domain-lib
Domain library types.
README
implementation-lib
Quoting Implementation Library.
README
shared-mocks-lib
Mock implementation used for testing.
README
Please follow the instruction in Onboarding Document to setup and run the service locally.
See the README.md file on each services for more Environment Variable Configuration options.
Logs are sent to standard output by default.
npm run test:unit
npm run test:integration
Requires integration tests pre-requisites
npm run test
After running the unit and/or integration tests:
npm run posttest
You can then consult the html report in:
coverage/lcov-report/index.html
We use npm audit to check dependencies for node vulnerabilities.
To start a new resolution process, run:
npm run audit:fix
You can check to see if the CI will pass based on the current dependencies with:
npm run audit:check
Execute locally the pre-commit checks - these will be executed with every commit and in the default CI/CD pipeline
Make sure these pass before committing any code
npm run pre_commit_check
As part of our CI/CD process, we use CircleCI. The CircleCI workflow automates the process of publishing changed packages to the npm registry and building Docker images for select packages before publishing them to DockerHub. It also handles versioning, tagging commits, and pushing changes back to the repository.
The process includes five phases.
-
Setup : This phase initializes the environment, loads common functions, and retrieves commits and git change history since the last successful CI build.
-
Detecting Changed Package.
-
Publishing Changed Packages to NPM.
-
Building Docker Images and Publishing to DockerHub.
-
Pushing Commits to Git.
All code is automatically linted, built, and unit tested by CircleCI pipelines, where unit test results are kept for all runs. All libraries are automatically published to npm.js, and all Docker images are published to Docker Hub.
The following documentation provides insight into the Settlements Bounded Context.