summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2017-06-20 13:14:35 -0600
committerspisarski <s.pisarski@cablelabs.com>2017-06-20 13:14:35 -0600
commit9211ff2f307640c0e2791b4958272f5d3807360f (patch)
tree33aab7bd8129c2c5f47ef1fb469f694c85b67346
parenta11bb69ff2b1bb31a0c95613f05a93cfd6e4a269 (diff)
Changes UserSettings constructor to use kwargs.
And changed line lengths to 79 for pep8. JIRA: SNAPS-104 Change-Id: I04413ccd783b5ccdac0f6d8e76780e728f765962 Signed-off-by: spisarski <s.pisarski@cablelabs.com>
-rw-r--r--snaps/openstack/create_user.py79
-rw-r--r--snaps/openstack/tests/create_user_tests.py38
2 files changed, 62 insertions, 55 deletions
diff --git a/snaps/openstack/create_user.py b/snaps/openstack/create_user.py
index fe7a64c..c6d4678 100644
--- a/snaps/openstack/create_user.py
+++ b/snaps/openstack/create_user.py
@@ -13,9 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
+
from keystoneclient.exceptions import NotFound
from snaps.openstack.os_credentials import OSCreds
-
from snaps.openstack.utils import keystone_utils
__author__ = 'spisarski'
@@ -43,15 +43,17 @@ class OpenStackUser:
def create(self, cleanup=False):
"""
Creates the user in OpenStack if it does not already exist
- :param cleanup: Denotes whether or not this is being called for cleanup or not
+ :param cleanup: Denotes whether or not this is being called for cleanup
:return: The OpenStack user object
"""
self.__keystone = keystone_utils.keystone_client(self.__os_creds)
- self.__user = keystone_utils.get_user(self.__keystone, self.user_settings.name)
+ self.__user = keystone_utils.get_user(self.__keystone,
+ self.user_settings.name)
if self.__user:
logger.info('Found user with name - ' + self.user_settings.name)
elif not cleanup:
- self.__user = keystone_utils.create_user(self.__keystone, self.user_settings)
+ self.__user = keystone_utils.create_user(self.__keystone,
+ self.user_settings)
else:
logger.info('Did not create user due to cleanup mode')
@@ -79,60 +81,55 @@ class OpenStackUser:
def get_os_creds(self, project_name=None):
"""
Returns an OSCreds object based on this user account and a project
- :param project_name: the name of the project to leverage in the credentials
+ :param project_name: the name of the project to leverage in the
+ credentials
:return:
"""
- return OSCreds(username=self.user_settings.name,
- password=self.user_settings.password,
- auth_url=self.__os_creds.auth_url,
- project_name=project_name,
- identity_api_version=self.__os_creds.identity_api_version,
- user_domain_id=self.__os_creds.user_domain_id,
- project_domain_id=self.__os_creds.project_domain_id,
- proxy_settings=self.__os_creds.proxy_settings)
+ return OSCreds(
+ username=self.user_settings.name,
+ password=self.user_settings.password,
+ auth_url=self.__os_creds.auth_url,
+ project_name=project_name,
+ identity_api_version=self.__os_creds.identity_api_version,
+ user_domain_id=self.__os_creds.user_domain_id,
+ project_domain_id=self.__os_creds.project_domain_id,
+ proxy_settings=self.__os_creds.proxy_settings)
class UserSettings:
- def __init__(self, config=None, name=None, password=None, project_name=None, domain_name='default', email=None,
- enabled=True):
+ def __init__(self, **kwargs):
"""
Constructor
- :param config: dict() object containing the configuration settings using the attribute names below as each
- member's the key and overrides any of the other parameters.
:param name: the user's name (required)
:param password: the user's password (required)
:param project_name: the user's primary project name (optional)
- :param domain_name: the user's domain name (default='default'). For v3 APIs
+ :param domain_name: the user's domain name (default='default'). For v3
+ APIs
:param email: the user's email address (optional)
- :param enabled: denotes whether or not the user is enabled (default True)
+ :param enabled: denotes whether or not the user is enabled
+ (default True)
"""
- if config:
- self.name = config.get('name')
- self.password = config.get('password')
- self.project_name = config.get('project_name')
- self.email = config.get('email')
-
- if config.get('domain_name'):
- self.domain_name = config['domain_name']
- else:
- self.domain_name = domain_name
-
- if config.get('enabled') is not None:
- self.enabled = config['enabled']
- else:
- self.enabled = enabled
+ self.name = kwargs.get('name')
+ self.password = kwargs.get('password')
+ self.project_name = kwargs.get('project_name')
+ self.email = kwargs.get('email')
+
+ if kwargs.get('domain_name'):
+ self.domain_name = kwargs['domain_name']
+ else:
+ self.domain_name = 'default'
+
+ if kwargs.get('enabled') is not None:
+ self.enabled = kwargs['enabled']
else:
- self.name = name
- self.password = password
- self.project_name = project_name
- self.email = email
- self.enabled = enabled
- self.domain_name = domain_name
+ self.enabled = True
if not self.name or not self.password:
- raise Exception('The attributes name and password are required for UserSettings')
+ raise Exception(
+ 'The attributes name and password are required for '
+ 'UserSettings')
if not isinstance(self.enabled, bool):
raise Exception('The attribute enabled must be of type boolean')
diff --git a/snaps/openstack/tests/create_user_tests.py b/snaps/openstack/tests/create_user_tests.py
index 007f7f0..fdc3644 100644
--- a/snaps/openstack/tests/create_user_tests.py
+++ b/snaps/openstack/tests/create_user_tests.py
@@ -12,8 +12,9 @@
# 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 uuid
import unittest
+import uuid
+
from snaps.openstack.create_user import OpenStackUser, UserSettings
from snaps.openstack.tests.os_source_file_test import OSComponentTestCase
from snaps.openstack.utils import keystone_utils
@@ -32,7 +33,7 @@ class UserSettingsUnitTests(unittest.TestCase):
def test_empty_config(self):
with self.assertRaises(Exception):
- UserSettings(config=dict())
+ UserSettings(**dict())
def test_name_only(self):
with self.assertRaises(Exception):
@@ -40,7 +41,7 @@ class UserSettingsUnitTests(unittest.TestCase):
def test_config_with_name_only(self):
with self.assertRaises(Exception):
- UserSettings(config={'name': 'foo'})
+ UserSettings(**{'name': 'foo'})
def test_name_pass_enabled_str(self):
with self.assertRaises(Exception):
@@ -48,7 +49,8 @@ class UserSettingsUnitTests(unittest.TestCase):
def test_config_with_name_pass_enabled_str(self):
with self.assertRaises(Exception):
- UserSettings(config={'name': 'foo', 'password': 'bar', 'enabled': 'true'})
+ UserSettings(
+ **{'name': 'foo', 'password': 'bar', 'enabled': 'true'})
def test_name_pass_only(self):
settings = UserSettings(name='foo', password='bar')
@@ -59,7 +61,7 @@ class UserSettingsUnitTests(unittest.TestCase):
self.assertTrue(settings.enabled)
def test_config_with_name_pass_only(self):
- settings = UserSettings(config={'name': 'foo', 'password': 'bar'})
+ settings = UserSettings(**{'name': 'foo', 'password': 'bar'})
self.assertEqual('foo', settings.name)
self.assertEqual('bar', settings.password)
self.assertIsNone(settings.project_name)
@@ -67,7 +69,9 @@ class UserSettingsUnitTests(unittest.TestCase):
self.assertTrue(settings.enabled)
def test_all(self):
- settings = UserSettings(name='foo', password='bar', project_name='proj-foo', email='foo@bar.com', enabled=False)
+ settings = UserSettings(name='foo', password='bar',
+ project_name='proj-foo', email='foo@bar.com',
+ enabled=False)
self.assertEqual('foo', settings.name)
self.assertEqual('bar', settings.password)
self.assertEqual('proj-foo', settings.project_name)
@@ -75,8 +79,10 @@ class UserSettingsUnitTests(unittest.TestCase):
self.assertFalse(settings.enabled)
def test_config_all(self):
- settings = UserSettings(config={'name': 'foo', 'password': 'bar', 'project_name': 'proj-foo',
- 'email': 'foo@bar.com', 'enabled': False})
+ settings = UserSettings(**{'name': 'foo', 'password': 'bar',
+ 'project_name': 'proj-foo',
+ 'email': 'foo@bar.com',
+ 'enabled': False})
self.assertEqual('foo', settings.name)
self.assertEqual('bar', settings.password)
self.assertEqual('proj-foo', settings.project_name)
@@ -91,12 +97,13 @@ class CreateUserSuccessTests(OSComponentTestCase):
def setUp(self):
"""
- Instantiates the CreateImage object that is responsible for downloading and creating an OS image file
- within OpenStack
+ Instantiates the CreateImage object that is responsible for downloading
+ and creating an OS image file within OpenStack
"""
guid = str(uuid.uuid4())[:-19]
guid = self.__class__.__name__ + '-' + guid
- self.user_settings = UserSettings(name=guid + '-name', password=guid + '-password')
+ self.user_settings = UserSettings(name=guid + '-name',
+ password=guid + '-password')
self.keystone = keystone_utils.keystone_client(self.os_creds)
@@ -118,19 +125,22 @@ class CreateUserSuccessTests(OSComponentTestCase):
created_user = self.user_creator.create()
self.assertIsNotNone(created_user)
- retrieved_user = keystone_utils.get_user(self.keystone, self.user_settings.name)
+ retrieved_user = keystone_utils.get_user(self.keystone,
+ self.user_settings.name)
self.assertIsNotNone(retrieved_user)
self.assertEqual(created_user, retrieved_user)
def test_create_user_2x(self):
"""
- Tests the creation of an OpenStack user twice to ensure it only creates one.
+ Tests the creation of an OpenStack user twice to ensure it only creates
+ one.
"""
self.user_creator = OpenStackUser(self.os_creds, self.user_settings)
created_user = self.user_creator.create()
self.assertIsNotNone(created_user)
- retrieved_user = keystone_utils.get_user(self.keystone, self.user_settings.name)
+ retrieved_user = keystone_utils.get_user(self.keystone,
+ self.user_settings.name)
self.assertIsNotNone(retrieved_user)
self.assertEqual(created_user, retrieved_user)