runOpkeyTests
- Rajashekar.Gaddi
- Chandresh Patel
Opkey is a no-code continuous testing platform for web, mobile, and ERP applications. It enables businesses to automate test case generation, accelerate regression cycles, enhance test coverage, and reduce costs. Recognized by industry analysts like IDC, Gartner, and Forrester, Opkey is transforming the future of test automation.
FlexDeploy's runOpkeyTest operation enables seamless Opkey integration, allowing teams to execute test suites and review results directly within FlexDeploy. This integration streamlines testing within CI/CD pipelines, ensuring software quality and faster delivery.
Test Instance Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Opkeyone Server URL |
| Yes | Provide Opkeyone server URL. (ex: |
Opkey User Name |
| Yes | Provide Opkey username. |
Opkey Password |
| Yes | Provide Opkey password. |
Opkey CLI jar path |
| Yes | Provide Opkey jar path. (ex: |
Inputs
Property Name | Property Code | Required | Description |
|---|---|---|---|
Opkey Project Name |
| Yes | Provide the Opkey project name. |
Opkey Test Suite Path |
| Yes | Provide the Opkey test suite path. (ex: |
Opkey Agent Name |
| Yes | Provide the agent name. (ex: |
Opkey Plugin Name |
| Yes | Provide the plugin name. (ex: |
Opkey Additional Arguments |
| No | Provide any additional arguments. If you want to pass Global Variables then you can do something like
|
Outputs
Output Name | Description |
|---|---|
| Test suite status |
| Total Test count |
| Total successful Test count |
| Total failure Test count |
| Total skiped Test count |
Artifacts
This operation doesn’t consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the target.
Endpoint Execution
This operation will execute on all of the selected endpoints and will execute on each of the selected endpoints.
Additional Information
Using global variables in FlexDeploy Opkey Plugin
Credential information and other dynamic data for your test cases are often passed at runtime to enhance security or accommodate frequently changing values. This approach eliminates the need to modify test cases once they’ve been created. To streamline this process, Opkey provides an option to pass these values through a parameter called the --global variable.
Let’s look at an example of how this can be applied in FlexDeploy.
Before running the test suite, make sure you’ve created global variables in Opkey that can be mapped to your test cases. These global variables are defined within Opkey and allow you to dynamically pass values at runtime during test execution. In this example, FSMUserName and FSMPassword are global variables used to store a user’s login credentials, which can then be referenced in your test cases.
The FlexDeploy Opkey Plugin (runOpkeyTest operation) has a input option called Additional Arguments, which enables you to pass extra commands, including global variables, to the Opkey test during execution. If you are using out of box Opkey-runOpkeyTests, you can define the workflow inputOPKEY_INP_ADDITIONAL_ARGUMENTS for this purpose.
FlexDeploy supports referencing property values configured at Project, Target or Integration Instance levels. In FlexDeploy YAML configuration, setting groovy: true treats the value as a Groovy expression, which is evaluated before being passed to test workflow. This feature allows you to directly reference the current target properties (Deploy or Utility execution target group) without needing to qualify them, streamlining the process.
However, when dealing with sensitive information such as passwords, you should avoid evaluating these values, as they would otherwise be exposed in clear text. Instead, these sensitive values should be passed as environment variables, which requires qualifying the property with either the Target Group Code or Integration Instance Code, depending on where the property is configured. Note that this applies to any other property that you want to reference as an environment variable.
For example, if you have a Cloud Account configured in FlexDeploy with properties for username and password, you can dynamically reference these properties and prefix them with the Integration Instance account code. This ensures that credentials are securely passed during test or deployment execution without exposing sensitive information.
Windows Example
---
testName: Opkey Demo
description: Generated Opkey Test
workflow:
name: Opkey-runOpkeyTests
inputs:
- code: OPKEY_INP_PROJECT_NAME
value: Flexagon
- code: OPKEY_INP_TEST_SUITE_PATH
value: 'Project Workspace/FSM/FSM Validate'
- code: OPKEY_INP_AGENT_NAME
value: utlwt01
- code: OPKEY_INP_PLUGIN_NAME
value: OracleFusion
- code: OPKEY_INP_ADDITIONAL_ARGUMENTS
groovy: true
value: '"--global-variable FSMUserName=%" + FDFSM_CLOUD_ACCOUNT_CODE + "_FDFSMACCT_USERNAME%,FSMPassword=%" + FDFSM_CLOUD_ACCOUNT_CODE + "_FDFSMACCT_PASSWORD%"'
- code: TEST_INSTANCE
value: OPKEYTEST Linux Example
Note use of \ to escape $ character in Groovy.
---
testName: Opkey Demo
description: Generated Opkey Test
workflow:
name: Opkey-runOpkeyTests
inputs:
- code: OPKEY_INP_PROJECT_NAME
value: Flexagon
- code: OPKEY_INP_TEST_SUITE_PATH
value: 'Project Workspace\FSM\FSM Validate'
- code: OPKEY_INP_AGENT_NAME
value: utlwt01
- code: OPKEY_INP_PLUGIN_NAME
value: OracleFusion
- code: OPKEY_INP_ADDITIONAL_ARGUMENTS
groovy: true
value: '"--global-variable FSMUserName=\$" + FDFSM_CLOUD_ACCOUNT_CODE + "_FDFSMACCT_USERNAME,FSMPassword=\$" + FDFSM_CLOUD_ACCOUNT_CODE + "_FDFSMACCT_PASSWORD"'
- code: TEST_INSTANCE
value: OPKEYTEST Test-Suite Execution Guide
Related content
- style