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.

BMC AMI DevX Total Test

View this plugin on the Plugins site

totaltestUT: Total Test - Execute unit tests

  • connectionId : String
    This field specifies the host connection to use to execute on.

    Host connections can be configured in the Jenkins system configuration (Manage Jenkins -> Configure System).
  • credentialsId : String
    The available credentials to use for logging onto the host. Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
  • projectFolder : String
    The path to the Total Test project folder containing the test scenario or test suite to run.
  • testSuite : String
    A comma separated list of Total Test test scenarios/suites names. On Windows the names are case-insensitive.

    Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.

  • jcl : String
    The name of the JCL file to run the Total Test test scenario or test suite.
  • ccClearStats : boolean (optional)
    Indicates if the Code Coverage repository statistics should be cleared before running the test.
  • ccDB2 : boolean (optional)
  • ccPgmType : String (optional)
    The type of the program specified on the EXEC statement, in the JCL, for the Total Test step. If PGM=IKJEFT01 was specified, select "Live DB2". When PGM=DFSRRC00 was specified select "Live IMS", otherwise select TotalTest.
  • ccRepo : String (optional)
    The dataset where Total Test will write coverage information. This dataset will later be fed into the Code Coverage reporting system. Members with like systems, names, and compile date and times will automatically be merged together.
  • ccSystem : String (optional)
    A system name for this test. Code Coverage keeps statistics by programs separate by system name. This name can be any-specified name. The name must be 16 characters or less and will be converted to upper-case when the test is run.s. If not specified defaults to the test scenario/suite name.
  • ccTestId : String (optional)
    A test identification to be added to the Code Coverage test. This information can be useful when reviewing test reports from Code Coverage. This test identification can be any-specified string. The test identification must be 16 characters or less and will be converted to upper-case when the test is run. If not specified defaults to the test scenario/suite name.
  • deleteTemp : boolean (optional)
    Delete temporary files after test run. The default is to delete temporary files.
  • hlq : String (optional)
    Optional high level qualifier to be used when allocating datasets.
  • hostPort : String (optional)
  • recursive : boolean (optional)
    Indicates if the test runner should recursively check for Total Test Unit Test projects. The default is not to recursively check for Total Test Unit Test projects..
  • useStubs : boolean (optional)
    Indicates if stubs should be used when running the test scenario or test suite. The default is to use stubs.

totaltest: Total Test - Execute Total Test scenarios

  • environmentId : String
    Environment ID of the environment defined in the Total Test repository server or local TotalTestConfiguration directory where tests are executed.
  • folderPath : String
    • Folder path to the test scenario or context file(s) to execute (.xactx or .xaunit)
    • A relative path or an empty string will set the folder path relative to the Jenkins workspace directory
    • An absolute path can also be used to specify Test folder path
  • serverUrl : String
    This field specifies the CES URL where the Total Test repository server is published on.

    The CES URL can be configured in Jenkins system configuration (Manage Jenkins -> Configure System -> BMC Configurations -> Host Connections).
  • serverCredentialsId : String
    The available credentials to use for logging onto CES (used only when using the Total Test repository server). Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
  • connectionId : String
    This field specifies the host connection to use to execute on.

    Host connections can be configured in the Jenkins system configuration (Manage Jenkins -> Configure System).
  • credentialsId : String
    The available credentials to use for logging onto the host. Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
  • sonarVersion : String (optional)
    SonarQube version 5 or 6
  • logLevel : String (optional)
    Set the logging level to be used when executing the test.
  • accountInfo : String (optional)
    Optional job account information.

    Use the accounting information field to enter an account number and any other accounting information that your installation requires.
    The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.

  • ccThreshold : int (optional)
  • clearCodeCoverage : boolean (optional)
  • collectCCRepository : String (optional)
  • collectCCSystem : String (optional)
  • collectCCTestID : String (optional)
  • collectCodeCoverage : boolean (optional)
    Select this option to collect Code Coverage information during test execution.
  • compareJUnits : boolean (optional)
  • contextVariables : String (optional)
    Execution context variable in the format "field1=value1,field2=value2".
  • createJUnitReport : boolean (optional)
  • createReport : boolean (optional)
  • createResult : boolean (optional)
  • createSonarReport : boolean (optional)
  • customerId : String (optional)
    BMC customer id for use on the BMC cloud license server.

    This is required for obtaining a license from the BMC license server.
  • enterpriseDataHostPort : String (optional)
    This field allows you to specify the host and port of the Enterprise Data Communication Manager to connect to. The host and port must be separated by a ':' character.
  • enterpriseDataWorkspace : String (optional)
    The BMC AMI DevX Data Studio Communication Manager's workspace.
  • haltAtFailure : boolean (optional)
  • haltPipelineOnFailure : boolean (optional)
  • jclPath : String (optional)
    The path to the JCL file to use when executing '.testscenario' files.
  • jsonFile : String (optional)
    Optional JSON file containing tests to execute.

    Use the JSON file field to enter a JSON file containing the tests to execute.
    Note: This field is only used for Total Test CLI version 20.04.01 and later

  • localConfig : boolean (optional)
    When selected use the defined local TotalTestConfiguration directory. Otherwise use the Total Test repository server running on the CES server.
  • localConfigLocation : String (optional)
    Optional location of TotalTestConfiguration directory.

  • programList : String (optional)
    Optional comma separated list of tests tests to execute.

    Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
    Note: This field is only used for Total Test CLI version 20.04.01 and later

  • recursive : boolean (optional)
    Should test scenarios be found recursively in the folder
  • reportFolder : String (optional)
    The folder path containing produced test results vary depending on the Total Test CLI version.
    • Total Test CLI version 20.03.01 and later
      • The Report Folder field will be ignored.
      • The produced test result will be contained in the Output directory relative to the Test folder path.
      • Junit and Sonar report files are copied to TTTUnit and TTTSonar folders in the Jenkins workspace.
    • Total Test CLI version prior to 20.03.01
      • The produced test results will be contained in this folder path.
      • Default folder path is TTTReport.
      • Relative folder paths are relative to the Jenkins workspace.
      • An absolute path can also be used to specify Report folder.
    Note: This field is only used for Total Test CLI version prior to 20.03.01
  • selectEnvironmentRadio : String (optional)
  • selectProgramsOption : boolean (optional)
  • selectProgramsRadio : String (optional)
  • siteId : String (optional)
    BMC customer's site id for use on the BMC cloud license server.

    This is required for obtaining a license from the BMC license server.
  • sourceFolder : String (optional)
    Optional file path to a folder that contains source code of tested programs.
    Default is COBOL.
    It is only used to set the source path.
  • stopIfTestFailsOrThresholdReached : boolean (optional)
    Stop if test fails or threshold is reached (default is true)
  • uploadToServer : boolean (optional)
  • useEnterpriseData : boolean (optional)
  • useScenarios : boolean (optional)
    Should .scenarios files be used instead of .context files

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.