From adb5761c1aedadf5c07b8e70fe83b90893a6fb34 Mon Sep 17 00:00:00 2001 From: Julien Cristau Date: Mon, 12 Feb 2024 13:23:06 +0100 Subject: [PATCH] Bug 1825116 - whitespace fixes. r=jajohnson Differential Revision: https://phabricator.services.mozilla.com/D201566 --- taskcluster/scripts/lib/testrail_utils.py | 18 +++++++++--------- taskcluster/scripts/slack_notifier.py | 4 ++-- taskcluster/scripts/testrail_main.py | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/taskcluster/scripts/lib/testrail_utils.py b/taskcluster/scripts/lib/testrail_utils.py index d36de5b554c4..b78d54c114c9 100644 --- a/taskcluster/scripts/lib/testrail_utils.py +++ b/taskcluster/scripts/lib/testrail_utils.py @@ -4,21 +4,21 @@ # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. """ -This script contains utility functions designed to support the integration of automated -testing processes with TestRail, a test case management tool. The primary focus is on -creating and managing milestones in TestRail based on automated smoke tests for product -releases. It includes functions for building milestone names and descriptions, determining +This script contains utility functions designed to support the integration of automated +testing processes with TestRail, a test case management tool. The primary focus is on +creating and managing milestones in TestRail based on automated smoke tests for product +releases. It includes functions for building milestone names and descriptions, determining release types, and loading TestRail credentials. Functions: -- build_milestone_name(product_type, release_type, version_number): Constructs a formatted +- build_milestone_name(product_type, release_type, version_number): Constructs a formatted milestone name based on the product type, release type, and version number. -- build_milestone_description(milestone_name): Generates a detailed description for the +- build_milestone_description(milestone_name): Generates a detailed description for the milestone, including the release date and placeholders for testing status and QA recommendations. - get_release_version(): Reads and returns the release version number from a 'version.txt' file. -- get_release_type(version): Determines the release type (e.g., Alpha, Beta, RC) based on +- get_release_type(version): Determines the release type (e.g., Alpha, Beta, RC) based on the version string. -- load_testrail_credentials(json_file_path): Loads TestRail credentials from a JSON file +- load_testrail_credentials(json_file_path): Loads TestRail credentials from a JSON file and handles potential errors during the loading process. """ @@ -46,7 +46,7 @@ def build_milestone_description(milestone_name): TESTING_SUMMARY\n\n\ Known issues: n/a\n\ New issue: n/a\n\ - Verified issue: + Verified issue: """ ) diff --git a/taskcluster/scripts/slack_notifier.py b/taskcluster/scripts/slack_notifier.py index 062c622744fd..c4377f0ed08a 100644 --- a/taskcluster/scripts/slack_notifier.py +++ b/taskcluster/scripts/slack_notifier.py @@ -19,7 +19,7 @@ The module is intended to be integrated into automated testing and release workf Required Values for Notifications: -These values are required when calling the `send_success_notification` and `send_slack_notification` functions. +These values are required when calling the `send_success_notification` and `send_slack_notification` functions. They must be passed as an object with the following keys and their respective values. Required Keys and Expected Values: @@ -69,7 +69,7 @@ SLACK_SUCCESS_MESSAGE_TEMPLATE = Template( "text": "New Release: :firefox: $SHIPPING_PRODUCT-v$RELEASE_VERSION :star:" } }, - { + { "type": "divider" }, { diff --git a/taskcluster/scripts/testrail_main.py b/taskcluster/scripts/testrail_main.py index 9337ce9d02a5..19bb2f41eae9 100644 --- a/taskcluster/scripts/testrail_main.py +++ b/taskcluster/scripts/testrail_main.py @@ -4,7 +4,7 @@ # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. """ -This Python script automates creating milestones and test runs in TestRail and updating +This Python script automates creating milestones and test runs in TestRail and updating test cases based on the results of automated smoke tests for different product releases. Functionality includes: