[go: nahoru, domu]
Google Git
Sign in
chromium / chromium / src / a79ebd4d91b0ab4312a8952c6a4168caabe6cbcf / . / PRESUBMIT_test_mocks.py
blob: 9928c71f1beba210b00c1d8e6e550f422719befc [file] [log] [blame]
gayane3dff8c22014-12-04 17:09:51[diff] [blame]1# Copyright 2014 The Chromium Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
Chris Hall59f8d0c72020-05-01 07:31:19[diff] [blame]5from collections import defaultdict
Daniel Cheng13ca61a882017-08-25 15:11:25[diff] [blame]6import fnmatch
gayane3dff8c22014-12-04 17:09:51[diff] [blame]7import json
8import os
9import re
10import subprocess
11import sys
12
Daniel Cheng264a447d2017-09-28 22:17:59[diff] [blame]13# TODO(dcheng): It's kind of horrible that this is copy and pasted from
14# presubmit_canned_checks.py, but it's far easier than any of the alternatives.
15def _ReportErrorFileAndLine(filename, line_num, dummy_line):
16 """Default error formatter for _FindNewViolationsOfRule."""
17 return '%s:%s' % (filename, line_num)
18
19
20class MockCannedChecks(object):
21 def _FindNewViolationsOfRule(self, callable_rule, input_api,
22 source_file_filter=None,
23 error_formatter=_ReportErrorFileAndLine):
24 """Find all newly introduced violations of a per-line rule (a callable).
25
26 Arguments:
27 callable_rule: a callable taking a file extension and line of input and
28 returning True if the rule is satisfied and False if there was a
29 problem.
30 input_api: object to enumerate the affected files.
31 source_file_filter: a filter to be passed to the input api.
32 error_formatter: a callable taking (filename, line_number, line) and
33 returning a formatted error string.
34
35 Returns:
36 A list of the newly-introduced violations reported by the rule.
37 """
38 errors = []
39 for f in input_api.AffectedFiles(include_deletes=False,
40 file_filter=source_file_filter):
41 # For speed, we do two passes, checking first the full file. Shelling out
42 # to the SCM to determine the changed region can be quite expensive on
43 # Win32. Assuming that most files will be kept problem-free, we can
44 # skip the SCM operations most of the time.
45 extension = str(f.LocalPath()).rsplit('.', 1)[-1]
46 if all(callable_rule(extension, line) for line in f.NewContents()):
47 continue # No violation found in full text: can skip considering diff.
48
49 for line_num, line in f.ChangedContents():
50 if not callable_rule(extension, line):
51 errors.append(error_formatter(f.LocalPath(), line_num, line))
52
53 return errors
gayane3dff8c22014-12-04 17:09:51[diff] [blame]54
Zhiling Huang45cabf32018-03-10 00:50:03[diff] [blame]55
gayane3dff8c22014-12-04 17:09:51[diff] [blame]56class MockInputApi(object):
57 """Mock class for the InputApi class.
58
59 This class can be used for unittests for presubmit by initializing the files
60 attribute as the list of changed files.
61 """
62
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]63 DEFAULT_FILES_TO_SKIP = ()
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]64
gayane3dff8c22014-12-04 17:09:51[diff] [blame]65 def __init__(self):
Daniel Cheng264a447d2017-09-28 22:17:59[diff] [blame]66 self.canned_checks = MockCannedChecks()
Daniel Cheng13ca61a882017-08-25 15:11:25[diff] [blame]67 self.fnmatch = fnmatch
gayane3dff8c22014-12-04 17:09:51[diff] [blame]68 self.json = json
69 self.re = re
70 self.os_path = os.path
agrievebb9c5b472016-04-22 15:13:00[diff] [blame]71 self.platform = sys.platform
gayane3dff8c22014-12-04 17:09:51[diff] [blame]72 self.python_executable = sys.executable
Takuto Ikutadca10222022-04-13 02:51:21[diff] [blame]73 self.python3_executable = sys.executable
pastarmovj89f7ee12016-09-20 14:58:13[diff] [blame]74 self.platform = sys.platform
gayane3dff8c22014-12-04 17:09:51[diff] [blame]75 self.subprocess = subprocess
Dan Beam35b10c12019-11-27 01:17:34[diff] [blame]76 self.sys = sys
gayane3dff8c22014-12-04 17:09:51[diff] [blame]77 self.files = []
78 self.is_committing = False
gayanee1702662014-12-13 03:48:09[diff] [blame]79 self.change = MockChange([])
dpapad5c9c24e2017-05-31 20:51:34[diff] [blame]80 self.presubmit_local_path = os.path.dirname(__file__)
Bruce Dawson3740e0732022-04-07 16:17:22[diff] [blame]81 self.is_windows = sys.platform == 'win32'
Bruce Dawson344ab262022-06-04 11:35:10[diff] [blame]82 self.no_diffs = False
gayane3dff8c22014-12-04 17:09:51[diff] [blame]83
Zhiling Huang45cabf32018-03-10 00:50:03[diff] [blame]84 def CreateMockFileInPath(self, f_list):
85 self.os_path.exists = lambda x: x in f_list
86
Giovanni Ortuño Urquidiab84da62021-12-10 00:53:21[diff] [blame]87 def AffectedFiles(self, file_filter=None, include_deletes=True):
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]88 for file in self.files:
89 if file_filter and not file_filter(file):
90 continue
91 if not include_deletes and file.Action() == 'D':
92 continue
93 yield file
gayane3dff8c22014-12-04 17:09:51[diff] [blame]94
Lukasz Anforowicz7016d05e2021-11-30 03:56:27[diff] [blame]95 def RightHandSideLines(self, source_file_filter=None):
96 affected_files = self.AffectedSourceFiles(source_file_filter)
97 for af in affected_files:
98 lines = af.ChangedContents()
99 for line in lines:
100 yield (af, line[0], line[1])
101
glidere61efad2015-02-18 17:39:43[diff] [blame]102 def AffectedSourceFiles(self, file_filter=None):
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]103 return self.AffectedFiles(file_filter=file_filter)
104
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]105 def FilterSourceFile(self, file,
Josip Sokcevic8b6cc432020-08-05 17:45:33[diff] [blame]106 files_to_check=(), files_to_skip=()):
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]107 local_path = file.LocalPath()
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]108 found_in_files_to_check = not files_to_check
109 if files_to_check:
110 if type(files_to_check) is str:
111 raise TypeError('files_to_check should be an iterable of strings')
112 for pattern in files_to_check:
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]113 compiled_pattern = re.compile(pattern)
Henrique Ferreiro81d580022021-11-29 21:27:19[diff] [blame]114 if compiled_pattern.match(local_path):
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]115 found_in_files_to_check = True
Vaclav Brozekf01ed502018-03-16 19:38:24[diff] [blame]116 break
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]117 if files_to_skip:
118 if type(files_to_skip) is str:
119 raise TypeError('files_to_skip should be an iterable of strings')
120 for pattern in files_to_skip:
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]121 compiled_pattern = re.compile(pattern)
Henrique Ferreiro81d580022021-11-29 21:27:19[diff] [blame]122 if compiled_pattern.match(local_path):
Sylvain Defresnea8b73d252018-02-28 15:45:54[diff] [blame]123 return False
Robert Ma0303a3ad2020-07-22 18:48:48[diff] [blame]124 return found_in_files_to_check
glidere61efad2015-02-18 17:39:43[diff] [blame]125
davileene0426252015-03-02 21:10:41[diff] [blame]126 def LocalPaths(self):
Alexei Svitkine137d4c662019-07-17 21:28:24[diff] [blame]127 return [file.LocalPath() for file in self.files]
davileene0426252015-03-02 21:10:41[diff] [blame]128
gayane3dff8c22014-12-04 17:09:51[diff] [blame]129 def PresubmitLocalPath(self):
dpapad5c9c24e2017-05-31 20:51:34[diff] [blame]130 return self.presubmit_local_path
gayane3dff8c22014-12-04 17:09:51[diff] [blame]131
132 def ReadFile(self, filename, mode='rU'):
glidere61efad2015-02-18 17:39:43[diff] [blame]133 if hasattr(filename, 'AbsoluteLocalPath'):
134 filename = filename.AbsoluteLocalPath()
gayane3dff8c22014-12-04 17:09:51[diff] [blame]135 for file_ in self.files:
136 if file_.LocalPath() == filename:
137 return '\n'.join(file_.NewContents())
138 # Otherwise, file is not in our mock API.
Dirk Prankee3c9c62d2021-05-18 18:35:59[diff] [blame]139 raise IOError("No such file or directory: '%s'" % filename)
gayane3dff8c22014-12-04 17:09:51[diff] [blame]140
141
142class MockOutputApi(object):
gayane860db5c2014-12-05 16:16:46[diff] [blame]143 """Mock class for the OutputApi class.
gayane3dff8c22014-12-04 17:09:51[diff] [blame]144
Gao Shenga79ebd42022-08-08 17:25:59[diff] [blame^]145 An instance of this class can be passed to presubmit unittests for outputting
gayane3dff8c22014-12-04 17:09:51[diff] [blame]146 various types of results.
147 """
148
149 class PresubmitResult(object):
150 def __init__(self, message, items=None, long_text=''):
151 self.message = message
152 self.items = items
153 self.long_text = long_text
154
gayane940df072015-02-24 14:28:30[diff] [blame]155 def __repr__(self):
156 return self.message
157
gayane3dff8c22014-12-04 17:09:51[diff] [blame]158 class PresubmitError(PresubmitResult):
davileene0426252015-03-02 21:10:41[diff] [blame]159 def __init__(self, message, items=None, long_text=''):
gayane3dff8c22014-12-04 17:09:51[diff] [blame]160 MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
161 self.type = 'error'
162
163 class PresubmitPromptWarning(PresubmitResult):
davileene0426252015-03-02 21:10:41[diff] [blame]164 def __init__(self, message, items=None, long_text=''):
gayane3dff8c22014-12-04 17:09:51[diff] [blame]165 MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
166 self.type = 'warning'
167
168 class PresubmitNotifyResult(PresubmitResult):
davileene0426252015-03-02 21:10:41[diff] [blame]169 def __init__(self, message, items=None, long_text=''):
gayane3dff8c22014-12-04 17:09:51[diff] [blame]170 MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
171 self.type = 'notify'
172
173 class PresubmitPromptOrNotify(PresubmitResult):
davileene0426252015-03-02 21:10:41[diff] [blame]174 def __init__(self, message, items=None, long_text=''):
gayane3dff8c22014-12-04 17:09:51[diff] [blame]175 MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
176 self.type = 'promptOrNotify'
177
Daniel Cheng7052cdf2017-11-21 19:23:29[diff] [blame]178 def __init__(self):
179 self.more_cc = []
180
181 def AppendCC(self, more_cc):
Kevin McNee967dd2d22021-11-15 16:09:29[diff] [blame]182 self.more_cc.append(more_cc)
Daniel Cheng7052cdf2017-11-21 19:23:29[diff] [blame]183
gayane3dff8c22014-12-04 17:09:51[diff] [blame]184
185class MockFile(object):
186 """Mock class for the File class.
187
188 This class can be used to form the mock list of changed files in
189 MockInputApi for presubmit unittests.
190 """
191
Dominic Battre645d42342020-12-04 16:14:10[diff] [blame]192 def __init__(self, local_path, new_contents, old_contents=None, action='A',
193 scm_diff=None):
gayane3dff8c22014-12-04 17:09:51[diff] [blame]194 self._local_path = local_path
195 self._new_contents = new_contents
196 self._changed_contents = [(i + 1, l) for i, l in enumerate(new_contents)]
agrievef32bcc72016-04-04 14:57:40[diff] [blame]197 self._action = action
Dominic Battre645d42342020-12-04 16:14:10[diff] [blame]198 if scm_diff:
199 self._scm_diff = scm_diff
200 else:
201 self._scm_diff = (
202 "--- /dev/null\n+++ %s\n@@ -0,0 +1,%d @@\n" %
203 (local_path, len(new_contents)))
204 for l in new_contents:
205 self._scm_diff += "+%s\n" % l
Yoland Yanb92fa522017-08-28 17:37:06[diff] [blame]206 self._old_contents = old_contents
gayane3dff8c22014-12-04 17:09:51[diff] [blame]207
dbeam37e8e7402016-02-10 22:58:20[diff] [blame]208 def Action(self):
agrievef32bcc72016-04-04 14:57:40[diff] [blame]209 return self._action
dbeam37e8e7402016-02-10 22:58:20[diff] [blame]210
gayane3dff8c22014-12-04 17:09:51[diff] [blame]211 def ChangedContents(self):
212 return self._changed_contents
213
214 def NewContents(self):
215 return self._new_contents
216
217 def LocalPath(self):
218 return self._local_path
219
rdevlin.cronin9ab806c2016-02-26 23:17:13[diff] [blame]220 def AbsoluteLocalPath(self):
221 return self._local_path
222
jbriance9e12f162016-11-25 07:57:50[diff] [blame]223 def GenerateScmDiff(self):
jbriance2c51e821a2016-12-12 08:24:31[diff] [blame]224 return self._scm_diff
jbriance9e12f162016-11-25 07:57:50[diff] [blame]225
Yoland Yanb92fa522017-08-28 17:37:06[diff] [blame]226 def OldContents(self):
227 return self._old_contents
228
davileene0426252015-03-02 21:10:41[diff] [blame]229 def rfind(self, p):
230 """os.path.basename is called on MockFile so we need an rfind method."""
231 return self._local_path.rfind(p)
232
233 def __getitem__(self, i):
234 """os.path.basename is called on MockFile so we need a get method."""
235 return self._local_path[i]
236
pastarmovj89f7ee12016-09-20 14:58:13[diff] [blame]237 def __len__(self):
238 """os.path.basename is called on MockFile so we need a len method."""
239 return len(self._local_path)
240
Julian Pastarmov4f7af532019-07-17 19:25:37[diff] [blame]241 def replace(self, altsep, sep):
242 """os.path.basename is called on MockFile so we need a replace method."""
243 return self._local_path.replace(altsep, sep)
244
gayane3dff8c22014-12-04 17:09:51[diff] [blame]245
glidere61efad2015-02-18 17:39:43[diff] [blame]246class MockAffectedFile(MockFile):
247 def AbsoluteLocalPath(self):
248 return self._local_path
249
250
gayane3dff8c22014-12-04 17:09:51[diff] [blame]251class MockChange(object):
252 """Mock class for Change class.
253
254 This class can be used in presubmit unittests to mock the query of the
255 current change.
256 """
257
258 def __init__(self, changed_files):
259 self._changed_files = changed_files
Chris Hall59f8d0c72020-05-01 07:31:19[diff] [blame]260 self.footers = defaultdict(list)
gayane3dff8c22014-12-04 17:09:51[diff] [blame]261
262 def LocalPaths(self):
263 return self._changed_files
rdevlin.cronin11366822016-05-02 17:05:54[diff] [blame]264
265 def AffectedFiles(self, include_dirs=False, include_deletes=True,
266 file_filter=None):
267 return self._changed_files
Chris Hall59f8d0c72020-05-01 07:31:19[diff] [blame]268
269 def GitFootersFromDescription(self):
270 return self.footers