NEW @W-18394864@ Improved usability of violations (#77)

* @W-18394864@ Summarizer can create two tables now

* @W-18394864@ Dependencies can identify changed files

* @W-18394864@ Achieved compatibility with latest main

* @W-18394864@ Refactored for more sensible code placement

* @W-18394864@ Creating review with link to summary

* @W-18394864@ Fixing typo

* @W-18394864@ Table size limit now shared between tables

* @W-18394864@ Adding E2E test

* @W-18394864@ Fixing typo in CI job

* @W-18394864@ Fixing another typo in CI job

* @W-18394864@ Debugged issues with URL

* @W-18394864@ Summary message sorts violations

* @W-18394864@ Polishing code

* @W-18394864@ Adjusted truncation message

* @W-18394864@ Implemented feedback from code review

* @W-18394864@ Addressed feedback

* @W-18394864@ Updated README and adjusted permission checks.

* @W-18394864@ Feedback from code review

* @W-18394864@ Fixed linting issue

* @W-18394864@ feedback from code review

* @W-18394864@ removing wrongly added file

* @W-18394864@ Final feedback from code review

* @W-18394864@ Final-final feedback

* @W-18394864@ Final-final-final review

* @W-18394864@ Oversight

* fix: edit readme and errors (#79)

* @W-18394864@ Bundling changes

* @W-18394864@ Fixing linting problem

---------

Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com>

Author: jfeingold35

.github/workflows/ci.yml

@@ -45,6 +45,8 @@ jobs:
   test-action:
     name: GitHub Actions Test
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
 
     steps:
       - name: Checkout
@@ -76,7 +78,10 @@ jobs:
         uses: ./
         with:
           run-arguments: --view detail --workspace "./src,./__tests__" --output-file results.json
+          github-token: ${{github.token}}
 
       - name: Print Output
         id: output
-        run: echo "${{ steps.test-action.outputs.exit-code }}"
+        run: |
+          echo "${{ steps.test-action.outputs.exit-code }}"
+          echo "${{ steps.test-action.outputs.review-id }}"

README.md

@@ -15,12 +15,16 @@ The `forcedotcom/run-code-analyzer@v2` GitHub Action is based on [Salesforce Cod
 
 ## v2 Inputs
 * <b>`run-arguments`</b> *(Default: `--view detail --output-file sfca_results.json`)*
-  * Specifies the arguments passed to the `run` command.
-    * For a full list of acceptable arguments for the `run` command, see the [code-analyzer Command Reference](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_code-analyzer_commands_unified.htm).
-  * The stdout text from the `run` command is written to the [GitHub workflow run logs](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs).
+  * Specifies the flags passed to the `code-analyzer run` command.
+    * For a full list of valid flags for the `code-analyzer run` command, see the [code-analyzer Command Reference](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_code-analyzer_commands_unified.htm).
+  * The stdout text from the `code-analyzer run` command is written to the [GitHub workflow run logs](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs).
   * Each output file specified by a `--output-file` (or `-f`) flag is included in the ZIP archive [GitHub workflow run artifact](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts) for you to download.
 * <b>`results-artifact-name`</b>  *(Default: `salesforce-code-analyzer-results`)*
   * Specifies the name of the ZIP archive [GitHub workflow run artifact](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts) where the results output files are uploaded.
+* <b>`github-token`</b>
+  * When this action is run against a pull request, you can provide a GitHub token, which is used to create a review of the pull request. The review specifies how many violations were found (both in the project as a whole and in changed files) and links to the action summary page.
+  * This token must have write permissions for pull requests.
+    * You can use the default GitHub token stored as the `GITHUB_TOKEN` secret, as long as you also use the job-level `permissions` property to give that token write access for pull requests.
 
 ## v2 Outputs
 * `exit-code`
@@ -37,11 +41,13 @@ The `forcedotcom/run-code-analyzer@v2` GitHub Action is based on [Salesforce Cod
   * The number of Low (4) severity violations found.
 * `num-sev5-violations`
   * The number of Info (5) severity violations found.
+* `review-id`
+  * If the action created a pull request review, this is its ID.
 
-This `run-code-analyzer@v2` action won't exit your GitHub workflow when it finds violations. We recommend that you add a subsequent step to your workflow that uses the available outputs to determine how your workflow should proceed.
+This `run-code-analyzer@v2` action doesn't exit your GitHub workflow when it finds violations. We recommend that you add a subsequent step to your workflow that uses the available outputs to determine how your workflow should proceed.
 
 ## Environment Prerequisites
-The [Salesforce Code Analyzer v5.x](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) and its bundled engines can each have their own set of requirements in order to run successfully. So we recommend that you set up your GitHub runner(s) with this software:
+The [Salesforce Code Analyzer v5.x](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) and its bundled engines can each have their own set of requirements in order to run successfully. We recommend that you set up your GitHub runner(s) with this software:
 * `node` version 20.9.0 or greater
   * Required by all engines.
 * `java` version 11 or greater
@@ -52,15 +58,20 @@ The [Salesforce Code Analyzer v5.x](https://developer.salesforce.com/docs/platfo
 ## Example v2 Usage
 
     name: Salesforce Code Analyzer Workflow
-    on: push
+    on:
+      pull_request:
     jobs:
       salesforce-code-analyzer-workflow:
+        permissions:
+          pull-requests: write # Grants permission to create a pull request review. Only necessary if running against pull requests.
+          contents: read # Grants permission to check out the repository. Only necessary for private repos.
+          actions: read # Grants permission to read the in-progress actions. Only necessary for private repos.
         runs-on: ubuntu-latest
         steps:
           - name: Check out files
             uses: actions/checkout@v4
 
-          # PREREQUISITES - Only needed if runner doesn't already satisfy these requirements
+          # PREREQUISITES - Only needed if the runner doesn't already satisfy these requirements.
           - name: Ensure node v20.9.0 or greater
             uses: actions/setup-node@v4
             with:
@@ -87,8 +98,9 @@ The [Salesforce Code Analyzer v5.x](https://developer.salesforce.com/docs/platfo
             with:
               run-arguments: --workspace . --view detail --output-file sfca_results.html --output-file sfca_results.json
               results-artifact-name: salesforce-code-analyzer-results
+              github-token: ${{ github.token }}
 
-          - name: Check the outputs to determine whether to fail
+          - name: Check the Outputs to Determine Whether to Fail
             if: |
               steps.run-code-analyzer.outputs.exit-code > 0 ||
               steps.run-code-analyzer.outputs.num-sev1-violations > 0 ||

__tests__/data/sampleRunResults.json

@@ -1,12 +1,12 @@
 {
     "runDir": "/Users/runner/work/sample-sf-project/sample-sf-project/",
     "violationCounts": {
-        "total": 202,
+        "total": 203,
         "sev1": 0,
         "sev2": 88,
         "sev3": 49,
         "sev4": 44,
-        "sev5": 21
+        "sev5": 22
     },
     "versions": {
         "code-analyzer": "0.20.2",
@@ -3680,6 +3680,31 @@
             ],
             "message": "Avoid unescaped user controlled content in EL",
             "resources": ["https://docs.pmd-code.org/pmd-doc-7.8.0/pmd_rules_visualforce_security.html#vfunescapeel"]
+        },
+        {
+            "rule": "DetectCopyPasteForApex",
+            "engine": "cpd",
+            "severity": 5,
+            "tags": ["Recommended", "Design", "Apex"],
+            "primaryLocationIndex": 0,
+            "locations": [
+                {
+                    "file": "force-app/main/default/classes/NameController.cls",
+                    "startLine": 1,
+                    "startColumn": 1,
+                    "endLine": 10,
+                    "endColumn": 50
+                },
+                {
+                    "file": "force-app/main/default/classes/SharingInnerClass.cls",
+                    "startLine": 15,
+                    "startColumn": 1,
+                    "endLine": 25,
+                    "endColumn": 50
+                }
+            ],
+            "message": "Duplicate code detected for language 'apex'. Found 2 code locations containing the same block of code consisting of 123 tokens across 10 lines.",
+            "resources": ["https://docs.pmd-code.org/latest/pmd_userdocs_cpd.html#refactoring-duplicates"]
         }
     ]
 }

…data/sampleRunResults_expectedSummary.md …data/sampleRunResults_oneTableSummary.md__tests__/data/sampleRunResults_expectedSummary.md renamed to __tests__/data/sampleRunResults_oneTableSummary.md __tests__/data/sampleRunResults_expectedSummary.md renamed to __tests__/data/sampleRunResults_oneTableSummary.md

@@ -1,11 +1,11 @@
 ## Salesforce Code Analyzer Results
-### :warning: 202 Violation(s) Found
+### :warning: 203 Violation(s) Found
 <blockquote>
 :black_circle: 0 Critical severity violation(s)<br/>
 :red_circle: 88 High severity violation(s)<br/>
 :orange_circle: 49 Medium severity violation(s)<br/>
 :yellow_circle: 44 Low severity violation(s)<br/>
-:white_circle: 21 Info severity violation(s)
+:white_circle: 22 Info severity violation(s)
 </blockquote>
 <table><tr><th> </th><th>Location</th><th>Rule</th><th>Message</th></tr>
 <tr><td>:red_circle:</td><td><sup>force-app/main/default/aura/AccountRepeat/AccountRepeat.cmp-meta.xml:3:17</sup></td><td><sup>regex:AvoidOldSalesforceApiVersions</sup></td><td><sup>Found the use of a Salesforce API version that is 3 or more years old. Avoid using an API version that is &lt;= 56.0.</sup></td></tr>
@@ -189,6 +189,7 @@
 <tr><td>:yellow_circle:</td><td><sup>force-app/main/default/classes/testSELECT2.cls:2:12</sup></td><td><sup>pmd:<a href="https://docs.pmd-code.org/pmd-doc-7.8.0/pmd_rules_apex_documentation.html#apexdoc">ApexDoc</a></sup></td><td><sup>Missing ApexDoc comment</sup></td></tr>
 <tr><td>:yellow_circle:</td><td><sup>force-app/main/default/classes/testSELECT2.cls:4:12</sup></td><td><sup>pmd:<a href="https://docs.pmd-code.org/pmd-doc-7.8.0/pmd_rules_apex_documentation.html#apexdoc">ApexDoc</a></sup></td><td><sup>Missing ApexDoc comment</sup></td></tr>
 <tr><td>:yellow_circle:</td><td><sup>force-app/main/default/classes/testSELECT2.cls:11:12</sup></td><td><sup>pmd:<a href="https://docs.pmd-code.org/pmd-doc-7.8.0/pmd_rules_apex_documentation.html#apexdoc">ApexDoc</a></sup></td><td><sup>Missing ApexDoc comment</sup></td></tr>
+<tr><td>:white_circle:</td><td><sup>(main) force-app/main/default/classes/NameController.cls:1:1<br/>force-app/main/default/classes/SharingInnerClass.cls:15:1</sup></td><td><sup>cpd:<a href="https://docs.pmd-code.org/latest/pmd_userdocs_cpd.html#refactoring-duplicates">DetectCopyPasteForApex</a></sup></td><td><sup>Duplicate code detected for language 'apex'. Found 2 code locations containing the same block of code consisting of 123 tokens across 10 lines.</sup></td></tr>
 <tr><td>:white_circle:</td><td><sup>force-app/main/default/classes/NameController.cls:2:1</sup></td><td><sup>regex:NoTrailingWhitespace</sup></td><td><sup>Found trailing whitespace at the end of a line of code.</sup></td></tr>
 <tr><td>:white_circle:</td><td><sup>force-app/main/default/classes/NameController.cls:8:1</sup></td><td><sup>regex:NoTrailingWhitespace</sup></td><td><sup>Found trailing whitespace at the end of a line of code.</sup></td></tr>
 <tr><td>:white_circle:</td><td><sup>force-app/main/default/classes/SafeNoSharing.cls:11:1</sup></td><td><sup>regex:NoTrailingWhitespace</sup></td><td><sup>Found trailing whitespace at the end of a line of code.</sup></td></tr>