From 56cd6320d62deb991d1591f9f19edd71e4c49ac1 Mon Sep 17 00:00:00 2001 From: Christopher Wilcox Date: Wed, 28 Nov 2018 13:55:23 -0800 Subject: [PATCH] Add templates for flake8, coveragerc, noxfile, and black. (#6642) --- packages/google-cloud-container/.coveragerc | 18 +++ packages/google-cloud-container/.flake8 | 13 ++ packages/google-cloud-container/noxfile.py | 142 ++++++++++++++------ packages/google-cloud-container/synth.py | 41 +++--- 4 files changed, 153 insertions(+), 61 deletions(-) create mode 100644 packages/google-cloud-container/.coveragerc create mode 100644 packages/google-cloud-container/.flake8 diff --git a/packages/google-cloud-container/.coveragerc b/packages/google-cloud-container/.coveragerc new file mode 100644 index 000000000000..51fec440cebf --- /dev/null +++ b/packages/google-cloud-container/.coveragerc @@ -0,0 +1,18 @@ +[run] +branch = True + +[report] +fail_under = 100 +show_missing = True +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore abstract methods + raise NotImplementedError +omit = + */gapic/*.py + */proto/*.py + */google-cloud-python/core/*.py + */site-packages/*.py \ No newline at end of file diff --git a/packages/google-cloud-container/.flake8 b/packages/google-cloud-container/.flake8 new file mode 100644 index 000000000000..61766fa84d02 --- /dev/null +++ b/packages/google-cloud-container/.flake8 @@ -0,0 +1,13 @@ +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + *_pb2.py + + # Standard linting exemptions. + __pycache__, + .git, + *.pyc, + conf.py diff --git a/packages/google-cloud-container/noxfile.py b/packages/google-cloud-container/noxfile.py index aedea904850e..1c1f69cc6f13 100644 --- a/packages/google-cloud-container/noxfile.py +++ b/packages/google-cloud-container/noxfile.py @@ -1,10 +1,12 @@ -# Copyright 2017, Google LLC All rights reserved. +# -*- coding: utf-8 -*- +# +# Copyright 2018 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 +# 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, @@ -13,74 +15,126 @@ # limitations under the License. from __future__ import absolute_import - import os import nox -LOCAL_DEPS = ( - os.path.join('..', 'api_core'), -) +LOCAL_DEPS = (os.path.join("..", "api_core"), os.path.join("..", "core")) -def default(session): - """Default unit test session. - This is intended to be run **without** an interpreter set, so - that the current ``python`` (on the ``PATH``) or the version of - Python corresponding to the ``nox`` binary on the ``PATH`` can - run the tests. +@nox.session(python="3.7") +def blacken(session): + """Run black. + + Format code to uniform standard. """ - session.install('mock', 'pytest', 'pytest-cov') + session.install("black") + session.run( + "black", + "google", + "tests", + "docs", + "--exclude", + ".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py", + ) + + +@nox.session(python="3.7") +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", "black", *LOCAL_DEPS) + session.run( + "black", + "--check", + "google", + "tests", + "docs", + "--exclude", + ".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py", + ) + session.run("flake8", "google", "tests") + + +@nox.session(python="3.7") +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") + + +def default(session): + # Install all test dependencies, then install this package in-place. + session.install("mock", "pytest", "pytest-cov") for local_dep in LOCAL_DEPS: - session.install('-e', local_dep) - session.install('-e', '.') + session.install("-e", local_dep) + session.install("-e", ".") # Run py.test against the unit tests. session.run( - 'py.test', - '--quiet', - '--cov=google.cloud.container', - '--cov=google.cloud.container_v1', - '--cov=tests.unit', - '--cov-append', - '--cov-config=.coveragerc', - '--cov-report=', - os.path.join('tests', 'unit'), - *session.posargs + "py.test", + "--quiet", + "--cov=google.cloud", + "--cov=tests.unit", + "--cov-append", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=76", + os.path.join("tests", "unit"), + *session.posargs, ) -@nox.session(python=['2.7', '3.5', '3.6', '3.7']) + +@nox.session(python=["2.7", "3.5", "3.6", "3.7"]) def unit(session): - """Default unit test session.""" - # Install all test dependencies, then install local packages in-place. + """Run the unit test suite.""" default(session) -@nox.session(python=['2.7', '3.6']) + +@nox.session(python=["2.7", "3.7"]) def system(session): """Run the system test suite.""" + system_test_path = os.path.join("tests", "system.py") + system_test_folder_path = os.path.join("tests", "system") + # Sanity check: Only run tests if the environment variable is set. + if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""): + session.skip("Credentials must be set via environment variable") - # Sanity check: Only run system tests if the environment variable is set. - if not os.environ.get('GOOGLE_APPLICATION_CREDENTIALS', ''): - session.skip('Credentials must be set via environment variable.') + system_test_exists = os.path.exists(system_test_path) + system_test_folder_exists = os.path.exists(system_test_folder_path) + # Sanity check: only run tests if found. + if not system_test_exists and not system_test_folder_exists: + session.skip("System tests were not found") # Use pre-release gRPC for system tests. - session.install('--pre', 'grpcio') + session.install("--pre", "grpcio") # Install all test dependencies, then install this package into the # virtualenv's dist-packages. - session.install('mock', 'pytest') + session.install("mock", "pytest") for local_dep in LOCAL_DEPS: - session.install('-e', local_dep) - session.install('-e', '../test_utils/') - session.install('-e', '.') + session.install("-e", local_dep) + session.install("-e", "../test_utils/") + session.install("-e", ".") # Run py.test against the system tests. - session.run('py.test', '--quiet', 'tests/system/', *session.posargs) + if system_test_exists: + session.run("py.test", "--quiet", system_test_path, *session.posargs) + if system_test_folder_exists: + session.run("py.test", "--quiet", system_test_folder_path, *session.posargs) -@nox.session(python='3.6') -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.7") +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=77") + + session.run("coverage", "erase") diff --git a/packages/google-cloud-container/synth.py b/packages/google-cloud-container/synth.py index 85f43c898ae9..41812254e8c5 100644 --- a/packages/google-cloud-container/synth.py +++ b/packages/google-cloud-container/synth.py @@ -17,36 +17,43 @@ from synthtool import gcp gapic = gcp.GAPICGenerator() +common = gcp.CommonTemplates() - -#---------------------------------------------------------------------------- -# Generate container client -#---------------------------------------------------------------------------- +# ---------------------------------------------------------------------------- +# Generate container GAPIC layer +# ---------------------------------------------------------------------------- library = gapic.py_library( - 'container', - 'v1', - config_path='/google/container/artman_container_v1.yaml', - artman_output_name='container-v1') + "container", + "v1", + config_path="/google/container/artman_container_v1.yaml", + artman_output_name="container-v1", +) -s.move(library / 'google/cloud/container_v1') -s.move(library / 'tests/unit/gapic/v1') +s.move(library / "google/cloud/container_v1") +s.move(library / "tests/unit/gapic/v1") # Issues exist where python files should define the source encoding # https://github.com/googleapis/gapic-generator/issues/2097 s.replace( - 'google/**/proto/*_pb2.py', + "google/**/proto/*_pb2.py", r"(^.*$\n)*", r"# -*- coding: utf-8 -*-\n\g<0>") # Workaround https://github.com/googleapis/gapic-generator/issues/2449 s.replace( - 'google/cloud/container_v1/proto/cluster_service_pb2.py', - r'nodePool>\n', - r'nodePool>`__\n', + "google/cloud/container_v1/proto/cluster_service_pb2.py", + r"nodePool>\n", + r"nodePool>`__\n", ) s.replace( - 'google/cloud/container_v1/proto/cluster_service_pb2.py', - r'(\s+)`__ instead', - r'\g<1>instead', + "google/cloud/container_v1/proto/cluster_service_pb2.py", + r"(\s+)`__ instead", + r"\g<1>instead", ) + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- +templated_files = common.py_library(unit_cov_level=76, cov_level=77) +s.move(templated_files)