docs(samples): create connection sample for MySQL instance (#147)

* setup for cloudsql connection sample * fleshed out sample * complete sample * changing region tag pattern * adding new environment variables * adding missing env variable * fixing fixture with correct env variable * refactor * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * refactor test imports * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * kokoro lint errors * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * changing fixture use * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * refactoring variables * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fixing imports * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * changing fixture syntax * fixing import * fixing typecasting * updating fixture usage * changing fixtures * refactor fixtures Co-authored-by: Anthonios Partheniou <[email protected]> Co-authored-by: meredithslota <[email protected]> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Apr 15, 2022 · 87e9f8c · 87e9f8c
1 parent 83259da
commit 87e9f8c
Show file tree

Hide file tree

Showing 4 changed files with 288 additions and 4 deletions.
diff --git a/packages/google-cloud-bigquery-connection/samples/snippets/conftest.py b/packages/google-cloud-bigquery-connection/samples/snippets/conftest.py
@@ -19,15 +19,35 @@
 
 
 @pytest.fixture(scope="session")
-def project_id() -> str:
-    return os.environ["GOOGLE_CLOUD_PROJECT"]
+def connection_client() -> connection_service.ConnectionServiceClient:
+    return connection_service.ConnectionServiceClient()
 
 
 @pytest.fixture(scope="session")
-def connection_client() -> connection_service.ConnectionServiceClient:
-    return connection_service.ConnectionServiceClient()
+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
@@ -0,0 +1,64 @@
+# 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_connection_create]
+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
+
+    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)
+
+
+def create_mysql_connection(
+    project_id: str,
+    location: str,
+    cloud_sql_properties: bq_connection.CloudSqlProperties,
+) -> None:
+    connection = bq_connection.types.Connection({"cloud_sql": cloud_sql_properties})
+    client = bq_connection.ConnectionServiceClient()
+    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_connection_create]
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
@@ -0,0 +1,90 @@
+# 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
+
+
+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,
+) -> 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,
+    )
+    out, _ = capsys.readouterr()
+    assert "Created connection successfully:" in out
diff --git a/packages/google-cloud-bigquery-connection/testing/test-env.tmpl.sh b/packages/google-cloud-bigquery-connection/testing/test-env.tmpl.sh
@@ -0,0 +1,110 @@
+# 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
+#
+#      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.
+
+# Environment variables for system tests.
+export GOOGLE_CLOUD_PROJECT=your-project-id
+export GCP_PROJECT=$GOOGLE_CLOUD_PROJECT
+export FIRESTORE_PROJECT=
+
+export CLOUD_STORAGE_BUCKET=$GOOGLE_CLOUD_PROJECT
+export REQUESTER_PAYS_TEST_BUCKET="${CLOUD_STORAGE_BUCKET}-requester-pays-test"
+export API_KEY=
+export BIGTABLE_CLUSTER=bigtable-test
+export BIGTABLE_ZONE=us-central1-c
+export BIGTABLE_INSTANCE=
+export SPANNER_INSTANCE=
+export COMPOSER_LOCATION=us-central1
+export COMPOSER_ENVIRONMENT=
+export COMPOSER2_ENVIRONMENT=
+# Webserver for COMPOSER2_ENVIRONMENT
+export COMPOSER2_WEB_SERVER_URL=
+export CLOUD_KMS_KEY=
+
+export MYSQL_INSTANCE=
+export MYSQL_INSTANCE_ID=
+export MYSQL_INSTANCE_LOCATION=
+export MYSQL_USER=
+export MYSQL_PASSWORD=
+export MYSQL_DATABASE=
+export MYSQL_HOST=localhost:3306
+export POSTGRES_INSTANCE=
+export POSTGRES_USER=
+export POSTGRES_PASSWORD=
+export POSTGRES_DATABASE=
+export POSTGRES_HOST=localhost:5432
+export SQLSERVER_INSTANCE=
+export SQLSERVER_USER=
+export SQLSERVER_PASSWORD=
+export SQLSERVER_DATABASE=
+export SQLSERVER_HOST=127.0.0.1:1433
+export DB_SOCKET_DIR=
+
+export KG_API_KEY=
+export SLACK_TEST_SIGNATURE=
+export SLACK_SECRET=
+export FUNCTIONS_TOPIC=
+
+# Service account for HMAC samples
+export HMAC_KEY_TEST_SERVICE_ACCOUNT=
+
+# Environment variables for App Engine Flexible system tests.
+export GA_TRACKING_ID=
+export SQLALCHEMY_DATABASE_URI=sqlite://
+export PUBSUB_TOPIC=gae-mvm-pubsub-topic
+export PUBSUB_VERIFICATION_TOKEN=1234abc
+
+# Secret Manager Test Vars
+export GCLOUD_SECRETS_SERVICE_ACCOUNT=
+
+# Automl
+# A centralized project is used to remove duplicate work across all 7 languages 
+# and reduce the management of these resources.
+# https://docs.google.com/document/d/1-E7zTNqBm9ex7XIOhzMHCupwKWieyMKgAVwrRK5JTVY
+export AUTOML_PROJECT_ID=
+
+export ENTITY_EXTRACTION_DATASET_ID=
+export ENTITY_EXTRACTION_MODEL_ID=
+
+export SENTIMENT_ANALYSIS_DATASET_ID=
+export SENTIMENT_ANALYSIS_MODEL_ID=
+
+export TEXT_CLASSIFICATION_DATASET_ID=
+export TEXT_CLASSIFICATION_MODEL_ID=
+
+export TRANSLATION_DATASET_ID=
+export TRANSLATION_MODEL_ID=
+
+export VISION_CLASSIFICATION_DATASET_ID=
+export VISION_CLASSIFICATION_MODEL_ID=
+
+export OBJECT_DETECTION_DATASET_ID=
+# AutoML model takes 8-24 hours to create, having predefined 
+# and centralized models remove duplicate work across all languages.
+export OBJECT_DETECTION_MODEL_ID=
+
+# For git operations in the test driver(testing/run_tests.sh).
+# These are optional, but for avoiding flakes in Kokoro builds.
+export GITHUB_ACCESS_TOKEN=
+export GITHUB_USERNAME=
+
+# Cloud Run
+# For run/idp example, a Firebase IDP token
+export IDP_KEY=
+# For run/filesystem
+export IP_ADDRESS=
+export CONNECTOR=
+
+# Dialogflow examples.
+export SMART_REPLY_MODEL=
+export SMART_REPLY_ALLOWLIST=