forked from mongodb/mongo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvalidate_commit_message.py
executable file
·281 lines (238 loc) · 10 KB
/
validate_commit_message.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
#!/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."""
import argparse
import logging
import os
import re
import sys
from typing import List, Optional
from evergreen import EvergreenApi, RetryingEvergreenApi
from buildscripts.client.jiraclient import JiraAuth, JiraClient, SecurityLevel
JIRA_SERVER = "https://jira.mongodb.org"
EVG_CONFIG_FILE = "~/.evergreen.yml"
SERVER_TICKET_PREFIX = "SERVER-"
PUBLIC_PROJECT_PREFIX = "mongodb-mongo-"
LOGGER = logging.getLogger(__name__)
ERROR_MSG = """
################################################################################
Encountered an invalid commit message. Please correct to the commit message to
continue.
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}'
################################################################################
"""
COMMON_PUBLIC_PATTERN = r"""
((?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)
"""
"""Common Public pattern format."""
COMMON_LINT_PATTERN = r"(?P<lint>Fix\slint)"
"""Common Lint pattern format."""
COMMON_IMPORT_PATTERN = r"(?P<imported>Import\s(wiredtiger|tools):\s.*)"
"""Common Import pattern format."""
COMMON_REVERT_IMPORT_PATTERN = (r"Revert\s+[\"\']?(?P<imported>Import\s(wiredtiger|tools):\s.*)")
"""Common revert Import pattern format."""
COMMON_PRIVATE_PATTERN = r"""
((?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
"""
"""Common Private pattern format."""
STATUS_OK = 0
STATUS_ERROR = 1
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.
"""
return (r"""^((?P<commitqueue>Commit\sQueue\sMerge:)\s')"""
f"{pattern}"
# r"""('\s(?P<into>into\s'((?P<owner>[^/]+))/((?P<repo>[^:]+)):((?P<branch>[^']+))'))"""
)
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.
"""
return r"^" f"{pattern}"
# NOTE: re.VERBOSE is for visibility / debugging. As such significant white space must be
# escaped (e.g ' ' to \s).
VALID_PATTERNS = [
re.compile(
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,
),
re.compile(
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,
),
]
"""valid public patterns."""
PRIVATE_PATTERNS = [
re.compile(
new_patch_description(COMMON_PRIVATE_PATTERN),
re.MULTILINE | re.DOTALL | re.VERBOSE,
),
re.compile(
old_patch_description(COMMON_PRIVATE_PATTERN),
re.MULTILINE | re.DOTALL | re.VERBOSE,
),
]
"""private patterns."""
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,
))
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,
))
return False
else:
print(
ERROR_MSG.format(
error_msg="Commit without a ticket",
branch=project,
commit_message=message,
))
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:
"""Execute Main function to validate commit messages."""
parser = argparse.ArgumentParser(
usage="Validate the commit message. "
"It validates the latest message when no arguments are provided.")
parser.add_argument(
"version_id",
metavar="version id",
help="The id of the version to validate",
)
parser.add_argument(
"--evg-config-file",
default=EVG_CONFIG_FILE,
help="Path to evergreen configuration file containing auth information.",
)
args = parser.parse_args(argv)
evg_api = RetryingEvergreenApi.get_api(config_file=os.path.expanduser(args.evg_config_file))
jira_auth = JiraAuth()
jira_client = JiraClient(JIRA_SERVER, jira_auth)
orchestrator = CommitMessageValidationOrchestrator(evg_api, jira_client)
return orchestrator.validate_commit_messages(args.version_id)
if __name__ == "__main__":
sys.exit(main(sys.argv[1:]))