Skip to content
Navigation Menu
{{ message }}
forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnoxfile.py
More file actions
307 lines (236 loc) · 9.28 KB
/
Copy pathnoxfile.py
File metadata and controls
307 lines (236 loc) · 9.28 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
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# Copyright 2016 Google Inc. All Rights Reserved.
#
# 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
#
# http://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.
from __future__ import print_function
import fnmatch
import os
import tempfile
import nox
try:
import ci_diff_helper
except ImportError:
ci_diff_helper = None
#
# Helpers and utility functions
#
def _list_files(folder, pattern):
"""Lists all files below the given folder that match the pattern."""
for root, folders, files in os.walk(folder):
for filename in files:
if fnmatch.fnmatch(filename, pattern):
yield os.path.join(root, filename)
def _collect_dirs(
start_dir,
blacklist=set(['conftest.py', 'noxfile.py', 'lib', 'third_party']),
suffix='_test.py',
recurse_further=False):
"""Recursively collects a list of dirs that contain a file matching the
given suffix.
This works by listing the contents of directories and finding
directories that have `*_test.py` files.
"""
# Collect all the directories that have tests in them.
for parent, subdirs, files in os.walk(start_dir):
if './.' in parent:
continue # Skip top-level dotfiles
elif any(
f for f in files if f.endswith(suffix) and f not in blacklist
):
# Don't recurse further for tests, since py.test will do that.
if not recurse_further:
del subdirs[:]
# This dir has desired files in it. yield it.
yield parent
else:
# Filter out dirs we don't want to recurse into
subdirs[:] = [
s for s in subdirs
if s[0].isalpha() and
s not in blacklist]
def _get_changed_files():
"""Returns a list of files changed for this pull request / push.
If running on a public CI like Travis or Circle this is used to only
run tests/lint for changed files.
"""
if not ci_diff_helper:
return None
try:
config = ci_diff_helper.get_config()
except OSError: # Not on CI.
return None
changed_files = ci_diff_helper.get_changed_files('HEAD', config.base)
changed_files = set([
'./{}'.format(filename) for filename in changed_files])
return changed_files
def _filter_samples(sample_dirs, changed_files):
"""Filers the list of sample directories to only include directories that
contain files in the list of changed files."""
result = []
for sample_dir in sample_dirs:
for changed_file in changed_files:
if changed_file.startswith(sample_dir):
result.append(sample_dir)
return list(set(result))
def _determine_local_import_names(start_dir):
"""Determines all import names that should be considered "local".
This is used when running the linter to insure that import order is
properly checked.
"""
file_ext_pairs = [os.path.splitext(path) for path in os.listdir(start_dir)]
return [
basename
for basename, extension
in file_ext_pairs
if extension == '.py' or os.path.isdir(
os.path.join(start_dir, basename))
and basename not in ('__pycache__')]
#
# App Engine specific helpers
#
_GAE_ROOT = os.environ.get('GAE_ROOT')
if _GAE_ROOT is None:
_GAE_ROOT = tempfile.mkdtemp()
def _setup_appengine_sdk(session):
"""Installs the App Engine SDK, if needed."""
session.env['GAE_SDK_PATH'] = os.path.join(_GAE_ROOT, 'google_appengine')
session.run('gcp-devrel-py-tools', 'download-appengine-sdk', _GAE_ROOT)
#
# Test sessions
#
PYTEST_COMMON_ARGS = ['--junitxml=sponge_log.xml']
# Ignore I202 "Additional newline in a section of imports." to accommodate
# region tags in import blocks. Since we specify an explicit ignore, we also
# have to explicitly ignore the list of default ignores:
# `E121,E123,E126,E226,E24,E704,W503,W504` as shown by `flake8 --help`.
FLAKE8_COMMON_ARGS = [
'--show-source', '--builtin', 'gettext', '--max-complexity', '20',
'--import-order-style', 'google',
'--exclude', '.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py',
'--ignore=E121,E123,E126,E226,E24,E704,W503,W504,I100,I201,I202',
]
# Collect sample directories.
ALL_TESTED_SAMPLES = sorted(list(_collect_dirs('.')))
ALL_SAMPLE_DIRECTORIES = sorted(list(_collect_dirs(
'.',
suffix='.py',
recurse_further=True
)))
GAE_STANDARD_SAMPLES = [
sample for sample in ALL_TESTED_SAMPLES
if sample.startswith('./appengine/standard/')]
PY2_ONLY_SAMPLES = GAE_STANDARD_SAMPLES
PY3_ONLY_SAMPLES = [
sample for sample in ALL_TESTED_SAMPLES
if (sample.startswith('./appengine/standard_python37')
or sample.startswith('./functions/'))]
NON_GAE_STANDARD_SAMPLES_PY2 = sorted(list((
set(ALL_TESTED_SAMPLES) -
set(GAE_STANDARD_SAMPLES)) -
set(PY3_ONLY_SAMPLES)
))
NON_GAE_STANDARD_SAMPLES_PY3 = sorted(
list(set(ALL_TESTED_SAMPLES) - set(PY2_ONLY_SAMPLES)))
# Filter sample directories if on a CI like Travis or Circle to only run tests
# for changed samples.
CHANGED_FILES = _get_changed_files()
if CHANGED_FILES is not None:
print('Filtering based on changed files.')
ALL_TESTED_SAMPLES = _filter_samples(
ALL_TESTED_SAMPLES, CHANGED_FILES)
ALL_SAMPLE_DIRECTORIES = _filter_samples(
ALL_SAMPLE_DIRECTORIES, CHANGED_FILES)
GAE_STANDARD_SAMPLES = _filter_samples(
GAE_STANDARD_SAMPLES, CHANGED_FILES)
NON_GAE_STANDARD_SAMPLES_PY2 = _filter_samples(
NON_GAE_STANDARD_SAMPLES_PY2, CHANGED_FILES)
NON_GAE_STANDARD_SAMPLES_PY3 = _filter_samples(
NON_GAE_STANDARD_SAMPLES_PY3, CHANGED_FILES)
def _session_tests(session, sample, post_install=None):
"""Runs py.test for a particular sample."""
session.install('-r', 'testing/requirements.txt')
session.chdir(sample)
if os.path.exists('requirements.txt'):
session.install('-r', 'requirements.txt')
if post_install:
post_install(session)
session.run(
'pytest',
*(PYTEST_COMMON_ARGS + session.posargs),
# Pytest will return 5 when no tests are collected. This can happen
# on travis where slow and flaky tests are excluded.
# See http://doc.pytest.org/en/latest/_modules/_pytest/main.html
success_codes=[0, 5])
@nox.session(python='2.7')
@nox.parametrize('sample', GAE_STANDARD_SAMPLES)
def gae(session, sample):
"""Runs py.test for an App Engine standard sample."""
# Create a lib directory if needed, otherwise the App Engine vendor library
# will complain.
if not os.path.isdir(os.path.join(sample, 'lib')):
os.mkdir(os.path.join(sample, 'lib'))
_session_tests(session, sample, _setup_appengine_sdk)
@nox.session(python='2.7')
@nox.parametrize('sample', NON_GAE_STANDARD_SAMPLES_PY2)
def py27(session, sample):
"""Runs py.test for a sample using Python 2.7"""
_session_tests(session, sample)
@nox.session(python='3.6')
@nox.parametrize('sample', NON_GAE_STANDARD_SAMPLES_PY3)
def py36(session, sample):
"""Runs py.test for a sample using Python 3.6"""
_session_tests(session, sample)
@nox.session
@nox.parametrize('sample', ALL_SAMPLE_DIRECTORIES)
def lint(session, sample):
"""Runs flake8 on the sample."""
session.install('flake8', 'flake8-import-order')
local_names = _determine_local_import_names(sample)
args = FLAKE8_COMMON_ARGS + [
'--application-import-names', ','.join(local_names),
'.']
session.chdir(sample)
session.run('flake8', *args)
#
# Utility sessions
#
@nox.session
def missing_tests(session):
"""Lists all sample directories that do not have tests."""
print('The following samples do not have tests:')
for sample in set(ALL_SAMPLE_DIRECTORIES) - set(ALL_TESTED_SAMPLES):
print('* {}'.format(sample))
SAMPLES_WITH_GENERATED_READMES = sorted(
list(_collect_dirs('.', suffix='.rst.in')))
@nox.session
@nox.parametrize('sample', SAMPLES_WITH_GENERATED_READMES)
def readmegen(session, sample):
"""(Re-)generates the readme for a sample."""
session.install('jinja2', 'pyyaml')
if os.path.exists(os.path.join(sample, 'requirements.txt')):
session.install('-r', os.path.join(sample, 'requirements.txt'))
in_file = os.path.join(sample, 'README.rst.in')
session.run('python', 'scripts/readme-gen/readme_gen.py', in_file)
@nox.session
def check_requirements(session):
"""Checks for out of date requirements and optionally updates them.
This is intentionally not parametric, as it's desired to never have two
samples with differing versions of dependencies.
"""
session.install('-r', 'testing/requirements.txt')
if 'update' in session.posargs:
command = 'update-requirements'
else:
command = 'check-requirements'
reqfiles = list(_list_files('.', 'requirements*.txt'))
for reqfile in reqfiles:
session.run('gcp-devrel-py-tools', command, reqfile)
You can’t perform that action at this time.