Repository navigation
Expand file tree
/
Copy pathcheck_patch.py
More file actions
141 lines (111 loc) · 4.54 KB
/
Copy pathcheck_patch.py
File metadata and controls
141 lines (111 loc) · 4.54 KB
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
# SPDX-FileCopyrightText: 2025 BayLibre, SAS
# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: Apache-2.0
"""
This script is based on the one located at:
https://gitlab.com/riseproject/python/wheel_builder/-/blob/main/ci_scripts/check_patch.py
Its purpose is to check the contents of patches (commits) submitted to the
project for aan "Upstream-Status" tag, which is inspired by the same tag used
in the Yocto Project:
https://docs.yoctoproject.org/dev/contributor-guide/recipe-style-guide.html#patch-upstream-status
See the valid_statuses dictionary below for types of Upstream-Status tags
accepted.
"""
import sys
import subprocess
import re
valid_statuses = {
"Issue": {
"value": r"^\[https?://\S+\]$", # Mandatory url in brackets
"hint": "[url]",
"mandatory": True,
"description": "Brackets enclosed url of the issue opened on upstream project",
},
"Submitted": {
"value": r"^\[https?://\S+\]$", # Mandatory url in brackets
"hint": "[url]",
"mandatory": True,
"description": "Brackets enclosed url of the merge request opened on upstream project",
},
"To upstream": {
"value": r"^(\[.*\])?$", # Optional comment in brackets
"hint": "[comment]",
"mandatory": False,
"description": "Optional brackets enclosed comment to add any useful information for future upstream submission",
},
"Inappropriate": {
"value": r"^\[.+\]$", # Any comment in brackets
"hint": "[comment]",
"mandatory": True,
"description": "Brackets enclosed reason why the patch is inappropriate for upstream",
},
"Backport": {
"value": r"^\[https?://\S+\]$", # Mandatory url in brackets
"hint": "[url]",
"mandatory": True,
"description": "Brackets enclosed url of the backported patch",
},
}
def get_changed_patches(start_ref, end_ref):
"""Get the patch files added or modified between two refs.
Compares the two trees, so only those two commits need to be present: a
shallow checkout is enough, no history is walked.
"""
cmd = ["git", "diff", "--name-status", "--diff-filter=AM", start_ref, end_ref]
result = subprocess.run(cmd, capture_output=True, text=True, check=True)
files = []
for line in result.stdout.splitlines():
status, filename = line.split("\t", 1)
if filename.endswith(".patch"):
files.append(filename)
return files
def extract_patch(ref, patch_file):
"""Extract a patch file as it is in a given commit."""
cmd = ["git", "show", f"{ref}:{patch_file}"]
result = subprocess.run(cmd, capture_output=True, text=True)
if result.returncode != 0:
print(f"WARNING: Could not extract {patch_file} from {ref}")
return None
return result.stdout
def check_upstream_status(patch_content, patch):
"""Check if the Upstream-Status tag is correctly formatted in a patch file."""
status_key = "|".join(valid_statuses.keys())
match = re.search(r"^Upstream-Status: *(.*)$", patch_content, re.MULTILINE)
if not match:
print(f"❌Missing Upstream-Status tag in {patch}")
return False
value = match.groups()
match = re.search(rf"^({status_key}|\w+) *(.*)$", value[0], re.MULTILINE)
status, extra = match.groups()
if status not in valid_statuses.keys():
print(f"❌Invalid Upstream-Status '{status}' in {patch}")
return False
if not re.match(valid_statuses[status]["value"], extra):
print(f"❌Incorrect format for Upstream-Status '{status}' in {patch}")
return False
return True
def main():
if len(sys.argv) != 3:
print("Usage: python script.py <start_branch_or_commit> <end_branch_or_commit>")
sys.exit(1)
start_ref, end_ref = sys.argv[1], sys.argv[2]
error_found = False
for patch in get_changed_patches(start_ref, end_ref):
patch_content = extract_patch(end_ref, patch)
if patch_content:
if not check_upstream_status(patch_content, patch):
error_found = True
else:
print(f"✅{patch}")
if error_found:
print("Valid formats:")
for key, value in valid_statuses.items():
hint = value["hint"]
description = value["description"]
mandatory = "(mandatory)" if value["mandatory"] else ""
print(f" - Upstream-Status: {key} {hint}")
print(f" {hint}: {description} {mandatory}")
sys.exit(1)
sys.exit(0)
if __name__ == "__main__":
main()