forked from googleapis/google-resumable-media-python
-
Notifications
You must be signed in to change notification settings - Fork 3
/
noxfile.py
169 lines (138 loc) · 4.72 KB
/
noxfile.py
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
# Copyright 2017 Google Inc.
#
# 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 absolute_import
import os
import shutil
import nox
SYSTEM_TEST_ENV_VARS = (
'GOOGLE_APPLICATION_CREDENTIALS',
)
GOOGLE_AUTH = 'google-auth >= 0.10.0'
@nox.session(python=['2.7', '3.5', '3.6', '3.7', '3.8'])
def unit(session):
"""Run the unit test suite."""
# Install all test dependencies, then install this package in-place.
session.install('mock', 'pytest', 'pytest-cov')
session.install('-e', '.[requests]')
# Run py.test against the unit tests.
# NOTE: We don't require 100% line coverage for unit test runs since
# some have branches that are Py2/Py3 specific.
line_coverage = '--cov-fail-under=0'
session.run(
'py.test',
'--cov=google.resumable_media',
'--cov=tests.unit',
'--cov-append',
'--cov-config=.coveragerc',
'--cov-report=',
line_coverage,
os.path.join('tests', 'unit'),
*session.posargs
)
@nox.session(python='3.8')
def docs(session):
"""Build the docs for this library."""
session.install("-e", ".")
session.install("sphinx", "alabaster", "recommonmark")
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
"sphinx-build",
"-W", # warnings as errors
"-T", # show full traceback on exception
"-N", # no colors
"-b",
"html",
"-d",
os.path.join("docs", "_build", "doctrees", ""),
os.path.join("docs", ""),
os.path.join("docs", "_build", "html", ""),
)
@nox.session(python='3.8')
def doctest(session):
"""Run the doctests."""
session.install("-e", ".[requests]")
session.install("sphinx", "alabaster", "recommonmark")
session.install(
"sphinx",
"sphinx_rtd_theme",
"sphinx-docstring-typing >= 0.0.3",
"mock",
GOOGLE_AUTH,
)
# Run the doctests with Sphinx.
session.run(
"sphinx-build",
"-W",
"-b",
"doctest",
"-d", os.path.join("docs", "_build", "doctrees"),
os.path.join("docs", ""),
os.path.join("docs", "_build", "doctest"),
)
@nox.session(python='3.8')
def lint(session):
"""Run flake8.
Returns a failure if flake8 finds linting errors or sufficiently
serious code quality issues.
"""
session.install('flake8', 'black')
session.install('-e', '.')
session.run(
'flake8',
os.path.join('google', 'resumable_media'),
'tests',
)
session.run("black", "--check", os.path.join("google", "resumable_media"), "tests")
@nox.session(python='3.8')
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')
@nox.session(python='3.8')
def blacken(session):
session.install("black")
session.run("black", os.path.join("google", "resumable_media"), "tests")
@nox.session(python=['2.7', '3.8'])
def system(session):
"""Run the system test suite."""
# Sanity check: environment variables are set.
missing = []
for env_var in SYSTEM_TEST_ENV_VARS:
if env_var not in os.environ:
missing.append(env_var)
# Only run system tests if the environment variables are set.
if missing:
all_vars = ', '.join(missing)
msg = 'Environment variable(s) unset: {}'.format(all_vars)
session.skip(msg)
# Install all test dependencies, then install this package into the
# virutalenv's dist-packages.
session.install('mock', 'pytest', GOOGLE_AUTH)
session.install('-e', '.[requests]')
# Run py.test against the system tests.
session.run(
'py.test',
os.path.join('tests', 'system'),
*session.posargs
)
@nox.session(python='3.8')
def cover(session):
"""Run the final coverage report.
This outputs the coverage report aggregating coverage from the unit
test runs (not system test runs), and then erases coverage data.
"""
session.install('coverage', 'pytest-cov')
session.run('coverage', 'report', '--show-missing', '--fail-under=100')
session.run('coverage', 'erase')