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

packages/google-cloud-videointelligence/.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

packages/google-cloud-videointelligence/.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

packages/google-cloud-videointelligence/noxfile.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,49 +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)
 
 
-# TODO: Fix generated system tests
-#@nox.session(python=['2.7', '3.7'])
-#def system(session):
-#    """Run the system test suite."""
-#
-#    # 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.')
-#
-#    # Install all test dependencies, then install this package in-place.
-#    session.install('pytest')
-#    session.install('-e', '.')
-#
-#    # Run py.test against the unit tests.
-#    session.run('py.test', '--quiet', os.path.join('tests', 'system'),
-#                *session.posargs)
+@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")
 
-@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')
+    # 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")

packages/google-cloud-videointelligence/synth.py

@@ -19,29 +19,32 @@
 
 
 gapic = gcp.GAPICGenerator()
-
-versions = ['v1beta1', 'v1beta2', 'v1p1beta1', 'v1p2beta1', 'v1']
+common = gcp.CommonTemplates()
+versions = ["v1beta1", "v1beta2", "v1p1beta1", "v1p2beta1", "v1"]
 
 
+# ----------------------------------------------------------------------------
+# Generate videointelligence GAPIC layer
+# ----------------------------------------------------------------------------
 for version in versions:
     library = gapic.py_library(
-        'videointelligence',
-        version,
-        artman_output_name=f'video-intelligence-{version}')
+        "videointelligence", version, artman_output_name=f"video-intelligence-{version}"
+    )
 
     # TODO: stop excluding tests and nox.py (excluded as we lack system tests)
     s.move(
         library,
         excludes=[
-            'setup.py',
-            'nox*.py',
-            'README.rst',
-            'docs/index.rst', 
-            f'tests/system/gapic/{version}/'
-            f'test_system_video_intelligence_service_{version}.py',
-            #f'tests/unit/gapic/{version}/'
-            #f'test_video_intelligence_service_client_{version}.py',
-        ])
+            "setup.py",
+            "nox*.py",
+            "README.rst",
+            "docs/index.rst",
+            f"tests/system/gapic/{version}/"
+            f"test_system_video_intelligence_service_{version}.py",
+            # f'tests/unit/gapic/{version}/'
+            # f'test_video_intelligence_service_client_{version}.py',
+        ],
+    )
 
 s.replace(
     "**/*/video_intelligence_service_client.py",
@@ -53,5 +56,11 @@
     "tests/unit/gapic/**/test_video_intelligence_service_client_*.py",
     "^(\s+)expected_request = video_intelligence_pb2.AnnotateVideoRequest\(\)",
     "\g<1>expected_request = video_intelligence_pb2.AnnotateVideoRequest(\n"
-        "\g<1>    input_uri=input_uri, features=features)",
+    "\g<1>    input_uri=input_uri, features=features)",
 )
+
+# ----------------------------------------------------------------------------
+# Add templated files
+# ----------------------------------------------------------------------------
+templated_files = common.py_library(unit_cov_level=97, cov_level=100)
+s.move(templated_files)