The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Ranorex Test Execution Plugin

ranorex: Run a Ranorex test suite

  • cmdLineArgs (optional)
    Allows you to add Ranorex command line arguments. Some of the most important ones include:
    Flag Function
    config | cfg:<config parameter name>=<value>  Set values for configuration parameters.
    reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer>  Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120
    testcase | tc:<name or guid of test case> Runs this test case only.
    testsuite | ts:<path to test suite file> Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>.
    module | mo:<module name or guid> Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched.
    testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> Creates or overrides values for testcase parameters specified in the test suite.
    runlabel | rul:<custom value> Sets a custom runlabel for the test run.
    testcasedatarange | tcdr:<name or guid of test case>=<data range> Sets the data range for a testcase.
    • Type: String
  • rxGlobalParameter (optional)
    Allows you to create or override values for global parameters set in the test suite. Enter parameters according to the following pattern: "ParameterName=Value" Separate parameters with semicolons or add one parameter per line.
    • Type: String
  • rxJUnitReport (optional)
    • Type: boolean
  • rxReportDirectory (optional)
    Allows you to specify the directory that your report will be saved to. If no path is specified, the location of your Ranorex Test Suite file will be used.
    • Type: String
  • rxReportExtension (optional)
    • Type: String
  • rxReportFile (optional)
    Allows you to specify the file name of the report with the standard placeholders available in the test suite settings. By default, the following pattern is used (%S_%Y%M%D_%T).
    • Type: String
  • rxRunConfiguration (optional)
    Runs the test suite using one of the run configurations available in the test suite. Enter the exact name of the run configuration you want to use. By default, the run configuration currently selected in the test suite is used. If you want to create or edit run configurations, please use Ranorex Studio or the Ranorex Test Suite Runner.
    • Type: String
  • rxTestRail (optional)
    Reports the test run results to TestRail via API. Requires 'Test Rail User' and 'Test Rail Password'.
    • Type: boolean
  • rxTestRailPassword (optional)
    Password or API key for the user specified in 'Test Rail User'.
    • Type: String
  • rxTestRailRID (optional)
    (Optional) The identifier of an existing test run in TestRail to report test results to. Without this argument a new test run is created.
    • Type: String
  • rxTestRailRunName (optional)
    (Optional) Creates a new test run in TestRail with the specified name to report test results to. Without this argument the default name is used.
    • Type: String
  • rxTestRailUser (optional)
    Email used to sign in to TestRail.
    • Type: String
  • rxTestSuiteFilePath (optional)
    Enter the path to the test suite file (*.rxtst) located in the output folder of your solution.
    • Type: String
  • rxZippedReport (optional)
    Compresses the report and the associated files into a single archive with the .rxzlog extension. The following additional input fields will appear when this option is enabled:
    • Compressed report directory
    • Compressed report file name
    • Type: boolean
  • rxZippedReportDirectory (optional)
    Allows you to specify the directory that your compressed report will be saved to. If no path is specified, the location of your Ranorex Test Suite file will be used.
    • Type: String
  • rxZippedReportFile (optional)
    Allows you to specify the file name of the compressed report with the standard placeholders available in the test suite settings. If no filename is specified, the same name as the "Ranorex Report File Name" is used.
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.