Merge pull request #30 from Real-Dev-Squad/feature/add-test

Remove dummy test and add proper tests

Author: RitikJaiswal75

.github/workflows/pre-commit-test.yaml renamed to .github/workflows/pre-commit-lint-check.yaml

@@ -10,4 +10,3 @@ jobs:
       - run: npm install
       - run: npm run lint-check
       - run: npm run format-check
-      - run: npm test

.github/workflows/pre-commit-tests.yaml

@@ -0,0 +1,11 @@
+name: pre-merge-checks
+on:
+  pull_request:
+    branches: [main, develop]
+jobs:
+  Run-Tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm install
+      - run: npm test

src/typeDefinitions/default.types.d.ts

@@ -6,3 +6,10 @@ export interface discordCommand {
   name: string;
   description: string;
 }
+
+export interface responseJson {
+  type: number;
+  data: {
+    content: string;
+  };
+}

src/typeDefinitions/discordMessage.types.d.ts

@@ -7,7 +7,7 @@ export interface discordMessageRequest {
 
 export interface messageRequestData {
   name: string;
-  options: Array<messageRequestDataOptions>;
+  options?: Array<messageRequestDataOptions>;
 }
 
 export interface messageRequestDataOptions {

tests/fixtures/fixture.ts

@@ -0,0 +1,30 @@
+import { discordMessageRequest } from "../../src/typeDefinitions/discordMessage.types";
+import { InteractionType } from "discord-interactions";
+
+export const dummyHelloMessage: discordMessageRequest = {
+  type: InteractionType.APPLICATION_COMMAND,
+  data: {
+    name: "Hello",
+  },
+  member: {
+    user: {
+      id: 123456,
+      username: "ritik",
+    },
+  },
+  guild_id: 123456,
+};
+
+export const dummyVerifyMessage: discordMessageRequest = {
+  type: InteractionType.APPLICATION_COMMAND,
+  data: {
+    name: "VERIFY",
+  },
+  member: {
+    user: {
+      id: 123456,
+      username: "ritik",
+    },
+  },
+  guild_id: 123456,
+};

tests/unit/demo.test.ts

@@ -0,0 +1,25 @@
+import { InteractionResponseType } from "discord-interactions";
+import { responseJson } from "../../src/typeDefinitions/default.types";
+import { discordTextResponse } from "../../src/utils/discordResponse";
+import JSONResponse from "../../src/utils/JsonResponse";
+
+describe("Test discordResponse function", () => {
+  it("should return a JSONResponse", () => {
+    const response = discordTextResponse("Hello");
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+  it("Should have type as channelMessageWithSource", async () => {
+    const response: responseJson = await discordTextResponse("Hello").json();
+    expect(response?.type).toBe(
+      InteractionResponseType.CHANNEL_MESSAGE_WITH_SOURCE
+    );
+  });
+  it("Should contain a content property in data", async () => {
+    const response: responseJson = await discordTextResponse("Hello").json();
+    expect(response?.data).toHaveProperty("content");
+  });
+  it("Should have content as hello", async () => {
+    const response: responseJson = await discordTextResponse("Hello").json();
+    expect(response?.data.content).toBe("Hello");
+  });
+});

tests/unit/discordResponse.test.ts

@@ -0,0 +1,13 @@
+import { HELLO, VERIFY } from "../../src/constants/commands";
+import { getCommandName } from "../../src/utils/getCommandName";
+
+describe("Test getCommandName function", () => {
+  it("Returns hello command name in lower case", () => {
+    const commandName = getCommandName(HELLO);
+    expect(commandName).toBe("hello");
+  });
+  it("Returns Verify command name in lower case", () => {
+    const commandName = getCommandName(VERIFY);
+    expect(commandName).toBe("verify");
+  });
+});

tests/unit/getCommandName.test.ts

@@ -0,0 +1,14 @@
+import { commandNotFound } from "../../../src/controllers/commandNotFound";
+import { responseJson } from "../../../src/typeDefinitions/default.types";
+import JSONResponse from "../../../src/utils/JsonResponse";
+
+describe("Test CommandNotFound Handler", () => {
+  it("Should return an instance of JSONResponse", () => {
+    const response = commandNotFound();
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+  it("Should contain text 'Command Not Found'", async () => {
+    const response: responseJson = await commandNotFound().json();
+    expect(response.data.content).toBe("Command Not Found");
+  });
+});

tests/unit/handlers/commandNotFound.test.ts

@@ -0,0 +1,21 @@
+import { InteractionResponseType } from "discord-interactions";
+import { helloCommand } from "../../../src/controllers/helloCommand";
+import { responseJson } from "../../../src/typeDefinitions/default.types";
+import JSONResponse from "../../../src/utils/JsonResponse";
+
+describe("Test helloCommand function", () => {
+  it("Should be an instance of JSONResponse", () => {
+    const response = helloCommand(1234);
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+  it("Should have type as channelMessageWithSource", async () => {
+    const response: responseJson = await helloCommand(1234).json();
+    expect(response?.type).toBe(
+      InteractionResponseType.CHANNEL_MESSAGE_WITH_SOURCE
+    );
+  });
+  it("Should have content as 'Hello <@userId>'", async () => {
+    const response: responseJson = await helloCommand(1234).json();
+    expect(response.data.content).toBe("Hello <@1234>");
+  });
+});