Skip to content

Latest commit

 

History

History
179 lines (143 loc) · 12 KB

README.md

File metadata and controls

179 lines (143 loc) · 12 KB
Raw

firewatch

Thank you for your interest in the firewatch project! Please find some information about the project below. If you are looking for more information, please see the additional documentation below:

Features

  • Automatically creates Jira issues for failed OpenShift CI jobs.
    • The issues created are provided with any logs or junit files found in a failed step.
    • The issues can be created in any Jira instance or project (provided the proper credentials are supplied).
    • If multiple issues are created for a run, the issues will all be related to each other to help with issue.
    • The issues created have a "classification" section that is defined by the user in their firewatch config.
      • This can be used as a "best-guess" for what may have gone wrong during the job's run.
    • Firewatch will search for any past issues created by a specific step that has failed in the same way (pod failure or test failure) and list the 10 most recent ones.
      • This is meant to help the engineer working on the bug to find a solution.
      • If verbose test failure reporting is enabled, this search is refined further to only search for issues with the same test failure.
    • Firewatch searches for duplicate issues and makes a comment on the issues rather than filing a second issue.
      • This is done using the labels on issues created by firewatch. These labels should consist of the failure type, failed step, and the job name.
      • If the new failures matches the failure type, failed step, and job name; firewatch will make a comment notifying the user that this failure likely happened again.
      • If verbose test failure reporting is enabled, this search is refined further to only search for issues with the same test failure.
    • If no failures are found, firewatch will search for any open issues on the Jira server provided and add a comment to the issue mentioning that the job has passed since that issue was filed.
      • This functionality also uses the labels on issues created by firewatch.
      • Note: If you get a notification on an issue, but would like to continue working on the issue without getting notifications, add the ignore-passing-notification label to the issue.
    • Firewatch can optionally be configured to report successful runs by defining the "success_rules" section in the config.
      • For each rule in this section, a Jira story will be created (with status closed) reporting the job success.
    • Firewatch can optionally be configured to report test failures in a more verbose way (verbose test failure reporting).
      • When configured to do this, firewatch will report on EVERY test failure in all JUnit files. The issues created from this will specify the failed test name in the title and description.
      • This functionality has the potential to create A LOT of tickets if cascading failures occur. Because of this, firewatch is configured by default to only report up to 10 test failures per run. This value can be overridden, but do so with caution.
    • Firewatch will add any additional labels listed in the file provided in the --additional-labels-file argument to any bug created. Each label must be separated by a new line.
      • How to add a label to a file: echo "some-label" >> $SHARED_DIR/firewatch-additional-labels
      • This should be used if you'd like to dynamically add labels based on parameters that can only be determined during test execution in OpenShift CI.

Getting Started

Jira User Permissions

Firewatch can be used with any user in a Jira instance, but that user will need to have proper permissions in the project they are reporting to. The user should be able to:

  • Create issues
  • Add comments to issues
  • Add attachments to issues
  • Edit issues
  • Transition issues (this only happens when a "success" issue is created, then immediately closed)

If you are using firewatch in the Red Hat Jira instance, the default user is firewatch-tool.

If you are encountering permissions issues, please add the user to the project you are reporting to under the role you would like to choose. Typically, if you add the user in the Developer role, the tool will work as expected.

Usage in OpenShift CI

Reporting issues using this tool in OpenShift CI is very simple, you can do one of the following:

Remember, when you are using the firewatch-report-issues ref, some variables need to be defined in your configuration file:

  • FIREWATCH_CONFIG [REQUIRED]

    • This value should be a list of rules you have defined for firewatch to report on.

    IMPORTANT:

    For more information how to define these rules, please see the configuration guide.

    • Example:

      FIREWATCH_CONFIG: |
  {
    "failure_rules":
      [
          {"step": "exact-step-name", "failure_type": "pod_failure", "classification": "Infrastructure", "jira_project": "!default", "jira_component": ["some-component"], "jira_assignee": "some-user@redhat.com", "jira_security_level": "Restricted"},
          {"step": "*partial-name*", "failure_type": "all", "classification":  "Misc.", "jira_project": "OTHER", "jira_component": ["component-1", "component-2", "!default"], "jira_priority": "major", "group": {"name": "some-group", "priority": 1}},
          {"step": "*ends-with-this", "failure_type": "test_failure", "classification": "Test failures", "jira_epic": "!default", "jira_additional_labels": ["test-label-1", "test-label-2", "!default"], "group": {"name": "some-group", "priority": 2}},
          {"step": "*ignore*", "failure_type": "test_failure", "classification": "NONE", "jira_project": "NONE", "ignore": "true"},
          {"step": "affects-version", "failure_type": "all", "classification": "Affects Version", "jira_project": "TEST", "jira_epic": "!default", "jira_affects_version": "4.14", "jira_assignee": "!default"}
      ]

    # OPTIONAL
    "success_rules":
      [
        {"jira_project": "PROJECT", "jira_epic": "PROJECT-123", "jira_component": ["some-component"], "jira_affects_version": "!default", "jira_assignee": "some-user@redhat.com", "jira_priority": "major", "jira_security_level": "Restricted", "jira_additional_labels": ["test-label-1", "test-label-2", "!default"]},
        {"jira_project": "!default"},
      ]
  }

  • FIREWATCH_DEFAULT_JIRA_PROJECT [REQUIRED]

    • The default Jira project to report issues to.

  • FIREWATCH_JIRA_SERVER

    • The Jira server to report to.
    • DEFAULT: https://issues.stage.redhat.com

  • FIREWATCH_JIRA_API_TOKEN_PATH

    • The path to the file holding the Jira API token.
    • DEFAULT: /tmp/secrets/jira/access_token.

  • FIREWATCH_FAIL_WITH_TEST_FAILURES

    • A variable that will determine if the firewatch-report-issues step will fail with a non-zero exit code if a test failure is found in a JUnit file.
    • DEFAULT: "false"
    • BEHAVIOR:
      • "false": The firewatch-report-issues step will not fail with a non-zero exit code when test failures are found.
      • "true": The firewatch-report-issues step will fail with a non-zero exit code when test failures are found.

  • FIREWATCH_VERBOSE_TEST_FAILURE_REPORTING

    • A variable that will determine if firewatch will report on every test failure in all JUnit files (up to the limit defined in $FIREWATCH_VERBOSE_TEST_FAILURE_REPORTING_LIMIT).
    • DEFAULT: "false"
    • BEHAVIOR:
      • "false": Firewatch will only report on the first test failure found in a JUnit file.
      • "true": Firewatch will report on every test failure found in a JUnit file.

  • FIREWATCH_VERBOSE_TEST_FAILURE_REPORTING_LIMIT

    • The limit of test failures to report on when verbose test failure reporting is enabled.
    • DEFAULT: 10
    • BEHAVIOR:
      • If verbose test failure reporting is enabled, firewatch will only report on the first $FIREWATCH_VERBOSE_TEST_FAILURE_REPORTING_LIMIT test failures found in a JUnit file.

OPTIONAL DEFAULT VARIABLES:

  • FIREWATCH_DEFAULT_JIRA_EPIC [OPTIONAL]
    • The default Jira epic to report issues to where the "jira_epic" value is set to "!default".
  • FIREWATCH_DEFAULT_JIRA_COMPONENT [OPTIONAL]
    • The list of default Jira components that issues will be reported under where the "jira_component" list contains "!default".
    • For example:
      • IF $FIREWATCH_DEFAULT_JIRA_COMPONENT = ["default-1", "default-2"]
      • AND "jira_component": ["component-1", "!default"]
      • THEN when an issue is created under the rule containing the "jira_component" rule above, the components will be set to ["component-1", "default-1", "default-2"].
  • FIREWATCH_DEFAULT_JIRA_AFFECTS_VERSION [OPTIONAL]
    • The default value for "Affects Version" in Jira issues where the "jira_affects_version" value is set to "!default".
  • FIREWATCH_DEFAULT_JIRA_ADDITIONAL_LABELS [OPTIONAL]
    • The list of default Jira labels to be applied to issues where the "jira_additional_labels" list contains "!default".
    • For example:
      • IF $FIREWATCH_DEFAULT_JIRA_ADDITIONAL_LABELS = ["default-1", "default-2"]
      • AND "jira_additional_labels": ["label-1", "!default"]
      • THEN when an issue is created under the rule containing the "jira_additional_labels" rule above, the labels will be set to ["label-1", "default-1", "default-2"].
  • FIREWATCH_DEFAULT_JIRA_ASSIGNEE [OPTIONAL]
    • The default value for the assignee of issues where the "jira_assignee" value is set to "!default".
  • FIREWATCH_DEFAULT_JIRA_PRIORITY [OPTIONAL]
    • The default value for the priority of issues where the "jira_priority" value is set to "!default".
  • FIREWATCH_DEFAULT_JIRA_SECURITY_LEVEL [OPTIONAL]
    • The default value for the security level of issues where the "jira_security_level" value is set to "!default".

Local Usage

If you'd like to run firewatch locally, use the following instructions:

Docker (recommended)

  1. Ensure you have Docker installed on your system.
  2. Clone the repository: git clone https://github.com/CSPI-QE/firewatch.git.
  3. Navigate to the project root in your terminal: cd firewatch.
  4. Run the following to build and run a Docker container with firewatch installed: make build-run.
  5. Use the firewatch command to execute the tool. See the CLI usage guide for instructions on using the tool.

Local Machine (using venv)

  1. Clone the repository: git clone https://github.com/CSPI-QE/firewatch.git
  2. Navigate to the project root: cd firewatch
  3. Install the necessary dependencies: make dev-environment
  4. Use the firewatch command to execute the tool. See the CLI usage guide for instructions on using the tool.

Contributing

We welcome contributions to firewatch! If you'd like to contribute, please review our Contribution Guidelines for more information on how to get started.

License

firewatch is released under the GNU Public License.

Contact

If you have any questions, suggestions, or feedback, feel free to reach out to us:

We appreciate your interest in firewatch!