2019-12-06 16:59:35 +00:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
|
# Copyright (C) 2019-present MongoDB, Inc.
|
|
|
|
|
#
|
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
|
# it under the terms of the Server Side Public License, version 1,
|
|
|
|
|
# as published by MongoDB, Inc.
|
|
|
|
|
#
|
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
# Server Side Public License for more details.
|
|
|
|
|
#
|
|
|
|
|
# You should have received a copy of the Server Side Public License
|
|
|
|
|
# along with this program. If not, see
|
|
|
|
|
# <http://www.mongodb.com/licensing/server-side-public-license>.
|
|
|
|
|
#
|
|
|
|
|
# As a special exception, the copyright holders give permission to link the
|
|
|
|
|
# code of portions of this program with the OpenSSL library under certain
|
|
|
|
|
# conditions as described in each individual source file and distribute
|
|
|
|
|
# linked combinations including the program with the OpenSSL library. You
|
|
|
|
|
# must comply with the Server Side Public License in all respects for
|
|
|
|
|
# all of the code used other than as permitted herein. If you modify file(s)
|
|
|
|
|
# with this exception, you may extend this exception to your version of the
|
|
|
|
|
# file(s), but you are not obligated to do so. If you do not wish to do so,
|
|
|
|
|
# delete this exception statement from your version. If you delete this
|
|
|
|
|
# exception statement from all source files in the program, then also delete
|
|
|
|
|
# it in the license file.
|
|
|
|
|
#
|
|
|
|
|
"""Validate that the commit message is ok."""
|
2024-05-16 18:00:17 -04:00
|
|
|
|
2019-12-06 16:59:35 +00:00
|
|
|
import argparse
|
2021-12-29 10:57:03 -05:00
|
|
|
import logging
|
2021-09-07 12:31:17 -04:00
|
|
|
import os
|
2019-12-09 11:45:50 +00:00
|
|
|
import re
|
|
|
|
|
import sys
|
2021-12-29 10:57:03 -05:00
|
|
|
from typing import List, Optional
|
|
|
|
|
|
|
|
|
|
from evergreen import EvergreenApi, RetryingEvergreenApi
|
2020-06-25 14:19:50 -04:00
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
from buildscripts.client.jiraclient import JiraAuth, JiraClient, SecurityLevel
|
|
|
|
|
|
|
|
|
|
JIRA_SERVER = "https://jira.mongodb.org"
|
2021-09-07 12:31:17 -04:00
|
|
|
EVG_CONFIG_FILE = "~/.evergreen.yml"
|
2021-12-29 10:57:03 -05:00
|
|
|
SERVER_TICKET_PREFIX = "SERVER-"
|
|
|
|
|
PUBLIC_PROJECT_PREFIX = "mongodb-mongo-"
|
|
|
|
|
|
2020-06-25 14:19:50 -04:00
|
|
|
LOGGER = logging.getLogger(__name__)
|
2019-12-06 16:59:35 +00:00
|
|
|
|
2021-09-07 12:31:17 -04:00
|
|
|
ERROR_MSG = """
|
|
|
|
|
################################################################################
|
|
|
|
|
Encountered an invalid commit message. Please correct to the commit message to
|
2021-12-29 10:57:03 -05:00
|
|
|
continue.
|
2021-09-07 12:31:17 -04:00
|
|
|
|
|
|
|
|
Commit message should start with a Public Jira ticket, an "Import" for wiredtiger
|
|
|
|
|
or tools, or a "Revert" message.
|
|
|
|
|
|
|
|
|
|
{error_msg} on '{branch}':
|
|
|
|
|
'{commit_message}'
|
|
|
|
|
################################################################################
|
|
|
|
|
"""
|
|
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
COMMON_PUBLIC_PATTERN = r"""
|
2020-04-29 19:00:37 +01:00
|
|
|
((?P<revert>Revert)\s+[\"\']?)? # Revert (optional)
|
|
|
|
|
((?P<ticket>(?:EVG|SERVER|WT)-[0-9]+)[\"\']?\s*) # ticket identifier
|
|
|
|
|
(?P<body>(?:(?!\(cherry\spicked\sfrom).)*)? # To also capture the body
|
|
|
|
|
(?P<backport>\(cherry\spicked\sfrom.*)? # back port (optional)
|
2021-12-29 10:57:03 -05:00
|
|
|
"""
|
2020-04-29 19:00:37 +01:00
|
|
|
"""Common Public pattern format."""
|
|
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
COMMON_LINT_PATTERN = r"(?P<lint>Fix\slint)"
|
2020-04-29 19:00:37 +01:00
|
|
|
"""Common Lint pattern format."""
|
|
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
COMMON_IMPORT_PATTERN = r"(?P<imported>Import\s(wiredtiger|tools):\s.*)"
|
2020-04-29 19:00:37 +01:00
|
|
|
"""Common Import pattern format."""
|
|
|
|
|
|
2024-05-16 18:00:17 -04:00
|
|
|
COMMON_REVERT_IMPORT_PATTERN = r"Revert\s+[\"\']?(?P<imported>Import\s(wiredtiger|tools):\s.*)"
|
2021-08-20 14:59:53 -04:00
|
|
|
"""Common revert Import pattern format."""
|
|
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
COMMON_PRIVATE_PATTERN = r"""
|
2020-04-29 19:00:37 +01:00
|
|
|
((?P<revert>Revert)\s+[\"\']?)? # Revert (optional)
|
|
|
|
|
((?P<ticket>[A-Z]+-[0-9]+)[\"\']?\s*) # ticket identifier
|
|
|
|
|
(?P<body>(?:(?!('\s(into\s'(([^/]+))/(([^:]+)):(([^']+))'))).)*)? # To also capture the body
|
2021-12-29 10:57:03 -05:00
|
|
|
"""
|
2020-04-29 19:00:37 +01:00
|
|
|
"""Common Private pattern format."""
|
2019-12-06 16:59:35 +00:00
|
|
|
|
2020-04-28 20:46:00 -04:00
|
|
|
STATUS_OK = 0
|
|
|
|
|
STATUS_ERROR = 1
|
2019-12-06 16:59:35 +00:00
|
|
|
|
|
|
|
|
|
2020-04-29 19:00:37 +01:00
|
|
|
def new_patch_description(pattern: str) -> str:
|
|
|
|
|
"""
|
|
|
|
|
Wrap the pattern to conform to the new commit queue patch description format.
|
|
|
|
|
|
|
|
|
|
Add the commit queue prefix and suffix to the pattern. The format looks like:
|
|
|
|
|
|
|
|
|
|
Commit Queue Merge: '<commit message>' into '<owner>/<repo>:<branch>'
|
|
|
|
|
|
|
|
|
|
:param pattern: The pattern to wrap.
|
|
|
|
|
:return: A pattern to match the new format for the patch description.
|
|
|
|
|
"""
|
2024-05-16 18:00:17 -04:00
|
|
|
return (
|
|
|
|
|
r"""^((?P<commitqueue>Commit\sQueue\sMerge:)\s')""" f"{pattern}"
|
|
|
|
|
# r"""('\s(?P<into>into\s'((?P<owner>[^/]+))/((?P<repo>[^:]+)):((?P<branch>[^']+))'))"""
|
|
|
|
|
)
|
2020-04-29 19:00:37 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
def old_patch_description(pattern: str) -> str:
|
|
|
|
|
"""
|
|
|
|
|
Wrap the pattern to conform to the new commit queue patch description format.
|
|
|
|
|
|
|
|
|
|
Just add a start anchor. The format looks like:
|
|
|
|
|
|
|
|
|
|
<commit message>
|
|
|
|
|
|
|
|
|
|
:param pattern: The pattern to wrap.
|
|
|
|
|
:return: A pattern to match the old format for the patch description.
|
|
|
|
|
"""
|
2021-12-29 10:57:03 -05:00
|
|
|
return r"^" f"{pattern}"
|
2020-04-29 19:00:37 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
# NOTE: re.VERBOSE is for visibility / debugging. As such significant white space must be
|
|
|
|
|
# escaped (e.g ' ' to \s).
|
|
|
|
|
VALID_PATTERNS = [
|
2021-08-20 14:59:53 -04:00
|
|
|
re.compile(
|
2021-12-29 10:57:03 -05:00
|
|
|
new_patch_description(COMMON_PUBLIC_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
old_patch_description(COMMON_PUBLIC_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
new_patch_description(COMMON_LINT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
2021-08-20 14:59:53 -04:00
|
|
|
re.compile(
|
2021-12-29 10:57:03 -05:00
|
|
|
old_patch_description(COMMON_LINT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
new_patch_description(COMMON_IMPORT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
old_patch_description(COMMON_IMPORT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
new_patch_description(COMMON_REVERT_IMPORT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
|
|
|
|
re.compile(
|
|
|
|
|
old_patch_description(COMMON_REVERT_IMPORT_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
2020-04-29 19:00:37 +01:00
|
|
|
]
|
|
|
|
|
"""valid public patterns."""
|
|
|
|
|
|
|
|
|
|
PRIVATE_PATTERNS = [
|
|
|
|
|
re.compile(
|
2021-12-29 10:57:03 -05:00
|
|
|
new_patch_description(COMMON_PRIVATE_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
2020-04-29 19:00:37 +01:00
|
|
|
re.compile(
|
2021-12-29 10:57:03 -05:00
|
|
|
old_patch_description(COMMON_PRIVATE_PATTERN),
|
|
|
|
|
re.MULTILINE | re.DOTALL | re.VERBOSE,
|
|
|
|
|
),
|
2020-04-29 19:00:37 +01:00
|
|
|
]
|
|
|
|
|
"""private patterns."""
|
|
|
|
|
|
|
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
class CommitMessageValidationOrchestrator:
|
|
|
|
|
"""An orchestrator to validate that commit messages are valid."""
|
|
|
|
|
|
|
|
|
|
def __init__(self, evg_api: EvergreenApi, jira_client: JiraClient) -> None:
|
|
|
|
|
"""
|
|
|
|
|
Initialize the orchestrator.
|
|
|
|
|
|
|
|
|
|
:param evg_api: Evergreen API client.
|
|
|
|
|
:param jira_client: Client to Jira API.
|
|
|
|
|
"""
|
|
|
|
|
self.evg_api = evg_api
|
|
|
|
|
self.jira_client = jira_client
|
|
|
|
|
|
|
|
|
|
def validate_ticket(self, ticket: str, project: str) -> bool:
|
|
|
|
|
"""
|
|
|
|
|
Check that the given Jira ticket has a proper security level.
|
|
|
|
|
|
|
|
|
|
Commits targeting a public project should not have a defined security level (these are
|
|
|
|
|
public by default).
|
|
|
|
|
|
|
|
|
|
:param ticket: Ticket to check.
|
|
|
|
|
:param project: Project commit is targeting.
|
|
|
|
|
:return: True if ticket is valid.
|
|
|
|
|
"""
|
|
|
|
|
if ticket.startswith(SERVER_TICKET_PREFIX) and project.startswith(PUBLIC_PROJECT_PREFIX):
|
|
|
|
|
security_level = self.jira_client.get_ticket_security_level(ticket)
|
|
|
|
|
return security_level == SecurityLevel.NONE
|
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
def validate_msg(self, message: str, project: str) -> bool:
|
|
|
|
|
"""
|
|
|
|
|
Check that the given message is valid.
|
|
|
|
|
|
|
|
|
|
:param message: Commit message to validate.
|
|
|
|
|
:param project: Project commit is targeting.
|
|
|
|
|
:return: True if the message is valid.
|
|
|
|
|
"""
|
|
|
|
|
valid_matches = [valid_pattern.match(message) for valid_pattern in VALID_PATTERNS]
|
|
|
|
|
if any(valid_matches):
|
|
|
|
|
ticket_matches = [pattern.match(message) for pattern in VALID_PATTERNS[0:2]]
|
|
|
|
|
for match in [ticket_match for ticket_match in ticket_matches if ticket_match]:
|
|
|
|
|
if not self.validate_ticket(match.group("ticket"), project):
|
|
|
|
|
print(
|
|
|
|
|
ERROR_MSG.format(
|
|
|
|
|
error_msg="Reference to a internal Jira Ticket",
|
|
|
|
|
branch=project,
|
|
|
|
|
commit_message=message,
|
2024-05-16 18:00:17 -04:00
|
|
|
)
|
|
|
|
|
)
|
2021-12-29 10:57:03 -05:00
|
|
|
return False
|
|
|
|
|
return True
|
|
|
|
|
elif any(private_pattern.match(message) for private_pattern in PRIVATE_PATTERNS):
|
|
|
|
|
print(
|
|
|
|
|
ERROR_MSG.format(
|
|
|
|
|
error_msg="Reference to a private project",
|
|
|
|
|
branch=project,
|
|
|
|
|
commit_message=message,
|
2024-05-16 18:00:17 -04:00
|
|
|
)
|
|
|
|
|
)
|
2021-12-29 10:57:03 -05:00
|
|
|
return False
|
|
|
|
|
else:
|
|
|
|
|
print(
|
|
|
|
|
ERROR_MSG.format(
|
|
|
|
|
error_msg="Commit without a ticket",
|
|
|
|
|
branch=project,
|
|
|
|
|
commit_message=message,
|
2024-05-16 18:00:17 -04:00
|
|
|
)
|
|
|
|
|
)
|
2021-12-29 10:57:03 -05:00
|
|
|
return False
|
|
|
|
|
|
|
|
|
|
def validate_commit_messages(self, version_id: str) -> int:
|
|
|
|
|
"""
|
|
|
|
|
Validate the commit messages for the given build.
|
|
|
|
|
|
|
|
|
|
:param version_id: ID of version to validate.
|
|
|
|
|
:param evg_api: Evergreen API client.
|
|
|
|
|
:return: True if all commit messages were valid.
|
|
|
|
|
"""
|
|
|
|
|
found_error = False
|
|
|
|
|
code_changes = self.evg_api.patch_by_id(version_id).module_code_changes
|
|
|
|
|
for change in code_changes:
|
|
|
|
|
for message in change.commit_messages:
|
|
|
|
|
is_valid = self.validate_msg(message, change.branch_name)
|
|
|
|
|
found_error = found_error or not is_valid
|
|
|
|
|
|
|
|
|
|
return STATUS_ERROR if found_error else STATUS_OK
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def main(argv: Optional[List[str]] = None) -> int:
|
2020-04-28 20:46:00 -04:00
|
|
|
"""Execute Main function to validate commit messages."""
|
2019-12-09 11:45:50 +00:00
|
|
|
parser = argparse.ArgumentParser(
|
|
|
|
|
usage="Validate the commit message. "
|
2024-05-16 18:00:17 -04:00
|
|
|
"It validates the latest message when no arguments are provided."
|
|
|
|
|
)
|
2019-12-06 16:59:35 +00:00
|
|
|
parser.add_argument(
|
2021-07-13 15:55:44 -04:00
|
|
|
"version_id",
|
|
|
|
|
metavar="version id",
|
|
|
|
|
help="The id of the version to validate",
|
2019-12-06 16:59:35 +00:00
|
|
|
)
|
2021-12-29 10:57:03 -05:00
|
|
|
parser.add_argument(
|
|
|
|
|
"--evg-config-file",
|
|
|
|
|
default=EVG_CONFIG_FILE,
|
|
|
|
|
help="Path to evergreen configuration file containing auth information.",
|
|
|
|
|
)
|
2023-09-21 14:16:56 +00:00
|
|
|
|
2019-12-06 16:59:35 +00:00
|
|
|
args = parser.parse_args(argv)
|
2023-09-21 14:16:56 +00:00
|
|
|
evg_api = RetryingEvergreenApi.get_api(
|
2024-05-16 18:00:17 -04:00
|
|
|
config_file=os.path.expanduser(args.evg_config_file), log_on_error=True
|
|
|
|
|
)
|
2021-12-29 10:57:03 -05:00
|
|
|
jira_auth = JiraAuth()
|
|
|
|
|
jira_client = JiraClient(JIRA_SERVER, jira_auth)
|
|
|
|
|
orchestrator = CommitMessageValidationOrchestrator(evg_api, jira_client)
|
2021-07-13 15:55:44 -04:00
|
|
|
|
2021-12-29 10:57:03 -05:00
|
|
|
return orchestrator.validate_commit_messages(args.version_id)
|
2019-12-06 16:59:35 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
|
sys.exit(main(sys.argv[1:]))
|
