From 0263bd8d971fd9a53836c2041bfb1fc7d3683a86 Mon Sep 17 00:00:00 2001 From: Yu-Han Liu Date: Tue, 18 Jul 2023 09:52:02 -0700 Subject: [PATCH] chore: remove migrated snippets (#331) --- .../samples/snippets/__init__.py | 0 .../samples/snippets/conftest.py | 53 ---- .../snippets/create_mysql_connection.py | 66 ---- .../snippets/create_mysql_connection_test.py | 93 ------ .../samples/snippets/noxfile.py | 292 ------------------ .../samples/snippets/noxfile_config.py | 38 --- .../samples/snippets/quickstart.py | 33 -- .../samples/snippets/quickstart_test.py | 26 -- .../samples/snippets/requirements-test.txt | 2 - .../samples/snippets/requirements.txt | 1 - 10 files changed, 604 deletions(-) delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/__init__.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/conftest.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection_test.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/noxfile.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/noxfile_config.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/quickstart.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/quickstart_test.py delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/requirements-test.txt delete mode 100644 packages/google-cloud-bigquery-connection/samples/snippets/requirements.txt diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/__init__.py b/packages/google-cloud-bigquery-connection/samples/snippets/__init__.py deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/conftest.py b/packages/google-cloud-bigquery-connection/samples/snippets/conftest.py deleted file mode 100644 index eca2a7fd12d0..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/conftest.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright 2021 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. - -import os - -from google.cloud.bigquery_connection_v1.services import connection_service -import pytest - - -@pytest.fixture(scope="session") -def connection_client() -> connection_service.ConnectionServiceClient: - return connection_service.ConnectionServiceClient() - - -@pytest.fixture(scope="session") -def project_id() -> str: - return os.environ["GOOGLE_CLOUD_PROJECT"] - - -@pytest.fixture(scope="session") -def location() -> str: - return "US" - - -@pytest.fixture(scope="session") -def database() -> str: - return os.environ["MYSQL_DATABASE"] - - -@pytest.fixture(scope="session") -def cloud_sql_conn_name() -> str: - return os.environ["MYSQL_INSTANCE"] - - -@pytest.fixture(scope="session") -def mysql_username() -> str: - return os.environ["MYSQL_USER"] - - -@pytest.fixture(scope="session") -def mysql_password() -> str: - return os.environ["MYSQL_PASSWORD"] diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection.py b/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection.py deleted file mode 100644 index f4577afbb703..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection.py +++ /dev/null @@ -1,66 +0,0 @@ -# Copyright 2021 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. - -# [START bigqueryconnection_create_connection] -from google.cloud import bigquery_connection_v1 as bq_connection - -"""This sample shows how to create a BigQuery connection with a Cloud SQL for MySQL database""" - - -def main() -> None: - # TODO(developer): Set all variables for your Cloud SQL for MySQL connection. - project_id = "your-project-id" # set project_id - location = "US" # set location - # See: https://cloud.google.com/bigquery/docs/locations for a list of - # available locations. - database = "my-database" # set database name - username = "my-username" # set database username - password = "my-password" # set database password - cloud_sql_conn_name = "" # set the name of your connection - transport = "grpc" # Set the transport to either "grpc" or "rest" - - cloud_sql_credential = bq_connection.CloudSqlCredential( - { - "username": username, - "password": password, - } - ) - cloud_sql_properties = bq_connection.CloudSqlProperties( - { - "type_": bq_connection.CloudSqlProperties.DatabaseType.MYSQL, - "database": database, - "instance_id": cloud_sql_conn_name, - "credential": cloud_sql_credential, - } - ) - create_mysql_connection(project_id, location, cloud_sql_properties, transport) - - -def create_mysql_connection( - project_id: str, - location: str, - cloud_sql_properties: bq_connection.CloudSqlProperties, - transport: str, -) -> None: - connection = bq_connection.types.Connection({"cloud_sql": cloud_sql_properties}) - client = bq_connection.ConnectionServiceClient(transport=transport) - parent = client.common_location_path(project_id, location) - request = bq_connection.CreateConnectionRequest( - {"parent": parent, "connection": connection} - ) - response = client.create_connection(request) - print(f"Created connection successfully: {response.name}") - - -# [END bigqueryconnection_create_connection] diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection_test.py b/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection_test.py deleted file mode 100644 index 501af447d8b6..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/create_mysql_connection_test.py +++ /dev/null @@ -1,93 +0,0 @@ -# Copyright 2021 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. - -import google.api_core.exceptions -from google.cloud import bigquery_connection_v1 as bq_connection -from google.cloud.bigquery_connection_v1.services import connection_service -import pytest -import test_utils.prefixer - -from . import create_mysql_connection - -connection_prefixer = test_utils.prefixer.Prefixer("py-bq-r", "snippets", separator="-") - - -@pytest.fixture(scope="session") -def location_path( - connection_client: connection_service.ConnectionServiceClient(), - project_id: str, - location: str, -) -> str: - return connection_client.common_location_path(project_id, location) - - -@pytest.fixture(scope="module", autouse=True) -def cleanup_connection( - connection_client: connection_service.ConnectionServiceClient, location_path: str -) -> None: - for connection in connection_client.list_connections(parent=location_path): - connection_id = connection.name.split("/")[-1] - if connection_prefixer.should_cleanup(connection_id): - connection_client.delete_connection(name=connection.name) - - -@pytest.fixture(scope="session") -def connection_id( - connection_client: connection_service.ConnectionServiceClient, - project_id: str, - location: str, -) -> str: - id_ = connection_prefixer.create_prefix() - yield id_ - - connection_name = connection_client.connection_path(project_id, location, id_) - try: - connection_client.delete_connection(name=connection_name) - except google.api_core.exceptions.NotFound: - pass - - -@pytest.mark.parametrize("transport", ["grpc", "rest"]) -def test_create_mysql_connection( - capsys: pytest.CaptureFixture, - mysql_username: str, - mysql_password: str, - database: str, - cloud_sql_conn_name: str, - project_id: str, - location: str, - transport: str, -) -> None: - cloud_sql_credential = bq_connection.CloudSqlCredential( - { - "username": mysql_username, - "password": mysql_password, - } - ) - cloud_sql_properties = bq_connection.CloudSqlProperties( - { - "type_": bq_connection.CloudSqlProperties.DatabaseType.MYSQL, - "database": database, - "instance_id": cloud_sql_conn_name, - "credential": cloud_sql_credential, - } - ) - create_mysql_connection.create_mysql_connection( - project_id=project_id, - location=location, - cloud_sql_properties=cloud_sql_properties, - transport=transport, - ) - out, _ = capsys.readouterr() - assert "Created connection successfully:" in out diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/noxfile.py b/packages/google-cloud-bigquery-connection/samples/snippets/noxfile.py deleted file mode 100644 index de104dbc64d3..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/noxfile.py +++ /dev/null @@ -1,292 +0,0 @@ -# Copyright 2019 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 -# -# http://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. - -from __future__ import print_function - -import glob -import os -from pathlib import Path -import sys -from typing import Callable, Dict, Optional - -import nox - -# WARNING - WARNING - WARNING - WARNING - WARNING -# WARNING - WARNING - WARNING - WARNING - WARNING -# DO NOT EDIT THIS FILE EVER! -# WARNING - WARNING - WARNING - WARNING - WARNING -# WARNING - WARNING - WARNING - WARNING - WARNING - -BLACK_VERSION = "black==22.3.0" -ISORT_VERSION = "isort==5.10.1" - -# Copy `noxfile_config.py` to your directory and modify it instead. - -# `TEST_CONFIG` dict is a configuration hook that allows users to -# modify the test configurations. The values here should be in sync -# with `noxfile_config.py`. Users will copy `noxfile_config.py` into -# their directory and modify it. - -TEST_CONFIG = { - # You can opt out from the test for specific Python versions. - "ignored_versions": [], - # Old samples are opted out of enforcing Python type hints - # All new samples should feature them - "enforce_type_hints": False, - # An envvar key for determining the project id to use. Change it - # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a - # build specific Cloud project. You can also use your own string - # to use your own Cloud project. - "gcloud_project_env": "GOOGLE_CLOUD_PROJECT", - # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', - # If you need to use a specific version of pip, - # change pip_version_override to the string representation - # of the version number, for example, "20.2.4" - "pip_version_override": None, - # A dictionary you want to inject into your test. Don't put any - # secrets here. These values will override predefined values. - "envs": {}, -} - - -try: - # Ensure we can import noxfile_config in the project's directory. - sys.path.append(".") - from noxfile_config import TEST_CONFIG_OVERRIDE -except ImportError as e: - print("No user noxfile_config found: detail: {}".format(e)) - TEST_CONFIG_OVERRIDE = {} - -# Update the TEST_CONFIG with the user supplied values. -TEST_CONFIG.update(TEST_CONFIG_OVERRIDE) - - -def get_pytest_env_vars() -> Dict[str, str]: - """Returns a dict for pytest invocation.""" - ret = {} - - # Override the GCLOUD_PROJECT and the alias. - env_key = TEST_CONFIG["gcloud_project_env"] - # This should error out if not set. - ret["GOOGLE_CLOUD_PROJECT"] = os.environ[env_key] - - # Apply user supplied envs. - ret.update(TEST_CONFIG["envs"]) - return ret - - -# DO NOT EDIT - automatically generated. -# All versions used to test samples. -ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11"] - -# Any default versions that should be ignored. -IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"] - -TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS]) - -INSTALL_LIBRARY_FROM_SOURCE = os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False) in ( - "True", - "true", -) - -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True - -# -# Style Checks -# - - -# Linting with flake8. -# -# We ignore the following rules: -# E203: whitespace before ‘:’ -# E266: too many leading ‘#’ for block comment -# E501: line too long -# I202: Additional newline in a section of imports -# -# We also need to specify the rules which are ignored by default: -# ['E226', 'W504', 'E126', 'E123', 'W503', 'E24', 'E704', 'E121'] -FLAKE8_COMMON_ARGS = [ - "--show-source", - "--builtin=gettext", - "--max-complexity=20", - "--exclude=.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py", - "--ignore=E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202", - "--max-line-length=88", -] - - -@nox.session -def lint(session: nox.sessions.Session) -> None: - if not TEST_CONFIG["enforce_type_hints"]: - session.install("flake8") - else: - session.install("flake8", "flake8-annotations") - - args = FLAKE8_COMMON_ARGS + [ - ".", - ] - session.run("flake8", *args) - - -# -# Black -# - - -@nox.session -def blacken(session: nox.sessions.Session) -> None: - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - python_files = [path for path in os.listdir(".") if path.endswith(".py")] - - session.run("black", *python_files) - - -# -# format = isort + black -# - - -@nox.session -def format(session: nox.sessions.Session) -> None: - """ - Run isort to sort imports. Then run black - to format code to uniform standard. - """ - session.install(BLACK_VERSION, ISORT_VERSION) - python_files = [path for path in os.listdir(".") if path.endswith(".py")] - - # 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", *python_files) - session.run("black", *python_files) - - -# -# Sample Tests -# - - -PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"] - - -def _session_tests( - session: nox.sessions.Session, post_install: Callable = None -) -> None: - # check for presence of tests - test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob( - "**/test_*.py", recursive=True - ) - test_list.extend(glob.glob("**/tests", recursive=True)) - - if len(test_list) == 0: - print("No tests found, skipping directory.") - return - - if TEST_CONFIG["pip_version_override"]: - pip_version = TEST_CONFIG["pip_version_override"] - session.install(f"pip=={pip_version}") - """Runs py.test for a particular project.""" - concurrent_args = [] - if os.path.exists("requirements.txt"): - if os.path.exists("constraints.txt"): - session.install("-r", "requirements.txt", "-c", "constraints.txt") - else: - session.install("-r", "requirements.txt") - with open("requirements.txt") as rfile: - packages = rfile.read() - - if os.path.exists("requirements-test.txt"): - if os.path.exists("constraints-test.txt"): - session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt") - else: - session.install("-r", "requirements-test.txt") - with open("requirements-test.txt") as rtfile: - packages += rtfile.read() - - if INSTALL_LIBRARY_FROM_SOURCE: - session.install("-e", _get_repo_root()) - - if post_install: - post_install(session) - - if "pytest-parallel" in packages: - concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"]) - elif "pytest-xdist" in packages: - concurrent_args.extend(["-n", "auto"]) - - session.run( - "pytest", - *(PYTEST_COMMON_ARGS + session.posargs + concurrent_args), - # Pytest will return 5 when no tests are collected. This can happen - # on travis where slow and flaky tests are excluded. - # See http://doc.pytest.org/en/latest/_modules/_pytest/main.html - success_codes=[0, 5], - env=get_pytest_env_vars(), - ) - - -@nox.session(python=ALL_VERSIONS) -def py(session: nox.sessions.Session) -> None: - """Runs py.test for a sample using the specified version of Python.""" - if session.python in TESTED_VERSIONS: - _session_tests(session) - else: - session.skip( - "SKIPPED: {} tests are disabled for this sample.".format(session.python) - ) - - -# -# Readmegen -# - - -def _get_repo_root() -> Optional[str]: - """Returns the root folder of the project.""" - # Get root of this repository. Assume we don't have directories nested deeper than 10 items. - p = Path(os.getcwd()) - for i in range(10): - if p is None: - break - if Path(p / ".git").exists(): - return str(p) - # .git is not available in repos cloned via Cloud Build - # setup.py is always in the library's root, so use that instead - # https://github.com/googleapis/synthtool/issues/792 - if Path(p / "setup.py").exists(): - return str(p) - p = p.parent - raise Exception("Unable to detect repository root.") - - -GENERATED_READMES = sorted([x for x in Path(".").rglob("*.rst.in")]) - - -@nox.session -@nox.parametrize("path", GENERATED_READMES) -def readmegen(session: nox.sessions.Session, path: str) -> None: - """(Re-)generates the readme for a sample.""" - session.install("jinja2", "pyyaml") - dir_ = os.path.dirname(path) - - if os.path.exists(os.path.join(dir_, "requirements.txt")): - session.install("-r", os.path.join(dir_, "requirements.txt")) - - in_file = os.path.join(dir_, "README.rst.in") - session.run( - "python", _get_repo_root() + "/scripts/readme-gen/readme_gen.py", in_file - ) diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/noxfile_config.py b/packages/google-cloud-bigquery-connection/samples/snippets/noxfile_config.py deleted file mode 100644 index 0887541b3fa6..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/noxfile_config.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2021 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 -# -# http://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. - -# Default TEST_CONFIG_OVERRIDE for python repos. - -# You can copy this file into your directory, then it will be inported from -# the noxfile.py. - -# The source of truth: -# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile_config.py - -TEST_CONFIG_OVERRIDE = { - # You can opt out from the test for specific Python versions. - "ignored_versions": ["2.7"], - # Old samples are opted out of enforcing Python type hints - # All new samples should feature them - "enforce_type_hints": True, - # An envvar key for determining the project id to use. Change it - # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a - # build specific Cloud project. You can also use your own string - # to use your own Cloud project. - "gcloud_project_env": "GOOGLE_CLOUD_PROJECT", - # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', - # A dictionary you want to inject into your test. Don't put any - # secrets here. These values will override predefined values. - "envs": {}, -} diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/quickstart.py b/packages/google-cloud-bigquery-connection/samples/snippets/quickstart.py deleted file mode 100644 index 463bd8a87ccc..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/quickstart.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2021 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. - -# [START bigqueryconnection_quickstart] - -from google.cloud import bigquery_connection_v1 as bq_connection - - -def main( - project_id: str = "your-project-id", location: str = "US", transport: str = "grpc" -) -> None: - """Prints details and summary information about connections for a given admin project and location""" - client = bq_connection.ConnectionServiceClient(transport=transport) - print(f"List of connections in project {project_id} in location {location}") - req = bq_connection.ListConnectionsRequest( - parent=client.common_location_path(project_id, location) - ) - for connection in client.list_connections(request=req): - print(f"\tConnection {connection.friendly_name} ({connection.name})") - - -# [END bigqueryconnection_quickstart] diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/quickstart_test.py b/packages/google-cloud-bigquery-connection/samples/snippets/quickstart_test.py deleted file mode 100644 index 2a8df8f59eaf..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/quickstart_test.py +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright 2021 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. - -import pytest - -from . import quickstart - - -@pytest.mark.parametrize("transport", ["grpc", "rest"]) -def test_quickstart( - capsys: pytest.CaptureFixture, project_id: str, location: str, transport: str -) -> None: - quickstart.main(project_id, location, transport) - out, _ = capsys.readouterr() - assert "List of connections in project" in out diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/requirements-test.txt b/packages/google-cloud-bigquery-connection/samples/snippets/requirements-test.txt deleted file mode 100644 index 95b74e709387..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/requirements-test.txt +++ /dev/null @@ -1,2 +0,0 @@ -pytest==7.4.0 -google-cloud-testutils==1.3.3 \ No newline at end of file diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/requirements.txt b/packages/google-cloud-bigquery-connection/samples/snippets/requirements.txt deleted file mode 100644 index a4a588a27cda..000000000000 --- a/packages/google-cloud-bigquery-connection/samples/snippets/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -google-cloud-bigquery-connection==1.13.0 \ No newline at end of file