# Copyright European Organization for Nuclear Research (CERN) since 2012 # # Licensed 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. from json import loads from urllib.parse import quote_plus from requests.status_codes import codes from rucio.client.baseclient import BaseClient, choice from rucio.common.utils import build_url class ScopeClient(BaseClient): """Scope client class for working with rucio scopes""" SCOPE_BASEURL = 'accounts' def add_scope( self, account: str, scope: str ) -> bool: """ Sends the request to add a new scope. :param account: the name of the account to add the scope to. :param scope: the name of the new scope. :return: True if scope was created successfully. :raises Duplicate: if scope already exists. :raises AccountNotFound: if account doesn't exist. """ path = '/'.join([self.SCOPE_BASEURL, account, 'scopes', quote_plus(scope)]) url = build_url(choice(self.list_hosts), path=path) r = self._send_request(url, type_='POST') if r.status_code == codes.created: return True else: exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content) raise exc_cls(exc_msg) def list_scopes(self) -> list[str]: """ Sends the request to list all scopes. :return: a list containing the names of all scopes. """ path = '/'.join(['scopes/']) url = build_url(choice(self.list_hosts), path=path) r = self._send_request(url) if r.status_code == codes.ok: scopes = loads(r.text) return scopes else: exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content) raise exc_cls(exc_msg) def list_scopes_for_account(self, account: str) -> list[str]: """ Sends the request to list all scopes for a rucio account. :param account: the rucio account to list scopes for. :return: a list containing the names of all scopes for a rucio account. :raises AccountNotFound: if account doesn't exist. :raises ScopeNotFound: if no scopes exist for account. """ path = '/'.join([self.SCOPE_BASEURL, account, 'scopes/']) url = build_url(choice(self.list_hosts), path=path) r = self._send_request(url) if r.status_code == codes.ok: scopes = loads(r.text) return scopes else: exc_cls, exc_msg = self._get_exception(headers=r.headers, status_code=r.status_code, data=r.content) raise exc_cls(exc_msg)