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
|
# Copyright 2022 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Check various rules for .gitmodules files."""
import dataclasses
import logging
from pathlib import Path
from typing import Callable, Dict, Optional, Sequence
import urllib.parse
from pw_presubmit.presubmit import filter_paths
from pw_presubmit.presubmit_context import (
PresubmitContext,
PresubmitFailure,
)
from pw_presubmit import git_repo, plural, presubmit_context
_LOG: logging.Logger = logging.getLogger(__name__)
@dataclasses.dataclass
class Config:
# Allow submodules to exist in any form.
allow_submodules: bool = True
# Allow direct references to non-Google hosts.
allow_non_googlesource_hosts: bool = False
# Allow a specific subset of googlesource.com hosts. If an empty list then
# all googlesource hosts are permitted.
allowed_googlesource_hosts: Sequence[str] = ()
# Require relative URLs, like those that start with "/" or "../".
require_relative_urls: bool = False
# Allow "sso://" URLs.
allow_sso: bool = True
# Allow use of "git.corp.google.com" URLs.
allow_git_corp_google_com: bool = True
# Require a branch for each submodule.
require_branch: bool = False
# Arbitrary validator. Gets invoked with the submodule name and a dict of
# the submodule properties. Should throw exceptions or call ctx.fail to
# register errors.
validator: Optional[
Callable[[PresubmitContext, Path, str, Dict[str, str]], None]
] = None
def _parse_gitmodules(path: Path) -> Dict[str, Dict[str, str]]:
raw_submodules: str = git_repo.git_stdout(
'config', '--file', path, '--list'
)
submodules: Dict[str, Dict[str, str]] = {}
for line in raw_submodules.splitlines():
key: str
value: str
key, value = line.split('=', 1)
if not key.startswith('submodule.'):
raise PresubmitFailure(f'unexpected key {key!r}', path)
key = key.split('.', 1)[1]
submodule: str
param: str
submodule, param = key.rsplit('.', 1)
submodules.setdefault(submodule, {})
submodules[submodule][param] = value
return submodules
_GERRIT_HOST_SUFFIXES = ('.googlesource.com', '.git.corp.google.com')
def process_gitmodules(ctx: PresubmitContext, config: Config, path: Path):
"""Check if a specific .gitmodules file passes the options in the config."""
_LOG.debug('Evaluating path %s', path)
submodules: Dict[str, Dict[str, str]] = _parse_gitmodules(path)
if submodules and not config.allow_submodules:
ctx.fail(
f'submodules are not permitted but '
f'{plural(submodules, "submodule", exist=True)} {tuple(submodules)}'
)
assert isinstance(config.allowed_googlesource_hosts, (list, tuple))
for allowed in config.allowed_googlesource_hosts:
if '.' in allowed or '-review' in allowed:
raise PresubmitFailure(
f'invalid googlesource requirement: {allowed}'
)
for name, submodule in submodules.items():
_LOG.debug('======================')
_LOG.debug('evaluating submodule %s', name)
_LOG.debug('%r', submodule)
if config.require_branch:
_LOG.debug('branch is required')
if 'branch' not in submodule:
ctx.fail(
f'submodule {name} does not have a branch set but '
'branches are required'
)
url = submodule['url']
if config.validator:
config.validator(ctx, path, name, submodule)
if url.startswith(('/', '../')):
_LOG.debug('URL is relative, remaining checks are irrelevant')
continue
if config.require_relative_urls:
_LOG.debug('relative URLs required')
ctx.fail(
f'submodule {name} has non-relative url {url!r} but '
'relative urls are required'
)
continue
parsed = urllib.parse.urlparse(url)
if not config.allow_sso:
_LOG.debug('sso not allowed')
if parsed.scheme in ('sso', 'rpc'):
ctx.fail(
f'submodule {name} has sso/rpc url {url!r} but '
'sso/rpc urls are not allowed'
)
continue
if not config.allow_git_corp_google_com:
_LOG.debug('git.corp.google.com not allowed')
if '.git.corp.google.com' in parsed.netloc:
ctx.fail(
f'submodule {name} has git.corp.google.com url '
f'{url!r} but git.corp.google.com urls are not '
'allowed'
)
continue
if not config.allow_non_googlesource_hosts:
_LOG.debug('non-google hosted repos not allowed')
if parsed.scheme not in (
'sso',
'rpc',
) and not parsed.netloc.endswith(_GERRIT_HOST_SUFFIXES):
ctx.fail(
f'submodule {name} has prohibited non-Google url ' f'{url}'
)
continue
if config.allowed_googlesource_hosts:
_LOG.debug(
'allowed googlesource hosts: %r',
config.allowed_googlesource_hosts,
)
_LOG.debug('raw url: %s', url)
host = parsed.netloc
if host.endswith(_GERRIT_HOST_SUFFIXES) or parsed.scheme in (
'sso',
'rpc',
):
for suffix in _GERRIT_HOST_SUFFIXES:
host = host.replace(suffix, '')
_LOG.debug('host: %s', host)
if host not in config.allowed_googlesource_hosts:
ctx.fail(
f'submodule {name} is from prohibited Google '
f'Gerrit host {parsed.netloc}'
)
continue
def create(config: Config = Config()):
"""Create a gitmodules presubmit step with a given config."""
@filter_paths(endswith='.gitmodules')
def gitmodules(ctx: PresubmitContext):
"""Check various rules for .gitmodules files."""
ctx.paths = presubmit_context.apply_exclusions(ctx)
for path in ctx.paths:
process_gitmodules(ctx, config, path)
return gitmodules
|
