IntegrationTestService.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.integrationtesting;
 
import java.io.File;
import org.sleuthkit.autopsy.integrationtesting.config.TestSuiteConfig;
import org.sleuthkit.autopsy.integrationtesting.config.IntegrationTestConfig;
import org.sleuthkit.autopsy.integrationtesting.config.IntegrationCaseType;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.collections.CollectionUtils;
import org.openide.util.Exceptions;
import org.openide.util.Lookup;
import org.openide.util.Pair;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.Case.CaseType;
import org.sleuthkit.autopsy.casemodule.CaseActionException;
import org.sleuthkit.autopsy.casemodule.CaseDetails;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoException;
import org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings;
import org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings;
import org.sleuthkit.autopsy.core.UserPreferences;
import org.sleuthkit.autopsy.core.UserPreferencesException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.TimeStampUtils;
import org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor;
import org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.AutoIngestDataSourceProcessorException;
import org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorUtility;
import org.sleuthkit.autopsy.events.MessageServiceConnectionInfo;
import org.sleuthkit.autopsy.ingest.IngestJobSettings;
import org.sleuthkit.autopsy.integrationtesting.DiffService.DiffServiceException;
import org.sleuthkit.autopsy.integrationtesting.config.ConfigDeserializer;
import org.sleuthkit.autopsy.integrationtesting.config.ConnectionConfig;
import org.sleuthkit.autopsy.integrationtesting.config.EnvConfig;
import org.sleuthkit.autopsy.integrationtesting.config.TestingConfig;
import org.sleuthkit.autopsy.testutils.IngestUtils;
import org.sleuthkit.autopsy.testutils.TestUtilsException;
import org.sleuthkit.datamodel.CaseDbConnectionInfo;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData.DbType;

public class IntegrationTestService {

    public static class IntegrationTestDiffException extends Exception {
 
        private static final long serialVersionUID = 1L;

        public IntegrationTestDiffException(String message) {
            super(message);
        }
    }

    public static class IntegrationTestServiceException extends Exception {
 
        private static final long serialVersionUID = 1L;

        public IntegrationTestServiceException(String message) {
            super(message);
        }

        public IntegrationTestServiceException(String message, Throwable exception) {
            super(message, exception);
        }
 
    }
 
    private static final int DEFAULT_POSTGRES_PORT = 5432;
    private static final int DEFAULT_ACTIVEMQ_PORT = 61616;
    private static final int DEFAULT_SOLR_PORT = 8983;
 
    // default port for zookeeper cloud
    private static final int DEFAULT_ZOOKEEPER_PORT = 9983;
 
    private static final Logger logger = Logger.getLogger(IntegrationTestService.class.getName());
 
    private static final ConfigDeserializer configDeserializer = new ConfigDeserializer();
    private static final DiffService diffService = new DiffService();
    private static final ConfigurationModuleManager configurationModuleManager = new ConfigurationModuleManager();
  
    
    public void runIntegrationTests() throws IntegrationTestDiffException, IntegrationTestServiceException {
        IntegrationTestConfig config;
        try {
            config = configDeserializer.getIntegrationTestConfig();
        } catch (IOException ex) {
            throw new IntegrationTestServiceException("There was an error processing integration test config", ex);
        }
 
        EnvConfig envConfig = config.getEnvConfig();
        // setup external connections preserving old settings for reverting later.
        AllConnectionInfo oldSettings = null;
        boolean hasCrSettings = false;
        CentralRepoDbChoice oldCrChoice = null;
        try {
            oldSettings = pushNewMultiUserSettings(new AllConnectionInfo(envConfig.getDbConnection(),
                    envConfig.getMqConnection(), envConfig.getSolrConnection(), 
                    envConfig.getZkConnection(), envConfig.getCrConnection()));
            
            hasCrSettings = oldSettings.getCrConnection() != null;
            oldCrChoice = hasCrSettings ? getCurrentChoice() : null;
        } catch (UserPreferencesException | CentralRepoException ex) {
            logger.log(Level.SEVERE, "There was an error while trying to set up multi user connection information.", ex);
        }
 
        try {
            // iterate through test suites if any exist
            if (CollectionUtils.isEmpty(config.getTestSuites())) {
                logger.log(Level.WARNING, "No test suites discovered.  No tests will be run.");
            } else {
                for (TestSuiteConfig testSuiteConfig : config.getTestSuites()) {
                    for (CaseType caseType : IntegrationCaseType.getCaseTypes(testSuiteConfig.getCaseTypes())) {
                        if (hasCrSettings) {
                            try {
                                setCurrentChoice(caseType);
                            } catch (CentralRepoException ex) {
                                logger.log(Level.SEVERE, String.format("Unable to set cr settings to %s for test suite %s.", caseType.name(), testSuiteConfig.getName()));
                            }
                        }
                        
                        try {
                            runIntegrationTestSuite(envConfig, caseType, testSuiteConfig);
                        } catch (CaseActionException | IllegalStateException | NoCurrentCaseException | IllegalArgumentException ex) {
                            logger.log(Level.SEVERE, "There was an error working with current case: " + testSuiteConfig.getName(), ex);
                        }
                    }
                }
 
                String goldPath = PathUtil.getAbsolutePath(envConfig.getWorkingDirectory(), envConfig.getRootGoldPath());
                String outputPath = PathUtil.getAbsolutePath(envConfig.getWorkingDirectory(), envConfig.getRootTestOutputPath());
                String diffPath = PathUtil.getAbsolutePath(envConfig.getWorkingDirectory(), envConfig.getDiffOutputPath());
 
                try {
                    // write diff to file if requested
                    if (writeDiff(outputPath, goldPath, diffPath)) {
                        // if there is a diff, throw an exception accordingly
                        throw new IntegrationTestDiffException(String.format("There was a diff between the integration test gold data: %s "
                                + "and the current iteration output data: %s.  Diff file created at %s.",
                                goldPath, outputPath, diffPath));
                    }
                } catch (DiffServiceException ex) {
                    throw new IntegrationTestServiceException("There was an error while trying to diff output with gold data.", ex);
                }
            }
        } finally {
            if (oldSettings != null) {
                try {
                    // revert postgres, solr, activemq settings
                    pushNewMultiUserSettings(oldSettings);
                } catch (Exception ex) {
                    logger.log(Level.WARNING, "There was an error reverting database settings", ex);
                }
            }
            
            if (oldCrChoice != null) {
                try {
                    pushCurrentCrChoice(oldCrChoice);
                } catch (CentralRepoException ex) {
                    logger.log(Level.WARNING, "There was an error reverting cr settings", ex);
                }
            }
        }
    }

    private static class AllConnectionInfo {
 
        private final ConnectionConfig dbConnection;
        private final ConnectionConfig mqConnection;
        private final ConnectionConfig solrConnection;
        private final ConnectionConfig zkConnection;
        private final ConnectionConfig crConnection;

        AllConnectionInfo(ConnectionConfig dbConnection,
                ConnectionConfig mqConnection, ConnectionConfig solrConnection,
                ConnectionConfig zkConnection, ConnectionConfig crConnection) {
            this.dbConnection = dbConnection;
            this.mqConnection = mqConnection;
            this.solrConnection = solrConnection;
            this.zkConnection = zkConnection;
            this.crConnection = crConnection;
        }

        ConnectionConfig getDbConnection() {
            return dbConnection;
        }

        ConnectionConfig getMqConnection() {
            return mqConnection;
        }

        ConnectionConfig getSolrConnection() {
            return solrConnection;
        }

        ConnectionConfig getZkConnection() {
            return zkConnection;
        }

        ConnectionConfig getCrConnection() {
            return crConnection;
        }
    }
    
    
    private CentralRepoDbChoice getCurrentChoice() {
        CentralRepoDbManager manager = new CentralRepoDbManager();
        return manager.getSelectedDbChoice();
    }
    
    
    private CentralRepoDbChoice pushCurrentCrChoice(CentralRepoDbChoice curChoice) throws CentralRepoException {
        CentralRepoDbManager manager = new CentralRepoDbManager();
        CentralRepoDbChoice oldChoice = manager.getSelectedDbChoice();
        manager.setSelctedDbChoice(curChoice);
        manager.saveNewCentralRepo();
        return oldChoice;
    }
    
    private void setCurrentChoice(CaseType caseType) throws CentralRepoException {
        switch (caseType) {
            case MULTI_USER_CASE: 
                pushCurrentCrChoice(CentralRepoDbChoice.POSTGRESQL_CUSTOM);
                break;
            case SINGLE_USER_CASE:
                pushCurrentCrChoice(CentralRepoDbChoice.SQLITE);
                break;
            default: throw new IllegalArgumentException("No known case type: " + caseType);
        }
    }

    private AllConnectionInfo pushNewMultiUserSettings(AllConnectionInfo connectionInfo) throws UserPreferencesException, CentralRepoException {
        // take no action if no settings
        if (connectionInfo == null) {
            return null;
        }
 
        // setup connections and capture old settings.
        ConnectionConfig oldPostgresSettings = pushPostgresSettings(connectionInfo.getDbConnection());
        ConnectionConfig oldActiveMqSettings = pushActiveMqSettings(connectionInfo.getMqConnection());
        ConnectionConfig oldSolrSettings = pushSolrSettings(connectionInfo.getSolrConnection());
        ConnectionConfig oldZkSettings = pushZookeeperSettings(connectionInfo.getZkConnection());
        ConnectionConfig oldCrSettings = pushCentralRepoSettings(connectionInfo.getCrConnection());
 
        // return old settings
        return new AllConnectionInfo(oldPostgresSettings, oldActiveMqSettings, oldSolrSettings, oldZkSettings, oldCrSettings);
    }

    private ConnectionConfig pushPostgresSettings(ConnectionConfig connectionInfo) throws UserPreferencesException {
        // take no action if no database settings.
        if (connectionInfo == null) {
            return null;
        }
 
        // retrieve values
        String username = connectionInfo.getUserName();
        String host = connectionInfo.getHostName();
        String password = connectionInfo.getPassword();
        int port = connectionInfo.getPort() == null ? PostgresConnectionSettings.DEFAULT_PORT : connectionInfo.getPort();
 
        // ensure all necessary values are present.
        if (StringUtils.isBlank(username) || StringUtils.isBlank(password) || StringUtils.isBlank(host)) {
            logger.log(Level.WARNING, "Username, password, or host are not present.  Not setting multi user connection info.");
            return null;
        }
 
        // capture old information.
        CaseDbConnectionInfo oldInfo = UserPreferences.getDatabaseConnectionInfo();
 
        ConnectionConfig oldConnectionInfo = new ConnectionConfig(
                oldInfo.getHost(),
                parseIntOrDefault(oldInfo.getPort(), DEFAULT_POSTGRES_PORT),
                oldInfo.getUserName(),
                oldInfo.getPassword());
 
        UserPreferences.setDatabaseConnectionInfo(new CaseDbConnectionInfo(host, Integer.toString(port), username, password, DbType.POSTGRESQL));
        return oldConnectionInfo;
    }

    private ConnectionConfig pushActiveMqSettings(ConnectionConfig connectionInfo) throws UserPreferencesException {
        // take no action if no database settings.
        if (connectionInfo == null) {
            return null;
        }
 
        // retrieve values
        String host = connectionInfo.getHostName();
        String username = connectionInfo.getUserName() == null ? "" : connectionInfo.getUserName();
        String password = connectionInfo.getPassword() == null ? "" : connectionInfo.getPassword();
        int port = connectionInfo.getPort() == null ? DEFAULT_ACTIVEMQ_PORT : connectionInfo.getPort();
 
        // ensure all necessary values are present.
        if (StringUtils.isBlank(host)) {
            logger.log(Level.WARNING, "Host is not present.  Not setting active mq connection info.");
            return null;
        }
 
        // capture old information.
        MessageServiceConnectionInfo oldInfo = UserPreferences.getMessageServiceConnectionInfo();
        ConnectionConfig oldConnectionInfo = new ConnectionConfig(oldInfo.getHost(), oldInfo.getPort(), oldInfo.getUserName(), oldInfo.getPassword());
 
        UserPreferences.setMessageServiceConnectionInfo(new MessageServiceConnectionInfo(host, port, username, password));
        return oldConnectionInfo;
    }

    private ConnectionConfig pushSolrSettings(ConnectionConfig connectionInfo) {
        // take no action if no database settings.
        if (connectionInfo == null) {
            return null;
        }
 
        // retrieve values
        String host = connectionInfo.getHostName();
        int port = connectionInfo.getPort() == null ? DEFAULT_SOLR_PORT : connectionInfo.getPort();
 
        // ensure all necessary values are present.
        if (StringUtils.isBlank(host)) {
            logger.log(Level.WARNING, "Host is not present.  Not setting solr info.");
            return null;
        }
 
        // capture old information.
        String oldHost = UserPreferences.getIndexingServerHost();
        String oldPortStr = UserPreferences.getIndexingServerPort();
 
        UserPreferences.setIndexingServerHost(host);
        UserPreferences.setIndexingServerPort(port);
 
        return new ConnectionConfig(oldHost, parseIntOrDefault(oldPortStr, DEFAULT_SOLR_PORT), null, null);
    }

    private ConnectionConfig pushZookeeperSettings(ConnectionConfig connectionInfo) {
        if (connectionInfo == null) {
            return null;
        }
 
        String host = connectionInfo.getHostName();
 
        if (StringUtils.isBlank(host)) {
            return null;
        }
 
        int port = connectionInfo.getPort() == null ? DEFAULT_ZOOKEEPER_PORT : connectionInfo.getPort();
 
        ConnectionConfig oldInfo = new ConnectionConfig(
                UserPreferences.getZkServerHost(),
                parseIntOrDefault(UserPreferences.getZkServerPort(), DEFAULT_ZOOKEEPER_PORT),
                null,
                null);
 
        UserPreferences.setZkServerHost(host);
        UserPreferences.setZkServerPort(Integer.toString(port));
        return oldInfo;
    }

    private ConnectionConfig pushCentralRepoSettings(ConnectionConfig connectionInfo) throws CentralRepoException {
        // take no action if no database settings.
        if (connectionInfo == null) {
            return null;
        }
 
        // retrieve values
        String username = connectionInfo.getUserName();
        String host = connectionInfo.getHostName();
        String password = connectionInfo.getPassword();
        int port = connectionInfo.getPort() == null ? PostgresConnectionSettings.DEFAULT_PORT : connectionInfo.getPort();
 
        // ensure all necessary values are present.
        if (StringUtils.isBlank(username) || StringUtils.isBlank(password) || StringUtils.isBlank(host)) {
            logger.log(Level.WARNING, "Username, password, or host are not present.  Not setting central repo connection info.");
            return null;
        }
 
        // capture old information.
        CentralRepoDbManager manager = new CentralRepoDbManager();
        PostgresCentralRepoSettings pgCr = manager.getDbSettingsPostgres();
 
        ConnectionConfig oldConnectionInfo = new ConnectionConfig(
                pgCr.getHost(),
                pgCr.getPort(),
                pgCr.getUserName(),
                pgCr.getPassword());
 
        pgCr.setHost(host);
        pgCr.setUserName(username);
        pgCr.setPort(port);
        pgCr.setPassword(password);
        pgCr.saveSettings();
 
        return oldConnectionInfo;
    }

    private int parseIntOrDefault(String toBeParsed, int defaultVal) {
        if (toBeParsed == null) {
            return defaultVal;
        }
 
        try {
            return Integer.parseInt(toBeParsed);
        } catch (NumberFormatException ex) {
            return defaultVal;
        }
    }

    private void runIntegrationTestSuite(EnvConfig envConfig, CaseType caseType, TestSuiteConfig testSuiteConfig) throws CaseActionException, NoCurrentCaseException, IllegalStateException, IllegalArgumentException {
 
        String caseName = testSuiteConfig.getName();
 
        // create an autopsy case for each case in the config and for each case type for the specified case.
        // then run ingest for the case.
        Case autopsyCase = createCaseWithDataSources(
                envConfig.getWorkingDirectory(),
                envConfig.getRootCaseOutputPath(),
                caseName,
                caseType,
                testSuiteConfig.getDataSources());
        if (autopsyCase == null || autopsyCase != Case.getCurrentCase()) {
            throw new IllegalStateException(
                    String.format("Case was not properly ingested or setup correctly for environment.  Returned case is %s and current case is %s.",
                            autopsyCase, Case.getCurrentCase()));
        }
        // run configuration modules and get result
        Pair<IngestJobSettings, List<ConfigurationModule<?>>> configurationResult
                = configurationModuleManager.runConfigurationModules(caseName, testSuiteConfig.getConfigurationModules());
        IngestJobSettings ingestSettings = configurationResult.first();
        List<ConfigurationModule<?>> configModules = configurationResult.second();
        // run ingest with ingest settings derived from configuration modules.
        runIngest(autopsyCase, ingestSettings, caseName);
        // once ingested, run integration tests to produce output.
        OutputResults results = runIntegrationTests(testSuiteConfig.getIntegrationTests());
        // revert any autopsy environment changes made by configuration modules.
        configurationModuleManager.revertConfigurationModules(configModules);
        String outputFolder = PathUtil.getAbsolutePath(envConfig.getWorkingDirectory(), envConfig.getRootTestOutputPath());
        // write the results for the case to a file
        results.serializeToFile(
                envConfig.getUseRelativeOutput() == true
                ? Paths.get(outputFolder, testSuiteConfig.getRelativeOutputPath()).toString()
                : outputFolder,
                testSuiteConfig.getName(),
                caseType
        );
 
        Case.closeCurrentCase();
    }

    private Case createCaseWithDataSources(String workingDirectory, String caseOutputPath, String caseName, CaseType caseType, List<String> dataSourcePaths)
            throws CaseActionException, NoCurrentCaseException, IllegalStateException, IllegalArgumentException {
 
        Case openCase = null;
        String uniqueCaseName = String.format("%s_%s", caseName, TimeStampUtils.createTimeStamp());
        String outputFolder = PathUtil.getAbsolutePath(workingDirectory, caseOutputPath);
        String caseOutputFolder = Paths.get(outputFolder, uniqueCaseName).toString();
        File caseOutputFolderFile = new File(caseOutputFolder);
        if (!caseOutputFolderFile.exists()) {
            caseOutputFolderFile.mkdirs();
        }
 
        Case.createAsCurrentCase(
                caseType,
                caseOutputFolder,
                new CaseDetails(uniqueCaseName));
        openCase = Case.getCurrentCaseThrows();
 
        addDataSourcesToCase(PathUtil.getAbsolutePaths(workingDirectory, dataSourcePaths), caseName);
        return openCase;
    }

    private void addDataSourcesToCase(List<String> pathStrings, String caseName) {
        for (String strPath : pathStrings) {
            Path path = Paths.get(strPath);
            List<AutoIngestDataSourceProcessor> processors = null;
            try {
                processors = DataSourceProcessorUtility.getOrderedListOfDataSourceProcessors(path);
            } catch (AutoIngestDataSourceProcessorException ex) {
                logger.log(Level.WARNING, String.format("There was an error while adding data source: %s to case %s", strPath, caseName));
            }
 
            if (CollectionUtils.isEmpty(processors)) {
                continue;
            }
 
            try {
                IngestUtils.addDataSource(processors.get(0), path);
            } catch (TestUtilsException ex) {
                logger.log(Level.WARNING, String.format("There was an error adding datasource at path: " + strPath), ex);
            }
        }
    }

    private void runIngest(Case openCase, IngestJobSettings ingestJobSettings, String caseName) {
        try {
            if (CollectionUtils.isEmpty(openCase.getDataSources())) {
                logger.log(Level.WARNING, String.format("No datasources provided in %s. Not running ingest.", caseName));
            } else {
                IngestUtils.runIngestJob(openCase.getDataSources(), ingestJobSettings);
            }
        } catch (TskCoreException | TestUtilsException ex) {
            logger.log(Level.WARNING, String.format("There was an error while ingesting datasources for case %s", caseName), ex);
        }
    }

    private OutputResults runIntegrationTests(TestingConfig testSuiteConfig) {
        // this will capture output results
        OutputResults results = new OutputResults();
 
        // run through each IntegrationTestGroup
        for (IntegrationTestGroup testGroup : Lookup.getDefault().lookupAll(IntegrationTestGroup.class)) {
 
            // if test should not be included in results, skip it.
            if (!testSuiteConfig.hasIncludedTest(testGroup.getClass().getCanonicalName())) {
                continue;
            }
 
            List<Method> testMethods = Stream.of(testGroup.getClass().getMethods())
                    .filter((method) -> method.getAnnotation(IntegrationTest.class) != null)
                    .collect(Collectors.toList());
 
            if (CollectionUtils.isEmpty(testMethods)) {
                continue;
            }
 
            testGroup.setupClass();
            Map<String, Object> parametersMap = testSuiteConfig.getParameters(testGroup.getClass().getCanonicalName());
 
            for (Method testMethod : testMethods) {
                Object[] parameters = new Object[0];
                // no more than 1 parameter in a test method.
                if (testMethod.getParameters().length > 1) {
                    logger.log(Level.WARNING, String.format("Could not call method %s in class %s.  Multiple parameters cannot be handled.",
                            testMethod.getName(), testGroup.getClass().getCanonicalName()));
                    continue;
                    // if there is a parameter, deserialize parameters to the specified type.
                } else if (testMethod.getParameters().length > 0) {
                    parameters = new Object[]{configDeserializer.convertToObj(parametersMap, testMethod.getParameterTypes()[0])};
                }
 
                Object serializableResult = runIntegrationTestMethod(testGroup, testMethod, parameters);
                // add the results and capture the package, class, 
                // and method of the test for easy location of failed tests
                results.addResult(
                        testGroup.getClass().getPackage().getName(),
                        testGroup.getClass().getSimpleName(),
                        testMethod.getName(),
                        serializableResult);
            }
 
            testGroup.tearDownClass();
        }
 
        return results;
    }

    private Object runIntegrationTestMethod(IntegrationTestGroup testGroup, Method testMethod, Object[] parameters) {
        testGroup.setup();
 
        // run the test method and get the results
        Object serializableResult = null;
 
        try {
            serializableResult = testMethod.invoke(testGroup, parameters == null ? new Object[0] : parameters);
        } catch (InvocationTargetException ex) {
            // if the underlying method caused an exception, serialize that exception.
            serializableResult = ex.getCause();
        } catch (Exception ex) {
            // any other exception should also be caught as a firewall exception handler.
            logger.log(Level.WARNING,
                    String.format("test method %s in %s could not be properly invoked",
                            testMethod.getName(), testGroup.getClass().getCanonicalName()),
                    ex);
 
            serializableResult = ex;
        }
 
        testGroup.tearDown();
 
        return serializableResult;
    }

    private boolean writeDiff(String outputPath, String goldPath, String diffPath) throws DiffServiceException {
        if (StringUtils.isBlank(goldPath) || StringUtils.isBlank(diffPath)) {
            logger.log(Level.INFO, "gold path or diff output path not specified.  Not creating diff.");
        }
 
        File goldDir = new File(goldPath);
        if (!goldDir.exists()) {
            logger.log(Level.WARNING, String.format("Gold does not exist at location: %s.  Not creating diff.", goldDir.toString()));
        }
 
        File outputDir = new File(outputPath);
        if (!outputDir.exists()) {
            logger.log(Level.WARNING, String.format("Output path does not exist at location: %s.  Not creating diff.", outputDir.toString()));
        }
 
        String diff = diffService.diffFilesOrDirs(goldDir, outputDir);
        if (StringUtils.isNotBlank(diff)) {
            try {
                FileUtils.writeStringToFile(new File(diffPath), diff, "UTF-8");
            } catch (IOException ex) {
                logger.log(Level.SEVERE, "Unable to write diff file to {0}", diffPath);
            }
 
            return true;
        }
 
        return false;
    }
}