Class FastRunProperties

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.String>

    public class FastRunProperties
    extends java.util.HashMap<java.lang.String,​java.lang.String>
    This class is used to store the properties that the FAST framework will use while executing
    Since:
    1.0.0
    See Also:
    Serialized Form
    • Constructor Detail

      • FastRunProperties

        public FastRunProperties()
    • Method Detail

      • get

        public java.lang.String get​(java.lang.Object key)
        Returns the value to which the specified key is mapped.
        Specified by:
        get in interface java.util.Map<java.lang.String,​java.lang.String>
        Overrides:
        get in class java.util.HashMap<java.lang.String,​java.lang.String>
        Parameters:
        key - The key whose value will be retrieved
        Returns:
        String value belonging to the specified key
        Since:
        1.0.0
      • getDriverPath

        public java.lang.String getDriverPath()
        Returns the value of the driverPath property. The driverPath is the filepath of the xmlDrivers that the FAST Framework should execute. Equivalent to calling get(Object) with "driverPath"
        Returns:
        The driverPath
        Since:
        1.0.0
      • setDriverPath

        public void setDriverPath​(java.lang.String driverPath)
        Sets driverPath property
        Parameters:
        driverPath - The driverPath
        Since:
        1.0.0
      • getRelativeDriverPath

        public java.lang.String getRelativeDriverPath()
        Returns the value of the relativeDriverPath property. The relativeDriverPath is the filepath of the xmlDrivers that the FAST Framework should execute. It differs from the driverPath in that this path is relative to the project path. When used together with driverPath, this value will automatically be used instead. Equivalent to calling get(Object) with "relativeDriverPath"
        Returns:
        The relativeDriverPath
        Since:
        1.0.0
      • setRelativeDriverPath

        public void setRelativeDriverPath​(java.lang.String relativeDriverPath)
        Set relativeDriverPath property
        Parameters:
        relativeDriverPath - The relativeDriverPath
        Since:
        1.0.0
      • getExecutionReportsPath

        public java.lang.String getExecutionReportsPath()
                                                 throws FastException
        Returns the value of the executionReportsPath property. This is the location that the HtmlReports and test evidence from executing FastXml will be written to. Equivalent to calling get(Object) with "executionReportsPath"
        Returns:
        The executionReportsPath
        Throws:
        FastException - If an error occurs during execution
        Since:
        1.0.0
      • setExcecutionReportsPath

        public void setExcecutionReportsPath​(java.lang.String executionReportsPath)
        Set executionReportsPath property
        Parameters:
        executionReportsPath - The executionReportsPath
        Since:
        1.0.0
      • getBrowserType

        public Browsers getBrowserType()
                                throws FastException
        Returns the value of the browserType property. This is the Browsers that the FAST Framework will use while executing steps. Equivalent to calling get(Object) with "browserType"
        Returns:
        The browserType
        Throws:
        FastException - If an error occurs during execution
        Since:
        1.0.0
      • setBrowserType

        public void setBrowserType​(Browsers browserType)
        Set browserType property
        Parameters:
        browserType - The browserType
        Since:
        1.0.0
      • getDefaultFramework

        public Framework getDefaultFramework()
        Returns the value of the defaultFramework property. If defaultFramework has not been set, Framework.SELENIUM will be returned.
        Returns:
        The defaultFramework
        Since:
        1.0.0
      • setDefaultFramework

        public void setDefaultFramework​(Framework defaultFramework)
        Set defaultFramework property
        Parameters:
        defaultFramework - The defaultFramework
        Since:
        1.0.0
      • getDelimiter

        public java.lang.String getDelimiter()
        Returns the delimiter FAST uses internally.
        Returns:
        The delimiter
        Since:
        1.0.0
      • getScenarioTagsToRun

        public java.lang.String getScenarioTagsToRun()
        Returns the value of the scenarioTagsToRun property. Tags are delimited by comma's. Example: FirstTag,SecondTag. When using the FAST Framework, only the TestScript's possesing the tags in scenarioTagsToRun will be executed. If this field is empty, or includes the tag ALL, every TestScript will be executed. Equivalent to calling get(Object) with "scenarioTagsToRun"
        Returns:
        The scenarioTagsToRun
        Since:
        1.0.0
      • setScenarioTagsToRun

        public void setScenarioTagsToRun​(java.lang.String scenarioTagsToRun)
        Set scenarioTagsToRun property
        Parameters:
        scenarioTagsToRun - A comma delimited string designating which TestScripts should be executed. Only TestScripts containing any tags present in scenarioTagsToRun will be executed. If the tag also exists in scenarioTagsToSkip, the TestScript will be skipped
        Since:
        1.0.0
      • getScenarioTagsToSkip

        public java.lang.String getScenarioTagsToSkip()
        Returns the value of the scenarioTagsToSkip property. Tags are delimited by comma's. Example: FirstTag,SecondTag. When using the FAST Framework, the TestScript's possesing the tags in scenarioTagsToSkip will not be executed. If this field is empty, no TestScripts will be skipped. Equivalent to calling get(Object) with "scenarioTagsToSkip"
        Returns:
        The scenarioTagsToSkip
        Since:
        1.0.0
      • setScenarioTagsToSkip

        public void setScenarioTagsToSkip​(java.lang.String scenarioTagsToSkip)
        Set scenarioTagsToSkip property
        Parameters:
        scenarioTagsToSkip - A comma delimited string designating which TestScripts should be skipped.
        Since:
        1.0.0
      • getFunctionalTagsToRun

        public java.lang.String getFunctionalTagsToRun()
        Returns the value of the functionalTagsToRun property. Tags are delimited by comma's. Example: FirstTag,SecondTag. When using the FAST Framework, only the FunctionalTestStep's possesing the tags in functionalTagsToRun will be executed. If this field is empty, or includes the tag ALL, every FunctionalTestStep will be executed. Equivalent to calling get(Object) with "functionalTagsToRun"
        Returns:
        The functionalTagsToRun
        Since:
        1.0.0
      • setFunctionalTagsToRun

        public void setFunctionalTagsToRun​(java.lang.String functionalTagsToRun)
        Set functionalTagsToRun property
        Parameters:
        functionalTagsToRun - A comma delimited string designating which FunctionalTestSteps should be executed. Only FunctionalTestSteps containing any tags present in functionalTagsToRun will be executed. If the tag also exists in functionalTagsToRun, the FunctionalTestStep will be skipped
        Since:
        1.0.0
      • getFunctionalTagsToSkip

        public java.lang.String getFunctionalTagsToSkip()
        Returns the value of the functionalTagsToSkip property. Tags are delimited by comma's. Example: FirstTag,SecondTag. When using the FAST Framework, the FunctionalTestStep's possesing the tags in functionalTagsToSkip will not be executed. If this field is empty, no FunctionalTestSteps will be skipped. Equivalent to calling get(Object) with "functionalTagsToSkip"
        Returns:
        The functionalTagsToSkip
        Since:
        1.0.0
      • setFunctionalTagsToSkip

        public void setFunctionalTagsToSkip​(java.lang.String functionalTagsToSkip)
        Set functionalTagsToSkip property
        Parameters:
        functionalTagsToSkip - A comma delimited string designating which FunctionalTestSteps should be skipped.
        Since:
        1.0.0
      • getCloseDriverAfterScript

        public boolean getCloseDriverAfterScript()
        Returns the value of the closeDriverAfterScript property. When closeDriverAfterScript is "true" (case insensitive), this method will return true. If closeDriverAfterScript is null or empty, this method will default to true. When true, this property will make the FAST framework close any browser windows it opened during execution of a TestScript
        Returns:
        true if the closeDriverAfterScript property is set to "true" (case insensitive). Otherwise, this method will return false
        Since:
        1.0.0
      • setCloseDriverAfterTestScript

        public void setCloseDriverAfterTestScript​(java.lang.String closeDriverAfterScript)
        Set closeDriverAfterScript property
        Parameters:
        closeDriverAfterScript - The value
        Since:
        1.0.0
      • getCloseDriverAfterSuite

        public boolean getCloseDriverAfterSuite()
        Returns the value of the closeDriverAfterSuite property. When closeDriverAfterScript is "true" (case insensitive), this method will return true. If closeDriverAfterSuite is null or empty, this method will default to true. When true, this property will make the FAST framework close any browser windows it opened during execution of a FastXml
        Returns:
        true if the closeDriverAfterSuite property is set to "true" (case insensitive). Otherwise, this method will return false
        Since:
        1.0.0
      • setCloseDriverAfterTestSuite

        public void setCloseDriverAfterTestSuite​(java.lang.String closeDriverAfterSuite)
        Set closeDriverAfterSuite property
        Parameters:
        closeDriverAfterSuite - The value
        Since:
        1.0.0
      • getWebElementWait

        public java.lang.String getWebElementWait()
        Returns the value of the webElementWait property. This property determines how many seconds the FAST Framework will wait up to for elements to exist before attempting to interact with them. If this field is not specified, or is a non integer, this field will default to "3".
        Returns:
        The webElementWait value
        Since:
        1.0.0
      • setWebElementWait

        public void setWebElementWait​(java.lang.String webElementWait)
        Set webElementWait property
        Parameters:
        webElementWait - The number of seconds the FAST Framework should wait until an element exists before giving up.
        Since:
        1.0.0
      • getBrowserLoops

        public java.lang.String getBrowserLoops()
        Returns the value of the browserLoops property. This property determines how many times the FAST Framework will loop through the open browser windows while attempting to find an element. If this field is not specified, or is a non integer, this field will default to "3".
        Returns:
        The browserLoops value
        Since:
        1.0.0
      • setBrowserLoops

        public void setBrowserLoops​(java.lang.String browserLoops)
        Set browserLoops property
        Parameters:
        browserLoops - The browserLoops value
        Since:
        1.0.0
      • getRetryAttempts

        public java.lang.String getRetryAttempts()
        Returns the value of the retryAttempts property. This property determines how many times the FAST Framework will attempt to find an element within a specific browser window. If this field is not specified, is a non integer, this field will default to "3".
        Returns:
        The retryAttempts value
        Since:
        1.0.0
      • setRetryAttempts

        public void setRetryAttempts​(java.lang.String retryAttempts)
        Set retryAttempts property
        Parameters:
        retryAttempts - The browserLoops value
        Since:
        1.0.0
      • getSendStatuses

        public boolean getSendStatuses()
        Returns the value of the sendStatuses property. If true, the FAST Framework will attempt to sends statuses to eFast during execution.
        Returns:
        The sendStatuses value
        Since:
        1.0.0
      • setSendStatuses

        public void setSendStatuses​(java.lang.String sendStatuses)
        Set sendStatuses property
        Parameters:
        sendStatuses - The sendStatuses value
        Since:
        1.0.0
      • getDetailedResultFolder

        public java.lang.String getDetailedResultFolder()
        Returns the filepath of the detailedResultFolder
        Returns:
        The detailedResultFolder
        Since:
        1.0.0
      • setDetailedResultFolder

        public void setDetailedResultFolder​(java.lang.String detailedResultFolder)
        Sets detailed result folder.
        Parameters:
        detailedResultFolder - the filepath to the detailed result folder
        Since:
        1.0.0
      • getTempStartTime

        public java.util.Date getTempStartTime()
        Returns a start time set from the most recent fastXml. If no start time had been set, the current date time is returned
        Returns:
        A date
        Since:
        1.0.0
      • setTempStartTime

        public void setTempStartTime​(java.util.Date tempStartTime)
        Sets tempStartTime value. This field is to create part of the resultsFolder name.
        Parameters:
        tempStartTime - A date
        Since:
        1.0.0
      • getFastDriver

        public FastDriver getFastDriver()
        Returns the FastDriver currently being used by the FAST Framework
        Returns:
        The current FastDriver
        Since:
        1.0.0
      • setFastDriver

        public void setFastDriver​(FastDriver fastDriver)
        Sets fastDriver.
        Parameters:
        fastDriver - A fastDriver
        Since:
        1.0.0
      • getRuntimeReferences

        public java.util.Map<java.lang.String,​java.lang.String> getRuntimeReferences()
        Returns a map of the references created while executing the FAST Framework
        Returns:
        A map of references
        Since:
        1.0.0
      • setRuntimeReferences

        public void setRuntimeReferences​(java.util.Map<java.lang.String,​java.lang.String> runtimeReferences)
        Sets runtimeReferences
        Parameters:
        runtimeReferences - A map of reference names and values
        Since:
        1.0.0