Add a test

Author: JasonEtco

src/action.ts

@@ -6,6 +6,20 @@ import nunjucks from 'nunjucks'
 import dateFilter from 'nunjucks-date-filter'
 import { FrontMatterAttributes, listToArray, setOutputs } from './helpers'
 
+function logError(tools: Toolkit, template: string, action: 'creating' | 'updating', err: any) {
+  // Log the error message
+  const errorMessage = `An error occurred while ${action} the issue. This might be caused by a malformed issue title, or a typo in the labels or assignees. Check ${template}!`
+  tools.log.error(errorMessage)
+  tools.log.error(err)
+
+  // The error might have more details
+  if (err.errors) tools.log.error(err.errors)
+
+  // Exit with a failing status
+  core.setFailed(errorMessage + '\n\n' + err.message)
+  return tools.exit.failure()
+}
+
 export async function createAnIssue (tools: Toolkit) {
   const template = tools.inputs.filename || '.github/ISSUE_TEMPLATE.md'
   const assignees = tools.inputs.assignees
@@ -47,16 +61,11 @@ export async function createAnIssue (tools: Toolkit) {
   tools.log.debug('Templates compiled', templated)
 
   if (updateExisting !== null) {
-    let existingIssue
     tools.log.info(`Fetching issues with title "${templated.title}"`)
-    try {
-      const existingIssues = await tools.github.search.issuesAndPullRequests({
-        q: `is:${searchExistingType} is:issue repo:${process.env.GITHUB_REPOSITORY} in:title ${templated.title}`
-      })
-      existingIssue = existingIssues.data.items.find(issue => issue.title === templated.title)
-    } catch (err: any) {
-      tools.exit.failure(err)
-    }
+    const existingIssues = await tools.github.search.issuesAndPullRequests({
+      q: `is:${searchExistingType} is:issue repo:${process.env.GITHUB_REPOSITORY} in:title ${templated.title}`
+    })
+    const existingIssue = existingIssues.data.items.find(issue => issue.title === templated.title)
     if (existingIssue) {
       if (updateExisting === false) {
         tools.exit.success(`Existing issue ${existingIssue.title}#${existingIssue.number}: ${existingIssue.html_url} found but not updated`)
@@ -71,7 +80,7 @@ export async function createAnIssue (tools: Toolkit) {
           setOutputs(tools, issue)
           tools.exit.success(`Updated issue ${existingIssue.title}#${existingIssue.number}: ${existingIssue.html_url}`)
         } catch (err: any) {
-          tools.exit.failure(err)
+          return logError(tools, template, 'updating', err)
         }
       }
     } else {
@@ -93,16 +102,6 @@ export async function createAnIssue (tools: Toolkit) {
     setOutputs(tools, issue)
     tools.log.success(`Created issue ${issue.data.title}#${issue.data.number}: ${issue.data.html_url}`)
   } catch (err: any) {
-    // Log the error message
-    const errorMessage = `An error occurred while creating the issue. This might be caused by a malformed issue title, or a typo in the labels or assignees. Check ${template}!`
-    tools.log.error(errorMessage)
-    tools.log.error(err)
-
-    // The error might have more details
-    if (err.errors) tools.log.error(err.errors)
-
-    // Exit with a failing status
-    core.setFailed(errorMessage + '\n\n' + err.message)
-    tools.exit.failure()
+    return logError(tools, template, 'creating', err)
   }
 }

tests/__snapshots__/index.test.ts.snap

@@ -239,6 +239,24 @@ Array [
 ]
 `;
 
+exports[`create-an-issue logs a helpful error if updating an issue throws an error with more errors 1`] = `
+Array [
+  Array [
+    "An error occurred while updating the issue. This might be caused by a malformed issue title, or a typo in the labels or assignees. Check .github/ISSUE_TEMPLATE.md!",
+  ],
+  Array [
+    [HttpError: Validation error: {"foo":true}],
+  ],
+  Array [
+    Array [
+      Object {
+        "foo": true,
+      },
+    ],
+  ],
+]
+`;
+
 exports[`create-an-issue updates an existing open issue with the same title 1`] = `
 Object {
   "assignees": Array [

tests/index.test.ts

@@ -240,6 +240,7 @@ describe('create-an-issue', () => {
   it('logs a helpful error if creating an issue throws an error', async () => {
     nock.cleanAll()
     nock('https://api.github.com')
+      .get(/\/search\/issues.*/).reply(200, { items:[] })
       .post(/\/repos\/.*\/.*\/issues/).reply(500, {
         message: 'Validation error'
       })
@@ -253,6 +254,7 @@ describe('create-an-issue', () => {
   it('logs a helpful error if creating an issue throws an error with more errors', async () => {
     nock.cleanAll()
     nock('https://api.github.com')
+      .get(/\/search\/issues.*/).reply(200, { items:[] })
       .post(/\/repos\/.*\/.*\/issues/).reply(500, {
         message: 'Validation error',
         errors: [{ foo: true }]
@@ -263,4 +265,22 @@ describe('create-an-issue', () => {
     expect((tools.log.error as any).mock.calls).toMatchSnapshot()
     expect(tools.exit.failure).toHaveBeenCalled()
   })
+
+  it('logs a helpful error if updating an issue throws an error with more errors', async () => {
+    nock.cleanAll()
+    nock('https://api.github.com')
+      .get(/\/search\/issues.*/)
+      .reply(200, { items: [{ number: 1, title: 'Hello!' }] })
+      .patch(/\/repos\/.*\/.*\/issues\/.*/).reply(500, {
+        message: 'Validation error',
+        errors: [{ foo: true }]
+      })
+
+    process.env.INPUT_UPDATE_EXISTING = 'true'
+
+    await createAnIssue(tools)
+    expect(tools.log.error).toHaveBeenCalled()
+    expect((tools.log.error as any).mock.calls).toMatchSnapshot()
+    expect(tools.exit.failure).toHaveBeenCalled()
+  })
 })