graalpython/mx.graalpython/verify_patches.py at master · oracle/graalpython

History

156 lines (143 loc) · 7.53 KB

Raw

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

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

# The Universal Permissive License (UPL), Version 1.0

# Subject to the condition set forth below, permission is hereby granted to any

# person obtaining a copy of this software, associated documentation and/or

# data (collectively the "Software"), free of charge and under any and all

# copyright rights in the Software, and any and all patent rights owned or

# freely licensable by each licensor hereunder covering either (i) the

# unmodified Software as contributed to or provided by such licensor, or (ii)

# the Larger Works (as defined below), to deal in both

# (a) the Software, and

# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if

# one is included with the Software each a "Larger Work" to which the Software

# is contributed by such licensors),

# without restriction, including without limitation the rights to copy, create

# derivative works of, display, perform, and distribute the Software and make,

# use, sell, offer for sale, import, export, have made, and have sold the

# Software and the Larger Work(s), and to sublicense the foregoing rights on

# either these or other terms.

# This license is subject to the following condition:

# The above copyright notice and either this complete permission notice or at a

# minimum a reference to the UPL must be included in all copies or substantial

# portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

# SOFTWARE.

import argparse

import os

import re

import subprocess

from pathlib import Path

from pip._vendor import tomli # pylint: disable=no-name-in-module

from pip._vendor.packaging.specifiers import SpecifierSet # pylint: disable=no-name-in-module

# Approved license identifiers in SPDX "short identifier" format

ALLOWED_LICENSES = {

'UPL', # https://spdx.org/licenses/UPL-1.0.html

'MIT', # https://spdx.org/licenses/MIT.html

'BSD-3-Clause', # https://spdx.org/licenses/BSD-3-Clause.html

'BSD-2-Clause', # https://spdx.org/licenses/BSD-2-Clause.html

'Apache-2.0', # https://spdx.org/licenses/Apache-2.0.html

'MPL-2.0', # https://spdx.org/licenses/MPL-2.0.html

'LGPL-2.0-or-later', # https://spdx.org/licenses/LGPL-2.0-or-later.html

'LGPL-3.0-or-later', # https://spdx.org/licenses/LGPL-3.0-or-later.html

'PSF-2.0', # https://spdx.org/licenses/PSF-2.0.html

}

ALLOWED_WITH_CLAUSES = {

'openssl-exception',

}

SECTIONS = frozenset({'rules', 'add-sources'})

RULE_KEYS = frozenset({'version', 'patch', 'license', 'subdir', 'dist-type', 'install-priority', 'note', 'autopatch'})

CRATE_VERSION_SPECIFIER_RE = re.compile(r'(==|!=|<=|>=|<|>)\s*\d+(?:\.\d+)*')

# Make it work in pre-commit hooks in worktrees

os.environ.pop('GIT_DIR', None)

def validate_metadata(patches_dir, crates=False, git_mode=False):

if git_mode:

patch_files = {

patches_dir / file

for file in subprocess.run(

['git', '-C', patches_dir, 'ls-files'],

check=True,

stdout=subprocess.PIPE,

text=True,

).stdout.splitlines()

if Path(file).parent == Path('.')

}

else:

patch_files = set(patches_dir.iterdir())

with open(patches_dir / 'metadata.toml', 'rb') as f:

all_metadata = tomli.load(f)

patches = set()

for package, metadata in all_metadata.items():

try:

if unexpected_keys := set(metadata) - SECTIONS:

assert False, f"Unexpected top-level metadata keys: {unexpected_keys}"

if rules := metadata.get('rules'):

for rule in rules:

if unexpected_keys := set(rule) - RULE_KEYS:

assert False, f"Unexpected rule keys: {unexpected_keys}"

if patch := rule.get('patch'):

patch_path = patches_dir / patch

assert patch_path.is_file(), f"Patch file does not exists: {patch_path}"

if git_mode:

assert patch_path in patch_files, f"Patch file is not tracked by git: {patch_path}"

patches.add(patch_path)

license_id = rule.get('license')

assert license_id, f"'license' not specified for patch {patch}"

license_id = re.sub(r'[()]', ' ', license_id)

for part in re.split(f'AND|OR', license_id):

part = part.strip()

if ' WITH ' in part:

part, exception = re.split(r'\s+WITH\s+', part, maxsplit=1)

assert exception in ALLOWED_WITH_CLAUSES, \

f"License WITH clause {exception} not in allowed list of clauses: {', '.join(ALLOWED_WITH_CLAUSES)}"

assert part in ALLOWED_LICENSES, \

f"License {part} not in allowed list of licenses: {', '.join(ALLOWED_LICENSES)}"

if install_priority := rule.get('install-priority'):

assert isinstance(install_priority, int), "'rules.install_priority' must be an int"

if dist_type := rule.get('dist-type'):

assert dist_type in ('wheel', 'sdist'), "'rules.dist_type' must be on of 'wheel', 'sdist'"

if 'autopatch' in rule:

assert isinstance(rule['autopatch'], bool), "'rules.autopatch' must be a bool"

if version := rule.get('version'):

if crates:

for constraint in version.split(','):

assert CRATE_VERSION_SPECIFIER_RE.fullmatch(constraint.strip()), \

f"Unsupported crate version constraint: {constraint!r}"

else:

# Just try that it doesn't raise

SpecifierSet(version)

if add_sources := metadata.get('add-sources'):

for add_source in add_sources:

if unexpected_keys := set(add_source) - {'version', 'url'}:

assert False, f"Unexpected add_source keys: {unexpected_keys}"

assert add_source.get('version'), "Missing 'add_sources.version' key"

assert add_source.get('url'), "Missing 'add_sources.url' key"

except Exception as e:

raise AssertionError(f"{package}: {e}")

for patch_file in patch_files:

if patch_file.is_file() and patch_file.name.endswith('patch'):

assert patch_file in patches, f"Dangling patch file: {patch_file}"

crates_dir = patches_dir / 'crates'

if crates_dir.is_dir():

validate_metadata(crates_dir, crates=True, git_mode=git_mode)

def main():

parser = argparse.ArgumentParser()

parser.add_argument('--git-mode', action='store_true')

parser.add_argument('patches_dir', type=Path)

args = parser.parse_args()

validate_metadata(args.patches_dir, git_mode=args.git_mode)

if __name__ == '__main__':

main()

FilesExpand file tree

verify_patches.py

Latest commit

History

verify_patches.py

File metadata and controls