Merge pull request #115 from LibraryOfCongress/junit5

converting Junit4 to Junit5

Author: johnscancella

README.md

@@ -160,24 +160,23 @@ List<BagitWarning> warnings = linter.lintBag(rootDir, Arrays.asList(BagitWarning
 ## Developing Bagit-Java
 Bagit-Java uses [Gradle](https://gradle.org/) for its build system. Check out the great [documentation](https://docs.gradle.org/current/userguide/userguide_single.html) to learn more.
 ##### Running tests and code quality checks
-Inside the bagit-java root directory, run `gradle check`.
+Inside the bagit-java root directory, run `./gradlew check`.
 ##### Uploading to maven central
 1. Follow their guides
   1. http://central.sonatype.org/pages/releasing-the-deployment.html
   2. https://issues.sonatype.org/secure/Dashboard.jspa
-2. Once you have access, to create an official release and upload it you should specify the version by running `gradle -Pversion=<VERSION> uploadArchives`
+2. Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> uploadArchives`
   1. *Don't forget to tag the repository!*
 
 ##### Uploading to jcenter
 1. Follow their guide
   1. https://github.com/bintray/bintray-examples/tree/master/gradle-bintray-plugin-examples
-2. Once you have access, to create an official release and upload it you should specify the version by running `gradle -Pversion=<VERSION> bintrayUpload`
+2. Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> bintrayUpload`
   1. *Don't forget to tag the repository!*
 
 ### Note if using with Eclipse
-Simply run `gradle eclipse` and it will automatically create a eclipse project for you that you can import.
+Simply run `./gradlew eclipse` and it will automatically create a eclipse project for you that you can import.
 
 ### Roadmap for this library
-* Further refine reading and writing of bags version 0.93-0.97
 * Fix bugs/issues reported with new library (on going)
 * Translate to various languages (on going)

build.gradle

@@ -7,7 +7,7 @@ plugins {
   id "org.owasp.dependencycheck" version "3.1.2"
   id "com.dorongold.task-tree" version "1.3"
   id "org.ajoberstar.grgit" version "2.0.1"
-  id "com.github.spotbugs" version "1.4"
+  id "com.github.spotbugs" version "1.6.1"
   id "com.jfrog.bintray" version "1.7.3"
 }
 apply from: 'eclipse.gradle'
@@ -33,14 +33,23 @@ dependencies {
   'com.fasterxml.jackson.core:jackson-core:2.9.0.pr4', 
   'com.fasterxml.jackson.core:jackson-databind:2.9.0.pr4'
 
-  testCompile 'junit:junit:4.12', 
+  testCompile 'org.junit.jupiter:junit-jupiter-api:5.2.0', 
     'org.springframework.boot:spring-boot-starter-logging:1.5.4.RELEASE',
     'org.bouncycastle:bcprov-jdk15on:1.57',
     'org.kamranzafar:jtar:2.3'
+
+  testRuntime 'org.junit.jupiter:junit-jupiter-engine:5.2.0'
 }
 
-test { //show test output
-  testLogging.showStandardStreams = true
+test { 
+  useJUnitPlatform()
+  testLogging {
+    events "passed", "skipped", "failed"
+  }
+  reports {
+    html.enabled = true
+  }
+  //testLogging.showStandardStreams = true
 }
 
 tasks.withType(com.github.spotbugs.SpotBugsTask) {

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.2.1-bin.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-bin.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -13,11 +13,9 @@
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.atomic.AtomicLong;
 
-import org.junit.Assert;
-import org.junit.BeforeClass;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,18 +40,15 @@
 /**
  * This class assumes that the compliance test suite repo has been cloned and is available locally
  */
-public class BagitSuiteComplanceTest extends Assert {
+public class BagitSuiteComplanceTest extends TempFolderTest {
   private static final Logger logger = LoggerFactory.getLogger(BagitSuiteComplanceTest.class);
 
-  @Rule
-  public TemporaryFolder folder= new TemporaryFolder();
-  
   private static final Path complianceRepoRootDir = Paths.get("bagit-conformance-suite");
   private static final BagTestCaseVistor visitor = new BagTestCaseVistor();
   private static final BagReader reader = new BagReader();
   private static final BagVerifier verifier = new BagVerifier();
 
-  @BeforeClass
+  @BeforeAll
   public static void setupOnce() throws IOException{
     if(!Files.exists(complianceRepoRootDir)){
       throw new IOException("bagit-conformance-suite git repo was not found, did you clone it?");
@@ -94,7 +89,7 @@ public void testInvalidBags(){
       }
     }
 
-    assertEquals("every test case should throw an error", visitor.getInvalidTestCases().size(), errorCount);
+    Assertions.assertEquals(visitor.getInvalidTestCases().size(), errorCount, "every test case should throw an error");
     logger.debug("Count of all errors found in generic invalid cases: {}", map);
   }
 
@@ -125,7 +120,7 @@ public void testInvalidOperatingSystemSpecificBags(){
       }
     }
 
-    assertEquals("every test case should throw an error", osSpecificInvalidPaths.size(), errorCount);
+    Assertions.assertEquals(osSpecificInvalidPaths.size(), errorCount, "every test case should throw an error");
     logger.debug("Count of all errors found in os specific invalid cases: {}", map);
   }
 
@@ -135,7 +130,7 @@ public void testWarnings() throws Exception{
 
     for(Path bagDir : visitor.getWarningTestCases()){
       warnings = BagLinter.lintBag(bagDir);
-      assertTrue(warnings.size() > 0);
+      Assertions.assertTrue(warnings.size() > 0);
     }
   }
 
@@ -145,7 +140,7 @@ public void testReadWriteProducesSameBag() throws Exception{
     Path newBagDir;
 
     for(final Path bagDir : visitor.getValidTestCases()){
-      newBagDir = folder.newFolder().toPath();
+      newBagDir = folder.resolve("readWriteProducesSameBag");
       bag = reader.read(bagDir);
       BagWriter.write(bag, newBagDir);
 
@@ -158,22 +153,20 @@ public void testReadWriteProducesSameBag() throws Exception{
   private void testTagFileContents(final Bag originalBag, final Path newBagDir) throws IOException{
     Path original = originalBag.getRootDir().resolve("bagit.txt");
     Path newFile = newBagDir.resolve("bagit.txt");
-    assertTrue("bagit.txt files differ", 
-        compareFileContents(original, 
-            newFile, StandardCharsets.UTF_8));
+    Assertions.assertTrue(compareFileContents(original, newFile, StandardCharsets.UTF_8), "bagit.txt files differ");
 
     if(originalBag.getVersion().isSameOrOlder(new Version(0, 95))){
       original = originalBag.getRootDir().resolve("package-info.txt");
       newFile = newBagDir.resolve("package-info.txt");
-      assertTrue(original + " differs from " + newFile, 
-          compareFileContents(original, newFile, originalBag.getFileEncoding()));
+      Assertions.assertTrue(compareFileContents(original, newFile, originalBag.getFileEncoding()), 
+          original + " differs from " + newFile);
     }
     else{
       if(Files.exists(originalBag.getRootDir().resolve("bag-info.txt"))){
         original = originalBag.getRootDir().resolve("bag-info.txt");
         newFile = newBagDir.resolve("bag-info.txt");
-        assertTrue(original + " differs from " + newFile, 
-            compareFileContents(original,newFile, originalBag.getFileEncoding()));
+        Assertions.assertTrue(compareFileContents(original,newFile, originalBag.getFileEncoding()),
+            original + " differs from " + newFile);
       }
     }
 

src/integration/java/gov/loc/repository/bagit/BagitSuiteComplanceTest.java

@@ -7,7 +7,7 @@
 import java.nio.file.SimpleFileVisitor;
 import java.nio.file.attribute.BasicFileAttributes;
 
-import org.junit.Assert;
+import org.junit.jupiter.api.Assertions;
 
 public class FileExistsVistor extends SimpleFileVisitor<Path>{
   private transient final Path originalBag;
@@ -21,15 +21,15 @@ public FileExistsVistor(final Path originalBag, final Path newBag){
   @Override
   public FileVisitResult preVisitDirectory(final Path dir, final BasicFileAttributes attrs) throws IOException {
     Path relative = originalBag.relativize(dir);
-    Assert.assertTrue(Files.exists(newBag.resolve(relative)));
+    Assertions.assertTrue(Files.exists(newBag.resolve(relative)));
 
     return FileVisitResult.CONTINUE;
   }
 
   @Override
   public FileVisitResult visitFile(final Path path, final BasicFileAttributes attrs)throws IOException{
     final Path relative = originalBag.relativize(path);
-    Assert.assertTrue(Files.exists(newBag.resolve(relative)));
+    Assertions.assertTrue(Files.exists(newBag.resolve(relative)));
 
     return FileVisitResult.CONTINUE;
   }

src/integration/java/gov/loc/repository/bagit/FileExistsVistor.java

@@ -5,25 +5,21 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.Test;
 
 import gov.loc.repository.bagit.domain.Bag;
 import gov.loc.repository.bagit.reader.BagReader;
 import gov.loc.repository.bagit.verify.BagVerifier;
 import gov.loc.repository.bagit.writer.BagWriter;
 
-public class ReaderWriterVerifierIntegrationTest {
-  @Rule
-  public TemporaryFolder folder= new TemporaryFolder();
+public class ReaderWriterVerifierIntegrationTest extends TempFolderTest {
 
   @Test
   public void testReaderWriterVersion93() throws Exception{
     try(BagVerifier verifier = new BagVerifier()){
       BagReader reader = new BagReader();
       Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v0_93/bag").toURI());
-      Path outputDir = Paths.get(folder.newFolder().toURI());
+      Path outputDir = folder.resolve("version93");
 
       Bag bag = reader.read(rootDir);
       verifier.isValid(bag, true);
@@ -40,7 +36,7 @@ public void testReaderWriterVersion94() throws Exception{
     BagReader reader = new BagReader();
     Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v0_94/bag").toURI());
     Bag bag = reader.read(rootDir);
-    Path outputDir = Paths.get(folder.newFolder().toURI());
+    Path outputDir = folder.resolve("version94");
 
     BagWriter.write(bag, outputDir);
 
@@ -55,7 +51,7 @@ public void testReaderWriterVersion95() throws Exception{
     BagReader reader = new BagReader();
     Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v0_95/bag").toURI());
     Bag bag = reader.read(rootDir);
-    Path outputDir = Paths.get(folder.newFolder().toURI());
+    Path outputDir = folder.resolve("version95");
 
     BagWriter.write(bag, outputDir);
 
@@ -70,7 +66,7 @@ public void testReaderWriterVersion96() throws Exception{
     BagReader reader = new BagReader();
     Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v0_96/bag").toURI());
     Bag bag = reader.read(rootDir);
-    Path outputDir = Paths.get(folder.newFolder().toURI());
+    Path outputDir = folder.resolve("version96");
 
     BagWriter.write(bag, outputDir);
 
@@ -85,7 +81,7 @@ public void testReaderWriterVersion97() throws Exception{
     BagReader reader = new BagReader();
     Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v0_97/bag").toURI());
     Bag bag = reader.read(rootDir);
-    Path outputDir = Paths.get(folder.newFolder().toURI());
+    Path outputDir = folder.resolve("version97");
 
     BagWriter.write(bag, outputDir);
 
@@ -100,7 +96,7 @@ public void testReaderWriterVersion2_0() throws Exception{
     BagReader reader = new BagReader();
     Path rootDir = Paths.get(this.getClass().getClassLoader().getResource("bags/v2_0/bag").toURI());
     Bag bag = reader.read(rootDir);
-    Path outputDir = Paths.get(folder.newFolder().toURI());
+    Path outputDir = folder.resolve("version2");
 
     BagWriter.write(bag, outputDir);
 

src/integration/java/gov/loc/repository/bagit/ReaderWriterVerifierIntegrationTest.java

@@ -25,8 +25,8 @@ public abstract class AbstractCreateManifestsVistor extends SimpleFileVisitor<Pa
   private static final Logger logger = LoggerFactory.getLogger(AbstractCreateManifestsVistor.class);
   private static final ResourceBundle messages = ResourceBundle.getBundle("MessageBundle");
 
-  protected final Map<Manifest, MessageDigest> manifestToMessageDigestMap;
-  protected final boolean includeHiddenFiles;
+  protected transient final Map<Manifest, MessageDigest> manifestToMessageDigestMap;
+  protected transient final boolean includeHiddenFiles;
 
   public AbstractCreateManifestsVistor(final Map<Manifest, MessageDigest> manifestToMessageDigestMap, final boolean includeHiddenFiles){
     this.manifestToMessageDigestMap = manifestToMessageDigestMap;
@@ -57,12 +57,4 @@ public FileVisitResult visitFile(final Path path, final BasicFileAttributes attr
 
     return FileVisitResult.CONTINUE;
   }
-
-  public Map<Manifest, MessageDigest> getManifestToMessageDigestMap() {
-    return manifestToMessageDigestMap;
-  }
-
-  public boolean isIncludeHiddenFiles() {
-    return includeHiddenFiles;
-  }
 }

src/main/java/gov/loc/repository/bagit/creator/AbstractCreateManifestsVistor.java

@@ -19,7 +19,7 @@
 abstract public class AbstractPayloadFileExistsInManifestsVistor extends SimpleFileVisitor<Path> {
   protected static final Logger logger = LoggerFactory.getLogger(AbstractPayloadFileExistsInManifestsVistor.class);
   protected static final ResourceBundle messages = ResourceBundle.getBundle("MessageBundle");
-  protected final boolean ignoreHiddenFiles;
+  protected transient final boolean ignoreHiddenFiles;
 
   public AbstractPayloadFileExistsInManifestsVistor(final boolean ignoreHiddenFiles) {
     this.ignoreHiddenFiles = ignoreHiddenFiles;
@@ -34,8 +34,4 @@ public FileVisitResult preVisitDirectory(final Path dir, final BasicFileAttribut
 
     return FileVisitResult.CONTINUE;
   }
-
-  public boolean isIgnoreHiddenFiles() {
-    return ignoreHiddenFiles;
-  }
 }

src/main/java/gov/loc/repository/bagit/verify/AbstractPayloadFileExistsInManifestsVistor.java

@@ -19,10 +19,9 @@
 public class CheckIfFileExistsTask implements Runnable {
   private static final Logger logger = LoggerFactory.getLogger(CheckIfFileExistsTask.class);
   private static final ResourceBundle messages = ResourceBundle.getBundle("MessageBundle");
-  private final Path file;
-  //TODO if performance is an issue look at concurrentHashMap - it will take up more space but insertion is O(1) vs O(n)
-  private final Set<Path> missingFiles;
-  private final CountDownLatch latch;
+  private transient final Path file;
+  private transient final Set<Path> missingFiles;
+  private transient final CountDownLatch latch;
 
   public CheckIfFileExistsTask(final Path file, final Set<Path> missingFiles, final CountDownLatch latch) {
     this.file = file;
@@ -72,16 +71,4 @@ private boolean existsNormalized(){
 
     return false;
   }
-
-  public Path getFile() {
-    return file;
-  }
-
-  public Set<Path> getMissingFiles() {
-    return missingFiles;
-  }
-
-  public CountDownLatch getLatch() {
-    return latch;
-  }
 }