Merge pull request #16 from ca-dp/releases/add-chat-cmd

add chat cmd

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+# Overview
+
+copilot:summary
+
+# Explanation of Changes
+
+copilot: walkthrough
+
+copilot:poem
+
+# Related Issues
+
+<!---Please lint to the issue here.--->

.github/linters/.markdown-lint.yml

@@ -9,3 +9,5 @@ MD029:
 # Line length
 MD013:
   line_length: 120
+
+MD025: false

__tests__/github.test.ts

@@ -2,7 +2,11 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import nock from 'nock' // Import nock for mocking HTTP requests
 
-import { getPullRequestDiff, createGitHubComment } from '../src/github' // Please specify the path to your module
+import {
+  getPullRequestDiff,
+  createGitHubComment,
+  getIssueComment
+} from '../src/github' // Please specify the path to your module
 
 const getInputMock = jest.spyOn(core, 'getInput')
 // Set the GITHUB_REPOSITORY environment variable for testing
@@ -76,3 +80,36 @@ describe('createGitHubComment', () => {
     // Test that the GitHub API request is successful
   })
 })
+
+describe('getIssueComment', () => {
+  it('should return the issue comment', async () => {
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'GITHUB_TOKEN':
+          return 'token'
+        default:
+          return ''
+      }
+    })
+    github.context.payload = {
+      issue: {
+        // Mock the issue number
+        number: 2
+      }
+    }
+    nock('https://api.github.com', {
+      reqheaders: {
+        accept: 'application/vnd.github.v3+json',
+        authorization: 'token token',
+        'accept-encoding': 'gzip,deflate'
+      }
+    })
+      .get('/repos/test-org/test-repo/issues/comments/2')
+      .reply(200, {
+        body: 'This is a test comment'
+      })
+
+    const comment = await getIssueComment()
+    expect(comment).toBe('This is a test comment')
+  })
+})

__tests__/main.test.ts

@@ -11,7 +11,7 @@ import * as github from '../src/github'
 import * as ai from '../src/ai'
 import * as process from 'process'
 import * as prompt from '../src/prompt'
-import * as main from '../src/main' // Import the main module
+import * as main from '../src/main'
 
 const getInputMock = jest.spyOn(core, 'getInput')
 // Set the GITHUB_REPOSITORY environment variable for testing
@@ -34,6 +34,8 @@ describe('run', () => {
       switch (name) {
         case 'OPENAI_API_KEY':
           return 'mocked-api-key'
+        case 'cmd':
+          return 'review'
         default:
           return ''
       }
@@ -66,6 +68,8 @@ describe('run', () => {
           return 'token'
         case 'OPENAI_API_KEY':
           return 'mocked-api-key'
+        case 'cmd':
+          return 'review'
         default:
           return ''
       }
@@ -92,5 +96,98 @@ describe('run', () => {
     delete process.env.OPENAI_API_KEY
   })
 
+  it('should handle unknown command', async () => {
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'GITHUB_TOKEN':
+          return 'token'
+        case 'OPENAI_API_KEY':
+          return 'mocked-api-key'
+        case 'cmd':
+          return 'unknown'
+        default:
+          return ''
+      }
+    })
+    const setFailedMock = jest.spyOn(core, 'setFailed')
+    await main.run()
+    expect(setFailedMock).toHaveBeenCalledWith('Unknown command')
+  })
+
+  it('should run the action successfully on chat', async () => {
+    // Create mock functions
+    const getIssueCommentMock = jest.spyOn(github, 'getIssueComment')
+    getIssueCommentMock.mockResolvedValue('Mocked issue comment')
+
+    const completionRequestMock = jest.spyOn(ai, 'completionRequest')
+    completionRequestMock.mockResolvedValue('Mocked AI response')
+
+    const createGitHubCommentMock = jest.spyOn(github, 'createGitHubComment')
+    createGitHubCommentMock.mockResolvedValue(undefined)
+
+    // Set required environment variables
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'OPENAI_API_KEY':
+          return 'mocked-api-key'
+        case 'cmd':
+          return 'chat'
+        default:
+          return ''
+      }
+    })
+
+    // Set a dummy prompt
+    const getChatSystemPromptMock = jest.spyOn(prompt, 'getChatSystemPrompt')
+    getChatSystemPromptMock.mockReturnValue('Mocked system prompt')
+
+    // Call the function under test
+    await main.run()
+
+    // Ensure each function was called correctly
+    expect(getIssueCommentMock).toHaveBeenCalled()
+    expect(completionRequestMock).toHaveBeenCalledWith(
+      'mocked-api-key',
+      'Mocked system prompt',
+      'Mocked issue comment'
+    )
+    expect(createGitHubCommentMock).toHaveBeenCalledWith('Mocked AI response')
+  })
+
+  it('should handle empty AI response message on chat', async () => {
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'GITHUB_TOKEN':
+          return 'token'
+        case 'OPENAI_API_KEY':
+          return 'mocked-api-key'
+        case 'cmd':
+          return 'chat'
+        default:
+          return ''
+      }
+    })
+
+    // Set up a spy to capture the error message
+    const setFailedMock = jest.spyOn(core, 'setFailed')
+
+    // Create mock functions
+    const getIssueCommentMock = jest.spyOn(github, 'getIssueComment')
+    getIssueCommentMock.mockResolvedValue('Mocked issue comment')
+
+    // Mock AI response with an empty message
+    const completionRequestMock = jest.spyOn(ai, 'completionRequest')
+    completionRequestMock.mockResolvedValue('')
+
+    // Call the function under test
+    await main.run()
+
+    // Ensure the error message was set correctly
+    expect(setFailedMock).toHaveBeenCalledWith('Response content is missing')
+
+    // Clear environment variables
+    delete process.env.OPENAI_API_KEY
+  })
+
   // Additional test cases for other error scenarios can be added
 })

__tests__/prompt.test.ts

@@ -74,3 +74,18 @@ describe('getCodeReviewSystemPrompt', () => {
     expect(result).toEqual(expectedPrompt)
   })
 })
+
+describe('getChatSystemPrompt', () => {
+  it('should return the correct system prompt', () => {
+    const expectedPrompt = `
+    You are Software-Developer, a language model designed to chat with software developers.
+    Your task is to chat with the user, and respond to questions from troubled software developers and solve their problems.
+    Please ignore the '/chat' at the beginning of the question.
+    Also, don't repeat the prompt in your answer.
+`
+
+    const result = prompt.getChatSystemPrompt()
+
+    expect(result).toEqual(expectedPrompt)
+  })
+})

action.yml

@@ -9,6 +9,9 @@ inputs:
   OPENAI_API_KEY:
     description: 'OpenAI API Key'
     required: true
+  cmd:
+    description: 'Command to run(review or chat)'
+    required: true
 
 runs:
   using: node20

src/github.ts

@@ -28,3 +28,16 @@ export async function createGitHubComment(message: string): Promise<void> {
     body: message
   })
 }
+
+export async function getIssueComment(): Promise<string> {
+  const token = core.getInput('GITHUB_TOKEN', { required: true })
+  const octokit = github.getOctokit(token)
+
+  const { data: comment } = await octokit.rest.issues.getComment({
+    owner: github.context.repo.owner,
+    repo: github.context.repo.repo,
+    comment_id: github.context.issue.number
+  })
+
+  return (comment.body as unknown as string) || ''
+}