|
| 1 | +/* |
| 2 | + * Copyright 2025 Google LLC and Contributors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package com.google.cloud.spark.bigquery.integration; |
| 17 | + |
| 18 | +import static com.google.common.truth.Truth.assertThat; |
| 19 | + |
| 20 | +import com.google.cloud.bigquery.JobInfo; |
| 21 | +import com.google.cloud.bigquery.QueryJobConfiguration; |
| 22 | +import com.google.cloud.bigquery.TableId; |
| 23 | +import com.google.cloud.spark.bigquery.ReadSessionCreator; |
| 24 | +import com.google.cloud.spark.bigquery.connector.common.integration.IntegrationTestUtils; |
| 25 | +import com.google.cloud.spark.bigquery.connector.common.integration.SparkBigQueryIntegrationTestBase; |
| 26 | +import java.io.StringWriter; |
| 27 | +import java.util.Arrays; |
| 28 | +import java.util.List; |
| 29 | +import java.util.UUID; |
| 30 | +import java.util.stream.Collectors; |
| 31 | +import org.apache.log4j.Level; |
| 32 | +import org.apache.log4j.Logger; |
| 33 | +import org.apache.log4j.SimpleLayout; |
| 34 | +import org.apache.log4j.WriterAppender; |
| 35 | +import org.apache.spark.sql.Dataset; |
| 36 | +import org.apache.spark.sql.Row; |
| 37 | +import org.junit.After; |
| 38 | +import org.junit.Before; |
| 39 | +import org.junit.Test; |
| 40 | + |
| 41 | +public class MaterializedViewReadIT extends SparkBigQueryIntegrationTestBase { |
| 42 | + |
| 43 | + private final Logger logger = Logger.getLogger(ReadSessionCreator.class); |
| 44 | + private WriterAppender appender; |
| 45 | + private StringWriter stringWriter; |
| 46 | + private String testDataset; |
| 47 | + private String mvName; |
| 48 | + private TableId sourceTableId; |
| 49 | + private String testServiceAccount; |
| 50 | + |
| 51 | + @Before |
| 52 | + public void setUp() throws InterruptedException { |
| 53 | + // Set up a custom log appender to capture logs |
| 54 | + stringWriter = new StringWriter(); |
| 55 | + appender = new WriterAppender(new SimpleLayout(), stringWriter); |
| 56 | + appender.setThreshold(Level.WARN); |
| 57 | + logger.addAppender(appender); |
| 58 | + |
| 59 | + // Create a dedicated service account for this test |
| 60 | + String projectId = System.getenv("GOOGLE_CLOUD_PROJECT"); |
| 61 | + assertThat(projectId).isNotNull(); |
| 62 | + testServiceAccount = |
| 63 | + String.format( |
| 64 | + "mv-test-%s@%s.iam.gserviceaccount.com", |
| 65 | + UUID.randomUUID().toString().substring(0, 8), projectId); |
| 66 | + IntegrationTestUtils.createServiceAccount(testServiceAccount); |
| 67 | + |
| 68 | + // Create a temporary dataset and grant the new SA the BQ User role |
| 69 | + // This provides permissions to run jobs (for the fallback) but not to read table data directly |
| 70 | + testDataset = "mv_read_it_" + System.nanoTime(); |
| 71 | + IntegrationTestUtils.createDataset(testDataset); |
| 72 | + IntegrationTestUtils.grantServiceAccountRole( |
| 73 | + testServiceAccount, "roles/bigquery.user", testDataset); |
| 74 | + IntegrationTestUtils.grantServiceAccountRole( |
| 75 | + testServiceAccount, "roles/bigquery.metadataViewer", testDataset); |
| 76 | + |
| 77 | + // Create a source table |
| 78 | + sourceTableId = TableId.of(testDataset, "source_table_" + System.nanoTime()); |
| 79 | + IntegrationTestUtils.createTable(sourceTableId, "name:string, value:integer", "name,value"); |
| 80 | + |
| 81 | + // Create a Materialized View |
| 82 | + mvName = "test_mv_" + System.nanoTime(); |
| 83 | + String createMvSql = |
| 84 | + String.format( |
| 85 | + "CREATE MATERIALIZED VIEW `%s.%s` AS SELECT name, value FROM `%s.%s`", |
| 86 | + testDataset, mvName, testDataset, sourceTableId.getTable()); |
| 87 | + QueryJobConfiguration createMvJob = QueryJobConfiguration.newBuilder(createMvSql).build(); |
| 88 | + bigquery.create(JobInfo.of(createMvJob)).waitFor(); |
| 89 | + } |
| 90 | + |
| 91 | + @After |
| 92 | + public void tearDown() { |
| 93 | + logger.removeAppender(appender); |
| 94 | + try { |
| 95 | + if (testDataset != null) { |
| 96 | + IntegrationTestUtils.deleteDatasetAndTables(testDataset); |
| 97 | + } |
| 98 | + } finally { |
| 99 | + if (testServiceAccount != null) { |
| 100 | + IntegrationTestUtils.deleteServiceAccount(testServiceAccount); |
| 101 | + } |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + @Test |
| 106 | + public void testReadMaterializedView_lackingPermission_logsWarningAndFallsBack() { |
| 107 | + // This test confirms that when reading a Materialized View with a service account |
| 108 | + // that lacks `bigquery.tables.getData` permission, the connector: |
| 109 | + // 1. Logs a specific WARN message indicating the permission issue and the fallback. |
| 110 | + // 2. Successfully reads the data by falling back to materializing the view's query. |
| 111 | + |
| 112 | + // Arrange: Use the dedicated service account with insufficient permissions for a direct read. |
| 113 | + String mvToRead = testDataset + "." + mvName; |
| 114 | + |
| 115 | + // Act: Read the materialized view, impersonating the test service account |
| 116 | + Dataset<Row> df = |
| 117 | + spark |
| 118 | + .read() |
| 119 | + .format("bigquery") |
| 120 | + .option("viewsEnabled", "true") // Required to read any kind of view |
| 121 | + .option("impersonationServiceAccount", testServiceAccount) |
| 122 | + .load(mvToRead); |
| 123 | + |
| 124 | + List<Row> result = df.collectAsList(); |
| 125 | + |
| 126 | + // Assert |
| 127 | + // 1. Assert that the read was successful via fallback |
| 128 | + assertThat(result).hasSize(2); |
| 129 | + List<String> names = result.stream().map(row -> row.getString(0)).collect(Collectors.toList()); |
| 130 | + assertThat(names).containsExactlyElementsIn(Arrays.asList("name1", "name2")); |
| 131 | + |
| 132 | + // 2. Assert that the specific warning was logged |
| 133 | + String logOutput = stringWriter.toString(); |
| 134 | + assertThat(logOutput).contains("Failed to initiate a direct read from Materialized View"); |
| 135 | + assertThat(logOutput) |
| 136 | + .contains("The service account likely lacks 'bigquery.tables.getData' permission"); |
| 137 | + assertThat(logOutput).contains("Falling back to re-executing the view's underlying query"); |
| 138 | + } |
| 139 | +} |
0 commit comments