test(server): utils (#10028)

packages/backend/server/src/__tests__/utils/testing-module.ts

@@ -0,0 +1,110 @@
+import { ModuleMetadata } from '@nestjs/common';
+import { APP_GUARD } from '@nestjs/core';
+import { Query, Resolver } from '@nestjs/graphql';
+import {
+  Test,
+  TestingModule as BaseTestingModule,
+  TestingModuleBuilder,
+} from '@nestjs/testing';
+
+import { AppModule, FunctionalityModules } from '../../app.module';
+import { Runtime } from '../../base';
+import { GqlModule } from '../../base/graphql';
+import { AuthGuard, AuthModule } from '../../core/auth';
+import { ModelsModule } from '../../models';
+import { initTestingDB, TEST_LOG_LEVEL } from './utils';
+
+interface TestingModuleMeatdata extends ModuleMetadata {
+  tapModule?(m: TestingModuleBuilder): void;
+}
+
+export interface TestingModule extends BaseTestingModule {
+  initTestingDB(): Promise<void>;
+  [Symbol.asyncDispose](): Promise<void>;
+}
+
+function dedupeModules(modules: NonNullable<ModuleMetadata['imports']>) {
+  const map = new Map();
+
+  modules.forEach(m => {
+    if ('module' in m) {
+      map.set(m.module, m);
+    } else {
+      map.set(m, m);
+    }
+  });
+
+  return Array.from(map.values());
+}
+
+@Resolver(() => String)
+class MockResolver {
+  @Query(() => String)
+  hello() {
+    return 'hello world';
+  }
+}
+
+export async function createTestingModule(
+  moduleDef: TestingModuleMeatdata = {},
+  autoInitialize = true
+): Promise<TestingModule> {
+  // setting up
+  let imports = moduleDef.imports ?? [AppModule];
+  imports =
+    imports[0] === AppModule
+      ? [AppModule]
+      : dedupeModules([
+          ...FunctionalityModules,
+          ModelsModule,
+          AuthModule,
+          GqlModule,
+          ...imports,
+        ]);
+
+  const builder = Test.createTestingModule({
+    imports,
+    providers: [
+      {
+        provide: APP_GUARD,
+        useClass: AuthGuard,
+      },
+      MockResolver,
+      ...(moduleDef.providers ?? []),
+    ],
+    controllers: moduleDef.controllers,
+  });
+
+  if (moduleDef.tapModule) {
+    moduleDef.tapModule(builder);
+  }
+
+  const module = await builder.compile();
+
+  const testingModule = module as TestingModule;
+
+  testingModule.initTestingDB = async () => {
+    await initTestingDB(module);
+
+    const runtime = module.get(Runtime);
+    // by pass password min length validation
+    await runtime.set('auth/password.min', 1);
+  };
+
+  testingModule[Symbol.asyncDispose] = async () => {
+    await module.close();
+  };
+
+  if (autoInitialize) {
+    // we got a lot smoking tests try to break nestjs
+    // can't tolerate the noisy logs
+    // @ts-expect-error private
+    module.applyLogger({
+      logger: [TEST_LOG_LEVEL],
+    });
+    await testingModule.initTestingDB();
+    await testingModule.init();
+  }
+
+  return testingModule;
+}