Expand StudentFileAwareZipper test coverage

Author: cxcorp

tmc-langs-framework/src/test/java/fi/helsinki/cs/tmc/langs/io/zip/StudentFileAwareZipperTest.java

@@ -5,6 +5,7 @@
 import static org.junit.Assert.fail;
 
 import fi.helsinki.cs.tmc.langs.io.EverythingIsStudentFileStudentFilePolicy;
+import fi.helsinki.cs.tmc.langs.io.StudentFilePolicy;
 import fi.helsinki.cs.tmc.langs.utils.TestUtils;
 
 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
@@ -20,6 +21,7 @@
 import java.nio.file.FileVisitor;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.Enumeration;
 import java.util.HashMap;
@@ -77,10 +79,16 @@ public FileVisitResult postVisitDirectory(Path path, IOException ex)
     }
 
     @Test(expected = FileNotFoundException.class)
-    public void zipperThrowsExceptionWhenUnzippingNonExistentFile() throws IOException {
+    public void zipperThrowsExceptionWhenZippingNonExistentFile() throws IOException {
         zipper.zip(TEST_ASSETS_DIR.resolve("noSuchDir"));
     }
 
+    @Test(expected = IllegalArgumentException.class)
+    public void zipperThrowsExceptionWhenZippingRoot() throws IOException {
+        // platform-specific root
+        zipper.zip(Paths.get("/").toAbsolutePath());
+    }
+
     @Test
     public void zipperCorrectlyZipsSingleFile() throws IOException {
 
@@ -137,7 +145,43 @@ public void zipperDetectectsAndObeysTmcnosubmitFiles() throws IOException {
         expected.close();
         actual.close();
         Files.deleteIfExists(compressed);
+    }
+
+    @Test
+    public void zipperFollowsStudentPolicy() throws IOException {
+        Path uncompressed = TestUtils.getPath(StudentFileAwareUnzipperTest.class,
+                "zip_studentpolicy_test_case");
+
+        // Policy: zip every directory and file whose name starts with "include"
+        zipper.setStudentFilePolicy(new StudentFilePolicy() {
+            @Override
+            public boolean isStudentFile(Path path, Path projectRootPath) {
+                if (path.equals(projectRootPath)) {
+                    return true;
+                }
+                return path.getFileName().toString().startsWith("include");
+            }
+
+            @Override
+            public boolean mayDelete(Path file, Path projectRoot) {
+                return true;
+            }
+        });
 
+        byte[] zip = zipper.zip(uncompressed);
+        Path compressed = Files.createTempFile("testZip", ".zip");
+        Files.write(compressed, zip);
+
+        Path referenceZip = TEST_ASSETS_DIR.resolve("zip_studentpolicy_test_case.zip");
+
+        ZipFile expected = new ZipFile(referenceZip.toFile());
+        ZipFile actual = new ZipFile(compressed.toFile());
+
+        assertZipsEqualDecompressed(expected, actual);
+
+        expected.close();
+        actual.close();
+        Files.deleteIfExists(compressed);
     }
 
     private void assertZipsEqualDecompressed(ZipFile expected, ZipFile actual)

tmc-langs-framework/src/test/resources/zipTestResources/zip_studentpolicy_test_case.zip

@@ -0,0 +1 @@
+liirum laarum

tmc-langs-framework/src/test/resources/zip_studentpolicy_test_case/file.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec venenatis ac ante id egestas. Praesent at enim id lorem egestas iaculis eu pharetra dolor. Nullam ullamcorper laoreet massa, sit amet sodales ex pharetra vitae. Aliquam id vehicula nunc, bibendum mattis orci. Nunc fringilla sem enim, a suscipit justo convallis id. Etiam maximus urna lorem, ac maximus nulla sagittis nec. Curabitur nec mauris finibus, fringilla mauris eu, elementum neque. Sed et sem tellus. Suspendisse eget ipsum vel odio mattis venenatis. Morbi egestas elementum felis eu aliquet.

tmc-langs-framework/src/test/resources/zip_studentpolicy_test_case/include_laarum/Sit.txt

@@ -0,0 +1 @@
+Suspendisse tincidunt vehicula sem. Cras sit amet enim nec arcu euismod tincidunt nec sed eros. Curabitur tempor enim sit amet accumsan dictum. Fusce tempus lorem eget odio imperdiet fringilla. Proin lobortis consequat finibus. Praesent in nunc metus. Fusce hendrerit lacus id orci vulputate, vitae consequat velit tempor. Sed iaculis ac eros id sollicitudin. Proin vitae feugiat justo. Nunc ac diam aliquet, lacinia nibh eget, commodo nibh. Mauris ipsum leo, finibus non risus non, egestas semper nulla. Sed sit amet maximus tortor, a rhoncus neque. Morbi eu venenatis eros. Etiam imperdiet viverra vestibulum. Mauris tristique rhoncus ante et porta. Etiam consequat a orci eu scelerisque.

tmc-langs-framework/src/test/resources/zip_studentpolicy_test_case/include_laarum/include_Dolor.txt

@@ -0,0 +1 @@
+In iaculis quam eu accumsan condimentum. Proin molestie lectus magna, ac rutrum ex elementum eget. Duis tincidunt ante ex. Suspendisse aliquam venenatis aliquam. Nullam viverra consequat tincidunt. Praesent ut odio ac arcu consequat hendrerit. Proin rutrum sapien convallis accumsan pharetra.

tmc-langs-framework/src/test/resources/zip_studentpolicy_test_case/include_laarum/include_Ipsum.txt

@@ -0,0 +1,2 @@
+Lorem;Ipsum
+Yes;No