feat(cvsb-19169): Created new template (#3)

* feat(cvsb-19169): Created new template

* feat(cvsb-19169): added dvsa tslint rules

* fix(cvsb-19169): Fixed build error

* fix(cvsb-19169): fix tests

* feat(cvsb-19169): added a line about how to check that the template is running correctly

* docs(cvsb-19169): removed further reading links from DDD section

* feat(cvsb-19169): extracted the ticket format to a variable and updated the error message

* chore(cvsb-19169): removed vscode directory

* docs(cvsb-19169): removed redundant image

* docs(cvsb-19169): tweaked commitlint to allow Nodev10 compatibility

* feat(cvsb-19691): moved tests to tests folder

* fix(cvsb-19169): remove deploy command

* chore(cvsb-19169): Tidy up the webpack build config

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: https://EditorConfig.org
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,ts, *.json, *.yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab

.eslintignore

@@ -0,0 +1,8 @@
+node_modules
+.serverless
+.vscode
+*.config.js
+.webpack
+**/*.js
+.build,
+jest.config.ts

.eslintrc.js

@@ -0,0 +1,13 @@
+//https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'prettier/@typescript-eslint',
+    '@dvsa/eslint-config-ts',
+  ],
+};

.github/.dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: 'npm'
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: '/'
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: 'daily'

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+## Ticket title
+One line description
+[link to ticket number]()
+
+## Checklist
+- [ ] Code has been tested manually
+- [ ] PR title includes the JIRA ticket number
+- [ ] Branch is rebased against the latest develop
+- [ ] Squashed commit contains the JIRA ticket number

.gitignore

@@ -1,17 +1,45 @@
-# OS generated files #
-######################
+# MacOS specific hidden files
 .DS_Store
-.DS_Store?
+.AppleDouble
+.LSOverride
+Icon
 ._*
+.DocumentRevisions-V100
+.fseventsd
 .Spotlight-V100
+.TemporaryItems
 .Trashes
-ehthumbs.db
-# Ignore from project
-node_modules/**
-.build/**
-.artifacts/**
-npm-debug.log
-.serverless/**
-.vscode/**
-/**/*.tar
-/**/*.zip
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# package directories
+node_modules
+jspm_packages
+
+# Serverless directories
+.serverless
+
+# Webpack directories
+.webpack
+.serverless
+.build
+.artifact
+*.zip
+
+# env files
+*.env*
+
+# Coverage reports
+coverage
+reports
+.scannerwork
+
+# Source maps
+*.map
+
+.vscode/

.npm-version

@@ -0,0 +1 @@
+6.14.5

.npmrc

@@ -0,0 +1,13 @@
+# https://docs.npmjs.com/cli/v6/configuring-npm/npmrc
+# ~/.npm-init.js
+# https://docs.npmjs.com/cli/v6/using-npm/config
+# https://docs.npmjs.com/cli/v6/commands/npm-audit
+audit-level = high
+audit = true
+init-version = "1.0.0"
+# save exact dependencies in case some do not rely on semver toa void dependencies hell
+save-exact = true
+sign-git-commit = false
+# handled by semantic release - format is x.x.x compying with semver standards
+# tag-version-prefix
+versions = true

.nvmrc

@@ -0,0 +1 @@
+12.5.0

.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+.serverless
+.webpack
+.artifact
+.build

.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  printWidth: 120,
+  singleQuote: true,
+  trailingComma: 'all',
+};

.releaserc.json

@@ -0,0 +1,35 @@
+{
+  "branches": ["master"],
+  "repositoryUrl": "https://github.com/dvsa/cvs-svc-template.git",
+  "tagFormat": "${version}",
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "releaseRules": [
+          { "type": "docs", "release": "patch" },
+          { "type": "breaking", "release": "major" }
+        ],
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING_CHANGES", "BREAKING", "BREAKING_CHANGE"]
+        }
+      }
+    ],
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/git",
+      {
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "preset": "angular"
+}

.secignore

@@ -0,0 +1 @@
+.npmrc

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Driver & Vehicle Standards Agency
+Copyright (c) 2019 Driver & Vehicle Standards Agency
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1 +1,155 @@
-# cvs-template
+# cvs-svc-template
+
+The template for CVS lambda services
+
+## Dependencies
+
+The project runs on node 12.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 explicitely done per project using an `.npmrc` file.
+
+## Running the project
+
+Once the dependencies are installed, you will be required to rename the `/config/env.example` file to `.env.local` as we use dotenv files for configuration for local local development for example. Further 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.
+
+The application runs on port `:3001` by default when no stage is provided.
+
+### Environments
+
+We use `NODE_ENV` environment variable to set multi-stage builds (region, stages) with the help of dotenv through npm scripts to load the relevant `.env.<NODE_ENV>` file from `./config` folder into the `serverless.yml` file as we don't rely on serverless for deployment.
+If no `NODE_ENV` value is provided when running the scripts, it will default its `NODE_ENV` value to 'development' with the `.env.development` 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
+// ./config/.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 conjonction
+```
+
+```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 the secrets are will stored in `AWS Secrets Manager`.
+
+### Scripts
+
+The following scripts are available, for further information please refer to the project `package.json` file:
+
+- <b>start</b>: `npm start` - _launch serverless offline service_
+- <b>dev</b>: `npm run dev` - _run in parallel the service and unit tests in_ `--watch` _mode with live reload_.
+- <b>test</b>: `npm t` - _execute the unit test suite_
+- <b>build</b>: `npm run build` - _bundle the project for production_
+
+### Offline
+
+Serverless-offline with webpack is used to run the project locally. Please use `npm run dev` script to do so. Go to `http://localhost:3001/local/version` to confirm that everything has loaded correctly, you should see that the version is the same as the version in the `package.json`
+
+### Lambda locally
+
+Serverless can invoke lambda functions locally which provide a close experience to the real service if you decide not use the offline mode. `events` and `paths` can be found under `/local` folder.
+For further details using lambda locally please refer to the [serverless documentation](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke-local/).
+
+### Debugging
+
+Existing configuration to debug the running service has been made available for vscode, please refer to `.vscode/launch.json` file. Serverless offline will be available on port `:4000`. 2 jest configurations are also provided which will allow to run a test or multiple tests.
+
+For further information about debugging, please refer to the following documentation:
+
+- [Run-a-function-locally-on-source-changes](https://github.com/serverless-heaven/serverless-webpack#run-a-function-locally-on-source-changes)
+
+- [VSCode debugging](https://github.com/serverless-heaven/serverless-webpack#vscode-debugging)
+
+- [Debug process section](https://www.serverless.com/plugins/serverless-offline#usage-with-webpack)
+
+## Testing
+
+[json-serverless](https://github.com/pharindoko/json-serverless) has been added to the repository should we wish to mock external services during development and can be used in conjunction with the `test` environment.
+
+### Unit
+
+Jest is used for unit testing.
+Please refer to the [Jest documentation](https://jestjs.io/docs/en/getting-started) for further details.
+
+### Integration
+
+To be added and customised depending on needs, supertest is used but we could be looking at other packages such as nock, ts-mockito, typemoq, wiremock, etc.. or testing (pactjs, hoverfly, mockserver, etc..)
+
+## Infrastructure
+
+<Insert Design>
+
+### 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 `master` 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 `<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](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
+
+#### Code structure
+
+Domain Drive Design diagram with Interfaces, Application, Domain layers and Infrastructure across the layers.
+
+<p align="center">
+  <img src="./docs/DDD_architecture.jpg" alt="Domain Drive Design diagram with Interfaces, Application, Domain layers and Infrastructure across the layers" >
+</p>
+
+#### 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=<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`