SCP-49 Adds GH Check on main workflow

.github/linters/.eslintrc.yml

@@ -45,6 +45,7 @@ rules:
     'no-unused-vars': 'off',
     'prettier/prettier': 'error',
     'semi': 'off',
+    'no-shadow': 'warn',
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/await-thenable': 'error',
     '@typescript-eslint/ban-ts-comment': 'error',
@@ -56,7 +57,7 @@ rules:
     '@typescript-eslint/func-call-spacing': ['error', 'never'],
     '@typescript-eslint/no-array-constructor': 'error',
     '@typescript-eslint/no-empty-interface': 'error',
-    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/no-extraneous-class': 'error',
     '@typescript-eslint/no-for-in-array': 'error',
     '@typescript-eslint/no-inferrable-types': 'error',
@@ -76,8 +77,9 @@ rules:
     '@typescript-eslint/promise-function-async': 'error',
     '@typescript-eslint/require-array-sort-compare': 'error',
     '@typescript-eslint/restrict-plus-operands': 'error',
-    '@typescript-eslint/semi': ['error', 'never'],
+    '@typescript-eslint/semi': ['error', 'always'],
     '@typescript-eslint/space-before-function-paren': 'off',
     '@typescript-eslint/type-annotation-spacing': 'error',
-    '@typescript-eslint/unbound-method': 'error'
+    '@typescript-eslint/unbound-method': 'error',
+    'github/array-foreach' : 'off'
   }

.github/workflows/test-action.yml

@@ -8,11 +8,16 @@ on:
 
 permissions:
   contents: read
+  pull-requests: write
+  checks: write 
 
 jobs:
   test-action:
     name: GitHub Actions Test
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout
@@ -22,6 +27,8 @@ jobs:
       - name: Test Local Action
         id: test-action
         uses: ./
+        with:
+           github-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Print output command
         run: echo "${{ steps.test-action.outputs.output-command }}"

.prettierrc.json

@@ -1,8 +1,8 @@
 {
   "printWidth": 120,
   "tabWidth": 2,
   "useTabs": false,
-  "semi": false,
+  "semi": true,
   "singleQuote": true,
   "quoteProps": "as-needed",
   "jsxSingleQuote": false,

__tests__/index.test.ts

@@ -2,16 +2,16 @@
  * Unit tests for the action's entrypoint, src/index.ts
  */
 
-import * as main from '../src/main'
+import * as main from '../src/main';
 
 // Mock the action's entrypoint
-const runMock = jest.spyOn(main, 'run').mockImplementation()
+const runMock = jest.spyOn(main, 'run').mockImplementation();
 
 describe('index', () => {
   it('calls run when imported', async () => {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require('../src/index')
+    require('../src/index');
 
-    expect(runMock).toHaveBeenCalled()
-  })
-})
+    expect(runMock).toHaveBeenCalled();
+  });
+});

__tests__/main.test.ts

@@ -6,71 +6,71 @@
  * variables following the pattern `INPUT_<INPUT_NAME>`.
  */
 
-import * as core from '@actions/core'
-import * as main from '../src/main'
+import * as core from '@actions/core';
+import * as main from '../src/main';
 
 // Mock the action's main function
-const runMock = jest.spyOn(main, 'run')
+const runMock = jest.spyOn(main, 'run');
 
 // Other utilities
-const timeRegex = /^\d{2}:\d{2}:\d{2}/
+const timeRegex = /^\d{2}:\d{2}:\d{2}/;
 
 // Mock the GitHub Actions core library
-let debugMock: jest.SpyInstance
-let errorMock: jest.SpyInstance
-let getInputMock: jest.SpyInstance
-let setFailedMock: jest.SpyInstance
-let setOutputMock: jest.SpyInstance
+let debugMock: jest.SpyInstance;
+let errorMock: jest.SpyInstance;
+let getInputMock: jest.SpyInstance;
+let setFailedMock: jest.SpyInstance;
+let setOutputMock: jest.SpyInstance;
 
 describe('action', () => {
   beforeEach(() => {
-    jest.clearAllMocks()
+    jest.clearAllMocks();
 
-    debugMock = jest.spyOn(core, 'debug').mockImplementation()
-    errorMock = jest.spyOn(core, 'error').mockImplementation()
-    getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
-    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
-    setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
-  })
+    debugMock = jest.spyOn(core, 'debug').mockImplementation();
+    errorMock = jest.spyOn(core, 'error').mockImplementation();
+    getInputMock = jest.spyOn(core, 'getInput').mockImplementation();
+    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation();
+    setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation();
+  });
 
   it('sets the time output', async () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
         case 'milliseconds':
-          return '500'
+          return '500';
         default:
-          return ''
+          return '';
       }
-    })
+    });
 
-    await main.run()
-    expect(runMock).toHaveReturned()
+    await main.run();
+    expect(runMock).toHaveReturned();
 
     // Verify that all of the core library functions were called correctly
-    expect(debugMock).toHaveBeenNthCalledWith(1, 'Waiting 500 milliseconds ...')
-    expect(debugMock).toHaveBeenNthCalledWith(2, expect.stringMatching(timeRegex))
-    expect(debugMock).toHaveBeenNthCalledWith(3, expect.stringMatching(timeRegex))
-    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'time', expect.stringMatching(timeRegex))
-    expect(errorMock).not.toHaveBeenCalled()
-  })
+    expect(debugMock).toHaveBeenNthCalledWith(1, 'Waiting 500 milliseconds ...');
+    expect(debugMock).toHaveBeenNthCalledWith(2, expect.stringMatching(timeRegex));
+    expect(debugMock).toHaveBeenNthCalledWith(3, expect.stringMatching(timeRegex));
+    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'time', expect.stringMatching(timeRegex));
+    expect(errorMock).not.toHaveBeenCalled();
+  });
 
   it('sets a failed status', async () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
         case 'milliseconds':
-          return 'this is not a number'
+          return 'this is not a number';
         default:
-          return ''
+          return '';
       }
-    })
+    });
 
-    await main.run()
-    expect(runMock).toHaveReturned()
+    await main.run();
+    expect(runMock).toHaveReturned();
 
     // Verify that all of the core library functions were called correctly
-    expect(setFailedMock).toHaveBeenNthCalledWith(1, 'milliseconds not a number')
-    expect(errorMock).not.toHaveBeenCalled()
-  })
-})
+    expect(setFailedMock).toHaveBeenNthCalledWith(1, 'milliseconds not a number');
+    expect(errorMock).not.toHaveBeenCalled();
+  });
+});

action.yml

@@ -9,6 +9,9 @@ branding:
 
 # Define your inputs here.
 inputs:
+  github-token:
+    description: 'Your GitHub token'
+    required: true
   scanner-parameters:  
     description: 'Parameters to run a scan'
     required: false