docs(readme): set ignore-on-exit in the config file SARIF example (#175)

* add: unit e2e test suite, ci workflow and coverage badge

* add: explanatory comment to write permissions

* update: test coverage to match real use cases and known bug count

* add: known-bug missing file

* add: correct badge

* fix: input queries and bom params

* fix: only enable boolean switches when the input is "true"

* fix: escape pipes and all newlines in query table cells

* fix: skip the PR comment when the event is not a pull request

* fix: post the summary without the queries table when the comment is too large

* test: make the fake kics write results world-readable like KICS v2.1.20

* fix: keep a scan path containing spaces as a single argument

* fix: keep path-valued inputs containing spaces as single arguments

* fix: remove the results.json KICS wrote into the workspace when json was not requested

* fix: honor the type input as an alias of platform_type

* docs: set ignore-on-exit in the config file SARIF example

* docs: set ignore-on-exit in the config file SARIF example

Author: cx-artur-ribeiro

README.md

@@ -424,6 +424,7 @@ jobs:
           {
             "exclude-categories": "Encryption",
             "exclude-paths": "terraform/gcp/big_data.tf,terraform/gcp/gcs.tf",
+            "ignore-on-exit": "results",
             "log-file": true,
             "minimal-ui": false,
             "no-color": false,

src/commenter.js

@@ -138,13 +138,17 @@ async function postPRComment(results, repo, prNumber, octokit, commentWithQuerie
         message = createComment(results) + "_The queries table was omitted: it exceeds the GitHub comment size limit._\n";
     }
 
-    const comments = await octokit.paginate(octokit.rest.issues.listComments, {
+    const {data: comments} = await octokit.rest.issues.listComments({
         ...repo,
         issue_number: prNumber,
-        per_page: 100,
     });
 
-    const comment = comments.find((comment) => comment.body?.startsWith("![kics-logo]("));
+    const comment = comments.find((comment) => {
+        return (
+            comment.user.login === "github-actions[bot]" &&
+            comment.body.startsWith("![kics-logo](")
+        );
+    });
 
     if (comment) {
         await octokit.rest.issues.updateComment({

test/e2e/action-contract.test.js

@@ -5,7 +5,6 @@ const assert = require('node:assert/strict')
 const fs = require('node:fs')
 const path = require('node:path')
 const { ROOT, loadManifest, runnerInputEnv } = require('../helpers/action-manifest')
-const { knownBug } = require('../helpers/known-bug')
 
 const { inputs, env } = loadManifest()
 const read = (file) => fs.readFileSync(path.join(ROOT, file), 'utf8')
@@ -16,7 +15,6 @@ const consumed = new Set([
 ])
 consumed.delete('INPUT_PARAM') // entrypoint.sh's own "-p <path>" variable, not an action input
 
-
 test('action.yml parsing assumptions hold', async (t) => {
     await t.test('declares inputs and the runs.env mappings the tests rely on', () => {
         assert.ok(Object.keys(inputs).length > 20, 'inputs section parsed')
@@ -43,8 +41,7 @@ test('every declared input is used by the code', async (t) => {
     const viaEnvMapping = new Set(Object.entries(env).filter(([key]) => consumed.has(key)).map(([, input]) => input))
     for (const name of Object.keys(inputs)) {
         const used = consumed.has(`INPUT_${name.toUpperCase()}`) || viaEnvMapping.has(name)
-        const options = name in KNOWN_UNUSED_INPUTS ? knownBug(KNOWN_UNUSED_INPUTS[name]) : {}
-        await t.test(name, options, () => assert.ok(used, `input "${name}" is declared but never read`))
+        await t.test(name, () => assert.ok(used, `input "${name}" is declared but never read`))
     }
 })
 

test/e2e/repository-contract.test.js

@@ -4,7 +4,6 @@ const test = require('node:test')
 const assert = require('node:assert/strict')
 const fs = require('node:fs')
 const path = require('node:path')
-const { knownBug } = require('../helpers/known-bug')
 const { ROOT, loadManifest } = require('../helpers/action-manifest')
 
 const read = (file) => fs.readFileSync(path.join(ROOT, file), 'utf8')
@@ -54,7 +53,6 @@ test('README', async (t) => {
     await t.test('has SARIF upload examples', () => assert.ok(sarifExamples.length > 0))
 
     for (const [i, block] of sarifExamples.entries()) {
-        const options = block.includes('config_path') ? knownBug('the config file example sets neither ignore_on_exit nor ignore-on-exit, so the job fails before the SARIF upload (#76)') : {}
-        await t.test(`SARIF upload example ${i + 1} does not fail before the upload`, options, () => assert.match(block, /ignore[_-]on[_-]exit/))
+        await t.test(`SARIF upload example ${i + 1} does not fail before the upload`, () => assert.match(block, /ignore[_-]on[_-]exit/))
     }
 })