# -*- coding: utf-8 -*-

#

# Copyright 2024 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 pathlib

import re

import shutil

from typing import Dict, List

import warnings

import nox

FLAKE8_VERSION = "flake8==6.1.0"

BLACK_VERSION = "black[jupyter]==23.7.0"

ISORT_VERSION = "isort==5.11.0"

LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

DEFAULT_PYTHON_VERSION = "3.8"

UNIT_TEST_PYTHON_VERSIONS: List[str] = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]

UNIT_TEST_STANDARD_DEPENDENCIES = [

"mock",

"asyncmock",

"pytest",

"pytest-cov",

"pytest-asyncio",

]

UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = []

UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = []

UNIT_TEST_DEPENDENCIES: List[str] = []

UNIT_TEST_EXTRAS: List[str] = []

UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {}

SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8"]

SYSTEM_TEST_STANDARD_DEPENDENCIES: List[str] = [

"mock",

"pytest",

"google-cloud-testutils",

]

SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [

"pytest-asyncio==0.21.2",

]

SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = []

SYSTEM_TEST_DEPENDENCIES: List[str] = []

SYSTEM_TEST_EXTRAS: List[str] = []

SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {}

CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()

# 'docfx' is excluded since it only needs to run in 'docs-presubmit'

nox.options.sessions = [

"unit",

"system_emulated",

"system",

"mypy",

"cover",

"lint",

"lint_setup_py",

"blacken",

"docs",

"format",

]

# Error if a python version is missing

nox.options.error_on_missing_interpreters = True

@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.

"""

session.install(FLAKE8_VERSION, BLACK_VERSION)

session.run(

"black",

"--check",

*LINT_PATHS,

)

session.run("flake8", "google", "tests")

@nox.session(python=DEFAULT_PYTHON_VERSION)

def blacken(session):

"""Run black. Format code to uniform standard."""

session.install(BLACK_VERSION)

session.run(

"black",

*LINT_PATHS,

)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def format(session):

"""

Run isort to sort imports. Then run black

to format code to uniform standard.

"""

session.install(BLACK_VERSION, ISORT_VERSION)

# Use the --fss option to sort imports using strict alphabetical order.

# See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections

session.run(

"isort",

"--fss",

*LINT_PATHS,

)

session.run(

"black",

*LINT_PATHS,

)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def mypy(session):

"""Verify type hints are mypy compatible."""

session.install("-e", ".")

session.install(

"mypy", "types-setuptools", "types-protobuf", "types-mock", "types-requests"

)

session.install("google-cloud-testutils")

session.run(

"mypy",

"-p",

"google.cloud.bigtable.data",

"--check-untyped-defs",

"--warn-unreachable",

"--disallow-any-generics",

"--exclude",

"tests/system/v2_client",

"--exclude",

"tests/unit/v2_client",

)

@nox.session(python=DEFAULT_PYTHON_VERSION)

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 install_unittest_dependencies(session, *constraints):

standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES

session.install(*standard_deps, *constraints)

if UNIT_TEST_EXTERNAL_DEPENDENCIES:

warnings.warn(

"'unit_test_external_dependencies' is deprecated. Instead, please "

"use 'unit_test_dependencies' or 'unit_test_local_dependencies'.",

DeprecationWarning,

)

session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints)

if UNIT_TEST_LOCAL_DEPENDENCIES:

session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints)

if UNIT_TEST_EXTRAS_BY_PYTHON:

extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, [])

elif UNIT_TEST_EXTRAS:

extras = UNIT_TEST_EXTRAS

else:

extras = []

if extras:

session.install("-e", f".[{','.join(extras)}]", *constraints)

else:

session.install("-e", ".", *constraints)

@nox.session(python=UNIT_TEST_PYTHON_VERSIONS)

@nox.parametrize(

"protobuf_implementation",

["python", "upb", "cpp"],

)

def unit(session, protobuf_implementation):

# Install all test dependencies, then install this package in-place.

if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12"):

session.skip("cpp implementation is not supported in python 3.11+")

constraints_path = str(

CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"

)

install_unittest_dependencies(session, "-c", constraints_path)

# TODO(https://github.com/googleapis/synthtool/issues/1976):

# Remove the 'cpp' implementation once support for Protobuf 3.x is dropped.

# The 'cpp' implementation requires Protobuf<4.

if protobuf_implementation == "cpp":

session.install("protobuf<4")

# Run py.test against the unit tests.

session.run(

"py.test",

"--quiet",

f"--junitxml=unit_{session.python}_sponge_log.xml",

"--cov=google",

"--cov=tests/unit",

"--cov-append",

"--cov-config=.coveragerc",

"--cov-report=",

"--cov-fail-under=0",

os.path.join("tests", "unit"),

*session.posargs,

env={

"PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,

},

)

def install_systemtest_dependencies(session, *constraints):

# Use pre-release gRPC for system tests.

# Exclude version 1.52.0rc1 which has a known issue.

# See https://github.com/grpc/grpc/issues/32163

session.install("--pre", "grpcio!=1.52.0rc1")

session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints)

if SYSTEM_TEST_EXTERNAL_DEPENDENCIES:

session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints)

if SYSTEM_TEST_LOCAL_DEPENDENCIES:

session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints)

if SYSTEM_TEST_DEPENDENCIES:

session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints)

if SYSTEM_TEST_EXTRAS_BY_PYTHON:

extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, [])

elif SYSTEM_TEST_EXTRAS:

extras = SYSTEM_TEST_EXTRAS

else:

extras = []

if extras:

session.install("-e", f".[{','.join(extras)}]", *constraints)

else:

session.install("-e", ".", *constraints)

@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)

def system_emulated(session):

import subprocess

import signal

try:

subprocess.call(["gcloud", "--version"])

except OSError:

session.skip("gcloud not found but required for emulator support")

# Currently, CI/CD doesn't have beta component of gcloud.

subprocess.call(["gcloud", "components", "install", "beta", "bigtable"])

hostport = "localhost:8789"

session.env["BIGTABLE_EMULATOR_HOST"] = hostport

p = subprocess.Popen(

["gcloud", "beta", "emulators", "bigtable", "start", "--host-port", hostport]

)

try:

system(session)

finally:

# Stop Emulator

os.killpg(os.getpgid(p.pid), signal.SIGKILL)

@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)

def conformance(session):

TEST_REPO_URL = "https://github.com/googleapis/cloud-bigtable-clients-test.git"

CLONE_REPO_DIR = "cloud-bigtable-clients-test"

# install dependencies

constraints_path = str(

CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"

)

install_unittest_dependencies(session, "-c", constraints_path)

with session.chdir("test_proxy"):

# download the conformance test suite

clone_dir = os.path.join(CURRENT_DIRECTORY, CLONE_REPO_DIR)

if not os.path.exists(clone_dir):

print("downloading copy of test repo")

session.run("git", "clone", TEST_REPO_URL, CLONE_REPO_DIR, external=True)

session.run("bash", "-e", "run_tests.sh", external=True)

@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")

install_systemtest_dependencies(session, "-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.

"""

session.install("coverage", "pytest-cov")

session.run("coverage", "report", "--show-missing", "--fail-under=99")

session.run("coverage", "erase")

@nox.session(python="3.9")

def docs(session):

"""Build the docs for this library."""

session.install("-e", ".")

session.install(

# We need to pin to specific versions of the `sphinxcontrib-*` packages

# which still support sphinx 4.x.

# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344

# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.

"sphinxcontrib-applehelp==1.0.4",

"sphinxcontrib-devhelp==1.0.2",

"sphinxcontrib-htmlhelp==2.0.1",

"sphinxcontrib-qthelp==1.0.3",

"sphinxcontrib-serializinghtml==1.1.5",

"sphinx==4.5.0",

"alabaster",

"recommonmark",

)

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

session.run(

"sphinx-build",

"-W", # warnings as errors

"-T", # show full traceback on exception

"-N", # no colors

"-b",

"html",

"-d",

os.path.join("docs", "_build", "doctrees", ""),

os.path.join("docs", ""),

os.path.join("docs", "_build", "html", ""),

)

@nox.session(python="3.10")

def docfx(session):

"""Build the docfx yaml files for this library."""

session.install("-e", ".")

session.install(

# We need to pin to specific versions of the `sphinxcontrib-*` packages

# which still support sphinx 4.x.

# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344

# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.

"sphinxcontrib-applehelp==1.0.4",

"sphinxcontrib-devhelp==1.0.2",

"sphinxcontrib-htmlhelp==2.0.1",

"sphinxcontrib-qthelp==1.0.3",

"sphinxcontrib-serializinghtml==1.1.5",

"gcp-sphinx-docfx-yaml",

"alabaster",

"recommonmark",

)

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

session.run(

"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", ""),

)

# Customization: Add extra sections to the table of contents for the Classic vs Async clients

session.install("pyyaml")

session.run("python", "docs/scripts/patch_devsite_toc.py")

@nox.session(python="3.12")

@nox.parametrize(

"protobuf_implementation",

["python", "upb", "cpp"],

)

def prerelease_deps(session, protobuf_implementation):

"""Run all tests with prerelease versions of dependencies installed."""

if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12"):

session.skip("cpp implementation is not supported in python 3.11+")

# Install all dependencies

session.install("-e", ".[all, tests, tracing]")

unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES

session.install(*unit_deps_all)

system_deps_all = (

SYSTEM_TEST_STANDARD_DEPENDENCIES + SYSTEM_TEST_EXTERNAL_DEPENDENCIES

)

session.install(*system_deps_all)

# Because we test minimum dependency versions on the minimum Python

# version, the first version we test with in the unit tests sessions has a

# constraints file containing all dependencies and extras.

with open(

CURRENT_DIRECTORY

/ "testing"

/ f"constraints-{UNIT_TEST_PYTHON_VERSIONS[0]}.txt",

encoding="utf-8",

) as constraints_file:

constraints_text = constraints_file.read()

# Ignore leading whitespace and comment lines.

constraints_deps = [

match.group(1)

for match in re.finditer(

r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE

)

]

session.install(*constraints_deps)

prerel_deps = [

"protobuf",

# dependency of grpc

"six",

"grpc-google-iam-v1",

"googleapis-common-protos",

"grpcio",

"grpcio-status",

"google-api-core",

"google-auth",

"proto-plus",

"google-cloud-testutils",

# dependencies of google-cloud-testutils"

"click",

]

for dep in prerel_deps:

session.install("--pre", "--no-deps", "--upgrade", dep)

# Remaining dependencies

other_deps = [

"requests",

]

session.install(*other_deps)

# Print out prerelease package versions

session.run(

"python", "-c", "import google.protobuf; print(google.protobuf.__version__)"

)

session.run("python", "-c", "import grpc; print(grpc.__version__)")

session.run("python", "-c", "import google.auth; print(google.auth.__version__)")

session.run(

"py.test",

"tests/unit",

env={

"PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,

},

)

system_test_path = os.path.join("tests", "system.py")

system_test_folder_path = os.path.join("tests", "system")

# Only run system tests if found.

if os.path.exists(system_test_path):

session.run(

"py.test",

"--verbose",

f"--junitxml=system_{session.python}_sponge_log.xml",

system_test_path,

*session.posargs,

env={

"PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,

},

)

if os.path.exists(system_test_folder_path):

session.run(

"py.test",

"--verbose",

f"--junitxml=system_{session.python}_sponge_log.xml",

system_test_folder_path,

*session.posargs,

env={

"PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,

},

)