feat: add tests and fix env

Author: Lenbkr

.env.template

@@ -9,6 +9,6 @@ HOST=0.0.0.0
 # Auth lib
 AUTH_URL=http://localhost:8080
 KEYCLOAK_REALM=tazama
-CERT_PATH=private-key.pem
+CERT_PATH_PRIVATE=private-key.pem
 CLIENT_SECRET=
 CLIENT_ID=

.husky/pre-push

@@ -0,0 +1 @@
+npm test

README.md

@@ -30,7 +30,7 @@ A [registry](https://github.com/frmscoe/docs) of environment variables is provid
 | `KEYCLOAK_REALM` | KeyCloak Realm for Tazama | `tazama`
 | `CLIENT_ID` | KeyCloak defined client for auth-lib | `auth-lib-client`
 | `CLIENT_SECRET` | The secret of the KeyCloak client | `someClientGeneratedSecret123`
-| `CERT_PATH` | The pem file path for signing Tazama tokens | `/path/to/private-key.pem`
+| `CERT_PATH_PRIVATE` | The pem file path for signing Tazama tokens | `/path/to/private-key.pem`
 
 #### Build and Start
 

__tests__/unit/app.test.ts

@@ -0,0 +1,46 @@
+import { AuthenticationService } from '@frmscoe/auth-lib';
+import { getTazamaToken } from '../../src/logic.service';
+
+// AuthenticationService mocked in jest.setup.ts
+
+describe('App Services', () => {
+  it('should handle getToken from library - happy path', async () => {
+    const authBody = {
+      username: 'user',
+      password: 'password',
+    };
+
+    const tazamaToken = await getTazamaToken(authBody);
+
+    expect(typeof tazamaToken).toEqual('string');
+    expect(tazamaToken).toBeDefined();
+  });
+
+  it('should handle getToken from library - blank token', async () => {
+    const authBody = {
+      username: 'blank',
+      password: 'password',
+    };
+
+    try {
+      await getTazamaToken(authBody);
+      throw new Error('UNREACHABLE');
+    } catch (err) {
+      expect(err).toEqual(new Error('getTazamaToken retrieval failed'));
+    }
+  });
+
+  it('should handle getToken from library - error from getToken', async () => {
+    const authBody = {
+      username: 'reject',
+      password: 'password',
+    };
+
+    try {
+      await getTazamaToken(authBody);
+      throw new Error('UNREACHABLE');
+    } catch (err) {
+      expect(err).toEqual(new Error('getTazamaToken retrieval failed'));
+    }
+  });
+});

eslint.config.mjs

@@ -49,6 +49,7 @@ export default [
       '**/node_modules/**',
       '**/__tests__/**',
       '**/jest.config.ts',
+      '**/jest.setup.ts',
       '**/cluster-setup.ts',
     ],
   }

jest.config.ts

@@ -0,0 +1,215 @@
+// SPDX-License-Identifier: Apache-2.0
+
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+
+import type { Config } from '@jest/types';
+
+// Sync object
+const config: Config.InitialOptions = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  bail: 1,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/fv/vk9htm4s40xd4pb2lm_3tbym0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between 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: ['src/logic.service.ts'],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: '<rootDir>/coverage/',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  coveragePathIgnorePatterns: [
+    '/node_modules/',
+    './src/interfaces',
+    './src/models',
+    './__tests__',
+    'interfaces',
+    '.module.ts',
+    '.mock.ts',
+    './src/index.ts',
+    './src/clients/arangodb.ts',
+    './src/clients/index.ts',
+    './src/clients/redis.ts',
+    './router.ts',
+    './jest.config.ts',
+  ],
+
+  // 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: {
+    global: {
+      branches: 95,
+      functions: 95,
+      lines: 95,
+      statements: 95,
+    },
+  },
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  errorOnDeprecated: 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",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "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 between every test
+  resetMocks: true,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: ".",
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: ['<rootDir>/__tests__/'],
+
+  // 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: ['dotenv/config'],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  setupFilesAfterEnv: ['./jest.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: '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: ['**/*.test.ts'],
+
+  // 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: '(/__tests__/.*|(\\.|/)(test|spec))\\.(ts|js)$',
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.ts$': '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: true,
+
+  // 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;

jest.setup.ts

@@ -0,0 +1,17 @@
+const authLib = jest.requireActual('@frmscoe/auth-lib');
+
+class MockAuthenticationService {
+  getToken(u: string, p: string): Promise<string> {
+    if (u === 'blank') {
+      return Promise.resolve('');
+    } else if (u === 'reject') {
+      return Promise.reject('REJECT');
+    } else {
+      return Promise.resolve(`${u}${p}`);
+    }
+  }
+}
+
+const mockedAuthLib = { ...authLib, AuthenticationService: MockAuthenticationService };
+
+jest.mock('@frmscoe/auth-lib', () => mockedAuthLib);