From 128b5776de65647a6fa6060786ab8d8724e8ad3c 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-trace/.coveragerc | 7 ++ packages/google-cloud-trace/.flake8 | 1 + packages/google-cloud-trace/MANIFEST.in | 4 +- packages/google-cloud-trace/noxfile.py | 142 ++++++++++++++++-------- packages/google-cloud-trace/synth.py | 34 +++--- 5 files changed, 125 insertions(+), 63 deletions(-) diff --git a/packages/google-cloud-trace/.coveragerc b/packages/google-cloud-trace/.coveragerc index a54b99aa14b7..51fec440cebf 100644 --- a/packages/google-cloud-trace/.coveragerc +++ b/packages/google-cloud-trace/.coveragerc @@ -9,3 +9,10 @@ exclude_lines = 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-trace/.flake8 b/packages/google-cloud-trace/.flake8 index 1f44a90f8195..61766fa84d02 100644 --- a/packages/google-cloud-trace/.flake8 +++ b/packages/google-cloud-trace/.flake8 @@ -1,4 +1,5 @@ [flake8] +ignore = E203, E266, E501, W503 exclude = # Exclude generated code. **/proto/** diff --git a/packages/google-cloud-trace/MANIFEST.in b/packages/google-cloud-trace/MANIFEST.in index 8a2c2aa5ab99..9cbf175afe6b 100644 --- a/packages/google-cloud-trace/MANIFEST.in +++ b/packages/google-cloud-trace/MANIFEST.in @@ -1,7 +1,5 @@ include README.rst LICENSE +recursive-include google *.json *.proto recursive-include tests * -global-include google *.json *.proto -graft google global-exclude *.py[co] global-exclude __pycache__ -prune .tox diff --git a/packages/google-cloud-trace/noxfile.py b/packages/google-cloud-trace/noxfile.py index d636041905cb..a9efc0e344ce 100644 --- a/packages/google-cloud-trace/noxfile.py +++ b/packages/google-cloud-trace/noxfile.py @@ -1,10 +1,12 @@ -# Copyright 2016 Google LLC +# -*- 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,78 +15,126 @@ # limitations under the License. from __future__ import absolute_import - import os import nox -LOCAL_DEPS = ( - os.path.join('..', 'api_core'), - os.path.join('..', 'core'), -) +LOCAL_DEPS = (os.path.join("..", "api_core"), os.path.join("..", "core")) +@nox.session(python="3.7") +def blacken(session): + """Run black. + + Format code to uniform standard. + """ + session.install("black") + session.run( + "black", + "google", + "tests", + "docs", + "--exclude", + ".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py", + ) -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 the ``PATH`` can - run the tests. +@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. """ - # Install all test dependencies, then install local packages in-place. - session.install('mock', 'pytest', 'pytest-cov') + 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.trace', - '--cov-append', - '--cov-config=.coveragerc', - '--cov-report=', - '--cov-fail-under=97', - 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=97", + 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): """Run the unit test suite.""" default(session) -@nox.session(python='3.6') -def lint(session): - """Run linters. +@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") - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install('flake8', *LOCAL_DEPS) - session.install('.') - session.run('flake8', 'google', 'tests') + 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") -@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') + # Install all test dependencies, then install this package into the + # virtualenv's dist-packages. + session.install("mock", "pytest") + for local_dep in LOCAL_DEPS: + session.install("-e", local_dep) + session.install("-e", "../test_utils/") + session.install("-e", ".") + + # Run py.test against the system tests. + 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') +@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=100') - session.run('coverage', 'erase') + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") diff --git a/packages/google-cloud-trace/synth.py b/packages/google-cloud-trace/synth.py index c5e82c440dea..7c0301ef0155 100644 --- a/packages/google-cloud-trace/synth.py +++ b/packages/google-cloud-trace/synth.py @@ -18,29 +18,35 @@ import synthtool.gcp as gcp gapic = gcp.GAPICGenerator() +common = gcp.CommonTemplates() -for version in ['v1', 'v2']: +# ---------------------------------------------------------------------------- +# Generate trace GAPIC layer +# ---------------------------------------------------------------------------- +for version in ["v1", "v2"]: library = gapic.py_library( - 'trace', version, - config_path=f'/google/devtools/cloudtrace' - f'/artman_cloudtrace_{version}.yaml', - artman_output_name=f'trace-{version}', + "trace", + version, + config_path=f"/google/devtools/cloudtrace" f"/artman_cloudtrace_{version}.yaml", + artman_output_name=f"trace-{version}", ) - s.move(library / f'google/cloud/trace_{version}') - s.move(library / f'tests/unit/gapic/{version}') - + s.move(library / f"google/cloud/trace_{version}") + s.move(library / f"tests/unit/gapic/{version}") + # Fix up imports s.replace( - 'google/**/*.py', + "google/**/*.py", f"from google.devtools.cloudtrace_{version}.proto import ", f"from google.cloud.trace_{version}.proto import ", ) - # Issues exist where python files should define the source encoding # https://github.com/googleapis/gapic-generator/issues/2097 -s.replace( - 'google/**/proto/*_pb2.py', - r"(^.*$\n)*", - r"# -*- coding: utf-8 -*-\n\g<0>") +s.replace("google/**/proto/*_pb2.py", r"(^.*$\n)*", r"# -*- coding: utf-8 -*-\n\g<0>") + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- +templated_files = common.py_library(unit_cov_level=97, cov_level=100) +s.move(templated_files)