Add templates for flake8, coveragerc, noxfile, and black. (#6642)

packages/google-cloud-redis/.coveragerc

@@ -9,6 +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

packages/google-cloud-redis/.flake8

@@ -1,4 +1,5 @@
 [flake8]
+ignore = E203, E266, E501, W503
 exclude =
   # Exclude generated code.
   **/proto/**

packages/google-cloud-redis/noxfile.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,76 +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.
 
-def default(session):
-    """Default unit test session.
+    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.
     """
-    # 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.redis',
-        '--cov=google.cloud.redis_v1beta1',
-        '--cov=tests.unit',
-        '--cov-append',
-        '--cov-config=.coveragerc',
-        '--cov-report=',
-        '--cov-fail-under=97',
-        '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")

packages/google-cloud-redis/synth.py

@@ -22,54 +22,52 @@
 
 gapic = gcp.GAPICGenerator()
 common = gcp.CommonTemplates()
-excludes = [
-    'README.rst',
-    'setup.py',
-    'nox*.py',
-    'docs/conf.py',
-    'docs/index.rst',
-]
-
-for version in ['v1beta1', 'v1']:
+excludes = ["README.rst", "setup.py", "nox*.py", "docs/conf.py", "docs/index.rst"]
+
+# ----------------------------------------------------------------------------
+# Generate redis GAPIC layer
+# ----------------------------------------------------------------------------
+for version in ["v1beta1", "v1"]:
     library = gapic.py_library(
-        'redis', version,
-        config_path=f'artman_redis_{version}.yaml')
+        "redis", version, config_path=f"artman_redis_{version}.yaml"
+    )
 
     s.copy(library, excludes=excludes)
 
-
 # Fix docstrings
 s.replace(
-    'google/cloud/**/cloud_redis_client.py',
-    r'resources of the form:\n      ``',
-    r'resources of the form:\n\n      ``',)
+    "google/cloud/**/cloud_redis_client.py",
+    r"resources of the form:\n      ``",
+    r"resources of the form:\n\n      ``",
+)
 
 s.replace(
-    'google/cloud/**/cloud_redis_client.py',
+    "google/cloud/**/cloud_redis_client.py",
     r"""
             parent \(str\): Required. The resource name of the instance location using the form:
                 ::
 
                     `projects/{project_id}/locations/{location_id}`
                 where ``location_id`` refers to a GCP region""",
-
     r"""
             parent (str): Required. The resource name of the instance location using the form ``projects/{project_id}/locations/{location_id}``
-                where ``location_id`` refers to a GCP region""",)
+                where ``location_id`` refers to a GCP region""",
+)
 
 
 s.replace(
-    'google/cloud/**/cloud_redis_client.py',
+    "google/cloud/**/cloud_redis_client.py",
     r"""
                 with the following restrictions:
 
                 \* Must contain only lowercase letters, numbers, and hyphens\.""",
     r"""
                 with the following restrictions:
-                * Must contain only lowercase letters, numbers, and hyphens.""")
+                * Must contain only lowercase letters, numbers, and hyphens.""",
+)
 
 s.replace(
-    'google/cloud/**/cloud_redis_client.py',
+    "google/cloud/**/cloud_redis_client.py",
     r"""
             name \(str\): Required. Redis instance resource name using the form:
                 ::
@@ -78,17 +76,24 @@
                 where ``location_id`` refers to a GCP region""",
     r"""
             name (str): Required. Redis instance resource name using the form ``projects/{project_id}/locations/{location_id}/instances/{instance_id}```
-                where ``location_id`` refers to a GCP region""")
+                where ``location_id`` refers to a GCP region""",
+)
 
 s.replace(
-    'google/cloud/**/cloud_redis_client.py',
+    "google/cloud/**/cloud_redis_client.py",
     r"""
                 fields from ``Instance``:
 
                  \*   ``displayName``
                  \*   ``labels``
                  \*   ``memorySizeGb``
                  \*   ``redisConfig``""",
-
     r"""
-                fields from ``Instance``: ``displayName``, ``labels``, ``memorySizeGb``, and ``redisConfig``.""",)
+                fields from ``Instance``: ``displayName``, ``labels``, ``memorySizeGb``, and ``redisConfig``.""",
+)
+
+# ----------------------------------------------------------------------------
+# Add templated files
+# ----------------------------------------------------------------------------
+templated_files = common.py_library(unit_cov_level=97, cov_level=100)
+s.move(templated_files)