From 761b5f5045edbe8c81a31f501bf3b14de7dffe20 Mon Sep 17 00:00:00 2001 From: Steffany Brown <30247553+steffnay@users.noreply.github.com> Date: Fri, 20 May 2022 12:32:02 -0700 Subject: [PATCH 1/3] docs(samples): add create_migration_workflow snippet (#71) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(samples): add handwritten snippet structure * docs(samples): add create_migration_workflow snippet * fix copyright * remove types * lint * cleanup noxfile * enforce type hints * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Update samples/snippets/create_migration_workflow.py Co-authored-by: Anthonios Partheniou * Update samples/snippets/create_migration_workflow.py Co-authored-by: Anthonios Partheniou * pin dependencies * add type annotations Co-authored-by: Anthonios Partheniou Co-authored-by: Owl Bot --- samples/snippets/__init__.py | 15 + samples/snippets/create_migration_workflow.py | 72 ++++ .../create_migration_workflow_test.py | 69 ++++ samples/snippets/noxfile.py | 310 ++++++++++++++++++ samples/snippets/noxfile_config.py | 38 +++ samples/snippets/requirements-test.txt | 4 + samples/snippets/requirements.txt | 2 + 7 files changed, 510 insertions(+) create mode 100644 samples/snippets/__init__.py create mode 100644 samples/snippets/create_migration_workflow.py create mode 100644 samples/snippets/create_migration_workflow_test.py create mode 100644 samples/snippets/noxfile.py create mode 100644 samples/snippets/noxfile_config.py create mode 100644 samples/snippets/requirements-test.txt create mode 100644 samples/snippets/requirements.txt diff --git a/samples/snippets/__init__.py b/samples/snippets/__init__.py new file mode 100644 index 0000000..89aac76 --- /dev/null +++ b/samples/snippets/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2022 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. diff --git a/samples/snippets/create_migration_workflow.py b/samples/snippets/create_migration_workflow.py new file mode 100644 index 0000000..a0ee9cb --- /dev/null +++ b/samples/snippets/create_migration_workflow.py @@ -0,0 +1,72 @@ +# Copyright 2022 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 bigquery_migration_create_workflow] +def create_migration_workflow( + gcs_input_path: str, gcs_output_path: str, project_id: str +) -> None: + """Creates a migration workflow of a Batch SQL Translation and prints the response.""" + + from google.cloud import bigquery_migration_v2 + + parent = f"projects/{project_id}/locations/us" + + # Construct a BigQuery Migration client object. + client = bigquery_migration_v2.MigrationServiceClient() + + # Set the source dialect to Teradata SQL. + source_dialect = bigquery_migration_v2.Dialect() + source_dialect.teradata_dialect = bigquery_migration_v2.TeradataDialect( + mode=bigquery_migration_v2.TeradataDialect.Mode.SQL + ) + + # Set the target dialect to BigQuery dialect. + target_dialect = bigquery_migration_v2.Dialect() + target_dialect.bigquery_dialect = bigquery_migration_v2.BigQueryDialect() + + # Prepare the config proto. + translation_config = bigquery_migration_v2.TranslationConfigDetails( + gcs_source_path=gcs_input_path, + gcs_target_path=gcs_output_path, + source_dialect=source_dialect, + target_dialect=target_dialect, + ) + + # Prepare the task. + migration_task = bigquery_migration_v2.MigrationTask( + type_="Translation_Teradata2BQ", translation_config_details=translation_config + ) + + # Prepare the workflow. + workflow = bigquery_migration_v2.MigrationWorkflow( + display_name="demo-workflow-python-example-Teradata2BQ" + ) + + workflow.tasks["translation-task"] = migration_task # type: ignore + + # Prepare the API request to create a migration workflow. + request = bigquery_migration_v2.CreateMigrationWorkflowRequest( + parent=parent, + migration_workflow=workflow, + ) + + response = client.create_migration_workflow(request=request) + + print("Created workflow:") + print(response.display_name) + print("Current state:") + print(response.State(response.state)) + + +# [END bigquery_migration_create_workflow] diff --git a/samples/snippets/create_migration_workflow_test.py b/samples/snippets/create_migration_workflow_test.py new file mode 100644 index 0000000..cc4b504 --- /dev/null +++ b/samples/snippets/create_migration_workflow_test.py @@ -0,0 +1,69 @@ +# Copyright 2022 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. + + +from typing import Iterable, List, Optional + +from google.api_core.exceptions import ( + InternalServerError, + ServiceUnavailable, + TooManyRequests, +) + +from google.cloud import storage + +import pytest + +from test_utils.retry import RetryErrors +from test_utils.system import unique_resource_id + +from . import create_migration_workflow + +retry_storage_errors = RetryErrors( + (TooManyRequests, InternalServerError, ServiceUnavailable) +) + +storage_client = storage.Client() +PROJECT_ID = storage_client.project + + +def _create_bucket(bucket_name: str, location: Optional[str] = None) -> storage.Bucket: + bucket = storage_client.bucket(bucket_name) + retry_storage_errors(storage_client.create_bucket)(bucket_name, location=location) + + return bucket + + +@pytest.fixture +def buckets_to_delete() -> Iterable[List]: + doomed = [] + yield doomed + for item in doomed: + if isinstance(item, storage.Bucket): + retry_storage_errors(item.delete)(force=True) + + +def test_create_migration_workflow( + capsys: pytest.CaptureFixture, buckets_to_delete: List[storage.Bucket] +) -> None: + bucket_name = "bq_migration_create_workflow_test" + unique_resource_id() + path = f"gs://{PROJECT_ID}/{bucket_name}" + bucket = _create_bucket(bucket_name) + buckets_to_delete.extend([bucket]) + + create_migration_workflow.create_migration_workflow(path, path, PROJECT_ID) + out, _ = capsys.readouterr() + + assert "demo-workflow-python-example-Teradata2BQ" in out + assert "Current state:" in out diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py new file mode 100644 index 0000000..3b3ffa5 --- /dev/null +++ b/samples/snippets/noxfile.py @@ -0,0 +1,310 @@ +# 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, List, 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.6", "3.7", "3.8", "3.9", "3.10"] + +# 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 +# + + +def _determine_local_import_names(start_dir: str) -> List[str]: + """Determines all import names that should be considered "local". + + This is used when running the linter to insure that import order is + properly checked. + """ + file_ext_pairs = [os.path.splitext(path) for path in os.listdir(start_dir)] + return [ + basename + for basename, extension in file_ext_pairs + if extension == ".py" + or os.path.isdir(os.path.join(start_dir, basename)) + and basename not in ("__pycache__") + ] + + +# 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", + "--import-order-style=google", + "--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", "flake8-import-order") + else: + session.install("flake8", "flake8-import-order", "flake8-annotations") + + local_names = _determine_local_import_names(".") + args = FLAKE8_COMMON_ARGS + [ + "--application-import-names", + ",".join(local_names), + ".", + ] + 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") + glob.glob("test_*.py") + test_list.extend(glob.glob("tests")) + + 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/samples/snippets/noxfile_config.py b/samples/snippets/noxfile_config.py new file mode 100644 index 0000000..706b3f3 --- /dev/null +++ b/samples/snippets/noxfile_config.py @@ -0,0 +1,38 @@ +# 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/main/noxfile_config.py + +TEST_CONFIG_OVERRIDE = { + # 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": 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": "GOOGLE_CLOUD_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/samples/snippets/requirements-test.txt b/samples/snippets/requirements-test.txt new file mode 100644 index 0000000..a92c4e0 --- /dev/null +++ b/samples/snippets/requirements-test.txt @@ -0,0 +1,4 @@ +pytest==6.2.5 +google-cloud-testutils==1.3.0 +google-api-core==2.8.0 +google-cloud-storage==2.0.0 \ No newline at end of file diff --git a/samples/snippets/requirements.txt b/samples/snippets/requirements.txt new file mode 100644 index 0000000..ba188d3 --- /dev/null +++ b/samples/snippets/requirements.txt @@ -0,0 +1,2 @@ +google-cloud-bigquery-migration==0.4.1 +protobuf==3.19.1 From 5d0b0e644c07eec7c0df9270436b65d3660b4339 Mon Sep 17 00:00:00 2001 From: WhiteSource Renovate Date: Sun, 22 May 2022 20:07:18 +0200 Subject: [PATCH 2/3] chore(deps): update all dependencies (#73) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore(deps): update all dependencies * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot --- samples/snippets/create_migration_workflow_test.py | 3 --- samples/snippets/requirements-test.txt | 6 +++--- samples/snippets/requirements.txt | 2 +- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/samples/snippets/create_migration_workflow_test.py b/samples/snippets/create_migration_workflow_test.py index cc4b504..d687cb6 100644 --- a/samples/snippets/create_migration_workflow_test.py +++ b/samples/snippets/create_migration_workflow_test.py @@ -20,11 +20,8 @@ ServiceUnavailable, TooManyRequests, ) - from google.cloud import storage - import pytest - from test_utils.retry import RetryErrors from test_utils.system import unique_resource_id diff --git a/samples/snippets/requirements-test.txt b/samples/snippets/requirements-test.txt index a92c4e0..1e5f4d8 100644 --- a/samples/snippets/requirements-test.txt +++ b/samples/snippets/requirements-test.txt @@ -1,4 +1,4 @@ -pytest==6.2.5 -google-cloud-testutils==1.3.0 +pytest==7.1.2 +google-cloud-testutils==1.3.1 google-api-core==2.8.0 -google-cloud-storage==2.0.0 \ No newline at end of file +google-cloud-storage==2.3.0 \ No newline at end of file diff --git a/samples/snippets/requirements.txt b/samples/snippets/requirements.txt index ba188d3..513228d 100644 --- a/samples/snippets/requirements.txt +++ b/samples/snippets/requirements.txt @@ -1,2 +1,2 @@ google-cloud-bigquery-migration==0.4.1 -protobuf==3.19.1 +protobuf==3.20.1 From 71a46508f6e2f34ddaf1b63fd53ed086ad4768de Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Wed, 25 May 2022 11:46:28 -0400 Subject: [PATCH 3/3] chore(main): release 0.4.2 (#72) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- CHANGELOG.md | 7 +++++++ setup.py | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f00b4e8..9abbb33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +### [0.4.2](https://github.com/googleapis/python-bigquery-migration/compare/v0.4.1...v0.4.2) (2022-05-22) + + +### Documentation + +* **samples:** add create_migration_workflow snippet ([#71](https://github.com/googleapis/python-bigquery-migration/issues/71)) ([761b5f5](https://github.com/googleapis/python-bigquery-migration/commit/761b5f5045edbe8c81a31f501bf3b14de7dffe20)) + ### [0.4.1](https://github.com/googleapis/python-bigquery-migration/compare/v0.4.0...v0.4.1) (2022-05-05) diff --git a/setup.py b/setup.py index 616263c..0a42bd1 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ import setuptools # type: ignore -version = "0.4.1" +version = "0.4.2" package_root = os.path.abspath(os.path.dirname(__file__))