Skip to content

BagIt Support - Improved ignored files for BagIt handler #8755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcondon merged 1 commit into from
Jul 18, 2022
Merged

BagIt Support - Improved ignored files for BagIt handler #8755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/main/java/edu/harvard/iq/dataverse/util/file/BagItFileHandlerPostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class BagItFileHandlerPostProcessor {

private static final Logger logger = Logger.getLogger(BagItFileHandlerPostProcessor.class.getCanonicalName());

public static final List<String> FILES_TO_IGNORE = Arrays.asList("__", "._", ".DS_Store", "._.DS_Store");
public static final List<String> FILES_TO_IGNORE = Arrays.asList("__", "._", ".DS_Store");

public List<DataFile> process(List<DataFile> items) {
if(items == null) {
Expand All @@ -26,7 +26,11 @@ public List<DataFile> process(List<DataFile> items) {

for(DataFile item: items) {
String fileName = item.getCurrentName();
if(FILES_TO_IGNORE.contains(fileName)) {
if(fileName == null || fileName.isEmpty()) {
continue;
}

if(FILES_TO_IGNORE.stream().anyMatch(prefix -> fileName.startsWith(prefix))) {
logger.fine(String.format("action=BagItFileHandlerPostProcessor result=ignore-entry file=%s", fileName));
continue;
}
Expand Down
38 changes: 35 additions & 3 deletions src/test/java/edu/harvard/iq/dataverse/util/file/BagItFileHandlerPostProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,43 @@ public void should_return_null_when_datafiles_are_null() throws Exception {
@Test
public void should_ignore_mac_control_files() throws Exception {
String bagEntry = UUID.randomUUID().toString();
String macFile01 = "__";
String macFile02 = "._";
String macFile03 = ".DS_Store";
String macFile04 = "._.DS_Store";
List<DataFile> dataFiles = createDataFiles(bagEntry, macFile01, macFile02, macFile03, macFile04);
List<DataFile> dataFiles = createDataFiles(bagEntry, macFile03, macFile04);

List<DataFile> result = target.process(dataFiles);
MatcherAssert.assertThat(result.size(), Matchers.is(1));
MatcherAssert.assertThat(result.get(0).getCurrentName(), Matchers.is(bagEntry));
}

@Test
public void should_ignore_empty_files() throws Exception {
String bagEntry = UUID.randomUUID().toString();
String fileToIgnore = "";
List<DataFile> dataFiles = createDataFiles(bagEntry, fileToIgnore);

List<DataFile> result = target.process(dataFiles);
MatcherAssert.assertThat(result.size(), Matchers.is(1));
MatcherAssert.assertThat(result.get(0).getCurrentName(), Matchers.is(bagEntry));
}

@Test
public void should_ignore_files_that_start_with_dot_underscore() throws Exception {
String bagEntry = UUID.randomUUID().toString();
String fileToIgnore = "._FileNameToIgnore";
List<DataFile> dataFiles = createDataFiles(bagEntry, fileToIgnore);

List<DataFile> result = target.process(dataFiles);
MatcherAssert.assertThat(result.size(), Matchers.is(1));
MatcherAssert.assertThat(result.get(0).getCurrentName(), Matchers.is(bagEntry));
}

@Test
public void should_ignore_files_that_start_with_double_underscore() throws Exception {
String bagEntry = UUID.randomUUID().toString();
String fileToIgnore = "__FileNameToIgnore";
String validFile = "validName";
List<DataFile> dataFiles = createDataFiles(bagEntry, fileToIgnore);

List<DataFile> result = target.process(dataFiles);
MatcherAssert.assertThat(result.size(), Matchers.is(1));
Expand Down