refactor(bigquery): update code samples to use strings for table and dataset IDs

bigquery/samples/client_query_batch.py

@@ -42,4 +42,4 @@ def client_query_batch(client):
 
     print("Job {} is currently in state {}".format(query_job.job_id, query_job.state))
     # [END bigquery_query_batch]
-    return query_job.job_id
+    return query_job

bigquery/samples/client_query_destination_table_cmek.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def client_query_destination_table_cmek(client, table_id):
+def client_query_destination_table_cmek(client, table_id, kms_key_name):
 
     # [START bigquery_query_destination_table_cmek]
     from google.cloud import bigquery
@@ -24,14 +24,14 @@ def client_query_destination_table_cmek(client, table_id):
     # TODO(developer): Set table_id to the ID of the destination table.
     # table_id = "your-project.your_dataset.your_table_name"
 
-    job_config = bigquery.QueryJobConfig()
-    job_config.destination = table_id
-
     # Set the encryption key to use for the destination.
     # TODO(developer): Replace this key with a key you have created in KMS.
-    kms_key_name = "projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}".format(
-        "cloud-samples-tests", "us", "test", "test"
-    )
+    # kms_key_name = "projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}".format(
+    #     your-project, location, your-ring, your-key
+    # )
+
+    job_config = bigquery.QueryJobConfig()
+    job_config.destination = table_id
 
     encryption_config = bigquery.EncryptionConfiguration(kms_key_name=kms_key_name)
     job_config.destination_encryption_configuration = encryption_config

bigquery/samples/copy_table_cmek.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def copy_table_cmek(client, dest_table_id, orig_table_id):
+def copy_table_cmek(client, dest_table_id, orig_table_id, kms_key_name):
 
     # [START bigquery_copy_table_cmek]
     from google.cloud import bigquery
@@ -29,9 +29,9 @@ def copy_table_cmek(client, dest_table_id, orig_table_id):
 
     # Set the encryption key to use for the destination.
     # TODO(developer): Replace this key with a key you have created in KMS.
-    kms_key_name = "projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}".format(
-        "cloud-samples-tests", "us", "test", "test"
-    )
+    # kms_key_name = "projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}".format(
+    #     your-project, location, your-ring, your-key
+    # )
 
     encryption_config = bigquery.EncryptionConfiguration(kms_key_name=kms_key_name)
     job_config = bigquery.CopyJobConfig()

bigquery/samples/copy_table_multiple_source.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-def copy_table_multiple_source(client, dest_table_id, tables_ids):
+def copy_table_multiple_source(client, dest_table_id, table_ids):
 
     # [START bigquery_copy_table_multiple_source]
     # TODO(developer): Import the client library.
@@ -25,15 +25,15 @@ def copy_table_multiple_source(client, dest_table_id, tables_ids):
     # TODO(developer): Set dest_table_id to the ID of the destination table.
     # dest_table_id = "your-project.your_dataset.your_table_name"
 
-    # TODO(developer): Set tables_ids to the list of the IDs of the original tables.
-    # tables_ids = ["your-project.your_dataset.your_table_name", ...]
+    # TODO(developer): Set table_ids to the list of the IDs of the original tables.
+    # table_ids = ["your-project.your_dataset.your_table_name", ...]
 
     job = client.copy_table(
-        tables_ids,
+        table_ids,
         dest_table_id,
         location="US",  # Must match the source and the destination dataset(s) location.
     )  # Make an API request.
     job.result()  # Wait for the job to complete.
 
-    print("A copy of {} tables has been created".format(len(tables_ids)))
+    print("The tables {} have been appended to {}".format(table_ids, dest_table_id))
     # [END bigquery_copy_table_multiple_source]

bigquery/samples/tests/conftest.py

@@ -132,3 +132,8 @@ def model_id(client, dataset_id):
 
     client.query(sql).result()
     return model_id
+
+
+@pytest.fixture
+def kms_key_name():
+    return "projects/cloud-samples-tests/locations/us/keyRings/test/cryptoKeys/test"

bigquery/samples/tests/test_client_query_batch.py

@@ -18,6 +18,6 @@
 
 def test_client_query_batch(capsys, client):
 
-    job_id = client_query_batch.client_query_batch(client)
+    job = client_query_batch.client_query_batch(client)
     out, err = capsys.readouterr()
-    assert "Job {} is currently in state DONE".format(job_id) in out
+    assert "Job {} is currently in state {}".format(job.job_id, job.state) in out

bigquery/samples/tests/test_client_query_destination_table_cmek.py

@@ -16,10 +16,12 @@
 from .. import client_query_destination_table_cmek
 
 
-def test_client_query_destination_table_cmek(capsys, client, random_table_id):
+def test_client_query_destination_table_cmek(
+    capsys, client, random_table_id, kms_key_name
+):
 
     client_query_destination_table_cmek.client_query_destination_table_cmek(
-        client, random_table_id
+        client, random_table_id, kms_key_name
     )
     out, err = capsys.readouterr()
     assert "The destination table is written using the encryption configuration" in out

bigquery/samples/tests/test_client_query_dry_run.py

@@ -20,6 +20,6 @@ def test_client_query_dry_run(capsys, client):
 
     query_job = client_query_dry_run.client_query_dry_run(client)
     out, err = capsys.readouterr()
-    assert "This query will process 65935918 bytes." in out
+    assert "This query will process 0 bytes." not in out
     assert query_job.state == "DONE"
     assert query_job.dry_run

bigquery/samples/tests/test_client_query_legacy_sql.py

@@ -20,4 +20,4 @@ def test_client_query_legacy_sql(capsys, client):
 
     client_query_legacy_sql.client_query_legacy_sql(client)
     out, err = capsys.readouterr()
-    assert "Row(('Frances',), {'name': 0})" in out
+    assert "Row((" in out

bigquery/samples/tests/test_copy_table_cmek.py

@@ -16,8 +16,12 @@
 from .. import copy_table_cmek
 
 
-def test_copy_table_cmek(capsys, client, random_table_id, table_with_data_id):
+def test_copy_table_cmek(
+    capsys, client, random_table_id, table_with_data_id, kms_key_name
+):
 
-    copy_table_cmek.copy_table_cmek(client, random_table_id, table_with_data_id)
+    copy_table_cmek.copy_table_cmek(
+        client, random_table_id, table_with_data_id, kms_key_name
+    )
     out, err = capsys.readouterr()
     assert "A copy of the table created" in out

bigquery/samples/tests/test_copy_table_multiple_source.py

@@ -39,13 +39,16 @@ def test_copy_table_multiple_source(capsys, client, random_table_id, random_data
             body, table_ref, location="US", job_config=job_config
         ).result()
 
-    tables_ids = [
+    table_ids = [
         "{}.table1".format(random_dataset_id),
         "{}.table2".format(random_dataset_id),
     ]
 
     copy_table_multiple_source.copy_table_multiple_source(
-        client, random_table_id, tables_ids
+        client, random_table_id, table_ids
     )
     out, err = capsys.readouterr()
-    assert "A copy of 2 tables has been created" in out
+    assert (
+        "The tables {} have been appended to {}".format(table_ids, random_table_id)
+        in out
+    )