19 Utility Reference

Learn how to use the stap utility to perform actions in Oracle Communications Solution Test Automation Platform (STAP).

STAP uses the stap utility to perform various actions. The help command provides a comprehensive list of all commands within STAP. Running the help displays each command's name alongside a brief description of its function.

To retrieve information on how to run actions in STAP, run the following command in your home directory:

./stap --help

The help command provides the information required to perform various actions in STAP in its output.

./stap --help
=============================================================
Solution Test Automation Platform CLI
Version : versionNumber
=============================================================
Usage: stap --service -command [parameters]
 
Options:
 
--version
--help
--automation
        -compile
                  workspace
                  scenarios
                  generate
                  config
        -run
                  workspace
                  scenarios
                  tags
                  caseTags
                  config
                  mode
--publish
        -action
                  workspace
        -environment
                  workspace
        -scenario
                  workspace
--simulation
        -run
                  workspace
        -compile
                  workspace
--secure
        -environment
                  filepath
                  keyfilepath
                  keystorepass
                  aliasname

Parameters

--version

Displays the STAP version information.

--help

Shows documentation and help information about the stap utility commands. Optionally, you may specify a service or a specific command for more targeted help.

--automation

Indicates automation client operations.

-compile

Compiles the specified automation scenarios.

workspace

Specifies the STAP workspace location as a valid folder path. The default value is the current directory.

scenarios

Indicates one or more scenarios to compile or run. It accepts a list of values. The default value is either empty (to compile) or selected scenarios as per configuration or tags (to run).

generate

Specifies whether to generate result files from the compilation. Valid values are NO, YES, or MERGE.

config

Provides the file path for compile configuration as a valid file path.

-run

Runs the specified automation scenarios.

tags

Selects scenarios that match the specified tags. It accepts a list of values and belongs to the Scenario Selection group.

caseTags

Selects test cases that match the specified tags. It depends on the value of tags and accepts a list of values.

mode

Defines the execution mode. Possible values are trail or execute.

--publish

Enables the publish action for scenarios, environment, or workspace.

-action

Performs the publish action.

-environment

Carries out the environment publish action.

-scenario

Performs the publish action for a scenario.

--simulation

Executes a simulation.

-run

Runs a simulation publish action.

-compile

Compiles a simulation publish action.

--secure

Performs environment simulation with secure parameters.

-environment

Executes publishing in a secure environment.

filepath

Specifies the path to the JCEKS file, which must be a valid folder path and is mandatory.

keyfilepath

Supplies the path to the .properties file containing the data to be encrypted; this is a mandatory valid folder path.

keystorepass

Provides the keystore password, which must be supplied as a valid folder path and is mandatory.

aliasname

Identifies the secret key using an alias name; this is a mandatory value.