Skip to content

Getting Started

Here's a detailed breakdown of the process:

  1. Executing Commands with Parameters: You will use the ./slickagent command followed by specific subcommands and parameters. The source provides examples for two main actions: creating a run and importing a file.
    • Creating a Run: To initiate a test run in TestSlick, you use the init subcommand with the following parameters:
      sh
      ./slickagent init -u=<your_username> -p=<your_password> -o=<your_organization> -pr=<your_project> -r=<your_release>
      • -u: Specifies the username for authentication.
      • -p: Specifies the password for authentication.
      • -o: Specifies the target organization in TestSlick.
      • -pr: Specifies the target project in TestSlick.
      • -r: Specifies the repository under which the tests will be associated. This command will interact with the TestSlick API and, upon successful execution, will return a runId. This runId is crucial for associating subsequent file imports with this specific test run.
    • Importing a File into a Test Run: Once you have a runId, you can import a test results file using the following command structure:
      sh
      ./slickagent -mode=CI -u=<your_username> -p=<your_password> -o=<your_organization> -pr=<your_project> -r=<your_release> -file=<path_to_your_test_file> -runId=<the_run_id_obtained_earlier>
      • -mode=CI: Explicitly sets the agent to run in CI mode.
      • -u: Specifies the username for authentication.
      • -p: Specifies the password for authentication.
      • -o: Specifies the target organization in TestSlick.
      • -pr: Specifies the target project in TestSlick.
      • -r: Specifies the repository under which the tests are associated.
      • -file: Specifies the path to the test results file that you want to upload and process. You can import a JUnit XML format file. The actual path will depend on where your test results file is located in your CI environment.
      • -runId: Specifies the ID of the test run that you want to import the results into. This should be the runId returned by the init command.
  2. Authentication: As seen in the examples, both creating a run and importing a file require the -u (username) and -p (password) parameters for authentication. The agent will obtain an authentication token using these credentials, which will then be used to authorize its requests to the Sync Slick and TestSlick APIs.
  3. Viewing Available Parameters and Flags: If you need to see a complete list of all available parameters and flags for the slickagent executable, you can use the help command:
    sh
    ./slickagent help
    This will display information about all the available options for both interactive and CI modes.