tests: differentiate internal class from custom classes (#55)

chains-project · Aug 16, 2023 · 17926aa · 17926aa
1 parent 18753f4
commit 17926aa
Show file tree

Hide file tree

Showing 8 changed files with 242 additions and 1 deletion.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -18,5 +18,8 @@ jobs:
         with:
           distribution: 'oracle'
           java-version: '17'
+      - name: Build project
+        # We need to build the agent first, because the tests depend on it
+        run: mvn clean install -DskipTests
       - name: Run tests
-        run: mvn clean install
+        run: mvn test
diff --git a/...nt/src/test/resources-its/io/github/algomaster99/it/GenerateMojoIT/load_jdk_class/pom.xml b/...nt/src/test/resources-its/io/github/algomaster99/it/GenerateMojoIT/load_jdk_class/pom.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.example</groupId>
+    <artifactId>jdk_class</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <properties>
+        <maven.compiler.source>15</maven.compiler.source>
+        <maven.compiler.target>15</maven.compiler.target>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.6.0</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <mainClass>com.sun.CustomClass</mainClass>
+                        </manifest>
+                    </archive>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/...thub/algomaster99/it/GenerateMojoIT/load_jdk_class/src/main/java/com/sun/CustomClass.java b/...thub/algomaster99/it/GenerateMojoIT/load_jdk_class/src/main/java/com/sun/CustomClass.java
@@ -0,0 +1,7 @@
+package com.sun;
+
+public class CustomClass {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -62,6 +62,11 @@
         <artifactId>junit-jupiter-api</artifactId>
         <version>5.10.0</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.maven.shared</groupId>
+        <artifactId>maven-invoker</artifactId>
+        <version>3.2.0</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

diff --git a/watchdog-agent/pom.xml b/watchdog-agent/pom.xml
@@ -50,6 +50,14 @@
       <artifactId>asm-util</artifactId>
       <version>9.5</version>
     </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven.shared</groupId>
+      <artifactId>maven-invoker</artifactId>
+    </dependency>
   </dependencies>
 
   <build>
@@ -96,6 +104,18 @@
             </goals>
             <phase>package</phase>
           </execution>
+          <!--          Create watchdog-agent in target/classes so it could be accessed in test -->
+          <execution>
+            <id>shade-for-test</id>
+            <goals>
+              <goal>shade</goal>
+            </goals>
+            <phase>package</phase>
+            <configuration>
+              <outputDirectory>${project.build.directory}/classes</outputDirectory>
+              <finalName>${project.artifactId}</finalName>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
       <plugin>

diff --git a/watchdog-agent/src/test/java/AgentTest.java b/watchdog-agent/src/test/java/AgentTest.java
@@ -0,0 +1,113 @@
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.github.algomaster99.Terminator;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.StandardCopyOption;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.List;
+import org.apache.maven.shared.invoker.DefaultInvocationRequest;
+import org.apache.maven.shared.invoker.DefaultInvoker;
+import org.apache.maven.shared.invoker.InvocationRequest;
+import org.apache.maven.shared.invoker.InvocationResult;
+import org.apache.maven.shared.invoker.Invoker;
+import org.apache.maven.shared.invoker.MavenInvocationException;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+public class AgentTest {
+    @Disabled("Should be worked upon after the input is from an SBOM and not maven project")
+    @Test
+    void shouldDisallowLoadingCustomJDKClass() throws MavenInvocationException, IOException, InterruptedException {
+        // contract: watchdog-agent should detect if the class masquerading as an internal class
+
+        Path project = Paths.get("src/test/resources/load_jdk_class");
+
+        recursiveDeleteOnShutdownHook(project.resolve("target"));
+
+        InvocationRequest request = new DefaultInvocationRequest();
+        File pomFile = project.resolve("pom.xml").toFile();
+        request.setPomFile(pomFile);
+        request.setGoals(List.of("clean", "package"));
+
+        Invoker invoker = new DefaultInvoker();
+        InvocationResult result = invoker.execute(request);
+
+        assertThat(result.getExitCode()).isEqualTo(0);
+
+        String fingerprintFile =
+                project.resolve("target").resolve("classfile.sha256.jsonl").toString();
+        deleteContentsOfFile(fingerprintFile);
+
+        String agentArgs = "fingerprints=" + fingerprintFile;
+        String[] cmd = {
+            "java",
+            "-javaagent:" + getAgentPath(agentArgs),
+            "-jar",
+            project.resolve("target")
+                    .resolve("jdk_class-1.0-SNAPSHOT-jar-with-dependencies.jar")
+                    .toString()
+        };
+        ProcessBuilder pb = new ProcessBuilder(cmd);
+        pb.redirectInput(ProcessBuilder.Redirect.INHERIT);
+        pb.redirectOutput(ProcessBuilder.Redirect.INHERIT);
+        pb.redirectError(ProcessBuilder.Redirect.INHERIT);
+
+        Process p = pb.start();
+        int exitCode = p.waitFor();
+
+        assertThat(exitCode).isEqualTo(1);
+    }
+
+    private static void deleteContentsOfFile(String file) throws InterruptedException, IOException {
+        String[] deleteFile = {"rm", "-f", file};
+        Runtime.getRuntime().exec(deleteFile).waitFor();
+
+        String[] createFile = {"touch", file};
+        Runtime.getRuntime().exec(createFile).waitFor();
+    }
+
+    private static String getAgentPath(String agentArgs) throws IOException {
+        String tempDir = System.getProperty("java.io.tmpdir");
+        Path traceCollector = Path.of(tempDir, "watchdog-agent.jar");
+
+        try (InputStream traceCollectorStream = Terminator.class.getResourceAsStream("/watchdog-agent.jar")) {
+            Files.copy(traceCollectorStream, traceCollector, StandardCopyOption.REPLACE_EXISTING);
+        }
+
+        return traceCollector.toAbsolutePath() + "=" + agentArgs;
+    }
+
+    private static void recursiveDeleteOnShutdownHook(final Path path) {
+        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+            try {
+                Files.walkFileTree(path, new SimpleFileVisitor<>() {
+                    @Override
+                    public FileVisitResult visitFile(Path file, @SuppressWarnings("unused") BasicFileAttributes attrs)
+                            throws IOException {
+                        Files.deleteIfExists(file);
+                        return FileVisitResult.CONTINUE;
+                    }
+
+                    @Override
+                    public FileVisitResult postVisitDirectory(Path dir, IOException e) throws IOException {
+                        if (e == null) {
+                            Files.deleteIfExists(dir);
+                            return FileVisitResult.CONTINUE;
+                        }
+                        // directory iteration failed
+                        throw e;
+                    }
+                });
+            } catch (IOException e) {
+                throw new RuntimeException("Failed to delete " + path, e);
+            }
+        }));
+    }
+}
diff --git a/watchdog-agent/src/test/resources/load_jdk_class/pom.xml b/watchdog-agent/src/test/resources/load_jdk_class/pom.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.example</groupId>
+    <artifactId>jdk_class</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <properties>
+        <maven.compiler.source>15</maven.compiler.source>
+        <maven.compiler.target>15</maven.compiler.target>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.6.0</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <mainClass>com.sun.CustomClass</mainClass>
+                        </manifest>
+                    </archive>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/watchdog-agent/src/test/resources/load_jdk_class/src/main/java/com/sun/CustomClass.java b/watchdog-agent/src/test/resources/load_jdk_class/src/main/java/com/sun/CustomClass.java
@@ -0,0 +1,7 @@
+package com.sun;
+
+public class CustomClass {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+    }
+}