Add regression tests for Together-Java#22

Author: I-Al-Istannen

pom.xml

@@ -13,6 +13,7 @@
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <junit-jupiter.version>5.3.2</junit-jupiter.version>
   </properties>
 
   <build>
@@ -116,13 +117,19 @@
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-api</artifactId>
-      <version>5.3.1</version>
+      <version>${junit-jupiter.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-engine</artifactId>
-      <version>5.3.1</version>
+      <version>${junit-jupiter.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <version>${junit-jupiter.version}</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

src/test/java/org/togetherjava/discord/server/execution/JShellWrapperTest.java

@@ -1,87 +1,143 @@
 package org.togetherjava.discord.server.execution;
 
-import jdk.jshell.Diag;
-import jdk.jshell.SnippetEvent;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-import org.togetherjava.discord.server.Config;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.time.Duration;
 import java.util.List;
 import java.util.Properties;
 import java.util.concurrent.Executors;
 import java.util.stream.Collectors;
-
-import static org.junit.jupiter.api.Assertions.*;
+import jdk.jshell.Diag;
+import jdk.jshell.Snippet.Status;
+import jdk.jshell.SnippetEvent;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.togetherjava.discord.server.Config;
+import org.togetherjava.discord.server.execution.JShellWrapper.JShellResult;
 
 class JShellWrapperTest {
 
-    private static JShellWrapper wrapper;
-
-    @BeforeAll
-    static void setupWrapper() {
-        Properties properties = new Properties();
-        properties.setProperty("blocked.packages", "java.time");
-        Config config = new Config(properties);
-        TimeWatchdog timeWatchdog = new TimeWatchdog(
-                Executors.newScheduledThreadPool(1),
-                Duration.ofMinutes(20)
-        );
-        wrapper = new JShellWrapper(config, timeWatchdog);
+  private static JShellWrapper wrapper;
+
+  @BeforeAll
+  static void setupWrapper() {
+    Properties properties = new Properties();
+    properties.setProperty("blocked.packages", "java.time");
+    Config config = new Config(properties);
+    TimeWatchdog timeWatchdog = new TimeWatchdog(
+        Executors.newScheduledThreadPool(1),
+        Duration.ofMinutes(20)
+    );
+    wrapper = new JShellWrapper(config, timeWatchdog);
+  }
+
+  @AfterAll
+  static void cleanup() {
+    wrapper.close();
+  }
+
+  @Test
+  void reportsCompileTimeError() {
+    JShellWrapper.JShellResult result = wrapper.eval("crazy stuff");
+
+    assertFalse(result.getEvents().isEmpty(), "Found no events");
+
+    for (SnippetEvent snippetEvent : result.getEvents()) {
+      List<Diag> diags = wrapper.getSnippetDiagnostics(snippetEvent.snippet())
+          .collect(Collectors.toList());
+      assertFalse(diags.isEmpty(), "Has no diagnostics");
+      assertTrue(diags.get(0).isError(), "Diagnostic is no error");
     }
+  }
 
-    @AfterAll
-    static void cleanup() {
-        wrapper.close();
-    }
+  @Test
+  void correctlyComputesExpression() {
+    JShellWrapper.JShellResult result = wrapper.eval("1+1");
 
-    @Test
-    void reportsCompileTimeError() {
-        JShellWrapper.JShellResult result = wrapper.eval("crazy stuff");
+    assertEquals(result.getEvents().size(), 1, "Event count is not 1");
 
-        assertFalse(result.getEvents().isEmpty(), "Found no events");
+    SnippetEvent snippetEvent = result.getEvents().get(0);
 
-        for (SnippetEvent snippetEvent : result.getEvents()) {
-            List<Diag> diags = wrapper.getSnippetDiagnostics(snippetEvent.snippet()).collect(Collectors.toList());
-            assertFalse(diags.isEmpty(), "Has no diagnostics");
-            assertTrue(diags.get(0).isError(), "Diagnostic is no error");
-        }
-    }
+    assertNull(snippetEvent.exception(), "An exception occurred");
 
-    @Test
-    void correctlyComputesExpression() {
-        JShellWrapper.JShellResult result = wrapper.eval("1+1");
+    assertEquals("2", snippetEvent.value(), "Calculation was wrong");
+  }
 
-        assertEquals(result.getEvents().size(), 1, "Event count is not 1");
+  @Test
+  void savesHistory() {
+    wrapper.eval("int test = 1+1;");
+    JShellWrapper.JShellResult result = wrapper.eval("test");
 
-        SnippetEvent snippetEvent = result.getEvents().get(0);
+    assertEquals(result.getEvents().size(), 1, "Event count is not 1");
 
-        assertNull(snippetEvent.exception(), "An exception occurred");
+    SnippetEvent snippetEvent = result.getEvents().get(0);
 
-        assertEquals("2", snippetEvent.value(), "Calculation was wrong");
-    }
+    assertNull(snippetEvent.exception(), "An exception occurred");
+
+    assertEquals("2", snippetEvent.value(), "Calculation was wrong");
+  }
 
-    @Test
-    void savesHistory() {
-        wrapper.eval("int test = 1+1;");
-        JShellWrapper.JShellResult result = wrapper.eval("test");
+  @Test
+  void blocksPackage() {
+    assertThrows(
+        UnsupportedOperationException.class,
+        () -> wrapper.eval("java.time.LocalDateTime.now()"),
+        "No exception was thrown when accessing a blocked package."
+    );
+  }
 
-        assertEquals(result.getEvents().size(), 1, "Event count is not 1");
+  @ParameterizedTest(name = "Accessing \"{0}\" should fail")
+  @ValueSource(strings = {
+      "/opt",
+      "~",
+      "/tmp/"
+  })
+  void blocksFileAccess(String fileName) {
+    JShellResult result = wrapper.eval("new java.io.File(\"" + fileName + "\").listFiles()");
 
-        SnippetEvent snippetEvent = result.getEvents().get(0);
+    if (!allFailed(result)) {
+      printSnippetResult(result);
+    }
 
-        assertNull(snippetEvent.exception(), "An exception occurred");
+    assertTrue(
+        allFailed(result),
+        "Not all snippets were rejected when accessing a file."
+    );
+  }
 
-        assertEquals("2", snippetEvent.value(), "Calculation was wrong");
+  @Test
+  void blocksNetworkIo() {
+    JShellResult result = wrapper
+        .eval("new java.net.URL(\"https://duckduckgo.com\").openConnection().connect()");
+
+    if (!allFailed(result)) {
+      printSnippetResult(result);
     }
 
-    @Test
-    void blocksPackage() {
-        assertThrows(
-                UnsupportedOperationException.class,
-                () -> wrapper.eval("java.time.LocalDateTime.now()"),
-                "No exception was thrown when accessing a blocked package."
+    assertTrue(
+        allFailed(result),
+        "Not all snippets were rejected when doing network I/O."
+    );
+  }
+
+  private boolean allFailed(JShellResult result) {
+    return result.getEvents().stream()
+        .allMatch(snippetEvent ->
+            snippetEvent.status() == Status.REJECTED
+                || snippetEvent.exception() != null
         );
+  }
+
+  private void printSnippetResult(JShellResult result) {
+    for (SnippetEvent event : result.getEvents()) {
+      System.out.println(event);
     }
+  }
 }