xunliu commented on code in PR #5733: URL: https://github.com/apache/gravitino/pull/5733#discussion_r1880255087
########## authorizations/authorization-ranger/src/test/java/org/apache/gravitino/authorization/ranger/integration/test/RangerFilesetIT.java: ########## @@ -0,0 +1,536 @@ +/* + * 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.gravitino.authorization.ranger.integration.test; + +import static org.apache.gravitino.Catalog.AUTHORIZATION_PROVIDER; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.currentFunName; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerClient; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerHelper; +import static org.apache.gravitino.catalog.hive.HiveConstants.IMPERSONATION_ENABLE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_AUTH_TYPE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_PASSWORD; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_SERVICE_NAME; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_USERNAME; +import static org.apache.gravitino.integration.test.container.RangerContainer.RANGER_SERVER_PORT; + +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.security.PrivilegedExceptionAction; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import org.apache.gravitino.Catalog; +import org.apache.gravitino.Configs; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.MetadataObjects; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.Schema; +import org.apache.gravitino.auth.AuthConstants; +import org.apache.gravitino.auth.AuthenticatorType; +import org.apache.gravitino.authorization.Privileges; +import org.apache.gravitino.authorization.SecurableObject; +import org.apache.gravitino.authorization.SecurableObjects; +import org.apache.gravitino.authorization.ranger.RangerHelper; +import org.apache.gravitino.client.GravitinoMetalake; +import org.apache.gravitino.connector.AuthorizationPropertiesMeta; +import org.apache.gravitino.file.Fileset; +import org.apache.gravitino.integration.test.container.HiveContainer; +import org.apache.gravitino.integration.test.container.RangerContainer; +import org.apache.gravitino.integration.test.util.BaseIT; +import org.apache.gravitino.integration.test.util.GravitinoITUtils; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.apache.hadoop.fs.permission.FsPermission; +import org.apache.hadoop.security.UserGroupInformation; +import org.apache.ranger.RangerServiceException; +import org.apache.ranger.plugin.model.RangerPolicy; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Tag("gravitino-docker-test") +public class RangerFilesetIT extends BaseIT { + private static final Logger LOG = LoggerFactory.getLogger(RangerFilesetIT.class); + + private String RANGER_ADMIN_URL; + private String defaultBaseLocation; + private String metalakeName = "metalake"; + private String catalogName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_catalog"); + private String schemaName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_schema"); + private static final String provider = "hadoop"; + private FileSystem fileSystem; + private GravitinoMetalake metalake; + private Catalog catalog; + + @BeforeAll + public void startIntegrationTest() throws Exception { + // Enable Gravitino Authorization mode + Map<String, String> configs = Maps.newHashMap(); + configs.put(Configs.ENABLE_AUTHORIZATION.getKey(), String.valueOf(true)); + configs.put(Configs.SERVICE_ADMINS.getKey(), RangerITEnv.HADOOP_USER_NAME); + configs.put(Configs.AUTHENTICATORS.getKey(), AuthenticatorType.SIMPLE.name().toLowerCase()); + configs.put("SimpleAuthUserName", AuthConstants.ANONYMOUS_USER); + registerCustomConfigs(configs); + super.startIntegrationTest(); + + RangerITEnv.init(false); + RangerITEnv.startHiveRangerContainer(); + + RANGER_ADMIN_URL = + String.format( + "http://%s:%d";, + containerSuite.getRangerContainer().getContainerIpAddress(), RANGER_SERVER_PORT); + + Configuration conf = new Configuration(); + conf.set("fs.defaultFS", defaultBaseLocation()); + fileSystem = FileSystem.get(conf); + + createCatalogAndSchema(); + } + + @AfterAll + public void stop() throws IOException { + if (client != null) { + Arrays.stream(catalog.asSchemas().listSchemas()) + .filter(schema -> !schema.equals("default")) + .forEach( + (schema -> { + catalog.asSchemas().dropSchema(schema, false); + })); + Arrays.stream(metalake.listCatalogs()) + .forEach((catalogName -> metalake.dropCatalog(catalogName, true))); + client.disableMetalake(metalakeName); + client.dropMetalake(metalakeName); + } + if (fileSystem != null) { + fileSystem.close(); + } + try { + closer.close(); + } catch (Exception e) { + LOG.error("Failed to close CloseableGroup", e); + } + client = null; + RangerITEnv.cleanup(); + } + + @Test + @Order(0) + void testReadWritePath() throws IOException, RangerServiceException { + String filename = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_fileset"); + Fileset fileset = + catalog + .asFilesetCatalog() + .createFileset( + NameIdentifier.of(schemaName, filename), + "comment", + Fileset.Type.MANAGED, + storageLocation(filename), + null); + Assertions.assertTrue( + catalog.asFilesetCatalog().filesetExists(NameIdentifier.of(schemaName, fileset.name()))); + Assertions.assertTrue(fileSystem.exists(new Path(storageLocation(filename)))); + List<RangerPolicy> policies = + rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("write"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("execute"))) + .count()); + + String filesetRole = currentFunName(); + SecurableObject securableObject = + SecurableObjects.parse( + String.format("%s.%s.%s", catalogName, schemaName, fileset.name()), + MetadataObject.Type.FILESET, + Lists.newArrayList(Privileges.ReadFileset.allow())); + metalake.createRole(filesetRole, Collections.emptyMap(), Lists.newArrayList(securableObject)); + + policies = rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) + .count()); + Assertions.assertEquals( + 0, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("write"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("execute"))) Review Comment: Can we use `RangerHDFSPrivilege.EXECUTE.getName()` to replace "execute"? ########## authorizations/authorization-ranger/src/main/java/org/apache/gravitino/authorization/ranger/RangerHDFSMetadataObject.java: ########## @@ -0,0 +1,107 @@ +/* + * 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.gravitino.authorization.ranger; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.List; +import javax.annotation.Nullable; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.authorization.AuthorizationMetadataObject; + +public class RangerHDFSMetadataObject implements AuthorizationMetadataObject { + /** + * The type of object in the Ranger system. Every type will map one kind of the entity of the + * Gravitino type system. + */ + public enum Type implements AuthorizationMetadataObject.Type { + /** A path is mapped the path of storages like HDFS, S3 etc. */ + PATH(MetadataObject.Type.FILESET), + SCHEMA_PATH(MetadataObject.Type.SCHEMA); Review Comment: Why do we need to define a `SCHEMA_PATH`? ########## authorizations/authorization-ranger/src/main/java/org/apache/gravitino/authorization/ranger/RangerAuthorizationHDFSPlugin.java: ########## @@ -0,0 +1,257 @@ +/* + * 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.gravitino.authorization.ranger; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Lists; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.regex.Pattern; +import org.apache.gravitino.GravitinoEnv; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.authorization.AuthorizationMetadataObject; +import org.apache.gravitino.authorization.AuthorizationPrivilege; +import org.apache.gravitino.authorization.AuthorizationSecurableObject; +import org.apache.gravitino.authorization.Privilege; +import org.apache.gravitino.authorization.SecurableObject; +import org.apache.gravitino.authorization.SecurableObjects; +import org.apache.gravitino.authorization.ranger.reference.RangerDefines; +import org.apache.gravitino.catalog.FilesetDispatcher; +import org.apache.gravitino.exceptions.AuthorizationPluginException; +import org.apache.gravitino.file.Fileset; +import org.apache.ranger.plugin.model.RangerPolicy; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class RangerAuthorizationHDFSPlugin extends RangerAuthorizationPlugin { + private static final Logger LOG = LoggerFactory.getLogger(RangerAuthorizationHDFSPlugin.class); + + private static final Pattern pattern = Pattern.compile("^hdfs://[^/]*"); + + private static volatile RangerAuthorizationHDFSPlugin instance = null; + + private RangerAuthorizationHDFSPlugin(String metalake, Map<String, String> config) { + super(metalake, config); + } + + public static synchronized RangerAuthorizationHDFSPlugin getInstance( + String metalake, Map<String, String> config) { + if (instance == null) { + synchronized (RangerAuthorizationHadoopSQLPlugin.class) { + if (instance == null) { + instance = new RangerAuthorizationHDFSPlugin(metalake, config); + } + } + } + return instance; + } + + @Override + public Map<Privilege.Name, Set<AuthorizationPrivilege>> privilegesMappingRule() { + return ImmutableMap.of( + Privilege.Name.READ_FILESET, + ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.READ, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE), + Privilege.Name.WRITE_FILESET, + ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.WRITE, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE)); + } + + @Override + public Set<AuthorizationPrivilege> ownerMappingRule() { + return ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.READ, + RangerPrivileges.RangerHdfsPrivilege.WRITE, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE); + } + + @Override + public List<String> policyResourceDefinesRule() { + return ImmutableList.of(RangerDefines.PolicyResource.PATH.getName()); + } + + @Override + protected RangerPolicy createPolicyAddResources(AuthorizationMetadataObject metadataObject) { + RangerPolicy policy = new RangerPolicy(); + policy.setService(rangerServiceName); + policy.setName(metadataObject.fullName()); + RangerPolicy.RangerPolicyResource policyResource = + new RangerPolicy.RangerPolicyResource(metadataObject.names().get(0), false, true); + policy.getResources().put(RangerDefines.PolicyResource.PATH.getName(), policyResource); + return policy; + } + + @Override + public AuthorizationSecurableObject generateAuthorizationSecurableObject( + List<String> names, + AuthorizationMetadataObject.Type type, + Set<AuthorizationPrivilege> privileges) { + AuthorizationMetadataObject authMetadataObject = + new RangerHDFSMetadataObject(AuthorizationMetadataObject.getLastName(names), type); + authMetadataObject.validateAuthorizationMetadataObject(); + return new RangerHDFSSecurableObject( + authMetadataObject.name(), authMetadataObject.type(), privileges); + } + + @Override + public Set<Privilege.Name> allowPrivilegesRule() { + return ImmutableSet.of( + Privilege.Name.CREATE_FILESET, Privilege.Name.READ_FILESET, Privilege.Name.WRITE_FILESET); + } + + @Override + public Set<MetadataObject.Type> allowMetadataObjectTypesRule() { + return ImmutableSet.of( + MetadataObject.Type.FILESET, + MetadataObject.Type.SCHEMA, + MetadataObject.Type.CATALOG, + MetadataObject.Type.METALAKE); + } + + @Override + public List<AuthorizationSecurableObject> translatePrivilege(SecurableObject securableObject) { + List<AuthorizationSecurableObject> rangerSecurableObjects = new ArrayList<>(); + + securableObject.privileges().stream() + .filter(Objects::nonNull) + .forEach( + gravitinoPrivilege -> { + Set<AuthorizationPrivilege> rangerPrivileges = new HashSet<>(); + // Ignore unsupported privileges + if (!privilegesMappingRule().containsKey(gravitinoPrivilege.name())) { + return; + } + privilegesMappingRule().get(gravitinoPrivilege.name()).stream() + .forEach( + rangerPrivilege -> + rangerPrivileges.add( + new RangerPrivileges.RangerHivePrivilegeImpl( + rangerPrivilege, gravitinoPrivilege.condition()))); + + switch (gravitinoPrivilege.name()) { + case CREATE_FILESET: + // Ignore the Gravitino privilege `CREATE_FILESET` in the + // RangerAuthorizationHDFSPlugin + break; + case READ_FILESET: + case WRITE_FILESET: + switch (securableObject.type()) { + case METALAKE: + case CATALOG: + case SCHEMA: + break; + case FILESET: + rangerSecurableObjects.add( + generateAuthorizationSecurableObject( + translateMetadataObject(securableObject).names(), + RangerHDFSMetadataObject.Type.PATH, + rangerPrivileges)); + break; + default: + throw new AuthorizationPluginException( + "The privilege %s is not supported for the securable object: %s", + gravitinoPrivilege.name(), securableObject.type()); + } + break; + default: + LOG.warn( + "RangerAuthorizationHDFSPlugin -> privilege {} is not supported for the securable object: {}", + gravitinoPrivilege.name(), + securableObject.type()); + } + }); + + return rangerSecurableObjects; + } + + @Override + public List<AuthorizationSecurableObject> translateOwner(MetadataObject gravitinoMetadataObject) { + List<AuthorizationSecurableObject> rangerSecurableObjects = new ArrayList<>(); + switch (gravitinoMetadataObject.type()) { + case METALAKE: + case CATALOG: + case SCHEMA: + return rangerSecurableObjects; + case FILESET: + rangerSecurableObjects.add( + generateAuthorizationSecurableObject( + translateMetadataObject(gravitinoMetadataObject).names(), + RangerHDFSMetadataObject.Type.PATH, + ownerMappingRule())); + break; + default: + throw new AuthorizationPluginException( + "The owner privilege is not supported for the securable object: %s", + gravitinoMetadataObject.type()); + } + + return rangerSecurableObjects; + } + + @Override + public AuthorizationMetadataObject translateMetadataObject(MetadataObject metadataObject) { + Preconditions.checkArgument( + allowMetadataObjectTypesRule().contains(metadataObject.type()), + String.format( + "The metadata object type %s is not supported in the RangerAuthorizationHDFSPlugin", + metadataObject.type())); + List<String> nsMetadataObject = + Lists.newArrayList(SecurableObjects.DOT_SPLITTER.splitToList(metadataObject.fullName())); + Preconditions.checkArgument( + nsMetadataObject.size() > 0, "The metadata object must have at least one name."); + + if (metadataObject.type() == MetadataObject.Type.FILESET) { + RangerHDFSMetadataObject rangerHDFSMetadataObject = + new RangerHDFSMetadataObject( + getFileSetPath(metadataObject), RangerHDFSMetadataObject.Type.PATH); + rangerHDFSMetadataObject.validateAuthorizationMetadataObject(); + return rangerHDFSMetadataObject; + } else { + return new RangerHDFSMetadataObject("", RangerHDFSMetadataObject.Type.SCHEMA_PATH); + } + } + + private String getFileSetPath(MetadataObject metadataObject) { + FilesetDispatcher filesetDispatcher = GravitinoEnv.getInstance().filesetDispatcher(); + boolean testEnv = + System.getenv("GRAVITINO_TEST") != null || System.getenv("GRAVITINO_TEST_CLOUD_IT") == null; Review Comment: Why do we need this `|| System.getenv("GRAVITINO_TEST_CLOUD_IT") == null`? ########## authorizations/authorization-ranger/src/test/java/org/apache/gravitino/authorization/ranger/integration/test/RangerFilesetIT.java: ########## @@ -0,0 +1,536 @@ +/* + * 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.gravitino.authorization.ranger.integration.test; + +import static org.apache.gravitino.Catalog.AUTHORIZATION_PROVIDER; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.currentFunName; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerClient; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerHelper; +import static org.apache.gravitino.catalog.hive.HiveConstants.IMPERSONATION_ENABLE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_AUTH_TYPE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_PASSWORD; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_SERVICE_NAME; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_USERNAME; +import static org.apache.gravitino.integration.test.container.RangerContainer.RANGER_SERVER_PORT; + +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.security.PrivilegedExceptionAction; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import org.apache.gravitino.Catalog; +import org.apache.gravitino.Configs; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.MetadataObjects; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.Schema; +import org.apache.gravitino.auth.AuthConstants; +import org.apache.gravitino.auth.AuthenticatorType; +import org.apache.gravitino.authorization.Privileges; +import org.apache.gravitino.authorization.SecurableObject; +import org.apache.gravitino.authorization.SecurableObjects; +import org.apache.gravitino.authorization.ranger.RangerHelper; +import org.apache.gravitino.client.GravitinoMetalake; +import org.apache.gravitino.connector.AuthorizationPropertiesMeta; +import org.apache.gravitino.file.Fileset; +import org.apache.gravitino.integration.test.container.HiveContainer; +import org.apache.gravitino.integration.test.container.RangerContainer; +import org.apache.gravitino.integration.test.util.BaseIT; +import org.apache.gravitino.integration.test.util.GravitinoITUtils; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.apache.hadoop.fs.permission.FsPermission; +import org.apache.hadoop.security.UserGroupInformation; +import org.apache.ranger.RangerServiceException; +import org.apache.ranger.plugin.model.RangerPolicy; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Tag("gravitino-docker-test") +public class RangerFilesetIT extends BaseIT { + private static final Logger LOG = LoggerFactory.getLogger(RangerFilesetIT.class); + + private String RANGER_ADMIN_URL; + private String defaultBaseLocation; + private String metalakeName = "metalake"; + private String catalogName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_catalog"); + private String schemaName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_schema"); + private static final String provider = "hadoop"; + private FileSystem fileSystem; + private GravitinoMetalake metalake; + private Catalog catalog; + + @BeforeAll + public void startIntegrationTest() throws Exception { + // Enable Gravitino Authorization mode + Map<String, String> configs = Maps.newHashMap(); + configs.put(Configs.ENABLE_AUTHORIZATION.getKey(), String.valueOf(true)); + configs.put(Configs.SERVICE_ADMINS.getKey(), RangerITEnv.HADOOP_USER_NAME); + configs.put(Configs.AUTHENTICATORS.getKey(), AuthenticatorType.SIMPLE.name().toLowerCase()); + configs.put("SimpleAuthUserName", AuthConstants.ANONYMOUS_USER); + registerCustomConfigs(configs); + super.startIntegrationTest(); + + RangerITEnv.init(false); + RangerITEnv.startHiveRangerContainer(); + + RANGER_ADMIN_URL = + String.format( + "http://%s:%d";, + containerSuite.getRangerContainer().getContainerIpAddress(), RANGER_SERVER_PORT); + + Configuration conf = new Configuration(); + conf.set("fs.defaultFS", defaultBaseLocation()); + fileSystem = FileSystem.get(conf); + + createCatalogAndSchema(); + } + + @AfterAll + public void stop() throws IOException { + if (client != null) { + Arrays.stream(catalog.asSchemas().listSchemas()) + .filter(schema -> !schema.equals("default")) + .forEach( + (schema -> { + catalog.asSchemas().dropSchema(schema, false); + })); + Arrays.stream(metalake.listCatalogs()) + .forEach((catalogName -> metalake.dropCatalog(catalogName, true))); + client.disableMetalake(metalakeName); + client.dropMetalake(metalakeName); + } + if (fileSystem != null) { + fileSystem.close(); + } + try { + closer.close(); + } catch (Exception e) { + LOG.error("Failed to close CloseableGroup", e); + } + client = null; + RangerITEnv.cleanup(); + } + + @Test + @Order(0) + void testReadWritePath() throws IOException, RangerServiceException { + String filename = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_fileset"); + Fileset fileset = + catalog + .asFilesetCatalog() + .createFileset( + NameIdentifier.of(schemaName, filename), + "comment", + Fileset.Type.MANAGED, + storageLocation(filename), + null); + Assertions.assertTrue( + catalog.asFilesetCatalog().filesetExists(NameIdentifier.of(schemaName, fileset.name()))); + Assertions.assertTrue(fileSystem.exists(new Path(storageLocation(filename)))); + List<RangerPolicy> policies = + rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("write"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("execute"))) + .count()); + + String filesetRole = currentFunName(); + SecurableObject securableObject = + SecurableObjects.parse( + String.format("%s.%s.%s", catalogName, schemaName, fileset.name()), + MetadataObject.Type.FILESET, + Lists.newArrayList(Privileges.ReadFileset.allow())); + metalake.createRole(filesetRole, Collections.emptyMap(), Lists.newArrayList(securableObject)); + + policies = rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) + .count()); + Assertions.assertEquals( + 0, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("write"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("execute"))) + .count()); + + metalake.grantPrivilegesToRole( + filesetRole, + MetadataObjects.of( + String.format("%s.%s", catalogName, schemaName), + fileset.name(), + MetadataObject.Type.FILESET), + Lists.newArrayList(Privileges.WriteFileset.allow())); + + policies = rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) Review Comment: Can we use `RangerHDFSPrivilege.READ.getName()` to replace "read"? and other place, `"write"` ########## authorizations/authorization-ranger/src/test/java/org/apache/gravitino/authorization/ranger/integration/test/RangerFilesetIT.java: ########## @@ -0,0 +1,536 @@ +/* + * 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.gravitino.authorization.ranger.integration.test; + +import static org.apache.gravitino.Catalog.AUTHORIZATION_PROVIDER; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.currentFunName; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerClient; +import static org.apache.gravitino.authorization.ranger.integration.test.RangerITEnv.rangerHelper; +import static org.apache.gravitino.catalog.hive.HiveConstants.IMPERSONATION_ENABLE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_AUTH_TYPE; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_PASSWORD; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_SERVICE_NAME; +import static org.apache.gravitino.connector.AuthorizationPropertiesMeta.RANGER_USERNAME; +import static org.apache.gravitino.integration.test.container.RangerContainer.RANGER_SERVER_PORT; + +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.security.PrivilegedExceptionAction; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import org.apache.gravitino.Catalog; +import org.apache.gravitino.Configs; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.MetadataObjects; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.Schema; +import org.apache.gravitino.auth.AuthConstants; +import org.apache.gravitino.auth.AuthenticatorType; +import org.apache.gravitino.authorization.Privileges; +import org.apache.gravitino.authorization.SecurableObject; +import org.apache.gravitino.authorization.SecurableObjects; +import org.apache.gravitino.authorization.ranger.RangerHelper; +import org.apache.gravitino.client.GravitinoMetalake; +import org.apache.gravitino.connector.AuthorizationPropertiesMeta; +import org.apache.gravitino.file.Fileset; +import org.apache.gravitino.integration.test.container.HiveContainer; +import org.apache.gravitino.integration.test.container.RangerContainer; +import org.apache.gravitino.integration.test.util.BaseIT; +import org.apache.gravitino.integration.test.util.GravitinoITUtils; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.apache.hadoop.fs.permission.FsPermission; +import org.apache.hadoop.security.UserGroupInformation; +import org.apache.ranger.RangerServiceException; +import org.apache.ranger.plugin.model.RangerPolicy; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Tag("gravitino-docker-test") +public class RangerFilesetIT extends BaseIT { + private static final Logger LOG = LoggerFactory.getLogger(RangerFilesetIT.class); + + private String RANGER_ADMIN_URL; + private String defaultBaseLocation; + private String metalakeName = "metalake"; + private String catalogName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_catalog"); + private String schemaName = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_schema"); + private static final String provider = "hadoop"; + private FileSystem fileSystem; + private GravitinoMetalake metalake; + private Catalog catalog; + + @BeforeAll + public void startIntegrationTest() throws Exception { + // Enable Gravitino Authorization mode + Map<String, String> configs = Maps.newHashMap(); + configs.put(Configs.ENABLE_AUTHORIZATION.getKey(), String.valueOf(true)); + configs.put(Configs.SERVICE_ADMINS.getKey(), RangerITEnv.HADOOP_USER_NAME); + configs.put(Configs.AUTHENTICATORS.getKey(), AuthenticatorType.SIMPLE.name().toLowerCase()); + configs.put("SimpleAuthUserName", AuthConstants.ANONYMOUS_USER); + registerCustomConfigs(configs); + super.startIntegrationTest(); + + RangerITEnv.init(false); + RangerITEnv.startHiveRangerContainer(); + + RANGER_ADMIN_URL = + String.format( + "http://%s:%d";, + containerSuite.getRangerContainer().getContainerIpAddress(), RANGER_SERVER_PORT); + + Configuration conf = new Configuration(); + conf.set("fs.defaultFS", defaultBaseLocation()); + fileSystem = FileSystem.get(conf); + + createCatalogAndSchema(); + } + + @AfterAll + public void stop() throws IOException { + if (client != null) { + Arrays.stream(catalog.asSchemas().listSchemas()) + .filter(schema -> !schema.equals("default")) + .forEach( + (schema -> { + catalog.asSchemas().dropSchema(schema, false); + })); + Arrays.stream(metalake.listCatalogs()) + .forEach((catalogName -> metalake.dropCatalog(catalogName, true))); + client.disableMetalake(metalakeName); + client.dropMetalake(metalakeName); + } + if (fileSystem != null) { + fileSystem.close(); + } + try { + closer.close(); + } catch (Exception e) { + LOG.error("Failed to close CloseableGroup", e); + } + client = null; + RangerITEnv.cleanup(); + } + + @Test + @Order(0) + void testReadWritePath() throws IOException, RangerServiceException { + String filename = GravitinoITUtils.genRandomName("RangerFilesetE2EIT_fileset"); + Fileset fileset = + catalog + .asFilesetCatalog() + .createFileset( + NameIdentifier.of(schemaName, filename), + "comment", + Fileset.Type.MANAGED, + storageLocation(filename), + null); + Assertions.assertTrue( + catalog.asFilesetCatalog().filesetExists(NameIdentifier.of(schemaName, fileset.name()))); + Assertions.assertTrue(fileSystem.exists(new Path(storageLocation(filename)))); + List<RangerPolicy> policies = + rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("write"))) + .count()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter(item -> item.getRoles().contains(RangerHelper.GRAVITINO_OWNER_ROLE)) + .filter( + item -> + item.getAccesses().stream() + .anyMatch(access -> access.getType().equals("execute"))) + .count()); + + String filesetRole = currentFunName(); + SecurableObject securableObject = + SecurableObjects.parse( + String.format("%s.%s.%s", catalogName, schemaName, fileset.name()), + MetadataObject.Type.FILESET, + Lists.newArrayList(Privileges.ReadFileset.allow())); + metalake.createRole(filesetRole, Collections.emptyMap(), Lists.newArrayList(securableObject)); + + policies = rangerClient.getPoliciesInService(RangerITEnv.RANGER_HDFS_REPO_NAME); + Assertions.assertEquals(1, policies.size()); + Assertions.assertEquals(3, policies.get(0).getPolicyItems().size()); + Assertions.assertEquals( + 1, + policies.get(0).getPolicyItems().stream() + .filter( + item -> + item.getRoles().contains(rangerHelper.generateGravitinoRoleName(filesetRole))) + .filter( + item -> + item.getAccesses().stream().anyMatch(access -> access.getType().equals("read"))) Review Comment: Can we use `RangerHDFSPrivilege.READ.getName()` to replace "read"? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
