Make TokenClientJSON deprecated

All service clients' name should not contain "JSON" because of
Ic6d4c340e145a18cd45bc6fe750e9fdc8c5d2a8d of Tempest commit.
This patch makes TokenClientJSON deprecated and recommends to
use TokenClient instead.

Partially implements blueprint consistent-service-method-names

Change-Id: Icbf3bffddd22cb09628572c7a6d01735a123a0b0
This commit is contained in:
Ken'ichi Ohmichi
2015-07-07 00:42:52 +00:00
parent 79fa2e0fef
commit b57c812f31
7 changed files with 48 additions and 18 deletions

View File

@@ -248,7 +248,7 @@ class KeystoneAuthProvider(AuthProvider):
class KeystoneV2AuthProvider(KeystoneAuthProvider):
def _auth_client(self, auth_url):
return json_v2id.TokenClientJSON(
return json_v2id.TokenClient(
auth_url, disable_ssl_certificate_validation=self.dsvm,
ca_certs=self.ca_certs, trace_requests=self.trace_requests)
@@ -326,7 +326,7 @@ class KeystoneV2AuthProvider(KeystoneAuthProvider):
class KeystoneV3AuthProvider(KeystoneAuthProvider):
def _auth_client(self, auth_url):
return json_v3id.V3TokenClientJSON(
return json_v3id.V3TokenClient(
auth_url, disable_ssl_certificate_validation=self.dsvm,
ca_certs=self.ca_certs, trace_requests=self.trace_requests)

View File

@@ -13,16 +13,19 @@
# under the License.
import json
from oslo_log import log as logging
from tempest_lib.common import rest_client
from tempest_lib import exceptions
class TokenClientJSON(rest_client.RestClient):
class TokenClient(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__(
super(TokenClient, self).__init__(
None, None, None, disable_ssl_certificate_validation=dscv,
ca_certs=ca_certs, trace_requests=trace_requests)
@@ -101,3 +104,15 @@ class TokenClientJSON(rest_client.RestClient):
return body['token']['id'], body
else:
return body['token']['id']
class TokenClientJSON(TokenClient):
LOG = logging.getLogger(__name__)
def _warn(self):
self.LOG.warning("%s class was deprecated and renamed to %s" %
(self.__class__.__name__, 'TokenClient'))
def __init__(self, *args, **kwargs):
self._warn()
super(TokenClientJSON, self).__init__(*args, **kwargs)

View File

@@ -13,16 +13,19 @@
# under the License.
import json
from oslo_log import log as logging
from tempest_lib.common import rest_client
from tempest_lib import exceptions
class V3TokenClientJSON(rest_client.RestClient):
class V3TokenClient(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__(
super(V3TokenClient, self).__init__(
None, None, None, disable_ssl_certificate_validation=dscv,
ca_certs=ca_certs, trace_requests=trace_requests)
@@ -163,3 +166,15 @@ class V3TokenClientJSON(rest_client.RestClient):
return token, body['token']
else:
return token
class V3TokenClientJSON(V3TokenClient):
LOG = logging.getLogger(__name__)
def _warn(self):
self.LOG.warning("%s class was deprecated and renamed to %s" %
(self.__class__.__name__, 'V3TokenClient'))
def __init__(self, *args, **kwargs):
self._warn()
super(V3TokenClientJSON, self).__init__(*args, **kwargs)

View File

@@ -30,7 +30,7 @@ class TestTokenClientV2(base.TestCase):
self.fake_200_http = fake_http.fake_httplib2(return_type=200)
def test_auth(self):
token_client_v2 = token_client.TokenClientJSON('fake_url')
token_client_v2 = token_client.TokenClient('fake_url')
post_mock = self.useFixture(mockpatch.PatchObject(
token_client_v2, 'post', return_value=self.fake_200_http.request(
'fake_url', body={'access': {'token': 'fake_token'}})))
@@ -48,7 +48,7 @@ class TestTokenClientV2(base.TestCase):
body=req_dict)
def test_auth_with_tenant(self):
token_client_v2 = token_client.TokenClientJSON('fake_url')
token_client_v2 = token_client.TokenClient('fake_url')
post_mock = self.useFixture(mockpatch.PatchObject(
token_client_v2, 'post', return_value=self.fake_200_http.request(
'fake_url', body={'access': {'token': 'fake_token'}})))
@@ -67,7 +67,7 @@ class TestTokenClientV2(base.TestCase):
body=req_dict)
def test_request_with_str_body(self):
token_client_v2 = token_client.TokenClientJSON('fake_url')
token_client_v2 = token_client.TokenClient('fake_url')
self.useFixture(mockpatch.PatchObject(
token_client_v2, 'raw_request', return_value=(
httplib2.Response({'status': '200'}),
@@ -77,7 +77,7 @@ class TestTokenClientV2(base.TestCase):
self.assertIsInstance(body, dict)
def test_request_with_bytes_body(self):
token_client_v2 = token_client.TokenClientJSON('fake_url')
token_client_v2 = token_client.TokenClient('fake_url')
self.useFixture(mockpatch.PatchObject(
token_client_v2, 'raw_request', return_value=(
httplib2.Response({'status': '200'}),

View File

@@ -30,7 +30,7 @@ class TestTokenClientV2(base.TestCase):
self.fake_201_http = fake_http.fake_httplib2(return_type=201)
def test_auth(self):
token_client_v3 = token_client.V3TokenClientJSON('fake_url')
token_client_v3 = token_client.V3TokenClient('fake_url')
post_mock = self.useFixture(mockpatch.PatchObject(
token_client_v3, 'post', return_value=self.fake_201_http.request(
'fake_url', body={'access': {'token': 'fake_token'}})))
@@ -53,7 +53,7 @@ class TestTokenClientV2(base.TestCase):
body=req_dict)
def test_auth_with_tenant(self):
token_client_v2 = token_client.V3TokenClientJSON('fake_url')
token_client_v2 = token_client.V3TokenClient('fake_url')
post_mock = self.useFixture(mockpatch.PatchObject(
token_client_v2, 'post', return_value=self.fake_201_http.request(
'fake_url', body={'access': {'token': 'fake_token'}})))
@@ -82,7 +82,7 @@ class TestTokenClientV2(base.TestCase):
body=req_dict)
def test_request_with_str_body(self):
token_client_v3 = token_client.V3TokenClientJSON('fake_url')
token_client_v3 = token_client.V3TokenClient('fake_url')
self.useFixture(mockpatch.PatchObject(
token_client_v3, 'raw_request', return_value=(
httplib2.Response({"status": "200"}),
@@ -92,7 +92,7 @@ class TestTokenClientV2(base.TestCase):
self.assertIsInstance(body, dict)
def test_request_with_bytes_body(self):
token_client_v3 = token_client.V3TokenClientJSON('fake_url')
token_client_v3 = token_client.V3TokenClient('fake_url')
self.useFixture(mockpatch.PatchObject(
token_client_v3, 'raw_request', return_value=(
httplib2.Response({"status": "200"}),

View File

@@ -120,7 +120,7 @@ class TestKeystoneV2AuthProvider(BaseAuthTestsSetUp):
def setUp(self):
super(TestKeystoneV2AuthProvider, self).setUp()
self.stubs.Set(v2_client.TokenClientJSON, 'raw_request',
self.stubs.Set(v2_client.TokenClient, 'raw_request',
fake_identity._fake_v2_response)
self.target_url = 'test_api'
@@ -341,7 +341,7 @@ class TestKeystoneV3AuthProvider(TestKeystoneV2AuthProvider):
def setUp(self):
super(TestKeystoneV3AuthProvider, self).setUp()
self.stubs.Set(v3_client.V3TokenClientJSON, 'raw_request',
self.stubs.Set(v3_client.V3TokenClient, 'raw_request',
fake_identity._fake_v3_response)
def _get_fake_alt_identity(self):

View File

@@ -67,7 +67,7 @@ class KeystoneV2CredentialsTests(CredentialsTests):
identity_response = fake_identity._fake_v2_response
credentials_class = auth.KeystoneV2Credentials
tokenclient_class = v2_client.TokenClientJSON
tokenclient_class = v2_client.TokenClient
identity_version = 'v2'
def setUp(self):
@@ -147,7 +147,7 @@ class KeystoneV3CredentialsTests(KeystoneV2CredentialsTests):
credentials_class = auth.KeystoneV3Credentials
identity_response = fake_identity._fake_v3_response
tokenclient_class = v3_client.V3TokenClientJSON
tokenclient_class = v3_client.V3TokenClient
identity_version = 'v3'
def test_is_not_valid(self):