@into-cps-association/libms 0.4.5 → 0.5.0

package/test/unit/files-service.factory.unit.spec.ts

@@ -1,37 +1,51 @@
 // files-service.factory.spec.ts
+import { describe, it, expect, jest } from '@jest/globals';
 import { Test, TestingModule } from '@nestjs/testing';
 import { ConfigService } from '@nestjs/config';
-import FilesServiceFactory from '../../src/files/services/files-service.factory';
-import LocalFilesService from '../../src/files/services/local-files.service';
+import FilesServiceFactory from '../../src/files/files-service.factory';
+import LocalFilesService from '../../src/files/local/local-files.service';
 import { IFilesService } from '../../src/files/interfaces/files.service.interface';
+import GitFilesService from '../../src/files/git/git-files.service';
 
 describe('FilesServiceFactory', () => {
-  let serviceFactory: FilesServiceFactory;
   let configService: ConfigService;
   let localFilesService: IFilesService;
+  let gitFilesService: IFilesService;
+  let fileServices: IFilesService[];
 
   beforeEach(async () => {
-    localFilesService = new LocalFilesService(configService as ConfigService);
-
     const module: TestingModule = await Test.createTestingModule({
       providers: [
-        FilesServiceFactory,
+        GitFilesService,
         { provide: ConfigService, useValue: { get: jest.fn() } },
-        { provide: LocalFilesService, useValue: localFilesService },
+        LocalFilesService,
       ],
     }).compile();
 
-    serviceFactory = module.get<FilesServiceFactory>(FilesServiceFactory);
     configService = module.get<ConfigService>(ConfigService);
+    localFilesService = module.get<LocalFilesService>(LocalFilesService);
+    gitFilesService = module.get<GitFilesService>(GitFilesService);
+    fileServices = [gitFilesService, localFilesService];
   });
 
   it('should create a local files service when MODE is local', () => {
     jest.spyOn(configService, 'get').mockReturnValue('local');
-    expect(serviceFactory.create()).toBe(localFilesService);
+    expect(FilesServiceFactory.create(configService, fileServices)).toBe(
+      localFilesService,
+    );
+  });
+
+  it('should create a git files service when MODE is git', () => {
+    jest.spyOn(configService, 'get').mockReturnValue('git');
+    expect(FilesServiceFactory.create(configService, fileServices)).toBe(
+      gitFilesService,
+    );
   });
 
   it('should throw an error when MODE is invalid', () => {
     jest.spyOn(configService, 'get').mockReturnValue('invalid');
-    expect(() => serviceFactory.create()).toThrowError(`Invalid MODE: invalid`);
+    expect(() =>
+      FilesServiceFactory.create(configService, fileServices),
+    ).toThrow(`Invalid MODE: invalid`);
   });
 });

package/test/unit/files.resolver.unit.spec.ts

@@ -1,13 +1,18 @@
+import { describe, it, expect, jest } from '@jest/globals';
 import { Test, TestingModule } from '@nestjs/testing';
-import FilesResolver from '../../src/files/resolvers/files.resolver';
+import FilesResolver from '../../src/files/files.resolver';
 import {
   testDirectory,
   pathToTestDirectory,
   pathToTestFileContent,
   testFileContent,
 } from '../testUtil';
-import { IFilesService } from '../../src/files/interfaces/files.service.interface';
-import FilesServiceFactory from '../../src/files/services/files-service.factory';
+import {
+  FILE_SERVICE,
+  IFilesService,
+} from '../../src/files/interfaces/files.service.interface';
+import { Project } from 'src/types';
+import { CONFIG_MODE } from '../../src/enums/config-mode.enum';
 
 describe('Unit tests for FilesResolver', () => {
   let filesResolver: FilesResolver;
@@ -15,27 +20,29 @@ describe('Unit tests for FilesResolver', () => {
 
   beforeEach(async () => {
     const mockFilesService: IFilesService = {
-      listDirectory: jest.fn().mockImplementation(() => testDirectory),
-      readFile: jest.fn().mockImplementation(() => testFileContent),
+      listDirectory: jest
+        .fn<() => Promise<Project>>()
+        .mockResolvedValue(testDirectory),
+      readFile: jest
+        .fn<() => Promise<Project>>()
+        .mockImplementation(() => Promise.resolve(testFileContent)),
+      getMode: jest.fn<() => CONFIG_MODE>().mockReturnValue(CONFIG_MODE.LOCAL),
     };
 
     const module: TestingModule = await Test.createTestingModule({
       providers: [
         FilesResolver,
-        FilesServiceFactory,
         {
-          provide: FilesServiceFactory,
-          useValue: {
-            create: () => mockFilesService,
+          provide: FILE_SERVICE,
+          useFactory: () => {
+            return mockFilesService;
           },
         },
       ],
     }).compile();
 
     filesResolver = module.get<FilesResolver>(FilesResolver);
-    filesService = module
-      .get<FilesServiceFactory>(FilesServiceFactory)
-      .create();
+    filesService = module.get<IFilesService>(FILE_SERVICE);
   });
 
   it('should be defined', () => {

package/test/unit/git-files.service.unit.spec.ts

@@ -0,0 +1,81 @@
+import { describe, it, expect, jest } from '@jest/globals';
+import { Test, TestingModule } from '@nestjs/testing';
+import { ConfigService } from '@nestjs/config';
+import LocalFileService from 'src/files/local/local-files.service';
+import { Project } from 'src/types';
+import {
+  MockConfigService,
+  testDirectory,
+  testFileContent,
+} from 'test/testUtil';
+import GitFilesService from 'src/files/git/git-files.service';
+import { CONFIG_MODE } from 'src/enums/config-mode.enum';
+import { IFilesService } from 'src/files/interfaces/files.service.interface';
+
+jest.mock('fs', () => ({
+  promises: {
+    readdir: jest.fn(),
+    lstat: jest.fn(),
+    readFile: jest.fn(),
+  },
+}));
+
+describe('GitFilesService', () => {
+  let service: GitFilesService;
+  const mockConfigService = new MockConfigService();
+  const mockLocalFilesService: IFilesService = {
+    listDirectory: jest
+      .fn<() => Promise<Project>>()
+      .mockResolvedValue(testDirectory),
+    readFile: jest
+      .fn<() => Promise<Project>>()
+      .mockImplementation(() => Promise.resolve(testFileContent)),
+    getMode: jest.fn<() => CONFIG_MODE>().mockReturnValue(CONFIG_MODE.LOCAL),
+  };
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        GitFilesService,
+        { provide: ConfigService, useValue: mockConfigService },
+        { provide: LocalFileService, useValue: mockLocalFilesService },
+      ],
+    }).compile();
+
+    service = module.get<GitFilesService>(GitFilesService);
+    process.env.MODE = service.getMode();
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  it('should call list directory in localService', async () => {
+    // Arrange
+    const mockListDirectory = jest.spyOn(
+      mockLocalFilesService,
+      'listDirectory',
+    );
+
+    // Act
+    await service.listDirectory('/some/path');
+
+    // Assert
+    expect(mockListDirectory).toHaveBeenCalledTimes(1);
+  });
+
+  it('should call read file in localService', async () => {
+    // Arrange
+    const mockReadFile = jest.spyOn(mockLocalFilesService, 'readFile');
+
+    // Act
+    await service.readFile('/some/path/file.txt');
+
+    // Assert
+    expect(mockReadFile).toBeCalledTimes(1);
+  });
+});

package/test/unit/local-files.service.unit.spec.ts

@@ -1,8 +1,9 @@
+import { describe, it, expect, jest } from '@jest/globals';
 import { Test, TestingModule } from '@nestjs/testing';
 import { ConfigService } from '@nestjs/config';
 import * as fs from 'fs';
 import { join } from 'path';
-import LocalFilesService from '../../src/files/services/local-files.service';
+import LocalFilesService from '../../src/files/local/local-files.service';
 import {
   fstestFileContent,
   pathToTestDirectory,
@@ -11,6 +12,7 @@ import {
   MockConfigService,
   testFileName,
 } from '../testUtil';
+import { Dirent } from 'fs';
 
 jest.mock('fs', () => ({
   promises: {
@@ -56,7 +58,7 @@ describe('LocalFilesService', () => {
 
     jest
       .spyOn(fs.promises, 'readdir')
-      .mockResolvedValue(testFileArray as unknown as Promise<[]>);
+      .mockResolvedValue(testFileArray as unknown as Dirent[]);
 
     jest.spyOn(fs.promises, 'lstat').mockImplementation((pathToDirectory) => {
       if (typeof pathToDirectory === 'string') {

package/tsconfig.json

@@ -4,28 +4,31 @@
     "baseUrl": "./",
     "declaration": true, //generate declaration '.d.ts' files
     "emitDecoratorMetadata": true,
+    "esModuleInterop": true,
     "experimentalDecorators": true, //allow experimental decorators for es7
     "forceConsistentCasingInFileNames": false,
     "incremental": true,
-    "module": "commonjs", //use node module system
+    "lib": [
+      "ES2022"
+    ],
+    "module": "ES2022", //use node module system
     "moduleResolution": "node", //use node module resolution strategy node
-    //"noImplicitAny": true, //raise error on any type
     "noImplicitReturns": true, //raise error on implicit returns
     "noUnusedLocals": true, //raise error on unused locals
     "noUnusedParameters": true, //raise no error on unused parameters
     "noFallthroughCasesInSwitch": false,
-    "outDir": "./dist",
+    "outDir": "dist",
     "removeComments": true, //remove comments from build
     "skipLibCheck": true,
     "sourceMap": true, //generate .map files
+    // "strict": true, //enable all strict type-checking options
     "strictBindCallApply": false,
-    //"strictNullChecks": true,
-    //"strict": true, //enable all strict type-checking options
-    "target": "es2022",
+    "target": "ES2022",
     "types": ["node", "jest"], //use node and jest types
     "typeRoots": [
       "node_modules/@types" //use node_modules/@types for type definitions
-    ]
+    ],
   },
+  "include": ["src/**/*.ts", "test/**/*.ts"],
   "exclude": ["**/node_modules/*", "./dist"]
 }

package/.env

@@ -1,6 +0,0 @@
-PORT='4001'
-MODE='local'
-LOCAL_PATH ='/home/dtaas/Documents/git/into-cps/DTaaS/files'
-LOG_LEVEL='debug'
-APOLLO_PATH='/lib'
-GRAPHQL_PLAYGROUND='true'

package/.eslintignore

@@ -1,6 +0,0 @@
-api/
-build/
-dist/
-node_modules/
-script/
-src/types.ts

package/.eslintrc

@@ -1,53 +0,0 @@
-{
-  "env": {
-    "jest": true,
-    "jest/globals": true,
-    "node": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "airbnb-base",
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
-  "globals": {
-    "Atomics": "readonly",
-    "SharedArrayBuffer": "readonly"
-  },
-  "settings": {
-    "import/resolver": {
-      "node": {
-        "extensions": [".js"]
-      }
-    }
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "requireConfigFile": false,
-    "ecmaVersion": 2022,
-    "sourceType": "module" // Allows for the use of imports
-  },
-  "plugins": ["jest", "@typescript-eslint", "import"],
-  "rules": {
-    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
-    "no-console": "error",
-    "import/first": "error",
-    "linebreak-style": 0, // disable linter linebreak rule, to allow for both unix and windows developement
-    "import/no-unresolved": "off", // Whatever IDE will pass an error if if the module is not found, so no reason for this..
-    "import/extensions": "off", // That includes the production build.. We use linter for code checking / clean code optimization..
-    "no-use-before-define": "off"
-  },
-  "root": true,
-
-  "overrides": [
-    {
-      "files": ["*.ts"],
-      "parser": "@typescript-eslint/parser",
-      "parserOptions": {
-        "requireConfigFile": false,
-        "project": ["./tsconfig.json"]
-      },
-      "plugins": ["@typescript-eslint"]
-    }
-  ]
-}

package/coverage/clover.xml

@@ -1,162 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1717597601385" clover="3.2.0">
-  <project timestamp="1717597601385" name="All files">
-    <metrics statements="120" coveredstatements="89" conditionals="8" coveredconditionals="2" methods="23" coveredmethods="21" elements="151" coveredelements="112" complexity="0" loc="120" ncloc="120" packages="5" files="7" classes="7"/>
-    <package name="src">
-      <metrics statements="56" coveredstatements="38" conditionals="6" coveredconditionals="0" methods="7" coveredmethods="6"/>
-      <file name="bootstrap.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/bootstrap.ts">
-        <metrics statements="18" coveredstatements="0" conditionals="6" coveredconditionals="0" methods="1" coveredmethods="0"/>
-        <line num="1" count="0" type="stmt"/>
-        <line num="2" count="0" type="stmt"/>
-        <line num="3" count="0" type="stmt"/>
-        <line num="4" count="0" type="stmt"/>
-        <line num="5" count="0" type="stmt"/>
-        <line num="13" count="0" type="stmt"/>
-        <line num="14" count="0" type="stmt"/>
-        <line num="18" count="0" type="cond" truecount="0" falsecount="1"/>
-        <line num="20" count="0" type="stmt"/>
-        <line num="21" count="0" type="cond" truecount="0" falsecount="2"/>
-        <line num="22" count="0" type="stmt"/>
-        <line num="24" count="0" type="stmt"/>
-        <line num="28" count="0" type="stmt"/>
-        <line num="29" count="0" type="stmt"/>
-        <line num="30" count="0" type="stmt"/>
-        <line num="32" count="0" type="cond" truecount="0" falsecount="1"/>
-        <line num="33" count="0" type="stmt"/>
-        <line num="36" count="0" type="stmt"/>
-      </file>
-      <file name="types.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/types.ts">
-        <metrics statements="38" coveredstatements="38" conditionals="0" coveredconditionals="0" methods="6" coveredmethods="6"/>
-        <line num="1" count="3" type="stmt"/>
-        <line num="4" count="3" type="stmt"/>
-        <line num="6" count="3" type="stmt"/>
-        <line num="9" count="3" type="stmt"/>
-        <line num="13" count="3" type="stmt"/>
-        <line num="14" count="3" type="stmt"/>
-        <line num="15" count="3" type="stmt"/>
-        <line num="19" count="3" type="stmt"/>
-        <line num="20" count="3" type="stmt"/>
-        <line num="21" count="3" type="stmt"/>
-        <line num="25" count="3" type="stmt"/>
-        <line num="27" count="3" type="stmt"/>
-        <line num="30" count="3" type="stmt"/>
-        <line num="34" count="3" type="stmt"/>
-        <line num="35" count="3" type="stmt"/>
-        <line num="36" count="3" type="stmt"/>
-        <line num="40" count="3" type="stmt"/>
-        <line num="41" count="3" type="stmt"/>
-        <line num="42" count="3" type="stmt"/>
-        <line num="46" count="3" type="stmt"/>
-        <line num="48" count="3" type="stmt"/>
-        <line num="51" count="3" type="stmt"/>
-        <line num="55" count="3" type="stmt"/>
-        <line num="57" count="3" type="stmt"/>
-        <line num="60" count="3" type="stmt"/>
-        <line num="63" count="3" type="stmt"/>
-        <line num="66" count="3" type="stmt"/>
-        <line num="67" count="3" type="stmt"/>
-        <line num="68" count="3" type="stmt"/>
-        <line num="72" count="3" type="stmt"/>
-        <line num="74" count="3" type="stmt"/>
-        <line num="77" count="3" type="stmt"/>
-        <line num="80" count="3" type="stmt"/>
-        <line num="81" count="3" type="stmt"/>
-        <line num="82" count="3" type="stmt"/>
-        <line num="86" count="3" type="stmt"/>
-        <line num="88" count="3" type="stmt"/>
-        <line num="91" count="3" type="stmt"/>
-      </file>
-    </package>
-    <package name="src.cloudcmd">
-      <metrics statements="11" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="0"/>
-      <file name="cloudcmd.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/cloudcmd/cloudcmd.ts">
-        <metrics statements="11" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="0"/>
-        <line num="2" count="0" type="stmt"/>
-        <line num="3" count="0" type="stmt"/>
-        <line num="4" count="0" type="stmt"/>
-        <line num="6" count="0" type="stmt"/>
-        <line num="11" count="0" type="stmt"/>
-        <line num="12" count="0" type="stmt"/>
-        <line num="16" count="0" type="stmt"/>
-        <line num="18" count="0" type="stmt"/>
-        <line num="20" count="0" type="stmt"/>
-        <line num="23" count="0" type="stmt"/>
-        <line num="32" count="0" type="stmt"/>
-      </file>
-    </package>
-    <package name="src.files">
-      <metrics statements="5" coveredstatements="5" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
-      <file name="files.module.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/files.module.ts">
-        <metrics statements="5" coveredstatements="5" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
-        <line num="1" count="1" type="stmt"/>
-        <line num="2" count="1" type="stmt"/>
-        <line num="3" count="1" type="stmt"/>
-        <line num="4" count="1" type="stmt"/>
-        <line num="9" count="1" type="stmt"/>
-      </file>
-    </package>
-    <package name="src.files.resolvers">
-      <metrics statements="11" coveredstatements="11" conditionals="0" coveredconditionals="0" methods="5" coveredmethods="5"/>
-      <file name="files.resolver.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/resolvers/files.resolver.ts">
-        <metrics statements="11" coveredstatements="11" conditionals="0" coveredconditionals="0" methods="5" coveredmethods="5"/>
-        <line num="1" count="3" type="stmt"/>
-        <line num="3" count="3" type="stmt"/>
-        <line num="4" count="3" type="stmt"/>
-        <line num="7" count="3" type="stmt"/>
-        <line num="11" count="9" type="stmt"/>
-        <line num="14" count="2" type="stmt"/>
-        <line num="15" count="3" type="stmt"/>
-        <line num="16" count="4" type="stmt"/>
-        <line num="19" count="2" type="stmt"/>
-        <line num="20" count="3" type="stmt"/>
-        <line num="21" count="4" type="stmt"/>
-      </file>
-    </package>
-    <package name="src.files.services">
-      <metrics statements="37" coveredstatements="35" conditionals="2" coveredconditionals="2" methods="10" coveredmethods="10"/>
-      <file name="files-service.factory.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/services/files-service.factory.ts">
-        <metrics statements="10" coveredstatements="10" conditionals="1" coveredconditionals="1" methods="2" coveredmethods="2"/>
-        <line num="1" count="4" type="stmt"/>
-        <line num="2" count="4" type="stmt"/>
-        <line num="4" count="4" type="stmt"/>
-        <line num="7" count="4" type="stmt"/>
-        <line num="10" count="6" type="stmt"/>
-        <line num="11" count="6" type="stmt"/>
-        <line num="16" count="6" type="stmt"/>
-        <line num="17" count="6" type="cond" truecount="1" falsecount="0"/>
-        <line num="18" count="5" type="stmt"/>
-        <line num="20" count="1" type="stmt"/>
-      </file>
-      <file name="local-files.service.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/services/local-files.service.ts">
-        <metrics statements="27" coveredstatements="25" conditionals="1" coveredconditionals="1" methods="8" coveredmethods="8"/>
-        <line num="1" count="5" type="stmt"/>
-        <line num="2" count="5" type="stmt"/>
-        <line num="3" count="5" type="stmt"/>
-        <line num="4" count="5" type="stmt"/>
-        <line num="9" count="5" type="stmt"/>
-        <line num="11" count="9" type="stmt"/>
-        <line num="14" count="4" type="stmt"/>
-        <line num="15" count="4" type="stmt"/>
-        <line num="17" count="4" type="stmt"/>
-        <line num="19" count="4" type="stmt"/>
-        <line num="20" count="20" type="stmt"/>
-        <line num="23" count="4" type="stmt"/>
-        <line num="25" count="20" type="stmt"/>
-        <line num="28" count="20" type="stmt"/>
-        <line num="32" count="4" type="stmt"/>
-        <line num="36" count="4" type="stmt"/>
-        <line num="37" count="4" type="stmt"/>
-        <line num="39" count="4" type="stmt"/>
-        <line num="40" count="4" type="stmt"/>
-        <line num="44" count="4" type="stmt"/>
-        <line num="46" count="4" type="stmt"/>
-        <line num="48" count="0" type="stmt"/>
-        <line num="53" count="20" type="stmt"/>
-        <line num="54" count="20" type="cond" truecount="1" falsecount="0"/>
-        <line num="55" count="20" type="stmt"/>
-        <line num="57" count="0" type="stmt"/>
-        <line num="62" count="4" type="stmt"/>
-      </file>
-    </package>
-  </project>
-</coverage>