refs #29 - Fetching of non-payload files should not be attempted - now throws an error if you try to fetch a non-payload file

Author: johnscancella

src/main/java/gov/loc/repository/bagit/transfer/BagFetcher.java

@@ -718,6 +718,9 @@ private void fetchFile(FetchTxt.FilenameSizeUrl filenameSizeUrl) throws BagTrans
                 URI uri = parseUri(filenameSizeUrl.getUrl());
                 Long size = filenameSizeUrl.getSize();
                 String destinationPath = filenameSizeUrl.getFilename();
+                if(!destinationPath.startsWith("data")){
+                  throw new BagTransferException("Destination of fetch file is [" + destinationPath + "] which is not a payload file.");
+                }
 
                 // Create the destination for the file.
                 log.trace(format("Creating destination: {0}", destinationPath));

src/test/java/gov/loc/repository/bagit/transfer/BagFetcherTest.java

@@ -5,6 +5,8 @@
 import gov.loc.repository.bagit.Bag;
 import gov.loc.repository.bagit.BagFactory;
 import gov.loc.repository.bagit.BagFile;
+import gov.loc.repository.bagit.transfer.dest.FileSystemFileDestination;
+import gov.loc.repository.bagit.transfer.fetch.HttpFetchProtocol;
 import gov.loc.repository.bagit.utilities.ResourceHelper;
 import gov.loc.repository.bagit.utilities.SimpleResult;
 
@@ -18,6 +20,7 @@
 import org.jmock.States;
 import org.jmock.integration.junit4.JMock;
 import org.junit.After;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -312,6 +315,59 @@ public void testMissingFetchTxt() throws Exception{
 		this.unit.fetch(bag, mockDestinationFactory, false);
 
 	}
+	
+	/**
+   * Fetching a payload file. This is correct according to the specs and works in the library.
+   *
+   * @link https://tools.ietf.org/html/draft-kunze-bagit#section-2.2.3
+   * @throws Exception
+   */
+  @Test
+  public void fetchToPayloadOk() throws Exception {
+    File templateBag = new File("src/test/resources/bad-fetch-bag");
+    File bagFile = new File("target/fetchToPayloadOk");
+    FileUtils.deleteDirectory(bagFile);
+    FileUtils.copyDirectory(templateBag, bagFile);
+    BagFetcher fetcher = new BagFetcher(bagFactory);
+    fetcher.registerProtocol("https", new HttpFetchProtocol());
+    Bag bag = bagFactory.createBag(bagFile, BagFactory.Version.V0_97, null);
+    FileSystemFileDestination dest = new FileSystemFileDestination(bagFile);
+    SimpleResult result = fetcher.fetch(bag, dest, false, true);
+    Assert.assertTrue(result.isSuccess());
+  }
+
+  /**
+   * Fetching a non-payload file. This is not allowed according to the specs, at least the specs
+   * only mention payload files.
+   * 
+   * @throws Exception
+   */
+  @Test
+  public void fetchNonPayloadFileShouldFail() throws Exception {
+    File templateBag = new File("src/test/resources/bad-fetch-bag");
+    File bagFile = new File("target/fetchNonPayloadFileShouldFail");
+    FileUtils.deleteDirectory(bagFile);
+    FileUtils.copyDirectory(templateBag, bagFile);
+
+    // Adding an extra line to the fetch.txt, to attempt to fetch a non-payload file
+    FileUtils.writeStringToFile(
+            new File(bagFile, "fetch.txt"),
+            "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d3/Wikipedia-logo-v2-nl.svg/135px-Wikipedia-logo-v2-nl.svg.png - metadata/wikipedia.png",
+            true);
+
+    BagFetcher fetcher = new BagFetcher(bagFactory);
+    fetcher.registerProtocol("https", new HttpFetchProtocol());
+    Bag bag = bagFactory.createBag(bagFile, BagFactory.Version.V0_97, null);
+    FileSystemFileDestination dest = new FileSystemFileDestination(bagFile);
+
+    // Depending on
+    SimpleResult result = fetcher.fetch(bag, dest, false, true); // Returns failure, but fetches metadata/wikipedia.png anyway
+    //SimpleResult result = fetcher.fetch(bag, dest, true, true); // Returns success, but does not fetch metadata/wikipedia.png anyway
+    Assert.assertFalse(result.isSuccess());
+
+    // However ...
+    Assert.assertFalse(new File(bagFile, "metadata/wikipedia.png").exists());
+  }
 
 	private void expectDest(Expectations e, FetchedFileDestinationFactory destFactory, String path) throws Exception{
 		FetchedFileDestination mockDestination = this.context.mock(FetchedFileDestination.class, "FetchedFileDestination:" + path);

src/test/resources/bad-fetch-bag/bag-info.txt

@@ -0,0 +1,3 @@
+Payload-Oxum: 18736.1
+Bagging-Date: 2016-01-31
+Bag-Size: 37.5 KB

src/test/resources/bad-fetch-bag/bagit.txt

@@ -0,0 +1,2 @@
+BagIt-Version: 0.97
+Tag-File-Character-Encoding: UTF-8

src/test/resources/bad-fetch-bag/fetch.txt

@@ -0,0 +1 @@
+https://upload.wikimedia.org/wikipedia/commons/thumb/d/d3/Wikipedia-logo-v2-nl.svg/135px-Wikipedia-logo-v2-nl.svg.png - data/wikipedia.png

src/test/resources/bad-fetch-bag/manifest-md5.txt

@@ -0,0 +1 @@
+bae7aa47892753a1355770164d780dec  data/wikipedia.png

src/test/resources/bad-fetch-bag/tagmanifest-md5.txt

@@ -0,0 +1,2 @@
+1cfd8dfce64cd9aefb016bfce5b5d14e  bag-info.txt
+9e5ad981e0d29adc278f6a294b8c2aca  bagit.txt