Skip to content

Latest commit

 

History

History
195 lines (126 loc) · 9.07 KB

README.md

File metadata and controls

195 lines (126 loc) · 9.07 KB
Raw

cvs-tsk-atf-daily-schedules

Service for extracting ATF daily schedules and importing into DynamicsCE via AWS EventBridge.

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 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. Further information about variables and 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 :3002 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.<NODE_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:

// ./.env.<NODE_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
/** 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-atf-daily-schedules-local-processWmsData/invocations
(POST) http://localhost:3002/2014-11-13/functions/cvs-tsk-atf-daily-schedules-local-processWmsData/invoke-async/

When no payload is sent to the function, the daily schedules for the current day are retrieved. To specify a different date, a payload can be sent to the function as shown below.

{ "detail": { "exportDate": "2021-11-29" } }

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.<NODE_ENV> file.

  • AWS_PROVIDER_PROFILE=default
  • AWS_REGION=eu-west-1
  • AWS_SERVER_PORT=3009
  • AWS_EVENT_BUS_NAME=default
  • AWS_EVENT_BUS_SOURCE=eventSourceName
  • LOG_LEVEL=info
  • WMS_HOST=mysqlURL
  • WMS_PORT=3306
  • WMS_USER=mysqlUser
  • WMS_PASSWORD=password123
  • WMS_SCHEMA=databaseName
  • WMS_SSL_CERT=certificateName

The LOGLEVEL values used in this project are debug, info, error and are case sensitive. LOG_LEVEL can be omitted, in which case it will default to info.
The WMS variables are used for connecting to mysql. There are three variations depending on where you are connecting to and the authenticate method.

Local mysql

  • WMS_HOST=mysqlURL
  • WMS_PORT=3306
  • WMS_USER=mysqlUser
  • WMS_PASSWORD=password123
  • WMS_SCHEMA=databaseName

Aurora mysql

  • WMS_HOST=mysqlURL
  • WMS_PORT=3306
  • WMS_USER=mysqlUser
  • WMS_PASSWORD=password123
  • WMS_SCHEMA=databaseName
  • WMS_SSL_CERT=certificateName

Same as local, but need WMS_SSL_CERT

Aurora mysql with IAM authentication

  • WMS_HOST=mysqlURL
  • WMS_PORT=3306
  • WMS_USER=mysqlUser
  • WMS_SCHEMA=databaseName
  • WMS_SSL_CERT=certificateName

Same as Aurora mysql, but missing WMS_PASSWORD. The code will get a token via RDS Signing.

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 for further details.

Integration

TBC

Infrastructure

Release

Releases (tag, release notes, changelog, github release, assets) are automatically managed by semantic-release and when pushing (or merging) to develop branch which is protected. semver 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.

The <type> '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 which will execute the following scripts: audit, lint, build, test and format your code with eslint and prettier.

You will be required to install git-secrets (brew approach is recommended) and DVSA repo-security-scanner that runs against your git log history to find accidentally committed passwords, private keys.

We follow the conventional commit format when we commit code to the repository and follow the angular convention.

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.

// 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, 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):

  • 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=<PATH_TO_SONAR_SCANNER>/sonar-scanner-3.3.0.1492-macosx/bin:$PATH
    • Start the SonarQube server: cd <PATH_TO_SONARQUBE_SERVER>/bin/macosx-universal-64 ./sonar.sh start
    • In the microservice folder run the command: npm run sonar-scanner