test: adding unit tests

package.json

@@ -13,7 +13,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "release": "standard-version",
-    "test": "npm run test:unit && npm run test:integration",
+    "test": "npm run test:unit",
     "prebuild": "npm run clean",
     "build": "tsc --project tsconfig.build.json  && npm run assets:copy",
     "start": "npm run build && cd dist && node --require ./common/tracing.js ./index.js",
@@ -84,6 +84,7 @@
     "jest": "^29.5.0",
     "jest-create-mock-instance": "^2.0.0",
     "jest-html-reporters": "^3.1.4",
+    "nock": "^13.5.4",
     "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",
     "rimraf": "^5.0.1",

src/containerConfig.ts

@@ -18,7 +18,7 @@ import { validateAndGetHandlersTokens } from './utils/configUtil';
 import { SwapJobHandler } from './models/swapJobHandler';
 import { IConfig, IJobManagerConfig, IngestionJobsConfig } from './common/interfaces';
 
-const queueClientFactory = (container: DependencyContainer): QueueClient => {
+export const queueClientFactory = (container: DependencyContainer): QueueClient => {
   const logger = container.resolve<Logger>(SERVICES.LOGGER);
   const config = container.resolve<IConfig>(SERVICES.CONFIG);
   const queueConfig = config.get<IJobManagerConfig>('jobManagement.config');

src/models/jobProcessor.ts

@@ -9,10 +9,10 @@ import { JOB_HANDLER_FACTORY_SYMBOL, JobHandlerFactory } from './jobHandlerFacto
 
 @injectable()
 export class JobProcessor {
+  private readonly dequeueIntervalMs: number;
   private readonly logContext: LogContext;
   private readonly jobTypes: string[];
   private readonly pollingTaskTypes: string[];
-  private readonly dequeueIntervalMs: number;
   private readonly ingestionConfig: IngestionConfig;
   private isRunning = true;
   public constructor(
@@ -82,7 +82,7 @@ export class JobProcessor {
     const logCtx: LogContext = { ...this.logContext, function: this.getJobWithTaskType.name };
     for (const taskType of this.pollingTaskTypes) {
       for (const jobType of this.jobTypes) {
-        this.logger.debug({ msg: `try to dequeue task of type "${taskType}" and job of type "${jobType}"`, logContext: logCtx });
+        this.logger.debug({ msg: `trying to dequeue task of type "${taskType}" and job of type "${jobType}"`, logContext: logCtx });
         const task = await this.queueClient.dequeue(jobType, taskType);
 
         if (!task) {

tests/configurations/unit/jest.config.js

@@ -14,6 +14,11 @@ module.exports = {
     '!**/routes/**',
     '!<rootDir>/src/*',
   ],
+  modulePathIgnorePatterns: [
+    '<rootDir>/src/models/newJobHandler.ts',
+    '<rootDir>/src/models/swapJobHandler.ts',
+    '<rootDir>/src/models/updateJobHandler.ts',
+  ],
   coverageDirectory: '<rootDir>/coverage',
   reporters: [
     'default',

tests/helpers/containerConfig.ts

@@ -0,0 +1,43 @@
+import jsLogger from '@map-colonies/js-logger';
+import { container, instancePerContainerCachingFactory } from 'tsyringe';
+import { trace } from '@opentelemetry/api';
+import { InjectionObject } from '../../src/common/dependencyRegistration';
+import { configMock, getMock, hasMock, registerDefaultConfig } from '../unit/mocks/configMock';
+import { SERVICES } from '../../src/common/constants';
+import { queueClientFactory } from '../../src/containerConfig';
+import { IngestionJobsConfig } from '../../src/common/interfaces';
+import { validateAndGetHandlersTokens } from '../../src/utils/configUtil';
+import { NewJobHandler } from '../../src/models/newJobHandler';
+import { UpdateJobHandler } from '../../src/models/updateJobHandler';
+import { SwapJobHandler } from '../../src/models/swapJobHandler';
+import { JOB_HANDLER_FACTORY_SYMBOL, jobHandlerFactory } from '../../src/models/jobHandlerFactory';
+
+function getTestContainerConfig(): InjectionObject<unknown>[] {
+  registerDefaultConfig();
+
+  const ingestionConfig = configMock.get<IngestionJobsConfig>('jobManagement.ingestion.jobs');
+
+  const handlersTokens = validateAndGetHandlersTokens(ingestionConfig);
+
+  return [
+    { token: SERVICES.LOGGER, provider: { useValue: jsLogger({ enabled: false }) } },
+    { token: SERVICES.CONFIG, provider: { useValue: configMock } },
+    { token: SERVICES.TRACER, provider: { useValue: trace.getTracer('testTracer') } },
+    { token: SERVICES.QUEUE_CLIENT, provider: { useFactory: instancePerContainerCachingFactory(queueClientFactory) } },
+    { token: JOB_HANDLER_FACTORY_SYMBOL, provider: { useFactory: instancePerContainerCachingFactory(jobHandlerFactory) } },
+    { token: handlersTokens.Ingestion_New, provider: { useClass: NewJobHandler } },
+    { token: handlersTokens.Ingestion_Update, provider: { useClass: UpdateJobHandler } },
+    { token: handlersTokens.Ingestion_Swap_Update, provider: { useClass: SwapJobHandler } },
+  ];
+}
+
+const resetContainer = (clearInstances = true): void => {
+  if (clearInstances) {
+    container.clearInstances();
+  }
+
+  getMock.mockReset();
+  hasMock.mockReset();
+};
+
+export { getTestContainerConfig, resetContainer };

tests/integration/helpers/containerConfig.ts

@@ -0,0 +1,43 @@
+import jsLogger from '@map-colonies/js-logger';
+import { container, instancePerContainerCachingFactory } from 'tsyringe';
+import { trace } from '@opentelemetry/api';
+import { InjectionObject } from '../../../src/common/dependencyRegistration';
+import { configMock, getMock, hasMock, registerDefaultConfig } from '../../unit/mocks/configMock';
+import { IngestionJobsConfig } from '../../../src/common/interfaces';
+import { validateAndGetHandlersTokens } from '../../../src/utils/configUtil';
+import { SERVICES } from '../../../src/common/constants';
+import { JOB_HANDLER_FACTORY_SYMBOL, jobHandlerFactory } from '../../../src/models/jobHandlerFactory';
+import { queueClientFactory } from '../../../src/containerConfig';
+import { NewJobHandler } from '../../../src/models/newJobHandler';
+import { UpdateJobHandler } from '../../../src/models/updateJobHandler';
+import { SwapJobHandler } from '../../../src/models/swapJobHandler';
+
+function getTestContainerConfig(): InjectionObject<unknown>[] {
+  registerDefaultConfig();
+
+  const ingestionConfig = configMock.get<IngestionJobsConfig>('jobManagement.ingestion.jobs');
+
+  const handlersTokens = validateAndGetHandlersTokens(ingestionConfig);
+
+  return [
+    { token: SERVICES.LOGGER, provider: { useValue: jsLogger({ enabled: false }) } },
+    { token: SERVICES.CONFIG, provider: { useValue: configMock } },
+    { token: SERVICES.TRACER, provider: { useValue: trace.getTracer('testTracer') } },
+    { token: SERVICES.QUEUE_CLIENT, provider: { useFactory: instancePerContainerCachingFactory(queueClientFactory) } },
+    { token: JOB_HANDLER_FACTORY_SYMBOL, provider: { useFactory: instancePerContainerCachingFactory(jobHandlerFactory) } },
+    { token: handlersTokens.Ingestion_New, provider: { useClass: NewJobHandler } },
+    { token: handlersTokens.Ingestion_Update, provider: { useClass: UpdateJobHandler } },
+    { token: handlersTokens.Ingestion_Swap_Update, provider: { useClass: SwapJobHandler } },
+  ];
+}
+
+const resetContainer = (clearInstances = true): void => {
+  if (clearInstances) {
+    container.clearInstances();
+  }
+
+  getMock.mockReset();
+  hasMock.mockReset();
+};
+
+export { getTestContainerConfig, resetContainer };