Add support for suppression criteria #25

martinschaef · 2022-06-29T18:10:57Z

Adds support for cli-specific suppression mechanisms in .codeguru-ignore.yml and bumps the version to 0.1.0:

version: 1.0  # The Version field is mandatory. All other fields are optional. 

# The CodeGuru Reviewer CLI produces a recommendations.json file which contains deterministic IDs for each
# recommendation. This ID can be excluded so that this recommendation will not be reported in future runs of the
# CLI.
ExcludeById:
- '4d2c43618a2dac129818bef77093730e84a4e139eef3f0166334657503ecd88d'

# We can tell the CLI to exclude all recommendations below a certain severity. This can be useful in CICD integration.
ExcludeBelowSeverity: 'HIGH'

# We can exclude all recommendations that have a certain tag. Available Tags can be found here:
# https://docs.aws.amazon.com/codeguru/detector-library/java/tags/
# https://docs.aws.amazon.com/codeguru/detector-library/python/tags/
ExcludeTags:
  - 'maintainability'

# We can also exclude recommendations by Detector ID. Detector IDs can be found here:
# https://docs.aws.amazon.com/codeguru/detector-library
ExcludeRecommendations:
# Ignore all recommendations for a given Detector ID 
  - detectorId: 'java/aws-region-enumeration@v1.0'
# Ignore all recommendations for a given Detector ID in a provided set of locations.
# Locations can be written as Unix GLOB expressions using wildcard symbols.
  - detectorId: 'java/aws-region-enumeration@v1.0'
    Locations:
      - 'src/main/java/com/folder01/*.java'

# Excludes all recommendations in the provided files. Files can be provided as Unix GLOB expressions.
ExcludeFiles:
  - tst/**

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

awsgaucho · 2022-06-30T19:38:22Z

.github/workflows/self-test-and-release.yml

+          ./gradlew properties -q | grep "version:"
+          ./gradlew properties -q | grep "version:" | awk '{print $2}'


Do we need both lines?

Maybe you need neither and this is a left-over. Looks like the one below is the one that matters.

will remove

awsgaucho · 2022-06-30T19:42:28Z

README.md

 # CodeGuru Reviewer CLI Wrapper
 Simple CLI wrapper for CodeGuru reviewer that provides a one-line command to scan a local clone of a repository and
 receive results. This CLI wraps the [AWS CLI](https://aws.amazon.com/cli/) commands to communicated with 
 [AWS CodeGuru Reviewer](https://aws.amazon.com/codeguru/). Using CodeGuru Reviewer may generate metering fees


[not from this PR] Typo in "communicated" in the line above

awsgaucho · 2022-06-30T19:43:12Z

README.md

+
 ### Prerequisites

 To run the CLI, we need to have a version of git, Java (e.g., [Amazon Corretto](https://aws.amazon.com/corretto/?filtered-posts.sort-by=item.additionalFields.createdDate&filtered-posts.sort-order=desc)) and the [AWS Command Line interface](https://aws.amazon.com/cli/) installed. Verify that both application are installed on our machine by running:


both applications

awsgaucho · 2022-06-30T19:44:13Z

README.md

+
+### Scan an Example
+
 Now, lets download an example project (requires Maven):


awsgaucho · 2022-06-30T19:52:58Z

README.md


-You can use this CLI to run CodeGuru from inside your CI/CD pipeline. See [this action](.github/workflows/self-test-and-release.yml#L30-L41) as an example. First, you need credentials for a role with the permissions mentioned above. If you already scanned
-the repository once with the CLI, the S3 bucket has been created, and the you do not need the `s3:CreateBucket*` permission anymore.
+# We can tell the CLI to exclude all recommendations below a certain severity. This can be useful in CICD integration.


nit: CI/CD for consistency

awsgaucho · 2022-06-30T19:54:16Z

src/main/java/com/amazonaws/gurureviewercli/Main.java

                }
            }

+            // try load the


complete or remove comment

awsgaucho · 2022-06-30T19:57:58Z

src/main/java/com/amazonaws/gurureviewercli/Main.java

            Log.info("Analysis finished.");
+            if (main.failOnRecommendations && !results.isEmpty()) {
+                RecommendationPrinter.print(results);
+                System.exit(5);


Log a message explaining why we are exiting with an error code?

The person who debugs why this is returning errcode 5 may not be the same one who decided to enable the flag.

awsgaucho · 2022-06-30T19:59:25Z

src/main/java/com/amazonaws/gurureviewercli/model/CodeInsightReport.java

+
+public class CodeInsightReport {
+
+    /*


remove dead code

awsgaucho · 2022-06-30T20:10:54Z

src/main/java/com/amazonaws/gurureviewercli/util/RecommendationPrinter.java

+            sb.append(recommendation.description());
+            sb.append("\n");
+            if (severityToInt(recommendation) < 2) {
+                Log.error(sb.toString());


This may look like that CLI wrapper itself hit an error. Aren't INFO messages with Severity: FOOBAR enough? Otherwise you're saying the same thing twice in different ways. I know this may allow loglevel-based filtering, but seems like it could also be a bit confusing.

Yeah, you're probably right ... I'll log everything at info

awsgaucho · 2022-06-30T20:20:44Z

src/main/java/com/amazonaws/gurureviewercli/util/RecommendationsFilter.java

+                continue;
+            }
+            if (rec.ruleMetadata() == null || rec.filePath().equals(".")) {
+                continue; // Always drop rules without metadata or the stats recomendation


Could we add an option to keep the recommendations that don't have any metadata? I think it's great to drop them, but until a better mechanism exists, this will hide the problem under the rug. With such an option we can still enable it in end-to-end regression testing and alert.

I'd rather fix this by making sure all rules have metadata. If there is no metadata, we don't know what rule it is, so we can't filter it. Usually, these are low severity, so customers who want to block pipelines using the CLI would likely suppress them anyway.

Oh, and this only happens when you filter. So we can still get these by running without filter. OK, that's good enough.

Add support for suppression criteria

48abb52

martinschaef requested a review from awsgaucho June 29, 2022 18:10

Martin Schaef added 16 commits June 29, 2022 14:27

Adding demo CI action

db2cb48

fixing ci action

93e1785

fixing ci action

fd754ea

fix permissions to upload release

907f759

working on the self test

3d304eb

fixing demo cicd

ea9b9a8

fixing demo cicd

b3a1c56

fixing demo cicd

0d21d9c

fixing demo cicd

458eefa

fixing demo cicd

1f5e1ae

fixing demo cicd

77bd97f

fixing demo cicd

3f3451e

fixing demo cicd

2a62ea7

fixing demo cicd

e97346e

fixing filter logic

87c27a0

fixing filter logic

8d0612d

awsgaucho reviewed Jun 30, 2022

View reviewed changes

Martin Schaef added 2 commits July 1, 2022 07:53

Adressing Nico's comments

7742d2e

minor fixes

14ec6a5

martinschaef requested a review from awsgaucho July 1, 2022 12:30

awsgaucho approved these changes Jul 1, 2022

View reviewed changes

martinschaef merged commit d3476f5 into aws:main Jul 1, 2022

martinschaef deleted the codeinsights branch July 1, 2022 14:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for suppression criteria #25

Add support for suppression criteria #25

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		./gradlew properties -q \| grep "version:"
		./gradlew properties -q \| grep "version:" \| awk '{print $2}'


		### Prerequisites

		To run the CLI, we need to have a version of git, Java (e.g., [Amazon Corretto](https://aws.amazon.com/corretto/?filtered-posts.sort-by=item.additionalFields.createdDate&filtered-posts.sort-order=desc)) and the [AWS Command Line interface](https://aws.amazon.com/cli/) installed. Verify that both application are installed on our machine by running:


		### Scan an Example

		Now, lets download an example project (requires Maven):

Add support for suppression criteria #25

Add support for suppression criteria #25

Uh oh!

Conversation

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants