Updated and tested check-and-get branch (#2)

* bump actions/core and actions/github

* join with the get-pr-commits action

* fix some tests

* add more coverage

* update to newer version

* build dist file

* update linting ruleset

* fix linting

* add missing token to the test job

Co-authored-by: Tobias Gesellchen <[email protected]>

Author: derKuba

.eslintrc.json

@@ -1,6 +1,6 @@
 {
     "plugins": ["jest", "@typescript-eslint"],
-    "extends": ["plugin:github/es6"],
+    "extends": ["plugin:github/recommended"],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
       "ecmaVersion": 9,
@@ -11,44 +11,10 @@
       "eslint-comments/no-use": "off",
       "import/no-namespace": "off",
       "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": "error",
-      "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
-      "@typescript-eslint/no-require-imports": "error",
-      "@typescript-eslint/array-type": "error",
-      "@typescript-eslint/await-thenable": "error",
-      "@typescript-eslint/ban-ts-ignore": "error",
       "camelcase": "off",
-      "@typescript-eslint/camelcase": "error",
-      "@typescript-eslint/class-name-casing": "error",
-      "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
-      "@typescript-eslint/func-call-spacing": ["error", "never"],
-      "@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
-      "@typescript-eslint/no-array-constructor": "error",
-      "@typescript-eslint/no-empty-interface": "error",
-      "@typescript-eslint/no-explicit-any": "error",
-      "@typescript-eslint/no-extraneous-class": "error",
-      "@typescript-eslint/no-for-in-array": "error",
-      "@typescript-eslint/no-inferrable-types": "error",
-      "@typescript-eslint/no-misused-new": "error",
-      "@typescript-eslint/no-namespace": "error",
-      "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/no-object-literal-type-assertion": "error",
-      "@typescript-eslint/no-unnecessary-qualifier": "error",
-      "@typescript-eslint/no-unnecessary-type-assertion": "error",
-      "@typescript-eslint/no-useless-constructor": "error",
-      "@typescript-eslint/no-var-requires": "error",
-      "@typescript-eslint/prefer-for-of": "warn",
-      "@typescript-eslint/prefer-function-type": "warn",
-      "@typescript-eslint/prefer-includes": "error",
-      "@typescript-eslint/prefer-interface": "error",
-      "@typescript-eslint/prefer-string-starts-ends-with": "error",
-      "@typescript-eslint/promise-function-async": "error",
-      "@typescript-eslint/require-array-sort-compare": "error",
-      "@typescript-eslint/restrict-plus-operands": "error",
-      "semi": "off",
-      "@typescript-eslint/semi": ["error", "never"],
-      "@typescript-eslint/type-annotation-spacing": "error",
-      "@typescript-eslint/unbound-method": "error"
+      "i18n-text/no-en": "off",
+      "semi": "off"
+
     },
     "env": {
       "node": true,

.github/workflows/test.yml

@@ -22,6 +22,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: ./
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           pattern: '\[(BUGFIX|DOCS|FEATURE|TASK)\] .+$'
           error: 'Your first line has to contain a commit type like "[BUGFIX]".'
 ...

__tests__/commit-message-checker.test.ts

@@ -26,102 +26,28 @@ let commitMessageChecker: any
 describe('commit-message-checker tests', () => {
   beforeAll(() => {
     // Now import
-    commitMessageChecker = require('../lib/commit-message-checker')
-  })
-
-  it('requires pattern', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: '',
-      flags: '',
-      error: '',
-      messages: []
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('PATTERN not defined.')
-  })
-
-  it('requires valid flags', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: 'some-pattern',
-      flags: 'abcdefgh',
-      error: '',
-      messages: []
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('FLAGS contains invalid characters "abcdefh".')
-  })
-
-  it('requires error message', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: 'some-pattern',
-      flags: '',
-      error: '',
-      messages: []
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('ERROR not defined.')
-  })
-
-  it('requires messages', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: 'some-pattern',
-      flags: '',
-      error: 'some-error',
-      messages: []
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('MESSAGES not defined.')
+    commitMessageChecker = require('../src/commit-message-checker')
   })
 
   it('check fails single message', async () => {
     const checkerArguments: ICheckerArguments = {
       pattern: 'some-pattern',
       flags: '',
-      error: 'some-error',
-      messages: ['some-message']
+      error: 'some-error'
     }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('some-error')
-  })
-
-  it('check fails multiple messages', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: 'some-pattern',
-      flags: '',
-      error: 'some-error',
-      messages: ['some-message', 'some-pattern']
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).rejects.toThrow('some-error')
+    expect(
+      commitMessageChecker.checkCommitMessages(checkerArguments, 'some-message')
+    ).toBe('some-error')
   })
 
   it('check succeeds on single message', async () => {
     const checkerArguments: ICheckerArguments = {
       pattern: '.*',
       flags: '',
-      error: 'some-error',
-      messages: ['some-message']
-    }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).resolves.toBeUndefined()
-  })
-
-  it('check succeeds on multiple messages', async () => {
-    const checkerArguments: ICheckerArguments = {
-      pattern: '.*',
-      flags: '',
-      error: 'some-error',
-      messages: ['some-message', 'other-message']
+      error: 'some-error'
     }
-    await expect(
-      commitMessageChecker.checkCommitMessages(checkerArguments)
-    ).resolves.toBeUndefined()
+    expect(
+      commitMessageChecker.checkCommitMessages(checkerArguments, 'some-message')
+    ).toBe('')
   })
 })

__tests__/input-helper.test.ts

@@ -26,7 +26,7 @@ let inputHelper: any
 
 // Mock @actions/core
 let inputs = {} as any
-const mockCore = jest.genMockFromModule('@actions/core') as any
+const mockCore: any = jest.genMockFromModule('@actions/core')
 mockCore.getInput = (name: string, options?: InputOptions) => {
   const val = inputs[name] || ''
   if (options && options.required && !val) {
@@ -36,7 +36,7 @@ mockCore.getInput = (name: string, options?: InputOptions) => {
 }
 
 // Mock @actions/github
-const mockGitHub = jest.genMockFromModule('@actions/github') as any
+const mockGitHub: any = jest.genMockFromModule('@actions/github')
 mockGitHub.context = {}
 
 describe('input-helper tests', () => {
@@ -46,7 +46,7 @@ describe('input-helper tests', () => {
     jest.setMock('@actions/github', mockGitHub)
 
     // Now import
-    inputHelper = require('../lib/input-helper')
+    inputHelper = require('../src/input-helper')
   })
 
   beforeEach(() => {
@@ -73,25 +73,6 @@ describe('input-helper tests', () => {
     }).toThrow('Input required and not supplied: error')
   })
 
-  it('requires event', () => {
-    inputs.pattern = 'some-pattern'
-    inputs.error = 'some-error'
-    expect(() => {
-      const checkerArguments: ICheckerArguments = inputHelper.getInputs()
-    }).toThrow('Event "undefined" is not supported.')
-  })
-
-  it('requires valid event', () => {
-    mockGitHub.context = {
-      eventName: 'some-event'
-    }
-    inputs.pattern = 'some-pattern'
-    inputs.error = 'some-error'
-    expect(() => {
-      const checkerArguments: ICheckerArguments = inputHelper.getInputs()
-    }).toThrow('Event "some-event" is not supported.')
-  })
-
   it('sets flags', () => {
     mockGitHub.context = {
       eventName: 'pull_request',
@@ -109,23 +90,6 @@ describe('input-helper tests', () => {
     expect(checkerArguments.flags).toBe('abcdefgh')
   })
 
-  it('requires pull_request payload', () => {
-    mockGitHub.context = {
-      eventName: 'pull_request',
-      payload: {
-        pull_request: {
-          title: '',
-          body: ''
-        }
-      }
-    }
-    inputs.pattern = 'some-pattern'
-    inputs.error = 'some-error'
-    expect(() => {
-      const checkerArguments: ICheckerArguments = inputHelper.getInputs()
-    }).toThrow('No pull_request found in the payload.')
-  })
-
   it('sets correct pull_request title payload', () => {
     mockGitHub.context = {
       eventName: 'pull_request',
@@ -142,8 +106,6 @@ describe('input-helper tests', () => {
     expect(checkerArguments).toBeTruthy()
     expect(checkerArguments.pattern).toBe('some-pattern')
     expect(checkerArguments.error).toBe('some-error')
-    expect(checkerArguments.messages).toBeTruthy()
-    expect(checkerArguments.messages[0]).toBe('some-title')
   })
 
   it('sets correct pull_request title and body payload', () => {
@@ -162,34 +124,6 @@ describe('input-helper tests', () => {
     expect(checkerArguments).toBeTruthy()
     expect(checkerArguments.pattern).toBe('some-pattern')
     expect(checkerArguments.error).toBe('some-error')
-    expect(checkerArguments.messages).toBeTruthy()
-    expect(checkerArguments.messages[0]).toBe('some-title\n\nsome-body')
-  })
-
-  it('requires push payload', () => {
-    mockGitHub.context = {
-      eventName: 'push',
-      payload: {}
-    }
-    inputs.pattern = 'some-pattern'
-    inputs.error = 'some-error'
-    expect(() => {
-      const checkerArguments: ICheckerArguments = inputHelper.getInputs()
-    }).toThrow('No commits found in the payload.')
-  })
-
-  it('requires push payload commits', () => {
-    mockGitHub.context = {
-      eventName: 'push',
-      payload: {
-        commits: {}
-      }
-    }
-    inputs.pattern = 'some-pattern'
-    inputs.error = 'some-error'
-    expect(() => {
-      const checkerArguments: ICheckerArguments = inputHelper.getInputs()
-    }).toThrow('No commits found in the payload.')
   })
 
   it('sets correct single push payload', () => {
@@ -209,8 +143,6 @@ describe('input-helper tests', () => {
     expect(checkerArguments).toBeTruthy()
     expect(checkerArguments.pattern).toBe('some-pattern')
     expect(checkerArguments.error).toBe('some-error')
-    expect(checkerArguments.messages).toBeTruthy()
-    expect(checkerArguments.messages[0]).toBe('some-message')
   })
 
   it('sets correct multiple push payload', () => {
@@ -233,8 +165,76 @@ describe('input-helper tests', () => {
     expect(checkerArguments).toBeTruthy()
     expect(checkerArguments.pattern).toBe('some-pattern')
     expect(checkerArguments.error).toBe('some-error')
-    expect(checkerArguments.messages).toBeTruthy()
-    expect(checkerArguments.messages[0]).toBe('some-message')
-    expect(checkerArguments.messages[1]).toBe('other-message')
+  })
+
+  it('requires pattern', async () => {
+    const checkerArguments: ICheckerArguments = {
+      pattern: '',
+      flags: '',
+      error: ''
+    }
+
+    expect(() => {
+      inputHelper.checkArgs(checkerArguments)
+    }).toThrow('PATTERN not defined.')
+  })
+
+  it('requires valid flags', async () => {
+    const checkerArguments: ICheckerArguments = {
+      pattern: 'some-pattern',
+      flags: 'abcdefgh',
+      error: ''
+    }
+    expect(() => {
+      inputHelper.checkArgs(checkerArguments)
+    }).toThrow('FLAGS contains invalid characters "abcdefh".')
+  })
+
+  it('requires valid error message', async () => {
+    const checkerArguments: ICheckerArguments = {
+      pattern: 'some-pattern',
+      flags: 'g',
+      error: ''
+    }
+    expect(() => {
+      inputHelper.checkArgs(checkerArguments)
+    }).toThrow('ERROR not defined.')
+  })
+
+  it('should throw error message on genOutput', async () => {
+    expect(() => {
+      inputHelper.genOutput()
+    }).toThrow("Cannot read properties of undefined (reading 'map')")
+  })
+
+  it('should return error message on genOutput', async () => {
+    const attributes = {
+      commitInfos: [
+        {
+          sha: 'aaaaaaa1111',
+          message: 'message1'
+        },
+        {
+          sha: 'bbbbbbb2222',
+          message: 'message2'
+        }
+      ],
+      preErrorMsg: 'i am a preErrorMessage',
+      postErrorMSG: 'i am a posterrormessage'
+    }
+    const expected: any = inputHelper.genOutput(
+      attributes.commitInfos,
+      attributes.preErrorMsg,
+      attributes.postErrorMSG
+    )
+
+    expect(expected).toMatchInlineSnapshot(`
+      "i am a preErrorMessage
+
+        aaaaaaa1111    message1
+        bbbbbbb2222    message2
+
+      i am a posterrormessage"
+    `)
   })
 })