Migrate token clients to tempest-lib
Migrate v2 and v3 identity token to tempest-lib. Compared to tempest, dropping the legacy json folder. Migrating ResponseBody* classes as well into rest_client.py, as they are needed by the token clients. Change-Id: I9b2dac8363772f004b9dc00dbdeb0e9f8205f6db
This commit is contained in:
Andrea Frittoli
parent
5512c4329a
commit
59b3f34774
|
|
@ -813,3 +813,50 @@ class RestClient(object):
|
|||
except jsonschema.ValidationError as ex:
|
||||
msg = ("HTTP response header is invalid (%s)") % ex
|
||||
raise exceptions.InvalidHTTPResponseHeader(msg)
|
||||
|
||||
|
||||
class ResponseBody(dict):
|
||||
"""Class that wraps an http response and dict body into a single value.
|
||||
|
||||
Callers that receive this object will normally use it as a dict but
|
||||
can extract the response if needed.
|
||||
"""
|
||||
|
||||
def __init__(self, response, body=None):
|
||||
body_data = body or {}
|
||||
self.update(body_data)
|
||||
self.response = response
|
||||
|
||||
def __str__(self):
|
||||
body = super(ResponseBody, self).__str__()
|
||||
return "response: %s\nBody: %s" % (self.response, body)
|
||||
|
||||
|
||||
class ResponseBodyData(object):
|
||||
"""Class that wraps an http response and string data into a single value.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, response, data):
|
||||
self.response = response
|
||||
self.data = data
|
||||
|
||||
def __str__(self):
|
||||
return "response: %s\nBody: %s" % (self.response, self.data)
|
||||
|
||||
|
||||
class ResponseBodyList(list):
|
||||
"""Class that wraps an http response and list body into a single value.
|
||||
|
||||
Callers that receive this object will normally use it as a list but
|
||||
can extract the response if needed.
|
||||
"""
|
||||
|
||||
def __init__(self, response, body=None):
|
||||
body_data = body or []
|
||||
self.extend(body_data)
|
||||
self.response = response
|
||||
|
||||
def __str__(self):
|
||||
body = super(ResponseBodyList, self).__str__()
|
||||
return "response: %s\nBody: %s" % (self.response, body)
|
||||
|
|
|
|||
|
|
@ -143,3 +143,7 @@ class CommandFailed(Exception):
|
|||
self.returncode,
|
||||
self.stdout,
|
||||
self.stderr))
|
||||
|
||||
|
||||
class IdentityError(TempestException):
|
||||
message = "Got identity error"
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
# Copyright 2015 NEC Corporation. All rights reserved.
|
||||
#
|
||||
# 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.
|
||||
|
||||
import json
|
||||
from tempest_lib.common import rest_client
|
||||
from tempest_lib import exceptions
|
||||
|
||||
|
||||
class TokenClientJSON(rest_client.RestClient):
|
||||
|
||||
def __init__(self, auth_url, disable_ssl_certificate_validation=None,
|
||||
ca_certs=None, trace_requests=None):
|
||||
dscv = disable_ssl_certificate_validation
|
||||
super(TokenClientJSON, self).__init__(
|
||||
None, None, None, disable_ssl_certificate_validation=dscv,
|
||||
ca_certs=ca_certs, trace_requests=trace_requests)
|
||||
|
||||
# Normalize URI to ensure /tokens is in it.
|
||||
if 'tokens' not in auth_url:
|
||||
auth_url = auth_url.rstrip('/') + '/tokens'
|
||||
|
||||
self.auth_url = auth_url
|
||||
|
||||
def auth(self, user, password, tenant=None):
|
||||
creds = {
|
||||
'auth': {
|
||||
'passwordCredentials': {
|
||||
'username': user,
|
||||
'password': password,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
if tenant:
|
||||
creds['auth']['tenantName'] = tenant
|
||||
|
||||
body = json.dumps(creds)
|
||||
resp, body = self.post(self.auth_url, body=body)
|
||||
self.expected_success(200, resp.status)
|
||||
|
||||
return rest_client.ResponseBody(resp, body['access'])
|
||||
|
||||
def auth_token(self, token_id, tenant=None):
|
||||
creds = {
|
||||
'auth': {
|
||||
'token': {
|
||||
'id': token_id,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
if tenant:
|
||||
creds['auth']['tenantName'] = tenant
|
||||
|
||||
body = json.dumps(creds)
|
||||
resp, body = self.post(self.auth_url, body=body)
|
||||
self.expected_success(200, resp.status)
|
||||
|
||||
return rest_client.ResponseBody(resp, body['access'])
|
||||
|
||||
def request(self, method, url, extra_headers=False, headers=None,
|
||||
body=None):
|
||||
"""A simple HTTP request interface."""
|
||||
if headers is None:
|
||||
headers = self.get_headers(accept_type="json")
|
||||
elif extra_headers:
|
||||
try:
|
||||
headers.update(self.get_headers(accept_type="json"))
|
||||
except (ValueError, TypeError):
|
||||
headers = self.get_headers(accept_type="json")
|
||||
|
||||
resp, resp_body = self.raw_request(url, method,
|
||||
headers=headers, body=body)
|
||||
self._log_request(method, url, resp)
|
||||
|
||||
if resp.status in [401, 403]:
|
||||
resp_body = json.loads(resp_body)
|
||||
raise exceptions.Unauthorized(resp_body['error']['message'])
|
||||
elif resp.status not in [200, 201]:
|
||||
raise exceptions.IdentityError(
|
||||
'Unexpected status code {0}'.format(resp.status))
|
||||
|
||||
if isinstance(resp_body, str):
|
||||
resp_body = json.loads(resp_body)
|
||||
return resp, resp_body
|
||||
|
||||
def get_token(self, user, password, tenant, auth_data=False):
|
||||
"""Returns (token id, token data) for supplied credentials."""
|
||||
body = self.auth(user, password, tenant)
|
||||
|
||||
if auth_data:
|
||||
return body['token']['id'], body
|
||||
else:
|
||||
return body['token']['id']
|
||||
|
|
@ -0,0 +1,165 @@
|
|||
# Copyright 2015 NEC Corporation. All rights reserved.
|
||||
#
|
||||
# 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.
|
||||
|
||||
import json
|
||||
from tempest_lib.common import rest_client
|
||||
from tempest_lib import exceptions
|
||||
|
||||
|
||||
class V3TokenClientJSON(rest_client.RestClient):
|
||||
|
||||
def __init__(self, auth_url, disable_ssl_certificate_validation=None,
|
||||
ca_certs=None, trace_requests=None):
|
||||
dscv = disable_ssl_certificate_validation
|
||||
super(V3TokenClientJSON, self).__init__(
|
||||
None, None, None, disable_ssl_certificate_validation=dscv,
|
||||
ca_certs=ca_certs, trace_requests=trace_requests)
|
||||
|
||||
if 'auth/tokens' not in auth_url:
|
||||
auth_url = auth_url.rstrip('/') + '/auth/tokens'
|
||||
|
||||
self.auth_url = auth_url
|
||||
|
||||
def auth(self, user_id=None, username=None, password=None, project_id=None,
|
||||
project_name=None, user_domain_id=None, user_domain_name=None,
|
||||
project_domain_id=None, project_domain_name=None, domain_id=None,
|
||||
domain_name=None, token=None):
|
||||
"""Obtains a token from the authentication service
|
||||
|
||||
:param user_id: user id
|
||||
:param username: user name
|
||||
:param user_domain_id: the user domain id
|
||||
:param user_domain_name: the user domain name
|
||||
:param project_domain_id: the project domain id
|
||||
:param project_domain_name: the project domain name
|
||||
:param domain_id: a domain id to scope to
|
||||
:param domain_name: a domain name to scope to
|
||||
:param project_id: a project id to scope to
|
||||
:param project_name: a project name to scope to
|
||||
:param token: a token to re-scope.
|
||||
|
||||
Accepts different combinations of credentials.
|
||||
Sample sample valid combinations:
|
||||
- token
|
||||
- token, project_name, project_domain_id
|
||||
- user_id, password
|
||||
- username, password, user_domain_id
|
||||
- username, password, project_name, user_domain_id, project_domain_id
|
||||
Validation is left to the server side.
|
||||
"""
|
||||
creds = {
|
||||
'auth': {
|
||||
'identity': {
|
||||
'methods': [],
|
||||
}
|
||||
}
|
||||
}
|
||||
id_obj = creds['auth']['identity']
|
||||
if token:
|
||||
id_obj['methods'].append('token')
|
||||
id_obj['token'] = {
|
||||
'id': token
|
||||
}
|
||||
|
||||
if (user_id or username) and password:
|
||||
id_obj['methods'].append('password')
|
||||
id_obj['password'] = {
|
||||
'user': {
|
||||
'password': password,
|
||||
}
|
||||
}
|
||||
if user_id:
|
||||
id_obj['password']['user']['id'] = user_id
|
||||
else:
|
||||
id_obj['password']['user']['name'] = username
|
||||
|
||||
_domain = None
|
||||
if user_domain_id is not None:
|
||||
_domain = dict(id=user_domain_id)
|
||||
elif user_domain_name is not None:
|
||||
_domain = dict(name=user_domain_name)
|
||||
if _domain:
|
||||
id_obj['password']['user']['domain'] = _domain
|
||||
|
||||
if (project_id or project_name):
|
||||
_project = dict()
|
||||
|
||||
if project_id:
|
||||
_project['id'] = project_id
|
||||
elif project_name:
|
||||
_project['name'] = project_name
|
||||
|
||||
if project_domain_id is not None:
|
||||
_project['domain'] = {'id': project_domain_id}
|
||||
elif project_domain_name is not None:
|
||||
_project['domain'] = {'name': project_domain_name}
|
||||
|
||||
creds['auth']['scope'] = dict(project=_project)
|
||||
elif domain_id:
|
||||
creds['auth']['scope'] = dict(domain={'id': domain_id})
|
||||
elif domain_name:
|
||||
creds['auth']['scope'] = dict(domain={'name': domain_name})
|
||||
|
||||
body = json.dumps(creds)
|
||||
resp, body = self.post(self.auth_url, body=body)
|
||||
self.expected_success(201, resp.status)
|
||||
return rest_client.ResponseBody(resp, body)
|
||||
|
||||
def request(self, method, url, extra_headers=False, headers=None,
|
||||
body=None):
|
||||
"""A simple HTTP request interface."""
|
||||
if headers is None:
|
||||
# Always accept 'json', for xml token client too.
|
||||
# Because XML response is not easily
|
||||
# converted to the corresponding JSON one
|
||||
headers = self.get_headers(accept_type="json")
|
||||
elif extra_headers:
|
||||
try:
|
||||
headers.update(self.get_headers(accept_type="json"))
|
||||
except (ValueError, TypeError):
|
||||
headers = self.get_headers(accept_type="json")
|
||||
|
||||
resp, resp_body = self.raw_request(url, method,
|
||||
headers=headers, body=body)
|
||||
self._log_request(method, url, resp)
|
||||
|
||||
if resp.status in [401, 403]:
|
||||
resp_body = json.loads(resp_body)
|
||||
raise exceptions.Unauthorized(resp_body['error']['message'])
|
||||
elif resp.status not in [200, 201, 204]:
|
||||
raise exceptions.IdentityError(
|
||||
'Unexpected status code {0}'.format(resp.status))
|
||||
|
||||
return resp, json.loads(resp_body)
|
||||
|
||||
def get_token(self, **kwargs):
|
||||
"""Returns (token id, token data) for supplied credentials"""
|
||||
|
||||
auth_data = kwargs.pop('auth_data', False)
|
||||
|
||||
if not (kwargs.get('user_domain_id') or
|
||||
kwargs.get('user_domain_name')):
|
||||
kwargs['user_domain_name'] = 'Default'
|
||||
|
||||
if not (kwargs.get('project_domain_id') or
|
||||
kwargs.get('project_domain_name')):
|
||||
kwargs['project_domain_name'] = 'Default'
|
||||
|
||||
body = self.auth(**kwargs)
|
||||
|
||||
token = body.response.get('x-subject-token')
|
||||
if auth_data:
|
||||
return token, body['token']
|
||||
else:
|
||||
return token
|
||||
Loading…
Reference in New Issue