| # 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. | |
| import json | |
| import uuid | |
| import pytest | |
| import requests | |
| from datetime import datetime | |
| import inspect | |
| import subprocess | |
| import xuserrest.utility.utils as xutils | |
| BASE_URL = "http://localhost:6080/service" | |
| AUTH = ("admin", "rangerR0cks!") | |
| HEADERS = {"Content-Type": "application/json"} | |
| RANGER_CONTAINER_NAME = "ranger" | |
| RANGER_LOG_FILE = "/var/log/ranger/ranger-admin-ranger.rangernw-.log" | |
| BIGINT_MIN = -9223372036854775808 | |
| BIGINT_MAX = 9223372036854775807 | |
| SERVICE_NAME = "admin" | |
| RANGER_CONFIG = None | |
| RANGER_KEY_ADMIN_CONFIG = None | |
| RANGER_AUDITOR_CONFIG = None | |
| RANGER_USER_CONFIG = None | |
| def init_configs(ranger_config, ranger_key_admin_config, ranger_auditor_config, ranger_user_config): | |
| global RANGER_CONFIG, RANGER_KEY_ADMIN_CONFIG, RANGER_AUDITOR_CONFIG, RANGER_USER_CONFIG | |
| RANGER_CONFIG = ranger_config | |
| RANGER_KEY_ADMIN_CONFIG = ranger_key_admin_config | |
| RANGER_AUDITOR_CONFIG = ranger_auditor_config | |
| RANGER_USER_CONFIG = ranger_user_config | |
| def create_service(user_name = "hdfs", password = "hdfs"): | |
| unique_name = f"test_service_{uuid.uuid4().hex[:8]}" | |
| # Create service | |
| service_payload = { | |
| "name": unique_name, | |
| "displayName": unique_name, | |
| "type": "hdfs", | |
| "isEnabled": True, | |
| "configs": { | |
| "username": user_name, | |
| "password": password, | |
| "fs.default.name": "hdfs://localhost:9000", | |
| "hadoop.security.authentication": "simple", | |
| "hadoop.security.authorization": "true", | |
| # "policy.download.auth.users": user_name, | |
| # "tag.download.auth.users": user_name, | |
| # "userstore.download.auth.users": user_name | |
| } | |
| } | |
| svc_resp = requests.post( | |
| f"{BASE_URL}/plugins/services", | |
| auth=AUTH, | |
| headers=HEADERS, | |
| data=json.dumps(service_payload) | |
| ) | |
| svc_resp.raise_for_status() | |
| service = svc_resp.json() | |
| service_id = service["id"] | |
| print(f"[+] Service created: name={service['name']}, id={service_id}") | |
| return service, service_id | |
| def assign_service_admin(service_id, service, username): | |
| configs = service.get("configs", {}) | |
| # Ranger stores service admins as a comma-separated string in configs | |
| existing_admins = configs.get("service.admin.users", "") | |
| admin_set = set(filter(None, existing_admins.split(","))) | |
| admin_set.add(username) | |
| configs["service.admin.users"] = ",".join(admin_set) | |
| update_payload = { | |
| "id": service_id, | |
| "name": service["name"], | |
| "displayName": service.get("displayName", service["name"]), | |
| "type": service["type"], | |
| "isEnabled": service.get("isEnabled", True), | |
| "configs": configs | |
| } | |
| resp = requests.put( | |
| f"{BASE_URL}/plugins/services/{service_id}", | |
| auth=AUTH, | |
| headers=HEADERS, | |
| json=update_payload | |
| ) | |
| #resp.raise_for_status() | |
| print(f"[+] User '{username}' added as service admin for service id={service_id}") | |
| print("\n [+] Response of updated service admin : ", resp.json(), "\n") | |
| def assign_service_admin_group(service_id, service, groupname): | |
| configs = service.get("configs", {}) | |
| # Ranger stores service admin groups as a comma-separated string in configs | |
| existing_groups = configs.get("service.admin.groups", "") | |
| group_set = set(filter(None, existing_groups.split(","))) | |
| group_set.add(groupname) | |
| configs["service.admin.groups"] = ",".join(group_set) | |
| update_payload = { | |
| "id": service_id, | |
| "name": service["name"], | |
| "displayName": service.get("displayName", service["name"]), | |
| "type": service["type"], | |
| "isEnabled": service.get("isEnabled", True), | |
| "configs": configs | |
| } | |
| resp = requests.put( | |
| f"{BASE_URL}/plugins/services/{service_id}", | |
| auth=AUTH, | |
| headers=HEADERS, | |
| json=update_payload | |
| ) | |
| #resp.raise_for_status() | |
| print(f"[+] Group '{groupname}' added as service admin group for service id={service_id}") | |
| print("\n [+] Response of updated service admin group : ", resp.json(), "\n") | |
| def delete_service(service_id): | |
| resp = requests.delete( | |
| f"{BASE_URL}/plugins/services/{service_id}", | |
| auth=AUTH, | |
| headers=HEADERS | |
| ) | |
| resp.raise_for_status() | |
| print(f"[+] Service deleted: id={service_id}") | |
| def assert_response(response, expected_status, text = None, service_name=SERVICE_NAME): | |
| xutils.assert_response(response, expected_status, text, service_name) | |
| def get_role_by_name(role_name, auth=AUTH): | |
| response = requests.get( | |
| f"{BASE_URL}/roles/roles/name/{role_name}", | |
| auth=auth, | |
| headers=HEADERS, | |
| ) | |
| return response.status_code == 200, response.json() | |
| # Remove Content-Type for DELETE requests | |
| def delete_role(role_id): | |
| resp = requests.delete( | |
| f"{BASE_URL}/roles/roles/{role_id}", | |
| auth=AUTH, | |
| headers={"Accept": "application/json"} # Changed from string to dictionary | |
| ) | |
| #assert_response(resp, [200, 204], f"Failed to delete role id={role_id}: {resp.text}") | |
| assert resp.status_code in [200, 204], f"Failed to delete role id={role_id}: {resp.text}" | |
| print(f" /n /n [+] Role deleted successfully with id={role_id}. Response status: {resp.status_code}. Response text: {resp.text} /n /n") | |
| def ensureRoleAccess(test_case, request, existing_service=None): | |
| service_list = [] | |
| if test_case == "admin": | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")(["admin"]) | |
| auth = (temp_user["name"], "Test@123") | |
| role, role_id = request.getfixturevalue("temp_role")() | |
| role_list = [role_id] | |
| elif test_case == "service admin": | |
| if existing_service is None: | |
| service, service_id = create_service() | |
| else: | |
| service = existing_service[0] | |
| service_id = service["id"] | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("auditor") | |
| assign_service_admin(service_id, service, temp_user['name']) | |
| auth = (temp_user["name"], "Test@123") | |
| role, role_id = request.getfixturevalue("temp_role")() | |
| service_list = [service_id] | |
| role_list = [role_id] | |
| elif test_case == "in service admin groups in grouplist": | |
| if existing_service is None: | |
| service, service_id = create_service() | |
| else: | |
| service = existing_service[0] | |
| service_id = service["id"] | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("auditor") | |
| group, group_id = request.getfixturevalue("temp_group")() | |
| assign_service_admin_group(service_id, service, group["name"]) | |
| xutils.assign_groups_to_user(temp_user["name"], [group["name"]], AUTH, BASE_URL, HEADERS) | |
| auth = (temp_user["name"], "Test@123") | |
| role, role_id = request.getfixturevalue("temp_role")() | |
| service_list = [service_id] | |
| role_list = [role_id] | |
| req = requests.get(f"{BASE_URL}/plugins/services/{service_id}", auth=AUTH, headers=HEADERS) | |
| print("\n [+] Service details after assigning service admin group: ", req.json(), "\n") | |
| req = requests.get(f"{BASE_URL}/xusers/users/{temp_user_id}", auth=AUTH, headers=HEADERS) | |
| print("\n [+] User details after assigning service admin group: ", req.json(), "\n") | |
| req = requests.get(f"{BASE_URL}/xusers/groups/{group_id}", auth=AUTH, headers=HEADERS) | |
| print("\n [+] Group details after assigning service admin group: ", req.json(), "\n") | |
| elif test_case.endswith("role-user"): # must be before endswith("user") | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("user") | |
| c_role, c_id = request.getfixturevalue("temp_role")(user_list=[{"name": temp_user["name"], "isAdmin": True}]) | |
| role, role_id = request.getfixturevalue("temp_role")(role_list=[{"name": c_role["name"], "isAdmin": True}]) | |
| auth = (temp_user["name"], "Test@123") | |
| role_list = [role_id, c_id] | |
| elif test_case.endswith("role-group"): # must be before endswith("group") | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("user") | |
| group, group_id = request.getfixturevalue("temp_group")() | |
| xutils.assign_groups_to_user(temp_user["name"], [group["name"]], ("admin", "rangerR0cks!"), "http://localhost:6080/service", { | |
| "Accept": "application/json", | |
| "Content-Type": "application/json" | |
| }) | |
| c_role, c_id = request.getfixturevalue("temp_role")(group_list=[{"name": group["name"], "isAdmin": True}]) | |
| role, role_id = request.getfixturevalue("temp_role")(role_list=[{"name": c_role["name"], "isAdmin": True}]) | |
| auth = (temp_user["name"], "Test@123") | |
| role_list = [role_id, c_id] | |
| elif test_case.endswith("user"): | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("user") | |
| role, role_id = request.getfixturevalue("temp_role")(user_list=[{"name": temp_user["name"], "isAdmin": True}]) | |
| auth = (temp_user["name"], "Test@123") | |
| role_list = [role_id] | |
| elif test_case.endswith("group"): | |
| temp_user, temp_user_id = request.getfixturevalue("temp_secure_user")("user") | |
| group, group_id = request.getfixturevalue("temp_group")() | |
| xutils.assign_groups_to_user(temp_user["name"], [group["name"]], AUTH, BASE_URL, HEADERS) | |
| role, role_id = request.getfixturevalue("temp_role")(group_list=[{"name": group["name"], "isAdmin": True}]) | |
| auth = (temp_user["name"], "Test@123") | |
| role_list = [role_id] | |
| else: | |
| raise ValueError(f"Unknown test_case: '{test_case}'") # catches mismatches early | |
| params = {"execUser": temp_user["name"]} | |
| if test_case in ["service admin", "in service admin groups in grouplist"]: | |
| params = {"serviceName": service["name"], "execUser": temp_user["name"]} | |
| clean_up_items = {"role_list": role_list, "service_list": service_list} | |
| return auth, params, role, clean_up_items |