fix(test): split up plain container and service module helpers

ssube · Jun 1, 2019 · 8a45015 · 8a45015
1 parent 8bbdd28
commit 8a45015
Show file tree

Hide file tree

Showing 19 changed files with 87 additions and 57 deletions.
diff --git a/test/TestBaseService.ts b/test/TestBaseService.ts
@@ -5,7 +5,7 @@ import { BaseService, BaseServiceData, BaseServiceOptions } from 'src/BaseServic
 import { ServiceEvent } from 'src/Service';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 class StubService extends BaseService<BaseServiceData> {
   constructor(options: BaseServiceOptions<BaseServiceData>) {
@@ -18,7 +18,7 @@ class StubService extends BaseService<BaseServiceData> {
 
 describeAsync('base service', async () => {
   itAsync('should throw on missing name', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     return expect(createService(container, StubService, {
       data: {
         filters: [],
@@ -32,7 +32,7 @@ describeAsync('base service', async () => {
   });
 
   itAsync('should log notifications', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, StubService, {
       data: {
         filters: [],
@@ -47,7 +47,7 @@ describeAsync('base service', async () => {
   });
 
   itAsync('should get ephemeral ID as UUID', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, StubService, {
       data: {
         filters: [],
@@ -62,7 +62,7 @@ describeAsync('base service', async () => {
   });
 
   itAsync('should get stable ID as kind:name pair', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, StubService, {
       data: {
         filters: [],

diff --git a/test/controller/TestCompletionController.ts b/test/controller/TestCompletionController.ts
@@ -3,11 +3,11 @@ import { expect } from 'chai';
 import { CompletionController } from 'src/controller/CompletionController';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 describeAsync('completion controller', async () => {
   itAsync('should exist', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
 
     const controller = await createService(container, CompletionController, {
       data: {

diff --git a/test/controller/TestEchoController.ts b/test/controller/TestEchoController.ts
@@ -9,19 +9,24 @@ import { User } from 'src/entity/auth/User';
 import { Command, CommandVerb } from 'src/entity/Command';
 import { Context } from 'src/entity/Context';
 import { Message } from 'src/entity/Message';
+import { Listener } from 'src/listener';
 import { ServiceModule } from 'src/module/ServiceModule';
 import { TransformModule } from 'src/module/TransformModule';
 import { Transform } from 'src/transform';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 describeAsync('echo controller', async () => {
   itAsync('should exist', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
 
     const controller = await createService(container, EchoController, {
       data: {
+        defaultTarget: {
+          kind: 'test-listener',
+          name: 'test-listener',
+        },
         filters: [],
         strict: true,
         transforms: [],
@@ -38,7 +43,12 @@ describeAsync('echo controller', async () => {
     const modules = [new ServiceModule({
       timeout: 100,
     }), new TransformModule()];
-    const { container, module } = await createContainer(...modules);
+    const { container, module, services } = await createServiceContainer(...modules);
+
+    services.addService(ineeda<Listener>({
+      kind: 'test-listener',
+      name: 'test-listener',
+    }));
 
     const msg = 'hello world';
     module.bind('test-transform').toInstance(ineeda<Transform>({
@@ -52,6 +62,10 @@ describeAsync('echo controller', async () => {
         sendMessage,
       }),
       data: {
+        defaultTarget: {
+          kind: 'test-listener',
+          name: 'test-listener',
+        },
         filters: [],
         strict: true,
         transforms: [{
@@ -75,6 +89,8 @@ describeAsync('echo controller', async () => {
     const cmd = new Command({
       context: ineeda<Context>({
         checkGrants: () => true,
+        name: 'test-user',
+        uid: 'test-user',
         user: ineeda<User>(),
       }),
       data: {},

diff --git a/test/controller/TestRandomController.ts b/test/controller/TestRandomController.ts
@@ -3,11 +3,11 @@ import { expect } from 'chai';
 import { RandomController } from 'src/controller/RandomController';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 describeAsync('random controller', async () => {
   itAsync('should exist', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
 
     const controller = await createService(container, RandomController, {
       data: {

diff --git a/test/controller/TestTimeController.ts b/test/controller/TestTimeController.ts
@@ -3,11 +3,11 @@ import { expect } from 'chai';
 import { TimeController } from 'src/controller/TimeController';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 describeAsync('time controller', async () => {
   itAsync('should exist', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
 
     const controller = await createService(container, TimeController, {
       data: {

diff --git a/test/controller/TestWeatherController.ts b/test/controller/TestWeatherController.ts
@@ -15,14 +15,14 @@ import { Transform } from 'src/transform';
 import { RequestFactory } from 'src/utils/Request';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 describeAsync('weather controller', async () => {
   itAsync('should send a message', async () => {
     const modules = [new ServiceModule({
       timeout: 100,
     }), new TransformModule()];
-    const { container, module } = await createContainer(...modules);
+    const { container, module } = await createServiceContainer(...modules);
 
     const data = { test: 'test' };
     module.bind(INJECT_REQUEST).toInstance(ineeda<RequestFactory>({

diff --git a/test/filter/TestCommandFilter.ts b/test/filter/TestCommandFilter.ts
@@ -7,13 +7,13 @@ import { FilterBehavior } from 'src/filter';
 import { CommandFilter, CommandFilterData } from 'src/filter/CommandFilter';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_FILTER_KIND = 'user-filter';
 const TEST_FILTER_NAME = 'test-filter';
 
 async function createFilter(data: CommandFilterData) {
-  const { container } = await createContainer();
+  const { container } = await createServiceContainer();
   const filter = await createService(container, CommandFilter, {
     data,
     metadata: {

diff --git a/test/filter/TestMessageFilter.ts b/test/filter/TestMessageFilter.ts
@@ -8,13 +8,13 @@ import { MessageFilter, MessageFilterData } from 'src/filter/MessageFilter';
 import { TYPE_TEXT } from 'src/utils/Mime';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_FILTER_KIND = 'user-filter';
 const TEST_FILTER_NAME = 'test-filter';
 
 async function createFilter(data: MessageFilterData) {
-  const { container } = await createContainer();
+  const { container } = await createServiceContainer();
   const filter = await createService(container, MessageFilter, {
     data,
     metadata: {

diff --git a/test/filter/TestSourceFilter.ts b/test/filter/TestSourceFilter.ts
@@ -8,13 +8,13 @@ import { SourceFilter, SourceFilterData } from 'src/filter/SourceFilter';
 import { TYPE_TEXT } from 'src/utils/Mime';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_FILTER_KIND = 'user-filter';
 const TEST_FILTER_NAME = 'test-filter';
 
 async function createFilter(data: SourceFilterData) {
-  const { container } = await createContainer();
+  const { container } = await createServiceContainer();
   const filter = await createService(container, SourceFilter, {
     data,
     metadata: {

diff --git a/test/filter/TestUserFilter.ts b/test/filter/TestUserFilter.ts
@@ -8,13 +8,13 @@ import { UserFilter, UserFilterData } from 'src/filter/UserFilter';
 import { ChecklistMode } from 'src/utils/Checklist';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_FILTER_KIND = 'user-filter';
 const TEST_FILTER_NAME = 'test-filter';
 
 async function createUserFilter(data: UserFilterData) {
-  const { container } = await createContainer();
+  const { container } = await createServiceContainer();
   const filter = await createService(container, UserFilter, {
     data,
     metadata: {

diff --git a/test/helpers/container.ts b/test/helpers/container.ts
@@ -34,25 +34,41 @@ export class TestModule extends Module {
   }
 }
 
+/**
+ * Create a DI container for tests.
+ */
 export async function createContainer(...modules: Array<Module>): Promise<{ container: Container, module: Module }> {
   const module = new TestModule();
   const container = Container.from(module, ...modules);
   await container.configure();
   return { container, module };
 }
 
+/**
+ * Create a DI container for tests with a stub service module that will create, but not get, services.
+ */
+export async function createServiceContainer(...modules: Array<Module>): Promise<{
+  container: Container,
+  module: Module,
+  services: ServiceModule,
+}> {
+  const services = new ServiceModule({
+    timeout: 100,
+  });
+  const { container, module } = await createContainer(...modules, services);
+  module.bind(INJECT_SERVICES).toInstance(services);
+  return { container, module, services };
+}
+
 export async function createService<
   TService,
   TData extends BotServiceData,
   TOptions extends BotServiceOptions<TData> = BotServiceOptions<TData>,
->(
-  container: Container,
-  type: Constructor<TService, TOptions>,
-  options: Partial<TOptions>,
+  >(
+    container: Container,
+    type: Constructor<TService, TOptions>,
+    options: Partial<TOptions>,
 ): Promise<TService> {
-  const services = ineeda<ServiceModule>({
-      createService: (def: ServiceDefinition<TData>) => container.create(def.metadata.kind, def),
-    });
   const schema = new Schema(); // tests use the real schema :D
   const locale = await container.create(Locale, {
     data: {
@@ -64,7 +80,6 @@ export async function createService<
     },
     [INJECT_LOGGER]: ConsoleLogger.global,
     [INJECT_SCHEMA]: schema,
-    [INJECT_SERVICES]: services,
   });
 
   const fullOptions = {
@@ -77,7 +92,6 @@ export async function createService<
     [INJECT_LOGGER]: ConsoleLogger.global,
     [INJECT_METRICS]: new Registry(),
     [INJECT_SCHEMA]: schema,
-    [INJECT_SERVICES]: services,
     [INJECT_STORAGE]: ineeda<Connection>({
       getRepository<T>(ctor: T) {
         return ineeda<Repository<T>>();

diff --git a/test/parser/TestArgsParser.ts b/test/parser/TestArgsParser.ts
@@ -14,7 +14,7 @@ import { Storage } from 'src/storage';
 import { TYPE_JPEG, TYPE_TEXT } from 'src/utils/Mime';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_CONFIG = {
   args: {
@@ -51,7 +51,7 @@ const TEST_STORAGE = ineeda<Storage>({
 
 describeAsync('args parser', async () => {
   itAsync('should parse a message body', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, ArgsParser, {
       data: TEST_CONFIG,
       metadata: TEST_METADATA,
@@ -71,7 +71,7 @@ describeAsync('args parser', async () => {
   });
 
   itAsync('should prompt to complete missing fields', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, ArgsParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,
@@ -100,7 +100,7 @@ describeAsync('args parser', async () => {
   });
 
   itAsync('should complete a fragment', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, ArgsParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,
@@ -134,7 +134,7 @@ describeAsync('args parser', async () => {
   });
 
   itAsync('should reject messages with other types', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, ArgsParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,

diff --git a/test/parser/TestEchoParser.ts b/test/parser/TestEchoParser.ts
@@ -12,7 +12,7 @@ import { Storage } from 'src/storage';
 import { TYPE_JPEG, TYPE_TEXT } from 'src/utils/Mime';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_CONFIG = {
   dataMapper: {
@@ -51,7 +51,7 @@ const TEST_STORAGE = ineeda<Storage>({
 
 describeAsync('echo parser', async () => {
   itAsync('should parse the message body as-is', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, EchoParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,
@@ -79,7 +79,7 @@ describeAsync('echo parser', async () => {
   });
 
   itAsync('should reject messages with other types', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, EchoParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,

diff --git a/test/parser/TestRegexParser.ts b/test/parser/TestRegexParser.ts
@@ -12,7 +12,7 @@ import { Storage } from 'src/storage';
 import { TYPE_JPEG, TYPE_TEXT } from 'src/utils/Mime';
 
 import { describeAsync, itAsync } from 'test/helpers/async';
-import { createContainer, createService } from 'test/helpers/container';
+import { createService, createServiceContainer } from 'test/helpers/container';
 
 const TEST_CONFIG = {
   dataMapper: {
@@ -47,7 +47,7 @@ const TEST_STORAGE = ineeda<Storage>({
 
 describeAsync('regex parser', async () => {
   itAsync('should split the message body into groups', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, RegexParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,
@@ -79,7 +79,7 @@ describeAsync('regex parser', async () => {
   });
 
   itAsync('should reject messages with other types', async () => {
-    const { container } = await createContainer();
+    const { container } = await createServiceContainer();
     const svc = await createService(container, RegexParser, {
       [INJECT_STORAGE]: TEST_STORAGE,
       data: TEST_CONFIG,