Merge pull request #23 from martinschaef/suppression

Support aws-codeguru-reviewer.yml files

Author: awsgaucho

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

@@ -43,21 +43,28 @@ jobs:
       - name: Run Code Guru
         if: steps.iam-role.outcome == 'success'
         run: |
-          ./build/install/aws-codeguru-cli/bin/aws-codeguru-cli --region us-west-2 -r python-code --no-prompt -c "c5f9c93d5605bfe3a4de02896a26b7b91eb7c007:a574f23f6ea3fe607a6d33cc6c8fe28d81ab37a2"
+          ./build/install/aws-codeguru-cli/bin/aws-codeguru-cli --region us-west-2 -r python-code --no-prompt -c "5a0c9579b6c9b0ea7a5f5c1b9328bb7100c7a16e:a574f23f6ea3fe607a6d33cc6c8fe28d81ab37a2"
 
-      - name: Print Summary of Findings Linux
+      - name: Upload findings artifact
         if: steps.iam-role.outcome == 'success'
+        uses: actions/upload-artifact@v1
+        with:
+          name: recommendations_python_${{ matrix.os }}
+          path: code-guru/
+
+      - name: Print Summary of Findings on ${{ matrix.os }}
+        if: steps.iam-role.outcome == 'success' && matrix.os != 'windows-latest' # cat and jq don't work the same way on windows
         run: |
           echo "detector,filePath,lineNumber" > summary-of-results.csv
           jq -r '.runs[0].results[] | {ruleId: .ruleId, firstFile: .locations[0].physicalLocation.artifactLocation.uri, firstLine: .locations[0].physicalLocation.region.startLine} | join(",")' \
             code-guru/recommendations.sarif.json | sort >> summary-of-results.csv
           cat summary-of-results.csv
       
-      - name: Validate Findings Linux
+      - name: Validate Findings ${{ matrix.os }}
         if: steps.iam-role.outcome == 'success'
         shell: bash
         env:
-          EXPECTED: 112
+          EXPECTED: 98
         run: |
           [[ $(jq -r '.runs[0].results[].ruleId' code-guru/recommendations.sarif.json | wc -l) -eq $EXPECTED ]] || { echo "Expected $EXPECTED recommendations but got $(jq -r '.runs[0].results[].ruleId' code-guru/recommendations.sarif.json | wc -l)"; exit 1; }
 
@@ -78,7 +85,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
     name: Self Test Java on ${{ matrix.os }}
-    steps:    
+    steps:
       - uses: actions/checkout@v2
       - name: Set up JDK 1.8
         uses: actions/setup-java@v1
@@ -115,15 +122,22 @@ jobs:
         run: |
           ./build/install/aws-codeguru-cli/bin/aws-codeguru-cli --region us-west-2 -r amazon-codeguru-samples -s amazon-codeguru-samples/src/main/java -b amazon-codeguru-samples/build/libs --no-prompt
 
-      - name: Print Summary of Findings Linux
+      - name: Upload findings artifact
         if: steps.iam-role.outcome == 'success'
+        uses: actions/upload-artifact@v1
+        with:
+          name: recommendations_java_${{ matrix.os }}
+          path: code-guru/
+
+      - name: Print Summary of Findings on ${{ matrix.os }}
+        if: steps.iam-role.outcome == 'success' && matrix.os != 'windows-latest' # cat and jq don't work the same way on windows
         run: |
           echo "detector,filePath,lineNumber" > summary-of-results.csv
           jq -r '.runs[0].results[] | {ruleId: .ruleId, firstFile: .locations[0].physicalLocation.artifactLocation.uri, firstLine: .locations[0].physicalLocation.region.startLine} | join(",")' \
             code-guru/recommendations.sarif.json | sort >> summary-of-results.csv
           cat summary-of-results.csv
       
-      - name: Validate Findings Linux
+      - name: Validate Findings ${{ matrix.os }}
         if: steps.iam-role.outcome == 'success'
         shell: bash
         env:
@@ -158,7 +172,7 @@ jobs:
         uses: actions/download-artifact@v1
         with:
           name: pass_status_windows-latest
-      - name: Set the statuses of the windows and linux job as output parameters
+      - name: Set the statuses of the windows and ${{ matrix.os }} job as output parameters
         id: set_outputs
         run: |
           echo "::set-output name=status_ubuntu-latest::$(<pass_status_ubuntu-latest/status_ubuntu-latest.txt)"

aws-codeguru-reviewer.yml

@@ -0,0 +1,8 @@
+version: 1.0
+
+# Sample YAML file to suppress recommendations in test code.
+# https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendation-suppression.html
+
+excludeFiles:
+  - "tst/**"
+  - "test-data/**"

build.gradle

@@ -23,7 +23,7 @@ repositories {
 
 defaultTasks 'clean', 'check', 'installDist'
 
-version = '0.0.4'
+version = '0.0.5'
 jar.archiveName = "${jar.baseName}.${jar.extension}"
 distZip.archiveName = "${jar.baseName}.zip"
 

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

@@ -65,6 +65,10 @@ public static void pack(final List<Path> sourceDirPaths,
                             final String zipFilePath) throws IOException {
 
         val files = getFilesInDirectories(sourceDirPaths);
+        val codeGuruConfigFile = relativeRoot.resolve("aws-codeguru-reviewer.yml");
+        if (codeGuruConfigFile != null && codeGuruConfigFile.toFile().isFile()) {
+            files.add(codeGuruConfigFile);
+        }
         packFiles(files, relativeRoot, Paths.get(zipFilePath));
     }
 

src/test/java/com/amazonaws/gurureviewercli/adapter/ArtifactAdapterTest.java

@@ -162,7 +162,6 @@ public void test_zipAndUpload_happyCaseBuildDir() throws Exception {
         // only include files from the util dir.
         val repoDir = Paths.get("./test-data/fake-repo");
         val buildArtifacts = repoDir.resolve("build-dir/lib");
-        final List<Path> buildDirs = Arrays.asList(buildArtifacts);
 
         val config = Configuration.builder()
                                   .s3Client(s3client)

src/test/java/com/amazonaws/gurureviewercli/util/ZipUtilsTest.java

@@ -1,24 +1,44 @@
 package com.amazonaws.gurureviewercli.util;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Arrays;
+import java.util.Comparator;
 import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
 import lombok.val;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 public class ZipUtilsTest {
 
+    private Path workDir;
+
+    @BeforeEach
+    void beforeEach() throws IOException {
+        workDir = Files.createTempDirectory("zip-files");
+    }
+
+    @AfterEach
+    void afterEach() throws IOException {
+        Files.walk(workDir)
+             .sorted(Comparator.reverseOrder())
+             .map(Path::toFile)
+             .forEach(File::delete);
+    }
+
     @Test
-    public void test_packUnpack() throws IOException {
+    void test_packUnpack() throws IOException {
         val testDir = Paths.get("test-data/fake-repo");
-        val zipName = Files.createTempDirectory("zip-files").resolve("test.zip").toString();
+        val zipName = workDir.resolve("test.zip").toString();
         ZipUtils.pack(Arrays.asList(testDir), testDir, zipName);
         try (ZipFile zipFile = new ZipFile(zipName)) {
             Enumeration<? extends ZipEntry> entries = zipFile.entries();
@@ -35,4 +55,28 @@ public void test_packUnpack() throws IOException {
             Assertions.assertTrue(expectedFileNames.isEmpty());
         }
     }
+
+    /*
+      If a aws-codeguru-reviewer.yml file is present, it has to be included in the zip file even if the root folder
+      is not mentioned in the list of source directories.
+     */
+    @Test
+    void test_packUnpackWithConfig() throws IOException {
+        val testDir = Paths.get("test-data/fake-repo-with-config");
+        val zipName = workDir.resolve("test.zip").toString();
+        ZipUtils.pack(Arrays.asList(testDir.resolve("src-dir")), testDir, zipName);
+        try (ZipFile zipFile = new ZipFile(zipName)) {
+            Enumeration<? extends ZipEntry> entries = zipFile.entries();
+            val expectedFileNames =
+                new HashSet<String>(Arrays.asList("src-dir/included-src.txt",
+                                                  "aws-codeguru-reviewer.yml"));
+            while (entries.hasMoreElements()) {
+                ZipEntry entry = entries.nextElement();
+                Assertions.assertFalse(entry.toString().contains("\\"), "Unexpected zip entry " + entry);
+                Assertions.assertTrue(expectedFileNames.contains(entry.toString()));
+                expectedFileNames.remove(entry.toString());
+            }
+            Assertions.assertTrue(expectedFileNames.isEmpty());
+        }
+    }
 }

test-data/fake-repo-with-config/aws-codeguru-reviewer.yml

@@ -0,0 +1,4 @@
+version: 1.0
+# See https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendation-suppression.html
+excludeFiles:
+  - "tst/**"

test-data/fake-repo-with-config/other-dir/should-not-be-included.txt

@@ -0,0 +1 @@
+

test-data/fake-repo-with-config/should-not-be-included.txt

@@ -0,0 +1 @@
+

test-data/fake-repo-with-config/src-dir/included-src.txt

@@ -0,0 +1 @@
+asdf