Merge pull request #6 from companieshouse/feature/idva6-1193-create-s…

…keleton-web-service

IDVA6-1193 create skeleton web service

.dockerignore

@@ -0,0 +1,9 @@
+*
+!src
+!dist
+!views
+!package.json
+!package-lock.json
+!tsconfig.json
+!docker_start.sh
+!node_modules

.eslintrc

@@ -5,7 +5,11 @@
         "sourceType": "module",
         "ecmaFeatures": {}
     },
-    "extends": ["standard"],
+    "extends": [
+        "standard",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+      ],
     "parser": "@typescript-eslint/parser",
     "overrides": [
          {
@@ -28,7 +32,7 @@
     "env": {
         "node": true,
         "commonjs": true,
-        "mocha": true,
+        "jest": true,
         "es6": true
     }
 }

.gitignore

@@ -111,3 +111,4 @@ typings/
 
 # IDE metadata
 .idea
+.vscode

Dockerfile

@@ -0,0 +1,12 @@
+ARG IMAGE_VERSION="latest"
+FROM 416670754337.dkr.ecr.eu-west-2.amazonaws.com/ci-node-runtime-20:${IMAGE_VERSION} 
+
+WORKDIR /opt/dist
+
+COPY dist docker_start.sh ./
+COPY ./package.json ./package-lock.json /opt/
+COPY node_modules /opt/node_modules
+
+CMD ["./docker_start.sh"]
+
+EXPOSE 3000

Tiltfile.dev

@@ -0,0 +1,19 @@
+local_resource(
+    name = 'dev:acsp-manage-users-web',
+    cmd = 'npm run build',
+    deps = ['src']
+)
+
+custom_build(
+    ref = 'acsp-manage-users-web:latest',
+    #the following build-command was updated as specified by https://github.com/companieshouse/docker-chs-development/pull/581
+    command = 'DOCKER_BUILDKIT=0 docker build --build-arg SSH_PRIVATE_KEY="$(ssh_key_path="$(ssh -G github.com | grep -e \'^identityfile.*\' | head -n1 | sed \'s|^identityfile \\(.*\\)|\\1|\')"; if [ -z "${ssh_key_path}" ]; then echo "Could not find ssh key path for github.com">&2; false; elif [ -f "${ssh_key_path}" ]; then cat "${ssh_key_path}"; else echo "Could not find ssh key for github at ${ssh_key_path}" >&2; false; fi)" --build-arg SSH_PRIVATE_KEY_PASSPHRASE --tag $EXPECTED_REF .',
+    live_update = [
+        sync(local_path = './src', remote_path = '/opt/src'),
+        restart_container()
+    ],
+    deps = [
+        './dist',
+        './src'
+    ]
+)

assets/src/scss/__global.scss

@@ -1,22 +1,13 @@
 $govuk-global-styles: true;
 
-@import "node_modules/govuk-frontend/govuk/all";
-
-html {
-  font-family: arial;
-}
-body {
-  .govuk-header__logo {
-    width: 35%;
-  }
-  .govuk-header__content {
-    width: 65%;
+@function custom-url-handler($filename) {
+    @return url("/fonts/#{$filename}");
   }
-}
 
-form {
-  fieldset {
-    border: 0;
-  }
-}
+$govuk-font-url-function: 'custom-url-handler';
+
+@import "node_modules/govuk-frontend/govuk/all";
 
+* {
+    font-family: "GDS Transport", Arial, sans-serif;
+}

docker_start.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+PORT=3000
+
+export NODE_PORT=${PORT}
+exec node /opt/dist/server.js -- ${PORT}

gulpfile.js

@@ -41,7 +41,7 @@ gulp.task("sass", () => {
 // Build and minify all .js files into app.min.js
 gulp.task("js", () => {
     return gulp
-        .src([`${srcDirJs}/*.js`, `${srcDirJs}/lib/*.js`])
+        .src([`${srcDirJs}/*.js`, "node_modules/govuk-frontend/govuk/all.js"])
         .pipe(concat("app.min.js"))
         .pipe(uglify())
         .pipe(gulp.dest(dstDirJs));

jest.config.ts

@@ -0,0 +1,201 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from "jest";
+
+const config: Config = {
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
+
+    // Stop running tests after `n` failures
+    // bail: 0,
+
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "/private/var/folders/9d/fzz80_hn16l_s4lhhrrx8q8r0000gn/T/jest_dx",
+
+    // Automatically clear mock calls, instances, contexts and results before every test
+    clearMocks: true,
+
+    // Indicates whether the coverage information should be collected while executing the test
+    // collectCoverage: true,
+
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: undefined,
+
+    // The directory where Jest should output its coverage files
+    // coverageDirectory: "coverage",
+
+    // An array of regexp pattern strings used to skip coverage collection
+    // coveragePathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // Indicates which provider should be used to instrument code for coverage
+    coverageProvider: "v8",
+
+    // A list of reporter names that Jest uses when writing coverage reports
+    // coverageReporters: [
+    //   "json",
+    //   "text",
+    //   "lcov",
+    //   "clover"
+    // ],
+
+    // An object that configures minimum threshold enforcement for coverage results
+    // coverageThreshold: undefined,
+
+    // A path to a custom dependency extractor
+    // dependencyExtractor: undefined,
+
+    // Make calling deprecated APIs throw helpful error messages
+    // errorOnDeprecated: false,
+
+    // The default configuration for fake timers
+    // fakeTimers: {
+    //   "enableGlobally": false
+    // },
+
+    // Force coverage collection from ignored files using an array of glob patterns
+    // forceCoverageMatch: [],
+
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: undefined,
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: undefined,
+
+    // A set of global variables that need to be available in all test environments
+    // globals: {},
+
+    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+    // maxWorkers: "50%",
+
+    // An array of directory names to be searched recursively up from the requiring module's location
+    // moduleDirectories: [
+    //   "node_modules"
+    // ],
+
+    // An array of file extensions your modules use
+    // moduleFileExtensions: [
+    //   "js",
+    //   "mjs",
+    //   "cjs",
+    //   "jsx",
+    //   "ts",
+    //   "tsx",
+    //   "json",
+    //   "node"
+    // ],
+
+    // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
+
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
+
+    // Activates notifications for test results
+    // notify: false,
+
+    // An enum that specifies notification mode. Requires { notify: true }
+    // notifyMode: "failure-change",
+
+    // A preset that is used as a base for Jest's configuration
+    preset: "ts-jest",
+
+    // Run tests from one or more projects
+    // projects: undefined,
+
+    // Use this configuration option to add custom reporters to Jest
+    // reporters: undefined,
+
+    // Automatically reset mock state before every test
+    // resetMocks: false,
+
+    // Reset the module registry before running each individual test
+    // resetModules: false,
+
+    // A path to a custom resolver
+    // resolver: undefined,
+
+    // Automatically restore mock state and implementation before every test
+    // restoreMocks: false,
+
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: undefined,
+
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
+
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
+
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
+
+    // A list of paths to modules that run some code to configure or set up the testing framework before each test
+    setupFilesAfterEnv: ["./test/src/setup.ts"],
+
+    // The number of seconds after which a test is considered as slow and reported as such in the results.
+    // slowTestThreshold: 5,
+
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
+
+    // The test environment that will be used for testing
+    // testEnvironment: "jest-environment-node",
+
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
+
+    // Adds a location field to test results
+    // testLocationInResults: false,
+
+    // The glob patterns Jest uses to detect test files
+    // testMatch: [
+    //   "**/__tests__/**/*.[jt]s?(x)",
+    //   "**/?(*.)+(spec|test).[tj]s?(x)"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    // testPathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // The regexp pattern or array of patterns that Jest uses to detect test files
+    // testRegex: [],
+
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: undefined,
+
+    // This option allows use of a custom test runner
+    // testRunner: "jest-circus/runner",
+
+    // A map from regular expressions to paths to transformers
+    transform: {
+        "^.+\\.(ts|tsx)?$": "ts-jest"
+    }
+
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "/node_modules/",
+    //   "\\.pnp\\.[^\\/]+$"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
+
+    // Indicates whether each individual test should be reported during the run
+    // verbose: undefined,
+
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
+
+    // Whether to use watchman for file crawling
+    // watchman: true,
+};
+
+export default config;