dimas-b commented on code in PR #2344: URL: https://github.com/apache/polaris/pull/2344#discussion_r2274879171
########## integration-tests/src/main/java/org/apache/polaris/service/it/test/CatalogFederationIntegrationTest.java: ########## @@ -0,0 +1,253 @@ +/* + * 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.polaris.service.it.test; + +import static org.apache.polaris.service.it.env.PolarisClient.polarisClient; +import static org.assertj.core.api.Assertions.assertThat; + +import java.net.URI; +import java.util.List; +import org.apache.polaris.core.admin.model.AuthenticationParameters; +import org.apache.polaris.core.admin.model.Catalog; +import org.apache.polaris.core.admin.model.CatalogGrant; +import org.apache.polaris.core.admin.model.CatalogPrivilege; +import org.apache.polaris.core.admin.model.CatalogProperties; +import org.apache.polaris.core.admin.model.CatalogRole; +import org.apache.polaris.core.admin.model.ConnectionConfigInfo; +import org.apache.polaris.core.admin.model.ExternalCatalog; +import org.apache.polaris.core.admin.model.FileStorageConfigInfo; +import org.apache.polaris.core.admin.model.IcebergRestConnectionConfigInfo; +import org.apache.polaris.core.admin.model.OAuthClientCredentialsParameters; +import org.apache.polaris.core.admin.model.PolarisCatalog; +import org.apache.polaris.core.admin.model.PrincipalWithCredentials; +import org.apache.polaris.core.admin.model.StorageConfigInfo; +import org.apache.polaris.service.it.env.ClientCredentials; +import org.apache.polaris.service.it.env.ManagementApi; +import org.apache.polaris.service.it.env.PolarisApiEndpoints; +import org.apache.polaris.service.it.env.PolarisClient; +import org.apache.polaris.service.it.ext.PolarisIntegrationTestExtension; +import org.apache.polaris.service.it.ext.SparkSessionBuilder; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; + +/** + * Integration test for catalog federation functionality. This test verifies that an external + * catalog can be created that federates with an internal catalog. + */ +@ExtendWith(PolarisIntegrationTestExtension.class) +public class CatalogFederationIntegrationTest { + + private static PolarisClient client; + private static ManagementApi managementApi; + private static PolarisApiEndpoints endpoints; + private static ClientCredentials adminCredentials; + private static SparkSession spark; + private static String sparkToken; + + private static final String PRINCIPAL_NAME = "test-catalog-federation-user"; + private static final String LOCAL_CATALOG_NAME = "test_catalog_local"; + private static final String EXTERNAL_CATALOG_NAME = "test_catalog_external"; + private static final String CATALOG_ROLE_NAME = "catalog_admin"; + private static final String PRINCIPAL_ROLE_NAME = "service_admin"; + + @TempDir static java.nio.file.Path warehouseDir; + + private URI baseLocation; + private PrincipalWithCredentials newUserCredentials; + + @BeforeAll + static void setup(PolarisApiEndpoints apiEndpoints, ClientCredentials credentials) { + endpoints = apiEndpoints; + client = polarisClient(endpoints); + managementApi = client.managementApi(credentials); + adminCredentials = credentials; + sparkToken = client.obtainToken(credentials); + } + + @AfterAll + static void close() throws Exception { + if (client != null) { + client.close(); + } + } + + @BeforeEach + void before() { + this.baseLocation = URI.create("file:///tmp/warehouse"); + } + + @AfterEach + void after() { + if (spark != null) { + SparkSession.clearDefaultSession(); + SparkSession.clearActiveSession(); + spark.close(); + } + managementApi.dropCatalog(EXTERNAL_CATALOG_NAME); + managementApi.dropCatalog(LOCAL_CATALOG_NAME); + managementApi.deletePrincipal(PRINCIPAL_NAME); + } + + @Test + void testCatalogFederation() { + newUserCredentials = managementApi.createPrincipal(PRINCIPAL_NAME); + assertThat(newUserCredentials).isNotNull(); + assertThat(newUserCredentials.getCredentials()).isNotNull(); + assertThat(newUserCredentials.getCredentials().getClientId()).isNotEmpty(); + assertThat(newUserCredentials.getCredentials().getClientSecret()).isNotEmpty(); Review Comment: why bother asserting this? ########## integration-tests/src/main/java/org/apache/polaris/service/it/test/CatalogFederationIntegrationTest.java: ########## @@ -0,0 +1,253 @@ +/* + * 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.polaris.service.it.test; + +import static org.apache.polaris.service.it.env.PolarisClient.polarisClient; +import static org.assertj.core.api.Assertions.assertThat; + +import java.net.URI; +import java.util.List; +import org.apache.polaris.core.admin.model.AuthenticationParameters; +import org.apache.polaris.core.admin.model.Catalog; +import org.apache.polaris.core.admin.model.CatalogGrant; +import org.apache.polaris.core.admin.model.CatalogPrivilege; +import org.apache.polaris.core.admin.model.CatalogProperties; +import org.apache.polaris.core.admin.model.CatalogRole; +import org.apache.polaris.core.admin.model.ConnectionConfigInfo; +import org.apache.polaris.core.admin.model.ExternalCatalog; +import org.apache.polaris.core.admin.model.FileStorageConfigInfo; +import org.apache.polaris.core.admin.model.IcebergRestConnectionConfigInfo; +import org.apache.polaris.core.admin.model.OAuthClientCredentialsParameters; +import org.apache.polaris.core.admin.model.PolarisCatalog; +import org.apache.polaris.core.admin.model.PrincipalWithCredentials; +import org.apache.polaris.core.admin.model.StorageConfigInfo; +import org.apache.polaris.service.it.env.ClientCredentials; +import org.apache.polaris.service.it.env.ManagementApi; +import org.apache.polaris.service.it.env.PolarisApiEndpoints; +import org.apache.polaris.service.it.env.PolarisClient; +import org.apache.polaris.service.it.ext.PolarisIntegrationTestExtension; +import org.apache.polaris.service.it.ext.SparkSessionBuilder; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; + +/** + * Integration test for catalog federation functionality. This test verifies that an external + * catalog can be created that federates with an internal catalog. + */ +@ExtendWith(PolarisIntegrationTestExtension.class) +public class CatalogFederationIntegrationTest { + + private static PolarisClient client; + private static ManagementApi managementApi; + private static PolarisApiEndpoints endpoints; + private static ClientCredentials adminCredentials; + private static SparkSession spark; + private static String sparkToken; + + private static final String PRINCIPAL_NAME = "test-catalog-federation-user"; + private static final String LOCAL_CATALOG_NAME = "test_catalog_local"; + private static final String EXTERNAL_CATALOG_NAME = "test_catalog_external"; + private static final String CATALOG_ROLE_NAME = "catalog_admin"; + private static final String PRINCIPAL_ROLE_NAME = "service_admin"; + + @TempDir static java.nio.file.Path warehouseDir; + + private URI baseLocation; + private PrincipalWithCredentials newUserCredentials; + + @BeforeAll + static void setup(PolarisApiEndpoints apiEndpoints, ClientCredentials credentials) { + endpoints = apiEndpoints; + client = polarisClient(endpoints); + managementApi = client.managementApi(credentials); + adminCredentials = credentials; + sparkToken = client.obtainToken(credentials); + } + + @AfterAll + static void close() throws Exception { + if (client != null) { + client.close(); + } + } + + @BeforeEach + void before() { + this.baseLocation = URI.create("file:///tmp/warehouse"); + } + + @AfterEach + void after() { + if (spark != null) { + SparkSession.clearDefaultSession(); + SparkSession.clearActiveSession(); + spark.close(); + } + managementApi.dropCatalog(EXTERNAL_CATALOG_NAME); + managementApi.dropCatalog(LOCAL_CATALOG_NAME); + managementApi.deletePrincipal(PRINCIPAL_NAME); + } + + @Test + void testCatalogFederation() { + newUserCredentials = managementApi.createPrincipal(PRINCIPAL_NAME); + assertThat(newUserCredentials).isNotNull(); + assertThat(newUserCredentials.getCredentials()).isNotNull(); + assertThat(newUserCredentials.getCredentials().getClientId()).isNotEmpty(); + assertThat(newUserCredentials.getCredentials().getClientSecret()).isNotEmpty(); + + FileStorageConfigInfo storageConfig = + FileStorageConfigInfo.builder() + .setStorageType(StorageConfigInfo.StorageTypeEnum.FILE) + .setAllowedLocations(List.of(baseLocation.toString())) + .build(); + + CatalogProperties catalogProperties = new CatalogProperties(baseLocation.toString()); + + Catalog localCatalog = + PolarisCatalog.builder() + .setType(Catalog.TypeEnum.INTERNAL) + .setName(LOCAL_CATALOG_NAME) + .setProperties(catalogProperties) + .setStorageConfigInfo(storageConfig) + .build(); + managementApi.createCatalog(localCatalog); + assertThat(managementApi.getCatalog(LOCAL_CATALOG_NAME)).isNotNull(); + assertThat(managementApi.getCatalog(LOCAL_CATALOG_NAME).getType()) + .isEqualTo(Catalog.TypeEnum.INTERNAL); + + CatalogGrant catalogGrant = + CatalogGrant.builder() + .setType(CatalogGrant.TypeEnum.CATALOG) + .setPrivilege(CatalogPrivilege.TABLE_WRITE_DATA) + .build(); + managementApi.addGrant(LOCAL_CATALOG_NAME, CATALOG_ROLE_NAME, catalogGrant); + assertThat(managementApi.listGrants(LOCAL_CATALOG_NAME, CATALOG_ROLE_NAME).getGrants()) + .contains(catalogGrant); Review Comment: nit: this assert validates grant handling, not catalog federation... It's ok to have it, but it overloads the test's meaning. ########## runtime/service/src/intTest/java/org/apache/polaris/service/it/CatalogFederationIT.java: ########## @@ -0,0 +1,39 @@ +/* + * 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.polaris.service.it; + +import io.quarkus.test.junit.QuarkusIntegrationTest; +import io.quarkus.test.junit.QuarkusTestProfile; +import io.quarkus.test.junit.TestProfile; +import java.util.Map; +import org.apache.polaris.service.it.test.CatalogFederationIntegrationTest; + +@TestProfile(CatalogFederationIT.CatalogFederationProfile.class) +@QuarkusIntegrationTest +public class CatalogFederationIT extends CatalogFederationIntegrationTest { Review Comment: This test probably belong in the `spark-tests` module, same as `SparkIT`... WDYT? ########## integration-tests/src/main/java/org/apache/polaris/service/it/test/CatalogFederationIntegrationTest.java: ########## @@ -0,0 +1,253 @@ +/* + * 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.polaris.service.it.test; + +import static org.apache.polaris.service.it.env.PolarisClient.polarisClient; +import static org.assertj.core.api.Assertions.assertThat; + +import java.net.URI; +import java.util.List; +import org.apache.polaris.core.admin.model.AuthenticationParameters; +import org.apache.polaris.core.admin.model.Catalog; +import org.apache.polaris.core.admin.model.CatalogGrant; +import org.apache.polaris.core.admin.model.CatalogPrivilege; +import org.apache.polaris.core.admin.model.CatalogProperties; +import org.apache.polaris.core.admin.model.CatalogRole; +import org.apache.polaris.core.admin.model.ConnectionConfigInfo; +import org.apache.polaris.core.admin.model.ExternalCatalog; +import org.apache.polaris.core.admin.model.FileStorageConfigInfo; +import org.apache.polaris.core.admin.model.IcebergRestConnectionConfigInfo; +import org.apache.polaris.core.admin.model.OAuthClientCredentialsParameters; +import org.apache.polaris.core.admin.model.PolarisCatalog; +import org.apache.polaris.core.admin.model.PrincipalWithCredentials; +import org.apache.polaris.core.admin.model.StorageConfigInfo; +import org.apache.polaris.service.it.env.ClientCredentials; +import org.apache.polaris.service.it.env.ManagementApi; +import org.apache.polaris.service.it.env.PolarisApiEndpoints; +import org.apache.polaris.service.it.env.PolarisClient; +import org.apache.polaris.service.it.ext.PolarisIntegrationTestExtension; +import org.apache.polaris.service.it.ext.SparkSessionBuilder; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; + +/** + * Integration test for catalog federation functionality. This test verifies that an external + * catalog can be created that federates with an internal catalog. + */ +@ExtendWith(PolarisIntegrationTestExtension.class) +public class CatalogFederationIntegrationTest { + + private static PolarisClient client; + private static ManagementApi managementApi; + private static PolarisApiEndpoints endpoints; + private static ClientCredentials adminCredentials; + private static SparkSession spark; + private static String sparkToken; + + private static final String PRINCIPAL_NAME = "test-catalog-federation-user"; + private static final String LOCAL_CATALOG_NAME = "test_catalog_local"; + private static final String EXTERNAL_CATALOG_NAME = "test_catalog_external"; + private static final String CATALOG_ROLE_NAME = "catalog_admin"; + private static final String PRINCIPAL_ROLE_NAME = "service_admin"; + + @TempDir static java.nio.file.Path warehouseDir; + + private URI baseLocation; + private PrincipalWithCredentials newUserCredentials; + + @BeforeAll + static void setup(PolarisApiEndpoints apiEndpoints, ClientCredentials credentials) { + endpoints = apiEndpoints; + client = polarisClient(endpoints); + managementApi = client.managementApi(credentials); + adminCredentials = credentials; + sparkToken = client.obtainToken(credentials); + } + + @AfterAll + static void close() throws Exception { + if (client != null) { + client.close(); + } + } + + @BeforeEach + void before() { + this.baseLocation = URI.create("file:///tmp/warehouse"); + } + + @AfterEach + void after() { + if (spark != null) { + SparkSession.clearDefaultSession(); + SparkSession.clearActiveSession(); + spark.close(); + } + managementApi.dropCatalog(EXTERNAL_CATALOG_NAME); + managementApi.dropCatalog(LOCAL_CATALOG_NAME); + managementApi.deletePrincipal(PRINCIPAL_NAME); + } + + @Test + void testCatalogFederation() { + newUserCredentials = managementApi.createPrincipal(PRINCIPAL_NAME); + assertThat(newUserCredentials).isNotNull(); + assertThat(newUserCredentials.getCredentials()).isNotNull(); + assertThat(newUserCredentials.getCredentials().getClientId()).isNotEmpty(); + assertThat(newUserCredentials.getCredentials().getClientSecret()).isNotEmpty(); + + FileStorageConfigInfo storageConfig = + FileStorageConfigInfo.builder() + .setStorageType(StorageConfigInfo.StorageTypeEnum.FILE) + .setAllowedLocations(List.of(baseLocation.toString())) + .build(); + + CatalogProperties catalogProperties = new CatalogProperties(baseLocation.toString()); + + Catalog localCatalog = + PolarisCatalog.builder() + .setType(Catalog.TypeEnum.INTERNAL) + .setName(LOCAL_CATALOG_NAME) + .setProperties(catalogProperties) + .setStorageConfigInfo(storageConfig) + .build(); + managementApi.createCatalog(localCatalog); + assertThat(managementApi.getCatalog(LOCAL_CATALOG_NAME)).isNotNull(); + assertThat(managementApi.getCatalog(LOCAL_CATALOG_NAME).getType()) + .isEqualTo(Catalog.TypeEnum.INTERNAL); Review Comment: nit: these look like redundant asserts to be... The test will fail anyway if the catalog is not created. If we want to enhance test coverage of the management API (as is validate that types are not lost on API round-trips) we should probably do that in dedicated (and simpler) tests. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@polaris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
