Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.integrationtesting.config.EnvConfig Class Reference

Public Member Functions

 EnvConfig (@JsonProperty("rootCaseOutputPath") String rootCaseOutputPath,@JsonProperty("rootTestSuitesPath") String rootTestSuitesPath,@JsonProperty("rootTestOutputPath") String rootTestOutputPath,@JsonProperty("dbConnection") ConnectionConfig dbConnection,@JsonProperty("mqConnection") ConnectionConfig mqConnection,@JsonProperty("solrConnection") ConnectionConfig solrConnection,@JsonProperty("zkConnection") ConnectionConfig zkConnection,@JsonProperty("crConnection") ConnectionConfig crConnection,@JsonProperty("workingDirectory") String workingDirectory,@JsonProperty("useRelativeOutput") Boolean useRelativeOutput,@JsonProperty("rootGoldPath") String rootGoldPath,@JsonProperty("diffOutputPath") String diffOutputPath)
 
ConnectionConfig getCrConnection ()
 
ConnectionConfig getDbConnection ()
 
String getDiffOutputPath ()
 
ConnectionConfig getMqConnection ()
 
String getRootCaseOutputPath ()
 
String getRootGoldPath ()
 
String getRootTestOutputPath ()
 
String getRootTestSuitesPath ()
 
ConnectionConfig getSolrConnection ()
 
boolean getUseRelativeOutput ()
 
String getWorkingDirectory ()
 
ConnectionConfig getZkConnection ()
 
void setUseRelativeOutput (boolean useRelativeOutput)
 
void setWorkingDirectory (String workingDirectory)
 

Private Attributes

final ConnectionConfig crConnection
 
final ConnectionConfig dbConnection
 
final String diffOutputPath
 
final ConnectionConfig mqConnection
 
final String rootCaseOutputPath
 
final String rootGoldPath
 
final String rootTestOutputPath
 
final String rootTestSuitesPath
 
final ConnectionConfig solrConnection
 
Boolean useRelativeOutput
 
String workingDirectory
 
final ConnectionConfig zkConnection
 

Detailed Description

Defines integration testing environment settings.

Definition at line 29 of file EnvConfig.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.EnvConfig ( @JsonProperty("rootCaseOutputPath") String  rootCaseOutputPath,
@JsonProperty("rootTestSuitesPath") String  rootTestSuitesPath,
@JsonProperty("rootTestOutputPath") String  rootTestOutputPath,
@JsonProperty("dbConnection") ConnectionConfig  dbConnection,
@JsonProperty("mqConnection") ConnectionConfig  mqConnection,
@JsonProperty("solrConnection") ConnectionConfig  solrConnection,
@JsonProperty("zkConnection") ConnectionConfig  zkConnection,
@JsonProperty("crConnection") ConnectionConfig  crConnection,
@JsonProperty("workingDirectory") String  workingDirectory,
@JsonProperty("useRelativeOutput") Boolean  useRelativeOutput,
@JsonProperty("rootGoldPath") String  rootGoldPath,
@JsonProperty("diffOutputPath") String  diffOutputPath 
)

Main constructor.

Parameters
rootCaseOutputPathThe location where cases will be created.
rootTestSuitesPathThe location of test suite configuration file(s).
rootTestOutputPathThe location where output results should be created.
dbConnectionThe connection information for the database (postgres).
mqConnectionThe active mq connection information.
solrConnectionThe solr connection information.
zkConnectionThe zookeeper connection information.
crConnectionThe central repo connection information.
workingDirectoryThe working directory (if not specified, the parent directory of the EnvConfig file is used.
useRelativeOutputIf true, results will be outputted maintaining the same relative path structure as the file (i.e. if file was found at /rootTestSuitesPath/folderX/fileY.json then it will now be outputted in /rootTestOutputPath/folderX/fileY/)
rootGoldPathThe path to the gold data for diff comparison.
diffOutputPathThe file location for diff output.

Definition at line 71 of file EnvConfig.java.

Member Function Documentation

ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getCrConnection ( )
Returns
The central repo connection.

Definition at line 195 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getDbConnection ( )
Returns
The connection information for the database (postgres).

Definition at line 167 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getDiffOutputPath ( )
Returns
The file location for diff output.

Definition at line 209 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getMqConnection ( )
Returns
The active mq connection information.

Definition at line 174 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getRootCaseOutputPath ( )
Returns
The path for where cases should be saved.

Definition at line 103 of file EnvConfig.java.

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getRootGoldPath ( )
Returns
The path to the gold data for diff comparison.

Definition at line 202 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getRootTestOutputPath ( )
Returns
The path for where output yaml data should be saved.

Definition at line 110 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getRootTestSuitesPath ( )
Returns
The root test suites path that will be searched or the path to a single file.

Definition at line 138 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.config.ConfigDeserializer.getIntegrationTestConfig().

ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getSolrConnection ( )
Returns
The solr connection information.

Definition at line 181 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

boolean org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getUseRelativeOutput ( )
Returns
If true, results will be outputted maintaining the same relative path structure as the file (i.e. if file was found at /rootTestSuitesPath/folderX/fileY.json then it will now be outputted in /rootTestOutputPath/folderX/fileY/)

Definition at line 148 of file EnvConfig.java.

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getWorkingDirectory ( )
Returns
The working directory. In practice, this is the folder that the configuration is located within. Any relative paths will be relative to this.

Definition at line 119 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.config.ConfigDeserializer.getIntegrationTestConfig(), and org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.getZkConnection ( )
Returns
The zookeeper connection.

Definition at line 188 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.runIntegrationTests().

void org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.setUseRelativeOutput ( boolean  useRelativeOutput)

Sets whether or not to use the relative output path.

Parameters
useRelativeOutputIf true, results will be outputted maintaining the same relative path structure as the file (i.e. if file was found at /rootTestSuitesPath/folderX/fileY.json then it will now be outputted in /rootTestOutputPath/folderX/fileY/)

Definition at line 160 of file EnvConfig.java.

void org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.setWorkingDirectory ( String  workingDirectory)

Sets the working directory.

Parameters
workingDirectoryThe working directory. In practice, this is the folder that the configuration is located within. Any relative paths will be relative to this.

Definition at line 130 of file EnvConfig.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.config.ConfigDeserializer.validate().

Member Data Documentation

final ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.crConnection
private

Definition at line 41 of file EnvConfig.java.

final ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.dbConnection
private

Definition at line 37 of file EnvConfig.java.

final String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.diffOutputPath
private

Definition at line 35 of file EnvConfig.java.

final ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.mqConnection
private

Definition at line 38 of file EnvConfig.java.

final String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.rootCaseOutputPath
private

Definition at line 31 of file EnvConfig.java.

final String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.rootGoldPath
private

Definition at line 34 of file EnvConfig.java.

final String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.rootTestOutputPath
private

Definition at line 32 of file EnvConfig.java.

final String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.rootTestSuitesPath
private

Definition at line 33 of file EnvConfig.java.

final ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.solrConnection
private

Definition at line 39 of file EnvConfig.java.

Boolean org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.useRelativeOutput
private

Definition at line 44 of file EnvConfig.java.

String org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.workingDirectory
private

Definition at line 43 of file EnvConfig.java.

final ConnectionConfig org.sleuthkit.autopsy.integrationtesting.config.EnvConfig.zkConnection
private

Definition at line 40 of file EnvConfig.java.


The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.