From 61673fe678a71de472e1f58f3a66f383749d48da Mon Sep 17 00:00:00 2001 From: Mario Torres Jr Date: Tue, 3 Jan 2023 14:46:49 -0600 Subject: [PATCH 1/2] docs: revise create table cmek sample --- docs/snippets.py | 2 +- samples/snippets/create_table_cmek.py | 46 ++++++++++++++++++++++ samples/snippets/create_table_cmek_test.py | 37 +++++++++++++++++ samples/snippets/noxfile.py | 1 - 4 files changed, 84 insertions(+), 2 deletions(-) create mode 100644 samples/snippets/create_table_cmek.py create mode 100644 samples/snippets/create_table_cmek_test.py diff --git a/docs/snippets.py b/docs/snippets.py index 05e4fa378..670b6010e 100644 --- a/docs/snippets.py +++ b/docs/snippets.py @@ -166,7 +166,7 @@ def test_create_table_cmek(client, to_delete): dataset = bigquery.Dataset(dataset_ref) client.create_dataset(dataset) to_delete.append(dataset) - + # TODO(Mattix23): When sample is updated in cloud.google.com, delete this one. # [START bigquery_create_table_cmek] # from google.cloud import bigquery # client = bigquery.Client() diff --git a/samples/snippets/create_table_cmek.py b/samples/snippets/create_table_cmek.py new file mode 100644 index 000000000..011c56d4e --- /dev/null +++ b/samples/snippets/create_table_cmek.py @@ -0,0 +1,46 @@ +# 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. + + +def create_table_cmek(table_id: str, kms_key_name: str) -> None: + orig_table_id = table_id + orig_key_name = kms_key_name + # [START bigquery_create_table_cmek] + from google.cloud import bigquery + + client = bigquery.Client() + + # TODO(dev): Change table_id to the full name of the table you want to create. + table_id = "your-project.your_dataset.your_table_name" + + # Set the encryption key to use for the table. + # TODO: Replace this key with a key you have created in Cloud KMS. + kms_key_name = "projects/your-project/locations/us/keyRings/test/cryptoKeys/test" + + # [END bigquery_create_table_cmek] + + table_id = orig_table_id + kms_key_name = orig_key_name + + # [START bigquery_create_table_cmek] + table = bigquery.Table(table_id) + table.encryption_configuration = bigquery.EncryptionConfiguration( + kms_key_name=kms_key_name + ) + table = client.create_table(table) # API request + + print(f"Created {table_id}.") + print(f"Key: {table.encryption_configuration.kms_key_name}.") + + # [END bigquery_create_table_cmek] diff --git a/samples/snippets/create_table_cmek_test.py b/samples/snippets/create_table_cmek_test.py new file mode 100644 index 000000000..429baf3fd --- /dev/null +++ b/samples/snippets/create_table_cmek_test.py @@ -0,0 +1,37 @@ +# 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. + +import typing + +import create_table_cmek + +if typing.TYPE_CHECKING: + import pytest + + +def test_create_table( + capsys: "pytest.CaptureFixture[str]", + random_table_id: str, +) -> None: + + kms_key_name = ( + "projects/cloud-samples-tests/locations/us/keyRings/test/cryptoKeys/test" + ) + + create_table_cmek.create_table_cmek(random_table_id, kms_key_name) + + out, _ = capsys.readouterr() + assert "Created" in out + assert random_table_id in out + assert kms_key_name in out diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py index e8283c38d..057708469 100644 --- a/samples/snippets/noxfile.py +++ b/samples/snippets/noxfile.py @@ -22,7 +22,6 @@ import nox - # WARNING - WARNING - WARNING - WARNING - WARNING # WARNING - WARNING - WARNING - WARNING - WARNING # DO NOT EDIT THIS FILE EVER! From 8c92d937f78eff83b29a882a2955bd543a89c152 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 3 Jan 2023 20:50:22 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- samples/snippets/noxfile.py | 1 + 1 file changed, 1 insertion(+) diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py index 057708469..e8283c38d 100644 --- a/samples/snippets/noxfile.py +++ b/samples/snippets/noxfile.py @@ -22,6 +22,7 @@ import nox + # WARNING - WARNING - WARNING - WARNING - WARNING # WARNING - WARNING - WARNING - WARNING - WARNING # DO NOT EDIT THIS FILE EVER!