[CASSANALYTICS-183] - Pass quoted identifiers to sidecar API calls for mixed-case keyspace/table restore #226
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 org.apache.cassandra.spark.data; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| class QualifiedTableNameTest | ||
| { | ||
| @Test | ||
| void testUnquotedIdentifiersReturnedAsIs() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("mykeyspace", "mytable", false); | ||
| assertThat(name.keyspace()).isEqualTo("mykeyspace"); | ||
| assertThat(name.table()).isEqualTo("mytable"); | ||
| assertThat(name.maybeQuotedKeyspace()).isEqualTo("mykeyspace"); | ||
| assertThat(name.maybeQuotedTable()).isEqualTo("mytable"); | ||
| } | ||
|
|
||
| @Test | ||
| void testQuotedIdentifiersWrappedInDoubleQuotes() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("MyKeyspace", "MyTable", true); | ||
| assertThat(name.maybeQuotedKeyspace()).isEqualTo("\"MyKeyspace\""); | ||
| assertThat(name.maybeQuotedTable()).isEqualTo("\"MyTable\""); | ||
| } | ||
|
|
||
| @Test | ||
| void testRawAccessorsUnaffectedByQuoteFlag() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("MyKeyspace", "MyTable", true); | ||
| assertThat(name.keyspace()).isEqualTo("MyKeyspace"); | ||
| assertThat(name.table()).isEqualTo("MyTable"); | ||
| } | ||
|
|
||
| @Test | ||
| void testToStringQuotesBothWhenFlagSet() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("MyKeyspace", "MyTable", true); | ||
| assertThat(name.toString()).isEqualTo("\"MyKeyspace\".\"MyTable\""); | ||
| } | ||
|
|
||
| @Test | ||
| void testToStringUnquotedWhenFlagNotSet() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("mykeyspace", "mytable", false); | ||
| assertThat(name.toString()).isEqualTo("mykeyspace.mytable"); | ||
| } | ||
|
|
||
| @Test | ||
| void testDefaultConstructorDoesNotQuote() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("MyKeyspace", "MyTable"); | ||
| assertThat(name.quoteIdentifiers()).isFalse(); | ||
| assertThat(name.maybeQuotedKeyspace()).isEqualTo("MyKeyspace"); | ||
| assertThat(name.maybeQuotedTable()).isEqualTo("MyTable"); | ||
| } | ||
|
|
||
| @Test | ||
| void testReservedWordIdentifiersQuoted() | ||
| { | ||
| QualifiedTableName name = new QualifiedTableName("keyspace", "table", true); | ||
| assertThat(name.maybeQuotedKeyspace()).isEqualTo("\"keyspace\""); | ||
| assertThat(name.maybeQuotedTable()).isEqualTo("\"table\""); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 org.apache.cassandra.spark.bulkwriter.cloudstorage; | ||
|
|
||
| import java.util.UUID; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import o.a.c.sidecar.client.shaded.common.request.data.CreateRestoreJobRequestPayload; | ||
| import o.a.c.sidecar.client.shaded.common.request.data.UpdateRestoreJobRequestPayload; | ||
| import o.a.c.sidecar.client.shaded.common.response.data.RestoreJobSummaryResponsePayload; | ||
| import o.a.c.sidecar.client.shaded.client.SidecarClient; | ||
| import org.apache.cassandra.spark.bulkwriter.JobInfo; | ||
| import org.apache.cassandra.spark.data.QualifiedTableName; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.ArgumentMatchers.eq; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| class CloudStorageDataTransferApiImplTest | ||
| { | ||
| private static final String QUOTED_KEYSPACE = "\"MyKeyspace\""; | ||
| private static final String QUOTED_TABLE = "\"MyTable\""; | ||
| private static final UUID JOB_ID = UUID.randomUUID(); | ||
|
|
||
| private SidecarClient sidecarClient; | ||
| private JobInfo jobInfo; | ||
| private CloudStorageDataTransferApiImpl api; | ||
|
|
||
| @BeforeEach | ||
| void setup() | ||
| { | ||
| sidecarClient = mock(SidecarClient.class); | ||
| jobInfo = mock(JobInfo.class); | ||
| when(jobInfo.qualifiedTableName()).thenReturn(new QualifiedTableName("MyKeyspace", "MyTable", true)); | ||
| when(jobInfo.getRestoreJobId()).thenReturn(JOB_ID); | ||
| when(jobInfo.getRestoreJobId(null)).thenReturn(JOB_ID); | ||
| api = new CloudStorageDataTransferApiImpl(jobInfo, sidecarClient, mock(StorageClient.class), null); | ||
| } | ||
|
|
||
| @Test | ||
| void testCreateRestoreJobUsesQuotedIdentifiers() throws Exception | ||
|
Contributor
There was a problem hiding this comment. What do you think about adding quoted identifiers tests to the other modified APIs? |
||
| { | ||
| when(sidecarClient.createRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), any())) | ||
| .thenReturn(CompletableFuture.completedFuture(null)); | ||
|
|
||
| api.createRestoreJob(mock(CreateRestoreJobRequestPayload.class)); | ||
|
|
||
| verify(sidecarClient).createRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), any()); | ||
| } | ||
|
|
||
| @Test | ||
| void testRestoreJobSummaryUsesQuotedIdentifiers() throws Exception | ||
| { | ||
| RestoreJobSummaryResponsePayload response = mock(RestoreJobSummaryResponsePayload.class); | ||
| when(sidecarClient.restoreJobSummary(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID))) | ||
| .thenReturn(CompletableFuture.completedFuture(response)); | ||
|
|
||
| RestoreJobSummaryResponsePayload result = api.restoreJobSummary(); | ||
|
|
||
| assertThat(result).isSameAs(response); | ||
| verify(sidecarClient).restoreJobSummary(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID)); | ||
| } | ||
|
|
||
| @Test | ||
| void testUpdateRestoreJobUsesQuotedIdentifiers() throws Exception | ||
| { | ||
| when(sidecarClient.updateRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID), any())) | ||
| .thenReturn(CompletableFuture.completedFuture(null)); | ||
|
|
||
| api.updateRestoreJob(mock(UpdateRestoreJobRequestPayload.class)); | ||
|
|
||
| verify(sidecarClient).updateRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID), any()); | ||
| } | ||
|
|
||
| @Test | ||
| void testAbortRestoreJobUsesQuotedIdentifiers() throws Exception | ||
| { | ||
| when(sidecarClient.abortRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID))) | ||
| .thenReturn(CompletableFuture.completedFuture(null)); | ||
|
|
||
| api.abortRestoreJob(); | ||
|
|
||
| verify(sidecarClient).abortRestoreJob(eq(QUOTED_KEYSPACE), eq(QUOTED_TABLE), eq(JOB_ID)); | ||
| } | ||
|
|
||
| @Test | ||
| void testUnquotedIdentifiersPassedAsIsWhenFlagNotSet() throws Exception | ||
| { | ||
| when(jobInfo.qualifiedTableName()).thenReturn(new QualifiedTableName("mykeyspace", "mytable", false)); | ||
| when(sidecarClient.createRestoreJob(eq("mykeyspace"), eq("mytable"), any())) | ||
| .thenReturn(CompletableFuture.completedFuture(null)); | ||
|
|
||
| api.createRestoreJob(mock(CreateRestoreJobRequestPayload.class)); | ||
|
|
||
| verify(sidecarClient).createRestoreJob(eq("mykeyspace"), eq("mytable"), any()); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wondering here if we really need wrappers with the "maybe*" prefix, or we can just use this as default for keyspace() and table(). What do you think @yifan-c / @frankgh ?