ProjectInstaller (SAFS API DOCUMENT)

java.lang.Object
- org.safs.install.ProjectInstaller

```
public class ProjectInstaller
extends java.lang.Object
```
Prepare and install a new SAFS Project based on a config.ini, safstid.ini, environment variables, command-line options, and internal defaults.
Virtually everything is optional.
If no parameters or options are provided then a new project will be created with the current "Working Directory" as the root project directory.
If only a -project or ProjectName is provided, then a new project will be created as a subdirectory of the current "Working Directory".
The class not only creates the required directory structure, but will also attempt to populate the project with common project-specific utility scripts and assets.
Refer to Config File Options for more detailed information on available options.

Author:

Carl Nagle

See Also:

processINIFile(File)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARG_BENCH`
`static java.lang.String`	`ARG_CONFIG`
`static java.lang.String`	`ARG_DATA`
`static java.lang.String`	`ARG_DIF`
`static java.lang.String`	`ARG_LOGS`
`static java.lang.String`	`ARG_OUTPUT`
`static java.lang.String`	`ARG_PATH`
`static java.lang.String`	`ARG_PROJECT`
`static java.lang.String`	`ARG_SAFS`
`static java.lang.String`	`ARG_SELENIUM`
`static java.lang.String`	`ARG_STAF`
`static java.lang.String`	`ARG_TEST`
`static java.lang.String`	`ARG_TYPE`
`protected java.io.File`	`benchDir`
`protected java.io.File`	`configFile`
`protected java.io.File`	`dataDir`
`protected java.io.File`	`difDir`
`protected java.io.File`	`driverDir`
`protected boolean`	`isSAFS`
`protected boolean`	`isSelenium`
`protected java.lang.String`	`LOG_NAME`
`protected java.io.File`	`logsDir`
`protected static java.lang.String`	`nl` newline
`protected java.io.File`	`outputDir`
`protected java.lang.StringBuffer`	`progress`
`protected java.io.File`	`projectDir`
`protected java.io.File`	`projectParent`
`protected java.io.File`	`safsDir`
`protected java.io.File`	`safsHome`
`protected java.io.File`	`safstidFile`
`protected java.io.File`	`seleniumHome`
`protected java.io.File`	`stafDir`
`protected java.io.File`	`testDir`
`protected java.io.File`	`workDir`

Constructor Summary

Constructors
Constructor and Description

ProjectInstaller()
Default constructor.
Functionality invoked with createProject(String[]).

Constructors
Constructor and Description
`ProjectInstaller()` Default constructor. Functionality invoked with createProject(String[]).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`createDirectory(java.io.File target, java.io.File relativeParent, java.lang.String role)`
`void`	`createProject(java.lang.String[] args)` If no arguments are provided then a default Project will be created in the "working directory".
`protected void`	`createProjectStructure()` Create the project directory structure using the required preset values.
`protected void`	`deduceMissingParameters()` fourth-order (last) processing to attempt to fill-in missing settings relative to other known info.
`static void`	`main(java.lang.String[] args)`
`protected void`	`processCMDLine(java.lang.String[] args)` third-order settings
`protected void`	`processEnvironment()` first-order settings
`protected void`	`processINIFile(java.io.File inifile)` second-order settings
`protected void`	`progress(java.lang.String message)` write progress/debug info to one or more sinks
`protected void`	`seekConfigFiles(java.lang.String[] args)` check for -config argument from command-line. -config can be absolute or relative to the working directory. Attempt to locate safstid.ini relative to -config, if not then Attempt to locate safstid.ini relative to working directory. sets configFile and safstidFile variables as appropriate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ARG_CONFIG
```
public static final java.lang.String ARG_CONFIG
```
    See Also:
    
    Constant Field Values
  - ARG_PATH
```
public static final java.lang.String ARG_PATH
```
    See Also:
    
    Constant Field Values
  - ARG_PROJECT
```
public static final java.lang.String ARG_PROJECT
```
    See Also:
    
    Constant Field Values
  - ARG_TYPE
```
public static final java.lang.String ARG_TYPE
```
    See Also:
    
    Constant Field Values
  - ARG_DATA
```
public static final java.lang.String ARG_DATA
```
    See Also:
    
    Constant Field Values
  - ARG_BENCH
```
public static final java.lang.String ARG_BENCH
```
    See Also:
    
    Constant Field Values
  - ARG_TEST
```
public static final java.lang.String ARG_TEST
```
    See Also:
    
    Constant Field Values
  - ARG_DIF
```
public static final java.lang.String ARG_DIF
```
    See Also:
    
    Constant Field Values
  - ARG_LOGS
```
public static final java.lang.String ARG_LOGS
```
    See Also:
    
    Constant Field Values
  - ARG_STAF
```
public static final java.lang.String ARG_STAF
```
    See Also:
    
    Constant Field Values
  - ARG_SAFS
```
public static final java.lang.String ARG_SAFS
```
    See Also:
    
    Constant Field Values
  - ARG_SELENIUM
```
public static final java.lang.String ARG_SELENIUM
```
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT
```
public static final java.lang.String ARG_OUTPUT
```
    See Also:
    
    Constant Field Values
  - LOG_NAME
```
protected java.lang.String LOG_NAME
```
  - safstidFile
```
protected java.io.File safstidFile
```
  - configFile
```
protected java.io.File configFile
```
  - workDir
```
protected java.io.File workDir
```
  - stafDir
```
protected java.io.File stafDir
```
  - safsHome
```
protected java.io.File safsHome
```
  - seleniumHome
```
protected java.io.File seleniumHome
```
  - safsDir
```
protected java.io.File safsDir
```
  - projectDir
```
protected java.io.File projectDir
```
  - projectParent
```
protected java.io.File projectParent
```
  - driverDir
```
protected java.io.File driverDir
```
  - dataDir
```
protected java.io.File dataDir
```
  - benchDir
```
protected java.io.File benchDir
```
  - difDir
```
protected java.io.File difDir
```
  - testDir
```
protected java.io.File testDir
```
  - logsDir
```
protected java.io.File logsDir
```
  - outputDir
```
protected java.io.File outputDir
```
  - progress
```
protected java.lang.StringBuffer progress
```
  - isSAFS
```
protected boolean isSAFS
```
  - isSelenium
```
protected boolean isSelenium
```
  - nl
```
protected static final java.lang.String nl
```
    newline
- Constructor Detail
  - ProjectInstaller
```
public ProjectInstaller()
```
    Default constructor.
    Functionality invoked with createProject(String[]).
    
    See Also:
    
    createProject(String[])
- Method Detail
  - progress
```
protected void progress(java.lang.String message)
```
    write progress/debug info to one or more sinks
  - processEnvironment
```
protected void processEnvironment()
```
    first-order settings
    - STAFDIR -- STAF Install Directory
    - SAFSDIR -- SAFS Install Directory
    - SELENIUM_PLUS -- SeleniumPlus Install Directory
    Anything found and set here can be overridden by second- and third-order settings.
    See Also:
    
    processINIFile(File), processCMDLine(String[])
  - processINIFile
```
protected void processINIFile(java.io.File inifile)
```
    second-order settings
    override first-order settings.
    Anything found and set here can be overridden by third-order settings.
    INI File Settings Sought:
```
[STAF]
 PATH=pathTo/STAFProc (parsed for STAF Install Directory)
 
[SAFS_DRIVER]
 DriverName=SAFS | SeleniumPlus
 DriverRoot=pathTo/SAFS or SeleniumPlus Install Directory
 
[SAFS_PROJECT]
 ProjectRoot=pathTo/ProjectParent directory (or ProjectDirectory if ProjectName is not provided)
 ProjectName=NameOfProject -- appended to project parent directory if provided
 
[SAFS_DIRECTORIES]
 DATADIR =Data directory -- absolute path, or project-relative path
 BENCHDIR=Benchmark directory -- absolute path, or project-relative path
 TESTDIR =Test directory -- absolute path, or project-relative path
 DIFFDIR =Differences directory -- absolute path, or project-relative path
 LOGDIR =Logs directory -- absolute path, or project-relative path
 
```
    See Also:
    
    processEnvironment(), processCMDLine(String[])
  - processCMDLine
```
protected void processCMDLine(java.lang.String[] args)
```
    third-order settings
    override first- and second-order settings.
    
    Parameters:
    
    args - -- createProject(String[])
    
    See Also:
    
    processEnvironment(), seekConfigFiles(String[]), processINIFile(File), deduceMissingParameters()
  - seekConfigFiles
```
protected void seekConfigFiles(java.lang.String[] args)
```
    check for -config argument from command-line.
    -config can be absolute or relative to the working directory.
    Attempt to locate safstid.ini relative to -config, if not then
    Attempt to locate safstid.ini relative to working directory.
    sets configFile and safstidFile variables as appropriate.
    
    Parameters:
    
    args -
  - deduceMissingParameters
```
protected void deduceMissingParameters()
```
    fourth-order (last) processing to attempt to fill-in missing settings relative to other known info.
  - createDirectory
```
protected void createDirectory(java.io.File target,
                               java.io.File relativeParent,
                               java.lang.String role)
                        throws java.lang.IllegalArgumentException
```
    Parameters:
    
    target - -- can be relative or absolute
    
    relativeParent - -- must be absolute if target is relative. can be null if target is absolute.
    
    role - - for logging/debug purposes (Project, Data, Test, Logs, Bench, Diff)
    
    Throws:
    
    java.lang.IllegalArgumentException - if we are unable to create the directory.
  - createProjectStructure
```
protected void createProjectStructure()
                               throws java.lang.IllegalArgumentException,
                                      java.lang.SecurityException
```
    Create the project directory structure using the required preset values.
    
    Throws:
    
    java.lang.IllegalArgumentException - -- if required parameters are invalid or null.
    
    java.lang.SecurityException
  - createProject
```
public void createProject(java.lang.String[] args)
```
    If no arguments are provided then a default Project will be created in the "working directory".
    Parameters:
    args -
    -config pathToTest.ini
    if not present will attempt to locate a "safstid.ini" in the current working directory. If safstid.ini is not present it will attempt to use other command-line parameters and internal default values.
    -project ProjectName
    Optional Name for the Project. This equates to the name of the root directory of the Project. If not provided, it is assumed the provided or derived path for the Project constitutes the name of the Project.
    -path pathToProject
    full or ini-relative path to the new Project. Would override any ProjectRoot INI entry. if the -project arg is also provided then the ProjectName is appended to -path to determine the full root directory for the new Project.
    -type SAFS|SeleniumPlus
    Defaults to SAFS project type, unless SeleniumPlus is specified.
    Only matters if BOTH SAFS and SeleniumPlus are installed on the machine and neither -safs nor -seleniumplus are provided.
    -data pathToDataDir
    Defaults to "Datapool" if not provided. Would override any DataDir INI entry.
    -bench pathToBenchDir
    Defaults to "Bench" if not provided. Would override any BenchDir INI entry.
    -test pathToTestDir
    Defaults to "Test" if not provided. Would override any TestDir INI entry.
    -dif pathToDifDir
    
    Defaults to "Dif" if not provided. Would override any DiffDir INI entry.
    -logs pathToLogsDir
    
    Defaults to "Logs" if not provided. Would override any LogDir INI entry.
    -staf pathToSTAFInstallDir
    Otherwise seeks STAFDIR environment variable.
    -safs pathToSAFSInstallDir
    Otherwise seeks SAFSDIR environment variable.
    -seleniumplus pathToSeleniumPlusInstallDir
    Otherwise seeks SELENIUM_PLUS environment variable.
    -output pathToOutputDir to contain our projectsetup.log
    Otherwise seeks SELENIUM_PLUS environment variable.
    See Also:
    
    processEnvironment(), seekConfigFiles(String[]), processINIFile(File), processCMDLine(String[]), deduceMissingParameters()
  - main
```
public static void main(java.lang.String[] args)
```
    See Also:
    
    createProject(String[])

Class ProjectInstaller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARG_CONFIG

ARG_PATH

ARG_PROJECT

ARG_TYPE

ARG_DATA

ARG_BENCH

ARG_TEST

ARG_DIF

ARG_LOGS

ARG_STAF

ARG_SAFS

ARG_SELENIUM

ARG_OUTPUT

LOG_NAME

safstidFile

configFile

workDir

stafDir

safsHome

seleniumHome

safsDir

projectDir

projectParent

driverDir

dataDir

benchDir

difDir

testDir

logsDir

outputDir

progress

isSAFS

isSelenium

nl

Constructor Detail

ProjectInstaller

Method Detail

progress

processEnvironment

processINIFile

processCMDLine

seekConfigFiles

deduceMissingParameters

createDirectory

createProjectStructure

createProject

main