Merge pull request #14 from martinschaef/windows

Adding support for Windows file system names and running on push on any branch

Author: awsgaucho

.github/workflows/java-compatible.yml

@@ -1,22 +1,20 @@
 
 name: Build with different JDKs
 
-on:
-  push:
-    branches:
-      - main
+on: push
 
 permissions:
     id-token: write
     contents: write
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         java: [ '8', '11', '16', '17' ]
-    name: Java ${{ matrix.Java }} build
+        os: [ubuntu-latest, windows-latest]
+    name: Java ${{ matrix.Java }} build on ${{ matrix.os }}
 
     steps:    
     - uses: actions/checkout@v2
@@ -26,7 +24,7 @@ jobs:
         distribution: 'temurin'
         java-version: ${{ matrix.java }}
     - name: Build project
-      run: ./gradlew clean installDist
+      run: ./gradlew clean test installDist --info
     - name: Run cli
       run: ./build/install/aws-codeguru-cli/bin/aws-codeguru-cli
 

build.gradle

@@ -44,7 +44,7 @@ repositories {
 
 defaultTasks('installDist')
 
-version = '0.0.3'
+version = '0.0.4'
 jar.archiveName = "${jar.baseName}.${jar.extension}"
 distZip.archiveName = "${jar.baseName}.zip"
 

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

@@ -36,9 +36,9 @@ public static void pack(final List<Path> sourceDirPaths, final String zipFilePat
                 try (val walk = Files.walk(pp)) {
                     walk.filter(path -> !Files.isDirectory(path))
                         .forEach(path -> {
-                            val normalizedPath = path.normalize().toAbsolutePath();
-                            val relpath = pp.relativize(normalizedPath).toString();
-                            ZipEntry zipEntry = new ZipEntry(relpath);
+                            val relativePath = pp.relativize(path.normalize().toAbsolutePath());
+                            // in case we run on Windows
+                            ZipEntry zipEntry = new ZipEntry(getUnixStylePathName(relativePath));
                             try {
                                 zs.putNextEntry(zipEntry);
                                 zs.write(Files.readAllBytes(path));
@@ -93,8 +93,9 @@ public static void packFiles(final Collection<Path> files,
         Path zipFile = Files.createFile(zipFilePath);
         try (ZipOutputStream zs = new ZipOutputStream(Files.newOutputStream(zipFile))) {
             for (val file : normalizedFiles) {
-                val relPath = normalizedRoot.relativize(file).normalize().toString();
-                ZipEntry zipEntry = new ZipEntry(relPath);
+                val relPath = normalizedRoot.relativize(file);
+                // replace Windows file separators
+                ZipEntry zipEntry = new ZipEntry(getUnixStylePathName(relPath));
                 try {
                     zs.putNextEntry(zipEntry);
                     zs.write(Files.readAllBytes(file));
@@ -138,6 +139,10 @@ public static List<Path> getFilesInDirectory(final Path directory) throws IOExce
         }
     }
 
+    private static String getUnixStylePathName(final Path path) {
+        return path.normalize().toString().replace('\\', '/' );
+    }
+
     /**
      * private construct.
      */

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

@@ -141,7 +141,7 @@ public void test_zipAndUpload_happyCaseAllFiles() throws Exception {
                         count++; // count the files that are not in the git folder.
                     }
                 }
-                Assertions.assertEquals(2, count, "Unexpected number of files in zip.");
+                Assertions.assertEquals(2, count, "Unexpected number of files in zip: " + count);
             }
             return null;
         };

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

@@ -0,0 +1,37 @@
+package com.amazonaws.gurureviewercli.util;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+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.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class ZipUtilsTest {
+
+    @Test
+    public void test_packUnpack() throws IOException {
+        val testDir = Paths.get("test-data/fake-repo");
+        val zipName = Files.createTempDirectory("zip-files").resolve("test.zip").toString();
+        ZipUtils.pack(Arrays.asList(testDir), testDir, zipName);
+        ZipFile zipFile = new ZipFile(zipName);
+        Enumeration<? extends ZipEntry> entries = zipFile.entries();
+        val expectedFileNames =
+            new HashSet<String>(Arrays.asList("build-dir/should-not-be-included.txt",
+                                              "build-dir/lib/included.txt",
+                                              "should-not-be-included.txt"));
+        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());
+    }
+}