test(experimental): add some tests for the inventory

Addressed minor output issue
Trialed writing tests using mocks on mongoose or using an actual db

Author: 06kellyjac

.github/workflows/ci-experimental-inventory.yml

@@ -0,0 +1,47 @@
+name: CI - experimental - inventory
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - experimental/license-inventory/**
+  pull_request:
+    branches: [main]
+    paths:
+      - experimental/license-inventory/**
+
+permissions:
+  pull-requests: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+        mongodb-version: [4.4]
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Start MongoDB
+        uses: supercharge/[email protected]
+        with:
+          mongodb-version: ${{ matrix.mongodb-version }}
+
+      - name: Install dependencies
+        working-directory: ./experimental/license-inventory
+        run: npm ci
+
+      - name: Test
+        working-directory: ./experimental/license-inventory
+        run: |
+          MONGO_URI="mongodb://localhost:27017/inventory" npm run test

experimental/license-inventory/.gitignore

@@ -1 +1,2 @@
 node_modules
+dist

experimental/license-inventory/docker-compose.yaml

@@ -22,7 +22,6 @@ services:
       OTEL_EXPORTER_OTLP_PROTOCOL: http/protobuf
       OTEL_SERVICE_NAME: license-inventory
       OTEL_RESOURCE_ATTRIBUTES: service.version=0.0.0
-      NODE_OPTIONS: --require @opentelemetry/auto-instrumentations-node/register
     ports:
       - 3000:3000
     working_dir: /usr/src/app

experimental/license-inventory/eslint.config.mjs

@@ -1,12 +1,11 @@
-import globals from "globals";
-import pluginJs from "@eslint/js";
-import tseslint from "typescript-eslint";
-
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
 
 /** @type {import('eslint').Linter.Config[]} */
 export default [
-  {files: ["**/*.{js,mjs,cjs,ts}"]},
-  {languageOptions: { globals: globals.node }},
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: globals.node } },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
-];
+];

experimental/license-inventory/jest.config.ts

@@ -0,0 +1,16 @@
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
+import type { JestConfigWithTsJest } from 'ts-jest';
+
+const jestConfig: JestConfigWithTsJest = {
+  roots: ['<rootDir>/src'],
+  modulePaths: [compilerOptions.baseUrl],
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  globalSetup: '<rootDir>/src/test/globalSetup.ts',
+  globalTeardown: '<rootDir>/src/test/globalTeardown.ts',
+  setupFilesAfterEnv: ['<rootDir>/src/test/setupFile.ts'],
+};
+
+export default jestConfig;

experimental/license-inventory/nodemon.json

@@ -2,5 +2,5 @@
   "watch": ["src", ".env"],
   "ext": "js,ts,json",
   "ignore": ["src/**/*.{spec,test}.ts"],
-  "exec": "ts-node -r tsconfig-paths/register --transpile-only src/server.ts | pino-pretty"
+  "exec": "ts-node -r tsconfig-paths/register -r @opentelemetry/auto-instrumentations-node/register --transpile-only src/server.ts | pino-pretty"
 }