@takaro/modules 0.0.0-next.0da151e

package/src/__tests__/gimme.integration.test.ts

@@ -0,0 +1,106 @@
+import { IntegrationTest, expect, IModuleTestsSetupData, modulesTestSetup, EventsAwaiter } from '@takaro/test';
+import { GameEvents, HookEvents } from '../dto/index.js';
+import { faker } from '@faker-js/faker';
+import { describe } from 'node:test';
+
+const group = 'gimme suite';
+
+const tests = [
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Can give an item to a player',
+    test: async function () {
+      const items = (await this.client.item.itemControllerSearch()).data.data;
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.gimmeModule.latestVersion.id,
+        userConfig: JSON.stringify({
+          items: items.map((item) => ({
+            item: item.id,
+            amount: faker.number.int({ min: 1, max: 5 }),
+            quality: faker.number.int({ min: 1, max: 6 }).toString(),
+          })),
+          commands: [],
+        }),
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE);
+      const executionEvents = (await new EventsAwaiter().connect(this.client)).waitForEvents(
+        HookEvents.COMMAND_EXECUTED,
+      );
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/gimme',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const resultLogs = (await executionEvents)[0].data.meta.result.logs;
+      expect(resultLogs.some((log: any) => log.msg.match(/giveItem 200 OK/))).to.be.true;
+
+      expect((await events).length).to.be.eq(1);
+      expect((await events)[0].data.meta.msg).to.match(/You received \dx \w/);
+    },
+  }),
+  /*   new IntegrationTest<IModuleTestsSetupData>({
+      group,
+      snapshot: false,
+      setup: modulesTestSetup,
+      name: 'Can execute command',
+      test: async function () {
+        await this.client.module.moduleInstallationsControllerInstallModule(
+          this.setupData.gameserver.id,
+          this.setupData.gimmeModule.id,
+          {
+            userConfig: JSON.stringify({
+              items: [],
+              commands: ['say hello from test'],
+            }),
+          },
+        );
+  
+        const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE);
+  
+        await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+          msg: '/gimme',
+          playerId: this.setupData.players[0].id,
+        });
+  
+        expect((await events).length).to.be.eq(1);
+        expect((await events)[0].data.meta.msg).to.eq('hello from test');
+      },
+    }), */
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'When no items or commands configured, displays an error',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.gimmeModule.latestVersion.id,
+        userConfig: JSON.stringify({
+          items: [],
+          commands: [],
+        }),
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/gimme',
+        playerId: this.setupData.players[0].id,
+      });
+
+      expect((await events).length).to.be.eq(1);
+      expect((await events)[0].data.meta.msg).to.match(/No items or commands configured/);
+    },
+  }),
+];
+
+describe(group, function () {
+  tests.forEach((test) => {
+    test.run();
+  });
+});

package/src/__tests__/help.integration.test.ts

@@ -0,0 +1,314 @@
+import { IntegrationTest, expect, IModuleTestsSetupData, modulesTestSetup, EventsAwaiter } from '@takaro/test';
+import { GameEvents } from '../dto/index.js';
+import { describe } from 'node:test';
+
+const group = 'help command suite';
+
+const tests = [
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Shows all available commands when no argument provided',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 3);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Available commands:');
+      // Should show help and ping commands from utils module
+      expect(messages.some((m) => m.data.meta.msg.includes('help:'))).to.be.true;
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Shows specific command help when command name provided',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help ping',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.eq(1);
+      expect(messages[0].data.meta.msg).to.include('ping:');
+      expect(messages[0].data.meta.msg).to.include('pong');
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search returns commands with matching names',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search ping',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Commands matching "ping":');
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search returns commands with matching help text',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search pong',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Commands matching "pong":');
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search is case-insensitive',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search PING',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Commands matching "PING":');
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search supports partial matches',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search hel',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Commands matching "hel":');
+      expect(messages.some((m) => m.data.meta.msg.includes('help:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search returns appropriate message when no matches found',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search nonexistentcommand',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.eq(1);
+      expect(messages[0].data.meta.msg).to.include('No commands found matching "nonexistentcommand"');
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Search works across multiple modules',
+    test: async function () {
+      // Install utils module
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      // Install another module (gimme) to have more commands
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.gimmeModule.latestVersion.id,
+        userConfig: JSON.stringify({
+          items: [],
+          commands: ['say test'],
+        }),
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help search command',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Commands matching "command":');
+      // Should find help command which has "command" in its help text
+      expect(messages.some((m) => m.data.meta.msg.includes('help:'))).to.be.true;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Does not show commands from disabled modules',
+    test: async function () {
+      // First install utils module normally so help command is available
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      // Install teleports module but disabled
+      const teleportsInstallation = await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.teleportsModule.latestVersion.id,
+      });
+
+      // Get the current system config and disable the teleports module
+      const systemConfig = teleportsInstallation.data.data.systemConfig as any;
+      systemConfig.enabled = false;
+
+      // Uninstall and reinstall teleports module with disabled config
+      await this.client.module.moduleInstallationsControllerUninstallModule(
+        teleportsInstallation.data.data.moduleId,
+        this.setupData.gameserver.id,
+      );
+
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.teleportsModule.latestVersion.id,
+        systemConfig: JSON.stringify(systemConfig),
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 3);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Available commands:');
+      // Should show commands from utils module but NOT from disabled teleports module
+      expect(messages.some((m) => m.data.meta.msg.includes('help:'))).to.be.true;
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.true;
+      // Should NOT show teleports commands
+      expect(messages.some((m) => m.data.meta.msg.includes('settp:'))).to.be.false;
+      expect(messages.some((m) => m.data.meta.msg.includes('teleport:'))).to.be.false;
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Does not show individually disabled commands',
+    test: async function () {
+      // Install utils module
+      const moduleInstallation = await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+      });
+
+      // Disable only the ping command
+      const systemConfig = moduleInstallation.data.data.systemConfig as any;
+      systemConfig.commands.ping.enabled = false;
+
+      // Uninstall and reinstall with new config
+      await this.client.module.moduleInstallationsControllerUninstallModule(
+        moduleInstallation.data.data.moduleId,
+        this.setupData.gameserver.id,
+      );
+
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.utilsModule.latestVersion.id,
+        systemConfig: JSON.stringify(systemConfig),
+      });
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 2);
+
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/help',
+        playerId: this.setupData.players[0].id,
+      });
+
+      const messages = await events;
+      expect(messages.length).to.be.greaterThan(0);
+      expect(messages[0].data.meta.msg).to.include('Available commands:');
+      // Should show help command but NOT ping command
+      expect(messages.some((m) => m.data.meta.msg.includes('help:'))).to.be.true;
+      expect(messages.some((m) => m.data.meta.msg.includes('ping:'))).to.be.false;
+    },
+  }),
+];
+
+describe(group, function () {
+  tests.forEach((test) => {
+    test.run();
+  });
+});