test: use templated noxfiles (#393)

* test: use templated noxfiles

Adjust test configuration to prepare for running on Kokoro.

* enable system tests on Circle CI

* use environment variables for project ID

* add google-cloud-testutils to test deps

* use pip script for circle

* use pandas from constraints

* fix constraints path

* use nox

* add ADC

Author: tswast

.circleci/config.yml

@@ -39,7 +39,7 @@ jobs:
     steps:
       - checkout
       - run: ci/config_auth.sh
-      - run: nox -s unit-3.8 system-3.8 cover
+      - run: export GOOGLE_APPLICATION_CREDENTIALS="$(pwd)/ci/service_account.json"; nox -s unit-3.8 system-3.8 cover
 
   # Conda
   "conda-3.7":
@@ -72,4 +72,4 @@ workflows:
       - "pip-3.7"
       - "pip-3.8"
       - "conda-3.7"
-      - "conda-3.9-NIGHTLY"
+      - "conda-3.9-NIGHTLY"

ci/constraints-3.7.pip

@@ -11,5 +11,5 @@ if [ -f "$DIR/service_account.json" ]; then
 fi
 
 # Install test requirements
-pip install coverage pytest pytest-cov flake8 codecov
+pip install coverage pytest pytest-cov flake8 codecov google-cloud-testutils
 pytest -v -m "not local_auth" --cov=pandas_gbq --cov-report xml:/tmp/pytest-cov.xml tests

ci/run_pip.sh

@@ -61,7 +61,7 @@ authentication methods:
    If pandas-gbq does not find cached credentials, it prompts you to open a
    web browser, where you can grant pandas-gbq permissions to access your
    cloud resources. These credentials are only used locally. See the
-   :doc:`privacy policy <privacy>` for details.
+   :doc:`privacy policy <../privacy>` for details.
 
 
 Authenticating with a Service Account

ci/run_tests.sh

@@ -1,14 +1,24 @@
-# Copyright (c) 2017 pandas-gbq Authors All rights reserved.
-# Use of this source code is governed by a BSD-style
-# license that can be found in the LICENSE file.
-
-"""Nox test automation configuration.
-
-See: https://nox.readthedocs.io/en/latest/
-"""
-
+# -*- 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
+#
+#     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,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generated by synthtool. DO NOT EDIT!
+
+from __future__ import absolute_import
 import os
-import os.path
+import pathlib
 import shutil
 
 import nox
@@ -18,9 +28,21 @@
 BLACK_PATHS = ["docs", "pandas_gbq", "tests", "noxfile.py", "setup.py"]
 
 DEFAULT_PYTHON_VERSION = "3.8"
-SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"]
+SYSTEM_TEST_PYTHON_VERSIONS = ["3.8", "3.9"]
 UNIT_TEST_PYTHON_VERSIONS = ["3.7", "3.8", "3.9"]
 
+CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()
+
+# 'docfx' is excluded since it only needs to run in 'docs-presubmit'
+nox.options.sessions = [
+    "unit",
+    "system",
+    "cover",
+    "lint",
+    "lint_setup_py",
+    "blacken",
+    "docs",
+]
 
 # Error if a python version is missing
 nox.options.error_on_missing_interpreters = True
@@ -29,6 +51,7 @@
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def lint(session):
     """Run linters.
+
     Returns a failure if the linters find linting errors or sufficiently
     serious code quality issues.
     """
@@ -55,32 +78,99 @@ def lint_setup_py(session):
     session.run("python", "setup.py", "check", "--restructuredtext", "--strict")
 
 
-@nox.session(python=UNIT_TEST_PYTHON_VERSIONS)
-def unit(session):
-    session.install("pytest", "pytest-cov")
+def default(session):
+    # Install all test dependencies, then install this package in-place.
+
+    constraints_path = str(
+        CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
+    )
     session.install(
-        "-e",
-        ".",
-        # Use dependencies versions from constraints file. This enables testing
-        # across a more full range of versions of the dependencies.
+        "mock",
+        "asyncmock",
+        "pytest",
+        "pytest-cov",
+        "pytest-asyncio",
         "-c",
-        os.path.join(".", "ci", "constraints-{}.pip".format(session.python)),
+        constraints_path,
     )
+
+    session.install("-e", ".[tqdm]", "-c", constraints_path)
+
+    # Run py.test against the unit tests.
     session.run(
-        "pytest",
-        os.path.join(".", "tests", "unit"),
-        "-v",
+        "py.test",
+        "--quiet",
+        f"--junitxml=unit_{session.python}_sponge_log.xml",
         "--cov=pandas_gbq",
-        "--cov=tests.unit",
-        "--cov-report",
-        "xml:/tmp/pytest-cov.xml",
+        "--cov=tests/unit",
+        "--cov-append",
+        "--cov-config=.coveragerc",
+        "--cov-report=",
+        "--cov-fail-under=0",
+        os.path.join("tests", "unit"),
         *session.posargs,
     )
 
 
+@nox.session(python=UNIT_TEST_PYTHON_VERSIONS)
+def unit(session):
+    """Run the unit test suite."""
+    default(session)
+
+
+@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
+def system(session):
+    """Run the system test suite."""
+    constraints_path = str(
+        CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
+    )
+    system_test_path = os.path.join("tests", "system.py")
+    system_test_folder_path = os.path.join("tests", "system")
+
+    # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true.
+    if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false":
+        session.skip("RUN_SYSTEM_TESTS is set to false, skipping")
+    # Install pyopenssl for mTLS testing.
+    if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true":
+        session.install("pyopenssl")
+
+    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", "google-cloud-testutils", "-c", constraints_path)
+    session.install("-e", ".[tqdm]", "-c", constraints_path)
+
+    # Run py.test against the system tests.
+    if system_test_exists:
+        session.run(
+            "py.test",
+            "--quiet",
+            f"--junitxml=system_{session.python}_sponge_log.xml",
+            system_test_path,
+            *session.posargs,
+        )
+    if system_test_folder_exists:
+        session.run(
+            "py.test",
+            "--quiet",
+            f"--junitxml=system_{session.python}_sponge_log.xml",
+            system_test_folder_path,
+            *session.posargs,
+        )
+
+
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 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.
     """
@@ -112,27 +202,36 @@ def docs(session):
     )
 
 
-@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
-def system(session):
-    session.install("pytest", "pytest-cov")
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def docfx(session):
+    """Build the docfx yaml files for this library."""
+
+    session.install("-e", ".")
     session.install(
-        "-e",
-        ".",
-        # Use dependencies versions from constraints file. This enables testing
-        # across a more full range of versions of the dependencies.
-        "-c",
-        os.path.join(".", "ci", "constraints-{}.pip".format(session.python)),
+        "sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml"
     )
 
-    # Skip local auth tests on CI.
-    additional_args = list(session.posargs)
-    if "CIRCLECI" in os.environ:
-        additional_args = additional_args + ["-m", "not local_auth"]
-
+    shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(
-        "pytest",
-        os.path.join(".", "tests", "system"),
-        os.path.join(".", "samples", "snippets"),
-        "-v",
-        *additional_args,
+        "sphinx-build",
+        "-T",  # show full traceback on exception
+        "-N",  # no colors
+        "-D",
+        (
+            "extensions=sphinx.ext.autodoc,"
+            "sphinx.ext.autosummary,"
+            "docfx_yaml.extension,"
+            "sphinx.ext.intersphinx,"
+            "sphinx.ext.coverage,"
+            "sphinx.ext.napoleon,"
+            "sphinx.ext.todo,"
+            "sphinx.ext.viewcode,"
+            "recommonmark"
+        ),
+        "-b",
+        "html",
+        "-d",
+        os.path.join("docs", "_build", "doctrees", ""),
+        os.path.join("docs", ""),
+        os.path.join("docs", "_build", "html", ""),
     )