Added functional tests for mime type and extension searches

This commit is contained in:
Eugene Livis 2021-10-15 13:12:23 -04:00
parent fee80988e8
commit ac7be89674

View File

@ -19,6 +19,8 @@
package org.sleuthkit.autopsy.mainui.datamodel;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.concurrent.ExecutionException;
import java.util.List;
import java.util.stream.Collectors;
@ -45,21 +47,21 @@ import org.sleuthkit.datamodel.TskCoreException;
*
*/
public class TableSearchTest extends NbTestCase {
private static final String MODULE_NAME = "TableSearchTest";
// Custom artifact and attribute names and display names
private static final String CUSTOM_DA_TYPE_NAME = "SEARCH_TEST_CUSTOM_DA_TYPE";
private static final String CUSTOM_DA_TYPE_DISPLAY_NAME = "Search test custom data artifact type";
private static final String CUSTOM_ATTR_TYPE_NAME = "SEARCH_TEST_CUSTOM_ATTRIBUTE_TYPE";
private static final String CUSTOM_ATTR_TYPE_DISPLAY_NAME = "Search test custom attribute type";
// Data used for attributes in the artifact tests
private static final String ARTIFACT_COMMENT = "Artifact comment";
private static final String ARTIFACT_CUSTOM_ATTR_STRING = "Custom attribute string";
private static final int ARTIFACT_INT = 5;
private static final double ARTIFACT_DOUBLE = 7.89;
/////////////////////////////////////////////////
// Data to be used across the test methods.
// These are initialized in setUpCaseDatabase().
@ -67,41 +69,48 @@ public class TableSearchTest extends NbTestCase {
Case openCase = null; // The case for testing
SleuthkitCase db = null; // The case database
Blackboard blackboard = null; // The blackboard
DataSource dataSource1 = null; // A local files data source
DataSource dataSource2 = null; // A local files data source
DataSource dataSource3 = null; // A local files data source
BlackboardArtifact.Type customDataArtifactType = null; // A custom data artifact type
BlackboardAttribute.Type customAttributeType = null; // A custom attribute type
// Data artifact test
DataArtifact customDataArtifact = null; // A custom artifact in dataSource1
AbstractFile customDataArtifactSourceFile = null; // The source file of customDataArtifact
AbstractFile customDataArtifactLinkedFile = null; // The linked file of customDataArtifact
// Extension and MIME type test
private String customMimeType = "fake/type";
private String customFileName = "test.fake";
private static String customExtension = "fake";
private static final List<String> CUSTOM_EXTENSIONS = Arrays.asList("." + customExtension); //NON-NLS
private static final List<String> EMPTY_RESULT_SET_EXTENSIONS = Arrays.asList(".blah", ".blah2", ".crazy"); //NON-NLS
public static Test suite() {
NbModuleSuite.Configuration conf = NbModuleSuite.createConfiguration(TableSearchTest.class).
clusters(".*").
enableModules(".*");
return conf.suite();
}
public TableSearchTest(String name) {
super(name);
}
// Main search method
public void testTableSearches() {
// Set up the database
setUpCaseDatabase();
// Run tests
dataArtifactSearchTest();
mimeTypeSearchTest();
mimeSearchTest();
extensionSearchTest();
}
/**
* Create a case and add sample data.
*/
@ -118,14 +127,14 @@ public class TableSearchTest extends NbTestCase {
dataSource2 = db.addLocalFilesDataSource("devId2", "C:\\Fake\\Path\\2", "EST", null, trans);
dataSource3 = db.addLocalFilesDataSource("devId3", "C:\\Fake\\Path\\3", "EST", null, trans);
trans.commit();
// Add files
AbstractFile folderA1 = db.addLocalDirectory(dataSource1.getId(), "folder1");
AbstractFile fileA1 = db.addLocalFile("file1.txt", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderA1);
fileA1.setMIMEType("text/plain");
fileA1.save();
AbstractFile folderA2 = db.addLocalDirectory(dataSource1.getId(), "folder2");
AbstractFile fileA2 =db.addLocalFile("file2.jpg", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderA2);
AbstractFile fileA2 = db.addLocalFile("file2.jpg", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderA2);
fileA2.setMIMEType("image/jpeg");
fileA2.save();
AbstractFile folderA3 = db.addLocalDirectory(folderA2.getId(), "folder3");
@ -135,32 +144,36 @@ public class TableSearchTest extends NbTestCase {
AbstractFile fileA4 = db.addLocalFile("file4.txt", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderA3);
fileA4.setMIMEType("text/plain");
fileA4.save();
AbstractFile folderB1 = db.addLocalDirectory(dataSource2.getId(), "folder1");
AbstractFile fileB1 = db.addLocalFile("fileA.txt", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderB1);
AbstractFile fileB1 = db.addLocalFile("fileA.txt", "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderB1);
fileB1.setMIMEType("text/plain");
fileB1.save();
AbstractFile customFile = db.addLocalFile(customFileName, "", 0, 0, 0, 0, 0, true, TskData.EncodingType.NONE, folderB1);
customFile.setMIMEType(customMimeType);
customFile.save();
// Create a custom artifact and attribute types
customDataArtifactType = blackboard.getOrAddArtifactType(CUSTOM_DA_TYPE_NAME, CUSTOM_DA_TYPE_DISPLAY_NAME, BlackboardArtifact.Category.DATA_ARTIFACT);
customAttributeType = blackboard.getOrAddAttributeType(CUSTOM_ATTR_TYPE_NAME,
customAttributeType = blackboard.getOrAddAttributeType(CUSTOM_ATTR_TYPE_NAME,
BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING, CUSTOM_ATTR_TYPE_DISPLAY_NAME);
// Add data artifacts
// DataSource1: contact, bookmark, and custom type
// DataSource2: contact
List<BlackboardAttribute> attrs = new ArrayList<>();
attrs.add(new BlackboardAttribute(BlackboardAttribute.Type.TSK_COMMENT, MODULE_NAME, "Contact 1"));
fileA1.newDataArtifact(BlackboardArtifact.Type.TSK_CONTACT, attrs);
attrs.clear();
attrs.add(new BlackboardAttribute(BlackboardAttribute.Type.TSK_COMMENT, MODULE_NAME, "Bookmark 1"));
fileA2.newDataArtifact(BlackboardArtifact.Type.TSK_GPS_BOOKMARK, attrs);
attrs.clear();
attrs.add(new BlackboardAttribute(BlackboardAttribute.Type.TSK_COMMENT, MODULE_NAME, "Contact 2"));
fileB1.newDataArtifact(BlackboardArtifact.Type.TSK_CONTACT, attrs);
// This is the main artifact for the DataArtifact test. Make attributes of several types.
attrs.clear();
attrs.add(new BlackboardAttribute(BlackboardAttribute.Type.TSK_COMMENT, MODULE_NAME, ARTIFACT_COMMENT));
@ -171,137 +184,229 @@ public class TableSearchTest extends NbTestCase {
customDataArtifact = fileA3.newDataArtifact(customDataArtifactType, attrs);
customDataArtifactSourceFile = fileA3;
customDataArtifactLinkedFile = fileA2;
} catch (TestUtilsException | TskCoreException | BlackboardException ex) {
Exceptions.printStackTrace(ex);
Assert.fail(ex.getMessage());
}
}
public void dataArtifactSearchTest() {
// Quick test that everything is initialized
assertTrue(db != null);
try {
// Get all contacts
DataArtifactSearchParam param = new DataArtifactSearchParam(BlackboardArtifact.Type.TSK_CONTACT, null);
DataArtifactDAO dataArtifactDAO = MainDAO.getInstance().getDataArtifactsDAO();
DataArtifactTableSearchResultsDTO results = dataArtifactDAO.getDataArtifactsForTable(param);
assertEquals(BlackboardArtifact.Type.TSK_CONTACT, results.getArtifactType());
assertEquals(2, results.getTotalResultsCount());
assertEquals(2, results.getItems().size());
// Get contacts from data source 2
param = new DataArtifactSearchParam(BlackboardArtifact.Type.TSK_CONTACT, dataSource2.getId());
results = dataArtifactDAO.getDataArtifactsForTable(param);
assertEquals(BlackboardArtifact.Type.TSK_CONTACT, results.getArtifactType());
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
// Get bookmarks from data source 2
param = new DataArtifactSearchParam(BlackboardArtifact.Type.TSK_WEB_BOOKMARK, dataSource2.getId());
results = dataArtifactDAO.getDataArtifactsForTable(param);
assertEquals(BlackboardArtifact.Type.TSK_WEB_BOOKMARK, results.getArtifactType());
assertEquals(0, results.getTotalResultsCount());
assertEquals(0, results.getItems().size());
// Get all custom artifacts
param = new DataArtifactSearchParam(customDataArtifactType, null);
results = dataArtifactDAO.getDataArtifactsForTable(param);
assertEquals(customDataArtifactType, results.getArtifactType());
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
// Check that a few of the expected column names are present
List<String> columnDisplayNames = results.getColumns().stream().map(p -> p.getDisplayName()).collect(Collectors.toList());
assertTrue(columnDisplayNames.contains(BlackboardAttribute.Type.TSK_COMMENT.getDisplayName()));
assertTrue(columnDisplayNames.contains(BlackboardAttribute.Type.TSK_COUNT.getDisplayName()));
assertTrue(columnDisplayNames.contains(customAttributeType.getDisplayName()));
// Get one of the rows
RowDTO rowDTO = results.getItems().get(0);
assertTrue(rowDTO instanceof DataArtifactRowDTO);
DataArtifactRowDTO dataArtifactRowDTO = (DataArtifactRowDTO) rowDTO;
// Check that the artifact, source content and linked file are correct
assertEquals(customDataArtifact, dataArtifactRowDTO.getDataArtifact());
assertEquals(customDataArtifactSourceFile, dataArtifactRowDTO.getSrcContent());
//assertEquals(customDataArtifactLinkedFile, dataArtifactRowDTO.getLinkedFile()); I'm doing something wrong or this isn't working yet
// Check that some of the expected column values are present
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_CUSTOM_ATTR_STRING));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_COMMENT));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_INT));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_DOUBLE));
} catch (ExecutionException ex) {
Exceptions.printStackTrace(ex);
Assert.fail(ex.getMessage());
}
}
public void mimeTypeSearchTest() {
public void mimeSearchTest() {
// Quick test that everything is initialized
assertTrue(db != null);
try {
ViewsDAO viewsDAO = MainDAO.getInstance().getViewsDAO();
// Get plain text files from data source 1
FileTypeMimeSearchParams param = new FileTypeMimeSearchParams("text/plain", dataSource1.getId());
SearchResultsDTO results = viewsDAO.getFilesByMime(param);
assertEquals(2, results.getTotalResultsCount());
assertEquals(2, results.getItems().size());
// Get jpeg files from data source 1
param = new FileTypeMimeSearchParams("image/jpeg", dataSource1.getId());
results = viewsDAO.getFilesByMime(param);
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
assertEquals(1, results.getItems().size());
// Get jpeg files from data source 2
param = new FileTypeMimeSearchParams("image/jpeg", dataSource2.getId());
results = viewsDAO.getFilesByMime(param);
assertEquals(0, results.getTotalResultsCount());
assertEquals(0, results.getItems().size());
assertEquals(0, results.getItems().size());
// Get plain text files from data source 1
param = new FileTypeMimeSearchParams("blah/blah", dataSource1.getId());
results = viewsDAO.getFilesByMime(param);
assertEquals(0, results.getTotalResultsCount());
assertEquals(0, results.getItems().size());
/*
// Check that a few of the expected column names are present
List<String> columnDisplayNames = results.getColumns().stream().map(p -> p.getDisplayName()).collect(Collectors.toList());
assertTrue(columnDisplayNames.contains(BlackboardAttribute.Type.TSK_COMMENT.getDisplayName()));
assertTrue(columnDisplayNames.contains(BlackboardAttribute.Type.TSK_COUNT.getDisplayName()));
assertTrue(columnDisplayNames.contains(customAttributeType.getDisplayName()));
// Get one of the rows
// Get plain text files from all data sources
param = new FileTypeMimeSearchParams("text/plain", null);
results = viewsDAO.getFilesByMime(param);
assertEquals(3, results.getTotalResultsCount());
assertEquals(3, results.getItems().size());
// Get the custom file by MIME type
param = new FileTypeMimeSearchParams(customMimeType, null);
results = viewsDAO.getFilesByMime(param);
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
RowDTO rowDTO = results.getItems().get(0);
assertTrue(rowDTO instanceof DataArtifactRowDTO);
DataArtifactRowDTO dataArtifactRowDTO = (DataArtifactRowDTO) rowDTO;
// Check that the artifact, source content and linked file are correct
assertEquals(customDataArtifact, dataArtifactRowDTO.getDataArtifact());
assertEquals(customDataArtifactSourceFile, dataArtifactRowDTO.getSrcContent());
//assertEquals(customDataArtifactLinkedFile, dataArtifactRowDTO.getLinkedFile()); I'm doing something wrong or this isn't working yet
// Check that some of the expected column values are present
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_CUSTOM_ATTR_STRING));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_COMMENT));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_INT));
assertTrue(dataArtifactRowDTO.getCellValues().contains(ARTIFACT_DOUBLE));*/
assertTrue(rowDTO instanceof FileRowDTO);
FileRowDTO fileRowDTO = (FileRowDTO) rowDTO;
assertEquals(customFileName, fileRowDTO.getFileName());
assertEquals(customExtension, fileRowDTO.getExtension());
} catch (ExecutionException ex) {
Exceptions.printStackTrace(ex);
Assert.fail(ex.getMessage());
}
}
}
public void extensionSearchTest() {
// Quick test that everything is initialized
assertTrue(db != null);
try {
ViewsDAO viewsDAO = MainDAO.getInstance().getViewsDAO();
// Get all text documents from data source 1
FileTypeExtensionsSearchParams param = new FileTypeExtensionsSearchParams(FileExtRootFilter.TSK_DOCUMENT_FILTER, dataSource1.getId());
SearchResultsDTO results = viewsDAO.getFilesByExtension(param);
assertEquals(3, results.getTotalResultsCount());
assertEquals(3, results.getItems().size());
// Get Word documents from data source 1
param = new FileTypeExtensionsSearchParams(FileExtDocumentFilter.AUT_DOC_OFFICE, dataSource1.getId());
results = viewsDAO.getFilesByExtension(param);
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
// Get image/jpeg files from data source 1
param = new FileTypeExtensionsSearchParams(FileExtRootFilter.TSK_IMAGE_FILTER, dataSource1.getId());
results = viewsDAO.getFilesByExtension(param);
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
// Get text documents from all data sources
param = new FileTypeExtensionsSearchParams(FileExtRootFilter.TSK_DOCUMENT_FILTER, null);
results = viewsDAO.getFilesByExtension(param);
assertEquals(4, results.getTotalResultsCount());
assertEquals(4, results.getItems().size());
// Get jpeg files from data source 2
param = new FileTypeExtensionsSearchParams(FileExtRootFilter.TSK_IMAGE_FILTER, dataSource2.getId());
results = viewsDAO.getFilesByExtension(param);
assertEquals(0, results.getTotalResultsCount());
assertEquals(0, results.getItems().size());
// Search for file extensions that should produce no results
param = new FileTypeExtensionsSearchParams(CustomRootFilter.EMPTY_RESULT_SET_FILTER, null);
results = viewsDAO.getFilesByExtension(param);
assertEquals(0, results.getTotalResultsCount());
assertEquals(0, results.getItems().size());
// Get the custom file by extension
param = new FileTypeExtensionsSearchParams(CustomRootFilter.CUSTOM_FILTER, null);
results = viewsDAO.getFilesByExtension(param);
assertEquals(1, results.getTotalResultsCount());
assertEquals(1, results.getItems().size());
RowDTO rowDTO = results.getItems().get(0);
assertTrue(rowDTO instanceof FileRowDTO);
FileRowDTO fileRowDTO = (FileRowDTO) rowDTO;
assertEquals(customFileName, fileRowDTO.getFileName());
assertEquals(customExtension, fileRowDTO.getExtension());
} catch (ExecutionException ex) {
Exceptions.printStackTrace(ex);
Assert.fail(ex.getMessage());
}
}
private enum CustomRootFilter implements FileExtSearchFilter {
CUSTOM_FILTER(0, "CUSTOM_FILTER", "Test", CUSTOM_EXTENSIONS), //NON-NLS
EMPTY_RESULT_SET_FILTER(1, "EMPTY_RESULT_SET_FILTER", "Test", EMPTY_RESULT_SET_EXTENSIONS); //NON-NLS
final int id;
final String name;
final String displayName;
final List<String> filter;
private CustomRootFilter(int id, String name, String displayName, List<String> filter) {
this.id = id;
this.name = name;
this.displayName = displayName;
this.filter = filter;
}
@Override
public String getName() {
return this.name;
}
@Override
public int getId() {
return this.id;
}
@Override
public String getDisplayName() {
return this.displayName;
}
@Override
public List<String> getFilter() {
return Collections.unmodifiableList(this.filter);
}
}
@Override
public void tearDown() {
try {