-
Notifications
You must be signed in to change notification settings - Fork 302
/
configclient.py
111 lines (89 loc) · 4.3 KB
/
configclient.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# 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 dumps
from requests.status_codes import codes
from rucio.client.baseclient import BaseClient, choice
from rucio.common.utils import build_url
class ConfigClient(BaseClient):
"""Client class for working with the configuration"""
CONFIG_BASEURL = 'config'
def get_config(self, section=None, option=None):
"""
Sends the request to get the matching configuration.
:param section: the optional name of the section.
:param option: the optional option within the section.
:return: dictionary containing the configuration.
"""
if section is None and option is not None:
raise ValueError('--section not specified')
path = self.CONFIG_BASEURL
if section is not None and option is None:
path += '/' + section
elif section is not None and option is not None:
path += '/'.join(['', section, option])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url, type_='GET')
if r.status_code == codes.ok:
return r.json()
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 set_config_option(self, section, option, value, use_body_for_params=True):
"""
Sends the request to create or set an option within a section. Missing sections will be created.
:param section: the name of the section.
:param option: the name of the option.
:param value: the value to set on the config option
:param use_body_for_params: send parameters in a json-encoded request body instead of url-encoded
TODO: remove this parameter
The format of the /config endpoint was recently changed. We migrated from performing a PUT on
"/config/<section>/<option>/<value>" to sending the parameters using a json-encoded body.
This was done to fix multiple un-wanted side effects related to how the middleware treats
values encoded in a path.
For a smooth transition, we allow both cases for now, but we should migrate to only passing
values via the request body.
:return: True if option was removed successfully. False otherwise.
"""
if use_body_for_params:
url = build_url(choice(self.list_hosts), path=self.CONFIG_BASEURL)
data = dumps({
section: {
option: value
}
})
r = self._send_request(url, type_='POST', data=data)
else:
path = '/'.join([self.CONFIG_BASEURL, section, option, value])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url, type_='PUT')
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 delete_config_option(self, section, option):
"""
Sends the request to remove an option from a section
:param section: the name of the section.
:param option: the name of the option.
:return: True if option was removed successfully. False otherwise.
"""
path = '/'.join([self.CONFIG_BASEURL, section, option])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url, type_='DEL')
if r.status_code == codes.ok:
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)