| # Copyright 2020 Google LLC | |
| # | |
| # 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. | |
| import os | |
| import shutil | |
| import nox | |
| BLACK_VERSION = "black==23.7.0" | |
| ISORT_VERSION = "isort==5.10.1" | |
| BLACK_PATHS = [ | |
| "apiclient", | |
| "googleapiclient", | |
| "scripts", | |
| "tests", | |
| "describe.py", | |
| "expandsymlinks.py", | |
| "noxfile.py", | |
| "owlbot.py", | |
| "setup.py", | |
| ] | |
| DEFAULT_PYTHON_VERSION = "3.14" | |
| test_dependencies = [ | |
| "django>=2.0.0", | |
| "google-auth", | |
| "google-auth-httplib2", | |
| "mox", | |
| "parameterized", | |
| "pyopenssl", | |
| "cryptography>=38.0.3", | |
| "pytest", | |
| "pytest-cov", | |
| "webtest", | |
| "coverage", | |
| ] | |
| nox.options.sessions = [ | |
| "unit-3.10", | |
| "unit-3.11", | |
| "unit-3.12", | |
| "unit-3.13", | |
| "unit-3.14", | |
| "unit-3.15", | |
| "lint", | |
| "format", | |
| "scripts", | |
| ] | |
| # Error if a python version is missing | |
| nox.options.error_on_missing_interpreters = True | |
| @nox.session(python=DEFAULT_PYTHON_VERSION) | |
| def lint(session): | |
| session.install("flake8") | |
| session.run( | |
| "flake8", | |
| "googleapiclient", | |
| "tests", | |
| "--count", | |
| "--select=E9,F63,F7,F82", | |
| "--show-source", | |
| "--statistics", | |
| ) | |
| @nox.session(python=DEFAULT_PYTHON_VERSION) | |
| def format(session): | |
| """ | |
| Run isort to sort imports. Then run black | |
| to format code to uniform standard. | |
| """ | |
| session.install(BLACK_VERSION, ISORT_VERSION) | |
| # Use the --fss option to sort imports using strict alphabetical order. | |
| # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections | |
| session.run( | |
| "isort", | |
| "--fss", | |
| *BLACK_PATHS, | |
| ) | |
| session.run( | |
| "black", | |
| *BLACK_PATHS, | |
| ) | |
| @nox.session(python=["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]) | |
| @nox.parametrize( | |
| "oauth2client", | |
| [ | |
| None, | |
| "oauth2client<2dev", | |
| "oauth2client>=2,<=3dev", | |
| "oauth2client>=3,<=4dev", | |
| "oauth2client>=4,<=5dev", | |
| ], | |
| ) | |
| def unit(session, oauth2client): | |
| # Clean up dist and build folders | |
| shutil.rmtree("dist", ignore_errors=True) | |
| shutil.rmtree("build", ignore_errors=True) | |
| session.install(*test_dependencies) | |
| if oauth2client is not None: | |
| session.install(oauth2client) | |
| # Create and install wheels | |
| session.install("setuptools", "wheel") | |
| session.run("python3", "setup.py", "bdist_wheel") | |
| session.install(os.path.join("dist", os.listdir("dist").pop())) | |
| root_dir = os.path.dirname(os.path.realpath(__file__)) | |
| constraints_path = str(f"{root_dir}/testing/constraints-{session.python}.txt") | |
| session.install("-r", constraints_path) | |
| # Run tests from a different directory to test the package artifacts | |
| temp_dir = session.create_tmp() | |
| session.chdir(temp_dir) | |
| shutil.copytree(os.path.join(root_dir, "tests"), "tests") | |
| # Run py.test against the unit tests. | |
| session.run( | |
| "py.test", | |
| "--quiet", | |
| "--cov=googleapiclient", | |
| "--cov=tests", | |
| "--cov-append", | |
| "--cov-config=.coveragerc", | |
| "--cov-report=", | |
| "--cov-fail-under=85", | |
| "tests", | |
| *session.posargs, | |
| ) | |
| @nox.session(python=DEFAULT_PYTHON_VERSION) | |
| def scripts(session): | |
| session.install(*test_dependencies) | |
| session.install("-e", ".") | |
| session.install("-r", "scripts/requirements.txt") | |
| # Run py.test against the unit tests. | |
| # TODO(https://github.com/googleapis/google-api-python-client/issues/2132): Add tests for describe.py | |
| session.run( | |
| "py.test", | |
| "--quiet", | |
| "--cov=scripts", | |
| "--cov-config=.coveragerc", | |
| "--cov-report=", | |
| "--cov-fail-under=90", | |
| "scripts", | |
| *session.posargs, | |
| ) |