tests: implement ELN style crate writer test for ZipWriterTest

Author: Pfeil

src/test/java/edu/kit/datamanager/ro_crate/HelpFunctions.java

@@ -17,6 +17,8 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -152,4 +154,25 @@ public static boolean compareTwoDir(File dir1, File dir2) throws IOException {
         }
         return true;
     }
+
+    /**
+     * Prints the file tree of the given directory for debugging and understanding
+     * a test more quickly.
+     *
+     * @param directoryToPrint the directory to print
+     * @throws IOException if an error occurs while printing the file tree
+     */
+    @SuppressWarnings("resource")
+    public static void printFileTree(Path directoryToPrint) throws IOException {
+        // Print all files recursively in a tree structure for debugging
+        System.out.printf("Files in %s:%n", directoryToPrint.getFileName().toString());
+        Files.walk(directoryToPrint)
+                .forEach(path -> {
+                    if (!path.toAbsolutePath().equals(directoryToPrint.toAbsolutePath())) {
+                        int depth = path.relativize(directoryToPrint).getNameCount();
+                        String prefix = "  ".repeat(depth);
+                        System.out.printf("%s%s%s%n", prefix, "└── ", path.getFileName());
+                    }
+                });
+    }
 }

…ger/ro_crate/writer/CrateWriterTest.java …er/ro_crate/writer/CommonWriterTest.javasrc/test/java/edu/kit/datamanager/ro_crate/writer/CrateWriterTest.java renamed to src/test/java/edu/kit/datamanager/ro_crate/writer/CommonWriterTest.java src/test/java/edu/kit/datamanager/ro_crate/writer/CrateWriterTest.java renamed to src/test/java/edu/kit/datamanager/ro_crate/writer/CommonWriterTest.java

@@ -1,37 +1,22 @@
 package edu.kit.datamanager.ro_crate.writer;
 
-import edu.kit.datamanager.ro_crate.Crate;
 import edu.kit.datamanager.ro_crate.HelpFunctions;
 import edu.kit.datamanager.ro_crate.RoCrate;
 import edu.kit.datamanager.ro_crate.entities.data.DataSetEntity;
-import edu.kit.datamanager.ro_crate.entities.data.FileEntity;
-import edu.kit.datamanager.ro_crate.preview.AutomaticPreview;
-import edu.kit.datamanager.ro_crate.preview.PreviewGenerator;
-import net.lingala.zip4j.ZipFile;
+
 import org.apache.commons.io.FileUtils;
-import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-abstract class CrateWriterTest {
-
-    /**
-     * Saves the crate with the writer fitting to this test class.
-     *
-     * @param crate the crate to save
-     * @param target the target path to the save location
-     * @throws IOException if an error occurs while saving the crate
-     */
-    abstract protected void saveCrate(Crate crate, Path target) throws IOException;
+interface CommonWriterTest extends TestableWriterStrategy {
 
     /**
      * Test where the writer needs to rename files or folders in order to make a valid crate.
@@ -41,11 +26,11 @@ abstract class CrateWriterTest {
      * @throws IOException if an error occurs while writing the crate
      */
     @Test
-    void testFilesBeingAdjusted(@TempDir Path tempDir) throws IOException {
+    default void testFilesBeingAdjusted(@TempDir Path tempDir) throws IOException {
         Path correctCrate = tempDir.resolve("compare_with_me");
         Path pathToFile = correctCrate.resolve("you-will-need-to-rename-this-file.ai");
         Path pathToDir = correctCrate.resolve("you-will-need-to-rename-this-dir");
-        this.createManualCrateStructure(correctCrate, pathToFile, pathToDir);
+        createManualCrateStructure(correctCrate, pathToFile, pathToDir);
 
         Path writtenCrate = tempDir.resolve("written-crate");
         Path extractionPath = tempDir.resolve("checkMe");
@@ -60,11 +45,11 @@ void testFilesBeingAdjusted(@TempDir Path tempDir) throws IOException {
                     )
                     .build();
             this.saveCrate(builtCrate, writtenCrate);
-            this.ensureCrateIsExtractedIn(writtenCrate, extractionPath);
+            ensureCrateIsExtractedIn(writtenCrate, extractionPath);
         }
 
-        printFileTree(correctCrate);
-        printFileTree(extractionPath);
+        HelpFunctions.printFileTree(correctCrate);
+        HelpFunctions.printFileTree(extractionPath);
 
         // The actual file name should **not** appear in the crate
         String fileName = pathToFile.getFileName().toString();
@@ -111,15 +96,15 @@ void testFilesBeingAdjusted(@TempDir Path tempDir) throws IOException {
      * @throws IOException if an error occurs while writing the crate
      */
     @Test
-    void testWritingMakesCopy(@TempDir Path tempDir) throws IOException {
+    default void testWritingMakesCopy(@TempDir Path tempDir) throws IOException {
         // We need a correct directory to compare with.
         // It is built manually to ensure we meet our expectations.
         // Reader-writer-consistency is tested at {@link CrateReaderTest}
         Path correctCrate = tempDir.resolve("compare_with_me");
         Path pathToFile = correctCrate.resolve("cp7glop.ai");
         Path pathToDir = correctCrate.resolve("lots_of_little_files");
 
-        this.createManualCrateStructure(correctCrate, pathToFile, pathToDir);
+        createManualCrateStructure(correctCrate, pathToFile, pathToDir);
 
         // Now use the builder to build the same crate independently.
         // The files will be reused (we need a place to take a copy from)
@@ -130,9 +115,9 @@ void testWritingMakesCopy(@TempDir Path tempDir) throws IOException {
 
         // extract the zip file to a temporary directory
         Path extractionPath = tempDir.resolve("extracted_for_testing");
-        this.ensureCrateIsExtractedIn(pathToZip, extractionPath);
-        printFileTree(correctCrate);
-        printFileTree(extractionPath);
+        ensureCrateIsExtractedIn(pathToZip, extractionPath);
+        HelpFunctions.printFileTree(correctCrate);
+        HelpFunctions.printFileTree(extractionPath);
 
         // compare the extracted directory with the correct one
         assertTrue(HelpFunctions.compareTwoDir(
@@ -151,12 +136,12 @@ void testWritingMakesCopy(@TempDir Path tempDir) throws IOException {
      * @throws IOException if an error occurs while writing the crate
      */
     @Test
-    void testWritingOnlyConsidersAddedFiles(@TempDir Path tempDir) throws IOException {
+    default void testWritingOnlyConsidersAddedFiles(@TempDir Path tempDir) throws IOException {
         Path correctCrate = tempDir.resolve("compare_with_me");
         Path pathToFile = correctCrate.resolve("cp7glop.ai");
         Path pathToDir = correctCrate.resolve("lots_of_little_files");
 
-        this.createManualCrateStructure(correctCrate, pathToFile, pathToDir);
+        createManualCrateStructure(correctCrate, pathToFile, pathToDir);
         {
             // This file is not part of the crate, and should therefore not be present
             Path falseFile = correctCrate.resolve("new");
@@ -176,8 +161,8 @@ void testWritingOnlyConsidersAddedFiles(@TempDir Path tempDir) throws IOExceptio
         // extract and compare
         Path extractionPath = tempDir.resolve("extracted_for_testing");
         ensureCrateIsExtractedIn(pathToZip, extractionPath);
-        printFileTree(correctCrate);
-        printFileTree(extractionPath);
+        HelpFunctions.printFileTree(correctCrate);
+        HelpFunctions.printFileTree(extractionPath);
 
         assertFalse(HelpFunctions.compareTwoDir(
                 correctCrate.toFile(),
@@ -187,116 +172,4 @@ void testWritingOnlyConsidersAddedFiles(@TempDir Path tempDir) throws IOExceptio
                 roCrate,
                 "/json/crate/fileAndDir.json");
     }
-
-    /**
-     * Prints the file tree of the given directory for debugging and understanding
-     * a test more quickly.
-     *
-     * @param directoryToPrint the directory to print
-     * @throws IOException if an error occurs while printing the file tree
-     */
-    @SuppressWarnings("resource")
-    protected static void printFileTree(Path directoryToPrint) throws IOException {
-        // Print all files recursively in a tree structure for debugging
-        System.out.printf("Files in %s:%n", directoryToPrint.getFileName().toString());
-        Files.walk(directoryToPrint)
-                .forEach(path -> {
-                    if (!path.toAbsolutePath().equals(directoryToPrint.toAbsolutePath())) {
-                        int depth = path.relativize(directoryToPrint).getNameCount();
-                        String prefix = "  ".repeat(depth);
-                        System.out.printf("%s%s%s%n", prefix, "└── ", path.getFileName());
-                    }
-                });
-    }
-
-    /**
-     * Ensures the crate is in extracted form in the given path.
-     *
-     * @param pathToCrate       the path to the crate, may not be a folder yet
-     * @param expectedPath      the path where the crate should be in extracted form
-     * @throws IOException if an error occurs while extracting the crate
-     */
-    protected void ensureCrateIsExtractedIn(Path pathToCrate, Path expectedPath) throws IOException {
-        try (ZipFile zf = new ZipFile(pathToCrate.toFile())) {
-            zf.extractAll(expectedPath.toFile().getAbsolutePath());
-        }
-    }
-
-    /**
-     * Creates a crate structure manually.
-     *
-     * @param correctCrate the path to the crate
-     * @param pathToFile   the path to the file
-     * @param pathToDir    the path to the directory
-     * @throws IOException if an error occurs while creating the crate structure
-     */
-    protected void createManualCrateStructure(Path correctCrate, Path pathToFile, Path pathToDir) throws IOException {
-        FileUtils.forceMkdir(correctCrate.toFile());
-        InputStream fileJson = ZipStreamStrategyTest.class
-                .getResourceAsStream("/json/crate/fileAndDir.json");
-        Assertions.assertNotNull(fileJson);
-        // fill the directory with expected files and dirs
-        // starting with the .json of our crate
-        Path json = correctCrate.resolve("ro-crate-metadata.json");
-        FileUtils.copyInputStreamToFile(fileJson, json.toFile());
-        // create preview
-        PreviewGenerator.generatePreview(correctCrate.toFile().getAbsolutePath());
-        // create the files and directories
-        FileUtils.writeStringToFile(pathToFile.toFile(), "content of Local File", Charset.defaultCharset());
-        // creates the directory and a subdirectory
-        Path subdir = pathToDir.resolve("subdir");
-        FileUtils.forceMkdir(subdir.toFile());
-        FileUtils.writeStringToFile(
-                subdir.resolve("subsubfirst.txt").toFile(),
-                "content of subsub file in subsubdir",
-                Charset.defaultCharset());
-        FileUtils.writeStringToFile(
-                pathToDir.resolve("first.txt").toFile(),
-                "content of first file in dir",
-                Charset.defaultCharset());
-        FileUtils.writeStringToFile(
-                pathToDir.resolve("second.txt").toFile(),
-                "content of second file in dir",
-                Charset.defaultCharset());
-        FileUtils.writeStringToFile(
-                pathToDir.resolve("third.txt").toFile(),
-                "content of third file in dir",
-                Charset.defaultCharset());
-    }
-
-    /**
-     * Creates a crate resembling the one we manually create in these tests.
-     *
-     * @param pathToFile      the file to add
-     * @param pathToSubdir the directory to add
-     * @return the crate builder
-     */
-    protected RoCrate.RoCrateBuilder getCrateWithFileAndDir(Path pathToFile, Path pathToSubdir) {
-        return new RoCrate.RoCrateBuilder(
-                "Example RO-Crate",
-                "The RO-Crate Root Data Entity",
-                "2024",
-                "https://creativecommons.org/licenses/by-nc-sa/3.0/au/"
-        )
-                .addDataEntity(
-                        new FileEntity.FileEntityBuilder()
-                                .addProperty("name", "Diagram showing trend to increase")
-                                .addProperty("contentSize", "383766")
-                                .addProperty("description", "Illustrator file for Glop Pot")
-                                .setEncodingFormat("application/pdf")
-                                .setLocationWithExceptions(pathToFile)
-                                .setId("cp7glop.ai")
-                                .build()
-                )
-                .addDataEntity(
-                        new DataSetEntity.DataSetBuilder()
-                                .addProperty("name", "Too many files")
-                                .addProperty("description",
-                                        "This directory contains many small files, that we're not going to describe in detail.")
-                                .setLocationWithExceptions(pathToSubdir)
-                                .setId("lots_of_little_files/")
-                                .build()
-                )
-                .setPreview(new AutomaticPreview());
-    }
 }

src/test/java/edu/kit/datamanager/ro_crate/writer/ElnFileFormatTest.java

@@ -0,0 +1,70 @@
+package edu.kit.datamanager.ro_crate.writer;
+
+import edu.kit.datamanager.ro_crate.Crate;
+import edu.kit.datamanager.ro_crate.HelpFunctions;
+import edu.kit.datamanager.ro_crate.RoCrate;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public interface ElnFileFormatTest extends TestableWriterStrategy {
+
+    /**
+     * Write in ELN format style, meaning with a subfolder in the zip file.
+     *
+     * @param crate the crate to write
+     * @param target the target path to the save location
+     * @throws IOException if an error occurs
+     */
+    void saveCrateElnStyle(Crate crate, Path target) throws IOException;
+
+    @Test
+    default void testMakesElnStyleCrate(@TempDir Path tempDir) throws IOException {
+        // We need a correct directory to compare with.
+        // It is built manually to ensure we meet our expectations.
+        // Reader-writer-consistency is tested at {@link CrateReaderTest}
+
+        // We compare the ELN style like this:
+        // tempDir
+        //   └── compare_with_me
+        //       └── crate-subfolder
+        //           ├── ...
+        //   └── extracted_for_testing
+        //       └── crate-subfolder
+        //           ├── ...
+        String crateName = "crate-subfolder";
+        Path correctCrate = tempDir
+                .resolve("compare_with_me")
+                .resolve(crateName);
+        Path pathToFile = correctCrate.resolve("cp7glop.ai");
+        Path pathToDir = correctCrate.resolve("lots_of_little_files");
+
+        createManualCrateStructure(correctCrate, pathToFile, pathToDir);
+
+        // Now use the builder to build the same crate independently.
+        // The files will be reused (we need a place to take a copy from)
+        RoCrate builtCrate = getCrateWithFileAndDir(pathToFile, pathToDir).build();
+
+        Path pathToZip = tempDir.resolve("%s.eln".formatted(crateName));
+        this.saveCrateElnStyle(builtCrate, pathToZip);
+
+        // extract the zip file to a temporary directory
+        Path extractionPath = tempDir.resolve("extracted_for_testing");
+        ensureCrateIsExtractedIn(pathToZip, extractionPath);
+        HelpFunctions.printFileTree(correctCrate);
+        HelpFunctions.printFileTree(extractionPath);
+
+        // compare the extracted directory with the correct one
+        assertTrue(HelpFunctions.compareTwoDir(
+                correctCrate.toFile(),
+                extractionPath.toFile()));
+        HelpFunctions.compareCrateJsonToFileInResources(
+                builtCrate,
+                "/json/crate/fileAndDir.json");
+    }
+}

src/test/java/edu/kit/datamanager/ro_crate/writer/FolderWriterTest.java

@@ -11,16 +11,16 @@
  * @author Nikola Tzotchev on 9.2.2022 г.
  * @version 1
  */
-class FolderWriterTest extends CrateWriterTest {
+class FolderWriterTest implements CommonWriterTest {
 
     @Override
-    protected void saveCrate(Crate crate, Path target) throws IOException {
+    public void saveCrate(Crate crate, Path target) throws IOException {
         Writers.newFolderWriter()
                 .save(crate, target.toAbsolutePath().toString());
     }
 
     @Override
-    protected void ensureCrateIsExtractedIn(Path pathToCrate, Path expectedPath) throws IOException {
+    public void ensureCrateIsExtractedIn(Path pathToCrate, Path expectedPath) throws IOException {
         FileUtils.copyDirectory(pathToCrate.toFile(), expectedPath.toFile());
     }
 }