docs(samples): add copy cmek table (#513)

Author: Praful Makani

samples/snippets/src/main/java/com/example/bigquery/CopyTableCMEK.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2020 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.
+ */
+
+package com.example.bigquery;
+
+// [START bigquery_copy_table_cmek]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.CopyJobConfiguration;
+import com.google.cloud.bigquery.EncryptionConfiguration;
+import com.google.cloud.bigquery.Job;
+import com.google.cloud.bigquery.JobInfo;
+import com.google.cloud.bigquery.TableId;
+
+// Sample to copy a cmek table
+public class CopyTableCMEK {
+
+  public static void runCopyTableCMEK() {
+    // TODO(developer): Replace these variables before running the sample.
+    String destinationDatasetName = "MY_DESTINATION_DATASET_NAME";
+    String destinationTableId = "MY_DESTINATION_TABLE_NAME";
+    String sourceDatasetName = "MY_SOURCE_DATASET_NAME";
+    String sourceTableId = "MY_SOURCE_TABLE_NAME";
+    String kmsKeyName = "MY_KMS_KEY_NAME";
+    EncryptionConfiguration encryption =
+        EncryptionConfiguration.newBuilder().setKmsKeyName(kmsKeyName).build();
+    copyTableCMEK(
+        sourceDatasetName, sourceTableId, destinationDatasetName, destinationTableId, encryption);
+  }
+
+  public static void copyTableCMEK(
+      String sourceDatasetName,
+      String sourceTableId,
+      String destinationDatasetName,
+      String destinationTableId,
+      EncryptionConfiguration encryption) {
+    try {
+      // Initialize client that will be used to send requests. This client only needs to be created
+      // once, and can be reused for multiple requests.
+      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
+
+      TableId sourceTable = TableId.of(sourceDatasetName, sourceTableId);
+      TableId destinationTable = TableId.of(destinationDatasetName, destinationTableId);
+
+      // For more information on CopyJobConfiguration see:
+      // https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigquery/JobConfiguration.html
+      CopyJobConfiguration configuration =
+          CopyJobConfiguration.newBuilder(destinationTable, sourceTable)
+              .setDestinationEncryptionConfiguration(encryption)
+              .build();
+
+      // For more information on Job see:
+      // https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/bigquery/package-summary.html
+      Job job = bigquery.create(JobInfo.of(configuration));
+
+      // Blocks until this job completes its execution, either failing or succeeding.
+      Job completedJob = job.waitFor();
+      if (completedJob == null) {
+        System.out.println("Job not executed since it no longer exists.");
+        return;
+      } else if (completedJob.getStatus().getError() != null) {
+        System.out.println(
+            "BigQuery was unable to copy table due to an error: \n" + job.getStatus().getError());
+        return;
+      }
+      System.out.println("Table cmek copied successfully.");
+    } catch (BigQueryException | InterruptedException e) {
+      System.out.println("Table cmek copying job was interrupted. \n" + e.toString());
+    }
+  }
+}
+// [END bigquery_copy_table_cmek]

samples/snippets/src/test/java/com/example/bigquery/CopyTableCMEKIT.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2020 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.
+ */
+
+package com.example.bigquery;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import com.google.cloud.bigquery.EncryptionConfiguration;
+import com.google.cloud.bigquery.Field;
+import com.google.cloud.bigquery.Schema;
+import com.google.cloud.bigquery.StandardSQLTypeName;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.util.UUID;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class CopyTableCMEKIT {
+
+  private String sourceTableName;
+  private String destinationTableName;
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+
+  private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME");
+  private static final String BIGQUERY_KMS_KEY_NAME = requireEnvVar("BIGQUERY_KMS_KEY_NAME");
+
+  private static String requireEnvVar(String varName) {
+    String value = System.getenv(varName);
+    assertNotNull(
+        "Environment variable " + varName + " is required to perform these tests.",
+        System.getenv(varName));
+    return value;
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireEnvVar("BIGQUERY_DATASET_NAME");
+    requireEnvVar("BIGQUERY_KMS_KEY_NAME");
+  }
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+
+    sourceTableName = "MY_SOURCE_TABLE_CMEK_TEST" + UUID.randomUUID().toString().substring(0, 8);
+    destinationTableName =
+        "MY_DESTINATION_TABLE_CMEK_TEST" + UUID.randomUUID().toString().substring(0, 8);
+    Schema schema =
+        Schema.of(
+            Field.of("stringField", StandardSQLTypeName.STRING),
+            Field.of("booleanField", StandardSQLTypeName.BOOL));
+    EncryptionConfiguration configuration =
+        EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build();
+    CreateTableCMEK.createTableCMEK(BIGQUERY_DATASET_NAME, sourceTableName, schema, configuration);
+
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() {
+    // Clean up
+    DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, sourceTableName);
+    DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, destinationTableName);
+    System.setOut(null);
+  }
+
+  @Test
+  public void testCopyTableCMEK() {
+    EncryptionConfiguration configuration =
+        EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build();
+    CopyTableCMEK.copyTableCMEK(
+        BIGQUERY_DATASET_NAME,
+        sourceTableName,
+        BIGQUERY_DATASET_NAME,
+        destinationTableName,
+        configuration);
+    assertThat(bout.toString()).contains("Table cmek copied successfully.");
+  }
+}