19 Creating an Automation Workspace Folder

This chapter describes the various components of the Automation Workspace folder in Oracle Communications Solution Test Automation Platform.

Topics in this chapter:

• Configuration Folder
• Environments Folder
• Results Folder
• Context Folder
• Scenarios Folder

Configuration Folder

The configuration folder contains the primary configuration file titled config.properties. This file contains all the configuration required to run STAP.

Note:

Configurations not related to config.properties should be created under the configuration folder in their respective folders.

The following is the setup for the configuration folder:

#-------------------------------------------------------------------------------
# STAP Environment Configuration
# Version 1.2.0
#-------------------------------------------------------------------------------
# Scenarios location
scenarios.home=${WORKSPACE}/scenarios
 
#-------------------------------------------------------------------------------
# Environment configurations location
environments.home=${WORKSPACE}/config/environments
 
#-------------------------------------------------------------------------------
# Execution configurations location
execution.Config.file=${WORKSPACE}/config/execution/execution.config.json
#-------------------------------------------------------------------------------
# Actions location
actions.home=LOAD_FROM_LIBRARY
#
#actions.home=${WORKSPACE}/actions
 
#-------------------------------------------------------------------------------
# Results storage location
#results=results
results.home=${WORKSPACE}/results
results.publish=NO
#results.publish.file=C:\software\Servers\apache-Server-1\webapps\STAPReports\reports\SE2EReports\results.js
#-------------------------------------------------------------------------------
# Context Configuration
#-------------------------------------------------------------------------------
# Context Storage Location
context.home=${WORKSPACE}/context
# Scenario Context
# Load Context for the test case
# Default NO
context.load=NO
context.save=NO
# Global Context
context.global.load=NO
context.global.save=NO
#-------------------------------------------------------------------------------
engine.configuration=${WORKSPACE}/config/engine.config.properties
#-------------------------------------------------------------------------------
 
 
 #-------------------------------------------------------------------------------
 # JMeter Configuration
 #-------------------------------------------------------------------------------
 # JMeter threads
 tools.jmeter.thread=4000
 # JMeter rampup(seconds)
 tools.jmeter.rampup=150
 # JMeter result location
 tools.jmeter.results.home=${WORKSPACE}/results/tools/jmeter
  
 #-------------------------------------------------------------------------------
 # Plugin Configuration : INTERNAL
 # List of Supported Plugins : REST,SOAP,SSH,Kafka
 #-------------------------------------------------------------------------------
 plugin.internal=REST,SOAP,SSH,Kafka
 #-------------------------------------------------------------------------------
 # Plugin Configuration : CUSTOM
 # Provide plugin configuration in config/plugin folder
 #-------------------------------------------------------------------------------
 #plugin.custom=
  
 #-------------------------------------------------------------------------------
 # Attribute Home
 # Provide location to load attribute data
 #-------------------------------------------------------------------------------
 attributeData.home=${WORKSPACE}/config/attributeData

Environments Folder

The environments folder contains the various testing environments in STAP. This folder is a subfolder under the configuration folder. You create the environments folder under the configuration folder and create folders for each separate environment. Under each environment folder, create individual files for each product API.

The following is the configuration for adding the environment details in the config.properties folder:

#-------------------------------------------------------------------------------
# Environment configurations location
#-------------------------------------------------------------------------------
environments.home=${WORKSPACE}/config/environments

Results Folder

Results of the test run are stored in the results folder. The path to this folder can either be relative to your workspace or a direct path to store the results outside your workspace.

The results of each test run are created under this folder with its relative timestamp. The format of this timestamp is $results/<timestamp>. To view the execution report, you open the report.html file.

The following is the configuration for adding the result details in the config.properties folder:

#-------------------------------------------------------------------------------
# Results storage location
#-------------------------------------------------------------------------------
results.home=${WORKSPACE}/results

Context Folder

The context folder stores the data of previous steps, enabling the simulation of scenarios where only the current step needs execution. This eliminates the need to repeatedly run prior steps, as the context provides the necessary values for the current step.

You configure the location of the context folder in config.properties.

The following is the configuration for adding the context details in the config.properties folder:

#-------------------------------------------------------------------------------
# Context Configuration
#-------------------------------------------------------------------------------
# Context Storage Location
context.home=${WORKSPACE}/context
 
#- Local Context. Load context while running. values : YES/NO
context.load=NO
#- Local Context. Save context for a scenario for debug. values : YES/NO
context.save=NO
 
# Global Context. Sharing data across scenarios.
context.global.load=NO
context.global.save=NO

Scenarios Folder

The scenarios folder contains the different scenarios to be run. Each scenario is stored in a separate folder within this folder.

Figure 19-1 displays the scenarios folder structure.

Figure 19-1 Scenarios Folder Structure

Description of "Figure 19-1 Scenarios Folder Structure"

The following is the configuration for adding the scenario details in the config.properties folder:

#-------------------------------------------------------------------------------
# Scenarios location
#-------------------------------------------------------------------------------
scenarios.home=${WORKSPACE}/scenarios

For more information, see Creating Scenarios.