From 00fd396d89682f7dc79f640205ea10c15dd4575f Mon Sep 17 00:00:00 2001
From: Nick Maassel <1653803+nsmaassel@users.noreply.github.com>
Date: Tue, 19 Mar 2024 20:18:07 -0700
Subject: [PATCH] Refactor enhanceUserStoryLogic test and add integration tests

---
 src/logic/EnhanceUserStoryLogic.test.ts | 102 ++++++++++++++----------
 1 file changed, 59 insertions(+), 43 deletions(-)

diff --git a/src/logic/EnhanceUserStoryLogic.test.ts b/src/logic/EnhanceUserStoryLogic.test.ts
index b204e49..256b91f 100644
--- a/src/logic/EnhanceUserStoryLogic.test.ts
+++ b/src/logic/EnhanceUserStoryLogic.test.ts
@@ -2,35 +2,37 @@ import { OpenAI } from "@langchain/openai";
 import { mock } from "jest-mock-extended";
 import { enhanceUserStoryLogic } from "./EnhanceUserStoryLogic";
 
-describe("enhanceUserStoryLogic", () => {
-  const inputtedUserStory =
-    "As a user, I want to be able to log in to my account so that I can access my dashboard.";
-  const openAIApiKey = "my-openai-api-key";
+// Common setup for all tests
+const inputtedUserStory =
+  "As a user, I want to be able to log in to my account so that I can access my dashboard.";
+const openAIApiKey = "my-openai-api-key";
 
-  // Create a mock instance
-  const llmMock = mock<OpenAI>();
+// Create a mock instance
+const llmMock = mock<OpenAI>();
 
-  // Define a mock parser function that always returns true
-  const mockParserTrue = () => true;
+// Define a mock parser function that always returns true
+const mockParserTrue = () => true;
 
-  // Define a mock parser function that always returns false
-  const mockParserFalse = () => false;
+// Define a mock parser function that always returns false
+const mockParserFalse = () => false;
 
-  // Define a mock response
-  const mockOpenAIResponse = {
-    userStory: "Mocked enhanced user story.",
-    acceptanceCriteria: ["Mocked acceptance criteria."],
-  };
+// Define a mock response
+const mockOpenAIResponse = {
+  userStory: "Mocked enhanced user story.",
+  acceptanceCriteria: ["Mocked acceptance criteria."],
+};
 
-  // Create a spy on the invoke method and mock its implementation
-  const invokeSpy = jest
-    .spyOn(llmMock, "invoke")
-    .mockResolvedValue(JSON.stringify(mockOpenAIResponse));
+// Create a spy on the invoke method and mock its implementation
+const invokeSpy = jest
+  .spyOn(llmMock, "invoke")
+  .mockResolvedValue(JSON.stringify(mockOpenAIResponse));
 
-  beforeEach(() => {
-    // Clear mock call history before each test
-    jest.clearAllMocks();
-  });
+beforeEach(() => {
+  // Clear mock call history before each test
+  jest.clearAllMocks();
+});
+
+describe("Unit Tests for enhanceUserStoryLogic", () => {
   it("should throw an error if the inputted user story is too short", async () => {
     const shortUserStory = "As a user, I want to log in.";
 
@@ -41,6 +43,30 @@ describe("enhanceUserStoryLogic", () => {
     );
   });
 
+  it("should throw an error if the response from OpenAI does not match the expected format", async () => {
+    // Change the implementation of the spy for this test case
+    invokeSpy.mockResolvedValue("invalid-response");
+
+    const invalidApiKey = "invalid-api-key";
+    await expect(
+      enhanceUserStoryLogic(
+        inputtedUserStory,
+        null,
+        invalidApiKey,
+        mockParserFalse
+      )
+    ).rejects.toThrow(
+      `After 5 attempts, the response from OpenAI did not match the expected format.`
+    );
+  }, 50000);
+});
+
+describe("Integration Tests for enhanceUserStoryLogic", () => {
+  beforeEach(() => {
+    // Reset the mock response before each test
+    invokeSpy.mockResolvedValue(JSON.stringify(mockOpenAIResponse));
+  });
+
   it("should return an object with enhanced user story and acceptance criteria", async () => {
     const resultString = await enhanceUserStoryLogic(
       inputtedUserStory,
@@ -59,29 +85,19 @@ describe("enhanceUserStoryLogic", () => {
     expect(invokeSpy).toHaveBeenCalledTimes(1);
   });
 
-  it("should throw an error if the response from OpenAI does not match the expected format", async () => {
-    // Change the implementation of the spy for this test case
-    invokeSpy.mockResolvedValue("invalid-response");
+  it("should return a valid JSON object", async () => {
+    // Mock the OpenAI response with newline characters and leading spaces
+    invokeSpy.mockResolvedValue(
+      `\n\n{\n    "userStory": "As a user, I want to log in so that I can access my account.",\n    "acceptanceCriteria": ["Given that I am on the login page, when I enter valid credentials, then I should be redirected to my account page."]\n}`
+    );
 
-    const invalidApiKey = "invalid-api-key";
-    await expect(
-      enhanceUserStoryLogic(
-        inputtedUserStory,
-        null,
-        invalidApiKey,
-        mockParserFalse
-      )
-    ).rejects.toThrow(
-      `After 5 attempts, the response from OpenAI did not match the expected format.`
+    const result = await enhanceUserStoryLogic(
+      inputtedUserStory,
+      llmMock,
+      openAIApiKey,
+      mockParserTrue
     );
-  }, 50000);
 
-  it("should return a valid JSON object", async () => {
-    // Mock the OpenAI response with newline characters and leading spaces
-    invokeSpy.mockResolvedValue(`\n\n{\n    "userStory": "As a user, I want to log in so that I can access my account.",\n    "acceptanceCriteria": ["Given that I am on the login page, when I enter valid credentials, then I should be redirected to my account page."]\n}`);
-  
-    const result = await enhanceUserStoryLogic(inputtedUserStory, llmMock, openAIApiKey, mockParserTrue);
-  
     // Check if the result can be stringified and parsed without throwing an error
     expect(() => {
       const stringified = JSON.stringify(result);