diff --git a/packages/google-cloud-texttospeech/.coveragerc b/packages/google-cloud-texttospeech/.coveragerc new file mode 100644 index 000000000000..51fec440cebf --- /dev/null +++ b/packages/google-cloud-texttospeech/.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-texttospeech/.flake8 b/packages/google-cloud-texttospeech/.flake8 new file mode 100644 index 000000000000..61766fa84d02 --- /dev/null +++ b/packages/google-cloud-texttospeech/.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-texttospeech/noxfile.py b/packages/google-cloud-texttospeech/noxfile.py index 1b9d44b21753..a9efc0e344ce 100644 --- a/packages/google-cloud-texttospeech/noxfile.py +++ b/packages/google-cloud-texttospeech/noxfile.py @@ -1,3 +1,5 @@ +# -*- coding: utf-8 -*- +# # Copyright 2018 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -18,28 +20,121 @@ import nox -LOCAL_DEPS = ( - os.path.join('..', 'api_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", + ) + + +@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('pytest', 'mock') + 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', os.path.join('tests', 'unit')) + session.run( + "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_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=["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") + + 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") + + # 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.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") diff --git a/packages/google-cloud-texttospeech/synth.py b/packages/google-cloud-texttospeech/synth.py index 8a7b9c2327e5..d7c5f05531d8 100644 --- a/packages/google-cloud-texttospeech/synth.py +++ b/packages/google-cloud-texttospeech/synth.py @@ -19,22 +19,26 @@ from synthtool import gcp gapic = gcp.GAPICGenerator() +common = gcp.CommonTemplates() +versions = ["v1beta1", "v1"] -versions = ['v1beta1', 'v1'] - - +# ---------------------------------------------------------------------------- +# Generate texttospeech GAPIC layer +# ---------------------------------------------------------------------------- for version in versions: - library = gapic.py_library('texttospeech', version) - s.move(library / f'google/cloud/texttospeech_{version}') - s.move(library / f'tests/unit/gapic/{version}') - s.move(library / f'docs/gapic/{version}') + library = gapic.py_library("texttospeech", version) + s.move(library / f"google/cloud/texttospeech_{version}") + s.move(library / f"tests/unit/gapic/{version}") + s.move(library / f"docs/gapic/{version}") # Use the highest version library to generate import alias. -s.move(library / 'google/cloud/texttospeech.py') - +s.move(library / "google/cloud/texttospeech.py") # Fix bad docstrings. -s.replace( - '**/gapic/*_client.py', - r'\\"(.+?)-\*\\"', - r'"\1-\\*"') +s.replace("**/gapic/*_client.py", r'\\"(.+?)-\*\\"', r'"\1-\\*"') + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- +templated_files = common.py_library(unit_cov_level=97, cov_level=100) +s.move(templated_files)