Runs

6 minute read

Runs summarizes each workflow run for a selected component. Select a run to display details such as the logs for each workflow step. If a run included testing or the generation of evidence data, test results and published evidence are also available in the run details.

Runs summary

The Runs feature lists workflow runs based upon permissions. The Runs list updates every time a new run starts or a run status changes.

To access and filter workflow runs:

  1. Select Up/down arrows, and then select an organization, sub-organization, or component.

  2. Select Runs on the left pane to display the list of its associated runs by commit name or event name, if not a commit.

  3. (Optional) Select Filter and then select an option to filter the runs list.

  4. (Optional) Search for a specific run, by entering all or part of the commit or workflow name into Search.

  5. (Optional) Select Sort down or Sort up next to Branch / Pull request or Completion date / Run duration to sort using either column.

You are displaying workflow runs, listed according to any searching, filtering, or sorting performed.

Runs
Figure 1. An example run summary
  1. Filter list by:

    • Component - Organization and sub-organization only

    • Branch/PR

    • Workflows

  2. Use the search to locate specific runs.

  3. Sort the runs by column: Branch/pull request and Completion/Run duration.

  4. Run details: Select the commit name, or in the case of a manual trigger, the workflow name, of a run from the run summary to access its run details.

  5. Components summary: Select the component name link to access the workflow component summary information.

  6. Workflow composer: Select the workflow name link in the triggered by field to edit the workflow.

Run details

Run details provides a comprehensive summary of each run executed in the CloudBees platform, including logs of each workflow step, any evidence generated for compliance requirements, and results of any tests run as part of the workflow.

To access the details of a run, select the commit name, or in the case of a manual trigger, the workflow name, of a run from the Runs summary.

Run details screen top information
Figure 2. Example information at the top of Run details.

The example above displays the following information in Run details:

  1. Repository and branch names.

  2. Run management options:

    • Select Rerun workflow to rerun a workflow without a commit (within 7 days of the original run).

    • Select New run to run a workflow without a commit (manual trigger only).

    • Select Stop run to cancel a run while it is executing.

  3. The run number and the status:

    • Processing

    • Successful

    • Failed

  4. Triggered by: If the run is manually triggered, the user who triggered it is named.

  5. Run times:

    • Start date and time

    • End date and time

    • Duration

  6. Two views:

    • The Jobs view displays the workflow steps, the logs, and any evidence generated.

    • The Test results view displays results of testing performed during the run.

Logs

The Jobs view in Run details displays an overview of all workflow steps and detailed logs for each step.

To access the logs for a run:

  1. Select the commit name, or in the case of a manual trigger, the workflow name, of a run from Runs.

  2. Select the Jobs tab, and then select the Logs tab.

The run log is displayed accordingly.

Run logs
Figure 3. Example run with log details.

As in the example above, Logs includes the following options:

  1. Select Composer icon to display/hide the workflow composer visual tool.

  2. Select the Logs tab to display the logs.

    To display published evidence data, select the Evidence tab.

    In the Logs view:

  3. Enter text to Search within the log. Select Select up icon and Select down icon to step through the log and highlight found instances. Select to clear the search.

  4. Select Expand all/Collapse to expand/collapse logs for all steps.

  5. Select Vertical ellipsis, and then:

    • Select Show timestamps or Hide timestamps to display or hide, respectively, the timestamp next to each log line number.

    • Select Download log to download a compressed archive file of the log.

  6. Select Arrow down icon next to any run step to display its log.

  7. Select Go to end to scroll down to the end of a step log or the list of steps.

Evidence

To fulfill compliance requirements, configure workflows to publish run evidence information. First, add an evidence step to a workflow. Run the workflow and then view the evidence in Run details.

To capture and publish run evidence data:

  1. Add a step to a workflow that calls the Publish evidence items action.

    The Publish evidence items action accepts as an input a Markdown text block that can include system property references such as ${{ cloudbees.run_id }} or ${{ vars.api_endpoint }}.
  2. Run the workflow.

  3. Select the commit name, or in the case of a manual trigger, the workflow name, of the run from the run summary to display Run details for the run.

  4. Select the Evidence tab in the Jobs view.

    evidence tab
    Figure 4. Example evidence output from a workflow run.
  5. (Optional) Perform any of the following, as in the above example:

    1. Switch between raw and formatted output.

    2. Download a TXT file of the output.

    3. Copy the output.

The captured run evidence is displayed in the Evidence tab of the Run details Jobs view.

Test results

The Test results view in Run details provides a detailed overview of test suites and test cases executed in a workflow run. This feature allows users to view all test suites and their associated test cases in one location.

A red indicator appears on the Test results tab if a test suite contains failed test cases. A list of test suites and test cases are displayed in the order: Failed, skipped, and passed.

Users can switch between two views: Test suites and Test cases.

The Test suites view displays the following information:

  • Total number of test cases in a test suite.

  • Number of passed, failed, and skipped test cases.

  • Individual test cases, along with their status and related logs.

The test case status is color-coded as mentioned in the table below:

Table 1. Color-coding test cases based on status
Test case status Color

Total test cases

Blue

Passed

Green

Failed

Red

Skipped

Orange

Select a number to view detailed information about the test cases in a test suite.

The Test cases view provides the following information:

  • The test suite associated with each test case.

  • Current status of each test case: Passed, failed, or skipped.

  • Log information of each case, if available.

View test suite details

To view the test result by test suites:

Select Test results in Run details. The Test suites view displays by default. Optionally, use the search option to locate a specific test suite.

test suites tab
Figure 5. Test suites view
  1. Indicates that one or more test cases have failed.

  2. Name of the test suite associated with the run.

  3. Select a number listed under one of the options (Total test cases, passed, failed, or skipped) to view details of test cases filtered by that option.

    • Select the number under Total test cases to view all the test cases that passed, failed, and skipped.

    • Select the number under Total cases passed to view only passed test cases.

    • Select the number under Total cases failed to view only failed test cases.

    • Select the number under Total cases skipped to view only skipped test cases.

      Selecting the number under the corresponding column displays the test cases in a detailed view along with the option to view the log.

      test suites detailed view
      Figure 6. Test cases in a test suite based on status
  4. Time taken (in seconds) to run all test cases in the test suite.

View test case details

To view the test results by test cases:

Select Test cases to view the data specific to test cases. Optionally, you can use the search option to locate a specific test case.

test cases tab
Figure 7. Test case view
  1. Name of the test case in the test suite.

  2. Name of the test suite in which each test case is included.

  3. Status of the test case associated with the run: Passed, failed, or skipped.

  4. Time taken (in seconds) to run each test case.

  5. Select View log to access the log.

  6. Total number of test cases in the run, including passed, failed, and skipped test cases.

View logs

Use the View log option to access the log information of a specific test case. The logs are available for failed test cases. For passed and skipped test cases, the No log reported text appears.

Log of failed test case
Figure 8. Log of failed test case