salt/tests/unit/modules/test_keystone.py
2021-02-25 17:31:33 +00:00

1090 lines
28 KiB
Python

"""
:codeauthor: Jayesh Kariya <jayeshk@saltstack.com>
"""
import salt.modules.config as config
import salt.modules.keystone as keystone
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.mock import MagicMock, call, patch
from tests.support.unit import TestCase
class MockEC2:
"""
Mock of EC2 class
"""
def __init__(self):
self.access = ""
self.secret = ""
self.tenant_id = ""
self.user_id = ""
self.connection_args = ""
self.profile = ""
@staticmethod
def create(userid, tenantid):
"""
Mock of create method
"""
cr_ec2 = MockEC2()
cr_ec2.tenant_id = tenantid
cr_ec2.user_id = userid
return cr_ec2
def delete(self, userid, accesskey):
"""
Mock of delete method
"""
self.access = accesskey
self.user_id = userid
return True
@staticmethod
def get(user_id, access, profile, **connection_args):
"""
Mock of get method
"""
cr_ec2 = MockEC2()
cr_ec2.profile = profile
cr_ec2.access = access
cr_ec2.user_id = user_id
cr_ec2.connection_args = connection_args
return cr_ec2
@staticmethod
def list(user_id):
"""
Mock of list method
"""
cr_ec2 = MockEC2()
cr_ec2.user_id = user_id
return [cr_ec2]
class MockEndpoints:
"""
Mock of Endpoints class
"""
def __init__(self):
self.id = "007"
self.region = "RegionOne"
self.adminurl = "adminurl"
self.internalurl = "internalurl"
self.publicurl = "publicurl"
self.service_id = "117"
@staticmethod
def list():
"""
Mock of list method
"""
return [MockEndpoints()]
@staticmethod
def create(region, service_id, publicurl, adminurl, internalurl):
"""
Mock of create method
"""
return (region, service_id, publicurl, adminurl, internalurl)
@staticmethod
def delete(id):
"""
Mock of delete method
"""
return id
class MockServices:
"""
Mock of Services class
"""
flag = None
def __init__(self):
self.id = "117"
self.name = "iptables"
self.description = "description"
self.type = "type"
@staticmethod
def create(name, service_type, description):
"""
Mock of create method
"""
service = MockServices()
service.id = "005"
service.name = name
service.description = description
service.type = service_type
return service
def get(self, service_id):
"""
Mock of get method
"""
service = MockServices()
if self.flag == 1:
service.id = "asd"
return [service]
elif self.flag == 2:
service.id = service_id
return service
return [service]
def list(self):
"""
Mock of list method
"""
service = MockServices()
if self.flag == 1:
service.id = "asd"
return [service]
return [service]
@staticmethod
def delete(service_id):
"""
Mock of delete method
"""
return service_id
class MockRoles:
"""
Mock of Roles class
"""
flag = None
def __init__(self):
self.id = "113"
self.name = "nova"
self.user_id = "446"
self.tenant_id = "a1a1"
@staticmethod
def create(name):
"""
Mock of create method
"""
return name
def get(self, role_id):
"""
Mock of get method
"""
role = MockRoles()
if self.flag == 1:
role.id = None
return role
role.id = role_id
return role
@staticmethod
def list():
"""
Mock of list method
"""
return [MockRoles()]
@staticmethod
def delete(role):
"""
Mock of delete method
"""
return role
@staticmethod
def add_user_role(user_id, role_id, tenant_id):
"""
Mock of add_user_role method
"""
return (user_id, role_id, tenant_id)
@staticmethod
def remove_user_role(user_id, role_id, tenant_id):
"""
Mock of remove_user_role method
"""
return (user_id, role_id, tenant_id)
@staticmethod
def roles_for_user(user, tenant):
"""
Mock of roles_for_user method
"""
role = MockRoles()
role.user_id = user
role.tenant_id = tenant
return [role]
class MockTenants:
"""
Mock of Tenants class
"""
flag = None
def __init__(self):
self.id = "446"
self.name = "nova"
self.description = "description"
self.enabled = "True"
@staticmethod
def create(name, description, enabled):
"""
Mock of create method
"""
tenant = MockTenants()
tenant.name = name
tenant.description = description
tenant.enabled = enabled
return tenant
def get(self, tenant_id):
"""
Mock of get method
"""
tenant = MockTenants()
if self.flag == 1:
tenant.id = None
return tenant
tenant.id = tenant_id
return tenant
@staticmethod
def list():
"""
Mock of list method
"""
return [MockTenants()]
@staticmethod
def delete(tenant_id):
"""
Mock of delete method
"""
return tenant_id
class MockServiceCatalog:
"""
Mock of ServiceCatalog class
"""
def __init__(self):
self.id = "446"
self.expires = "No"
self.user_id = "admin"
self.tenant_id = "ae04"
def get_token(self):
"""
Mock of get_token method
"""
return {
"id": self.id,
"expires": self.expires,
"user_id": self.user_id,
"tenant_id": self.tenant_id,
}
class MockUsers:
"""
Mock of Users class
"""
flag = None
def __init__(self):
self.id = "446"
self.name = "nova"
self.email = "salt@saltstack.com"
self.enabled = "True"
self.tenant_id = "a1a1"
self.password = "salt"
def create(self, name, password, email, tenant_id, enabled):
"""
Mock of create method
"""
user = MockUsers()
user.name = name
user.password = password
user.email = email
user.enabled = enabled
self.tenant_id = tenant_id
return user
def get(self, user_id):
"""
Mock of get method
"""
user = MockUsers()
if self.flag == 1:
user.id = None
return user
user.id = user_id
return user
@staticmethod
def list():
"""
Mock of list method
"""
return [MockUsers()]
@staticmethod
def delete(user_id):
"""
Mock of delete method
"""
return user_id
@staticmethod
def update(user, name, email, enabled):
"""
Mock of update method
"""
return (user, name, email, enabled)
@staticmethod
def update_password(user, password):
"""
Mock of update_password method
"""
return (user, password)
class Unauthorized(Exception):
"""
The base exception class for all exceptions.
"""
def __init__(self, message="Test"):
super().__init__(message)
self.msg = message
class AuthorizationFailure(Exception):
"""
Additional exception class to Unauthorized.
"""
def __init__(self, message="Test"):
super().__init__(message)
self.msg = message
class MockExceptions:
"""
Mock of exceptions class
"""
def __init__(self):
self.Unauthorized = Unauthorized
self.AuthorizationFailure = AuthorizationFailure
class MockKeystoneClient:
"""
Mock of keystoneclient module
"""
def __init__(self):
self.exceptions = MockExceptions()
class MockClient:
"""
Mock of Client class
"""
flag = None
def __init__(self, profile=None, **conn_args):
self.ec2 = MockEC2()
self.endpoints = MockEndpoints()
self.services = MockServices()
self.roles = MockRoles()
self.tenants = MockTenants()
self.service_catalog = MockServiceCatalog()
self.users = MockUsers()
def Client(self, **kwargs):
"""
Mock of Client method
"""
if self.flag == 1:
raise Unauthorized
return True
class KeystoneTestCase(TestCase, LoaderModuleMockMixin):
"""
Test cases for salt.modules.keystone
"""
def setup_loader_modules(self):
return {
keystone: {
"auth": MockClient,
"client": MockClient(),
"keystoneclient": MockKeystoneClient(),
"__salt__": {"config.get": config.get},
"__opts__": {},
},
config: {"__opts__": {}},
}
# 'ec2_credentials_create' function tests: 1
def test_ec2_credentials_create(self):
"""
Test if it create EC2-compatible credentials for user per tenant
"""
self.assertDictEqual(
keystone.ec2_credentials_create(), {"Error": "Could not resolve User ID"}
)
self.assertDictEqual(
keystone.ec2_credentials_create(user_id="salt"),
{"Error": "Could not resolve Tenant ID"},
)
self.assertDictEqual(
keystone.ec2_credentials_create(user_id="salt", tenant_id="72278"),
{"access": "", "tenant_id": "72278", "secret": "", "user_id": "salt"},
)
# 'ec2_credentials_delete' function tests: 1
def test_ec2_credentials_delete(self):
"""
Test if it delete EC2-compatible credentials
"""
self.assertDictEqual(
keystone.ec2_credentials_delete(), {"Error": "Could not resolve User ID"}
)
self.assertEqual(
keystone.ec2_credentials_delete(user_id="salt", access_key="72278"),
'ec2 key "72278" deleted under user id "salt"',
)
# 'ec2_credentials_get' function tests: 1
def test_ec2_credentials_get(self):
"""
Test if it return ec2_credentials for a user
(keystone ec2-credentials-get)
"""
self.assertDictEqual(
keystone.ec2_credentials_get(), {"Error": "Unable to resolve user id"}
)
self.assertDictEqual(
keystone.ec2_credentials_get(user_id="salt"),
{"Error": "Access key is required"},
)
self.assertDictEqual(
keystone.ec2_credentials_get(
user_id="salt", access="72278", profile="openstack1"
),
{
"salt": {
"access": "72278",
"secret": "",
"tenant": "",
"user_id": "salt",
}
},
)
# 'ec2_credentials_list' function tests: 1
def test_ec2_credentials_list(self):
"""
Test if it return a list of ec2_credentials
for a specific user (keystone ec2-credentials-list)
"""
self.assertDictEqual(
keystone.ec2_credentials_list(), {"Error": "Unable to resolve user id"}
)
self.assertDictEqual(
keystone.ec2_credentials_list(user_id="salt", profile="openstack1"),
{"salt": {"access": "", "secret": "", "tenant_id": "", "user_id": "salt"}},
)
# 'endpoint_get' function tests: 1
def test_endpoint_get(self):
"""
Test if it return a specific endpoint (keystone endpoint-get)
"""
self.assertDictEqual(
keystone.endpoint_get("nova", "RegionOne", profile="openstack"),
{"Error": "Could not find the specified service"},
)
ret = {"Error": "Could not find endpoint for the specified service"}
MockServices.flag = 1
self.assertDictEqual(
keystone.endpoint_get("iptables", "RegionOne", profile="openstack"), ret
)
MockServices.flag = 0
self.assertDictEqual(
keystone.endpoint_get("iptables", "RegionOne", profile="openstack"),
{
"adminurl": "adminurl",
"id": "007",
"internalurl": "internalurl",
"publicurl": "publicurl",
"region": "RegionOne",
"service_id": "117",
},
)
# 'endpoint_list' function tests: 1
def test_endpoint_list(self):
"""
Test if it return a list of available endpoints
(keystone endpoints-list)
"""
self.assertDictEqual(
keystone.endpoint_list(profile="openstack1"),
{
"007": {
"adminurl": "adminurl",
"id": "007",
"internalurl": "internalurl",
"publicurl": "publicurl",
"region": "RegionOne",
"service_id": "117",
}
},
)
# 'endpoint_create' function tests: 1
def test_endpoint_create(self):
"""
Test if it create an endpoint for an Openstack service
"""
self.assertDictEqual(
keystone.endpoint_create("nova"),
{"Error": "Could not find the specified service"},
)
MockServices.flag = 2
self.assertDictEqual(
keystone.endpoint_create(
"iptables",
"http://public/url",
"http://internal/url",
"http://adminurl/url",
"RegionOne",
),
{
"adminurl": "adminurl",
"id": "007",
"internalurl": "internalurl",
"publicurl": "publicurl",
"region": "RegionOne",
"service_id": "117",
},
)
# 'endpoint_delete' function tests: 1
def test_endpoint_delete(self):
"""
Test if it delete an endpoint for an Openstack service
"""
ret = {"Error": "Could not find any endpoints for the service"}
self.assertDictEqual(keystone.endpoint_delete("nova", "RegionOne"), ret)
with patch.object(
keystone, "endpoint_get", MagicMock(side_effect=[{"id": "117"}, None])
):
self.assertTrue(keystone.endpoint_delete("iptables", "RegionOne"))
# 'role_create' function tests: 1
def test_role_create(self):
"""
Test if it create named role
"""
self.assertDictEqual(
keystone.role_create("nova"), {"Error": 'Role "nova" already exists'}
)
self.assertDictEqual(
keystone.role_create("iptables"), {"Error": "Unable to resolve role id"}
)
# 'role_delete' function tests: 1
def test_role_delete(self):
"""
Test if it delete a role (keystone role-delete)
"""
self.assertDictEqual(
keystone.role_delete(), {"Error": "Unable to resolve role id"}
)
self.assertEqual(keystone.role_delete("iptables"), "Role ID iptables deleted")
# 'role_get' function tests: 1
def test_role_get(self):
"""
Test if it return a specific roles (keystone role-get)
"""
self.assertDictEqual(
keystone.role_get(), {"Error": "Unable to resolve role id"}
)
self.assertDictEqual(
keystone.role_get(name="nova"), {"nova": {"id": "113", "name": "nova"}}
)
# 'role_list' function tests: 1
def test_role_list(self):
"""
Test if it return a list of available roles (keystone role-list)
"""
self.assertDictEqual(
keystone.role_list(),
{
"nova": {
"id": "113",
"name": "nova",
"tenant_id": "a1a1",
"user_id": "446",
}
},
)
# 'service_create' function tests: 1
def test_service_create(self):
"""
Test if it add service to Keystone service catalog
"""
MockServices.flag = 2
self.assertDictEqual(
keystone.service_create("nova", "compute", "OpenStack Service"),
{
"iptables": {
"description": "description",
"id": "005",
"name": "iptables",
"type": "type",
}
},
)
# 'service_delete' function tests: 1
def test_service_delete(self):
"""
Test if it delete a service from Keystone service catalog
"""
self.assertEqual(
keystone.service_delete("iptables"),
'Keystone service ID "iptables" deleted',
)
# 'service_get' function tests: 1
def test_service_get(self):
"""
Test if it return a list of available services (keystone services-list)
"""
MockServices.flag = 0
self.assertDictEqual(
keystone.service_get(), {"Error": "Unable to resolve service id"}
)
MockServices.flag = 2
self.assertDictEqual(
keystone.service_get(service_id="c965"),
{
"iptables": {
"description": "description",
"id": "c965",
"name": "iptables",
"type": "type",
}
},
)
# 'service_list' function tests: 1
def test_service_list(self):
"""
Test if it return a list of available services (keystone services-list)
"""
MockServices.flag = 0
self.assertDictEqual(
keystone.service_list(profile="openstack1"),
{
"iptables": {
"description": "description",
"id": "117",
"name": "iptables",
"type": "type",
}
},
)
# 'tenant_create' function tests: 1
def test_tenant_create(self):
"""
Test if it create a keystone tenant
"""
self.assertDictEqual(
keystone.tenant_create("nova"),
{
"nova": {
"description": "description",
"id": "446",
"name": "nova",
"enabled": "True",
}
},
)
# 'tenant_delete' function tests: 1
def test_tenant_delete(self):
"""
Test if it delete a tenant (keystone tenant-delete)
"""
self.assertDictEqual(
keystone.tenant_delete(), {"Error": "Unable to resolve tenant id"}
)
self.assertEqual(keystone.tenant_delete("nova"), "Tenant ID nova deleted")
# 'tenant_get' function tests: 1
def test_tenant_get(self):
"""
Test if it return a specific tenants (keystone tenant-get)
"""
self.assertDictEqual(
keystone.tenant_get(), {"Error": "Unable to resolve tenant id"}
)
self.assertDictEqual(
keystone.tenant_get(tenant_id="446"),
{
"nova": {
"description": "description",
"id": "446",
"name": "nova",
"enabled": "True",
}
},
)
# 'tenant_list' function tests: 1
def test_tenant_list(self):
"""
Test if it return a list of available tenants (keystone tenants-list)
"""
self.assertDictEqual(
keystone.tenant_list(),
{
"nova": {
"description": "description",
"id": "446",
"name": "nova",
"enabled": "True",
}
},
)
# 'tenant_update' function tests: 1
def test_tenant_update(self):
"""
Test if it update a tenant's information (keystone tenant-update)
"""
self.assertDictEqual(
keystone.tenant_update(), {"Error": "Unable to resolve tenant id"}
)
# 'token_get' function tests: 1
def test_token_get(self):
"""
Test if it return the configured tokens (keystone token-get)
"""
self.assertDictEqual(
keystone.token_get(),
{"expires": "No", "id": "446", "tenant_id": "ae04", "user_id": "admin"},
)
# 'user_list' function tests: 1
def test_user_list(self):
"""
Test if it return a list of available users (keystone user-list)
"""
self.assertDictEqual(
keystone.user_list(),
{
"nova": {
"name": "nova",
"tenant_id": "a1a1",
"enabled": "True",
"id": "446",
"password": "salt",
"email": "salt@saltstack.com",
}
},
)
# 'user_get' function tests: 1
def test_user_get(self):
"""
Test if it return a specific users (keystone user-get)
"""
self.assertDictEqual(
keystone.user_get(), {"Error": "Unable to resolve user id"}
)
self.assertDictEqual(
keystone.user_get(user_id="446"),
{
"nova": {
"name": "nova",
"tenant_id": "a1a1",
"enabled": "True",
"id": "446",
"password": "salt",
"email": "salt@saltstack.com",
}
},
)
# 'user_create' function tests: 1
def test_user_create(self):
"""
Test if it create a user (keystone user-create)
"""
self.assertDictEqual(
keystone.user_create(
name="nova",
password="salt",
email="salt@saltstack.com",
tenant_id="a1a1",
),
{
"nova": {
"name": "nova",
"tenant_id": "a1a1",
"enabled": "True",
"id": "446",
"password": "salt",
"email": "salt@saltstack.com",
}
},
)
# 'user_delete' function tests: 1
def test_user_delete(self):
"""
Test if it delete a user (keystone user-delete)
"""
self.assertDictEqual(
keystone.user_delete(), {"Error": "Unable to resolve user id"}
)
self.assertEqual(keystone.user_delete("nova"), "User ID nova deleted")
# 'user_update' function tests: 1
def test_user_update(self):
"""
Test if it update a user's information (keystone user-update)
"""
self.assertDictEqual(
keystone.user_update(), {"Error": "Unable to resolve user id"}
)
self.assertEqual(keystone.user_update("nova"), "Info updated for user ID nova")
# 'user_verify_password' function tests: 1
def test_user_verify_password(self):
"""
Test if it verify a user's password
"""
mock = MagicMock(return_value="http://127.0.0.1:35357/v2.0")
with patch.dict(keystone.__salt__, {"config.option": mock}):
self.assertDictEqual(
keystone.user_verify_password(),
{"Error": "Unable to resolve user name"},
)
self.assertTrue(keystone.user_verify_password(user_id="446", name="nova"))
MockClient.flag = 1
self.assertFalse(keystone.user_verify_password(user_id="446", name="nova"))
# 'user_password_update' function tests: 1
def test_user_password_update(self):
"""
Test if it update a user's password (keystone user-password-update)
"""
self.assertDictEqual(
keystone.user_password_update(), {"Error": "Unable to resolve user id"}
)
self.assertEqual(
keystone.user_password_update("nova"), "Password updated for user ID nova"
)
# 'user_role_add' function tests: 1
def test_user_role_add(self):
"""
Test if it add role for user in tenant (keystone user-role-add)
"""
self.assertEqual(
keystone.user_role_add(user="nova", tenant="nova", role="nova"),
'"nova" role added for user "nova" for "nova" tenant/project',
)
MockRoles.flag = 1
self.assertDictEqual(
keystone.user_role_add(user="nova", tenant="nova", role="nova"),
{"Error": "Unable to resolve role id"},
)
MockTenants.flag = 1
self.assertDictEqual(
keystone.user_role_add(user="nova", tenant="nova"),
{"Error": "Unable to resolve tenant/project id"},
)
MockUsers.flag = 1
self.assertDictEqual(
keystone.user_role_add(user="nova"), {"Error": "Unable to resolve user id"}
)
# 'user_role_remove' function tests: 1
def test_user_role_remove(self):
"""
Test if it add role for user in tenant (keystone user-role-add)
"""
MockUsers.flag = 1
self.assertDictEqual(
keystone.user_role_remove(user="nova"),
{"Error": "Unable to resolve user id"},
)
MockUsers.flag = 0
MockTenants.flag = 1
self.assertDictEqual(
keystone.user_role_remove(user="nova", tenant="nova"),
{"Error": "Unable to resolve tenant/project id"},
)
MockTenants.flag = 0
MockRoles.flag = 1
self.assertDictEqual(
keystone.user_role_remove(user="nova", tenant="nova", role="nova"),
{"Error": "Unable to resolve role id"},
)
ret = '"nova" role removed for user "nova" under "nova" tenant'
MockRoles.flag = 0
self.assertEqual(
keystone.user_role_remove(user="nova", tenant="nova", role="nova"), ret
)
# 'user_role_list' function tests: 1
def test_user_role_list(self):
"""
Test if it return a list of available user_roles
(keystone user-roles-list)
"""
self.assertDictEqual(
keystone.user_role_list(user="nova"),
{"Error": "Unable to resolve user or tenant/project id"},
)
self.assertDictEqual(
keystone.user_role_list(user_name="nova", tenant_name="nova"),
{
"nova": {
"id": "113",
"name": "nova",
"tenant_id": "446",
"user_id": "446",
}
},
)
def test_api_version_verify_ssl(self):
"""
test api_version when using verify_ssl
"""
test_verify = [True, False, None]
conn_args = {
"keystone.user": "admin",
"connection_password": "password",
"connection_tenant": "admin",
"connection_tenant_id": "id",
"connection_auth_url": "https://127.0.0.1/v2.0/",
"connection_verify_ssl": True,
}
http_ret = {"dict": {"version": {"id": "id_test"}}}
for verify in test_verify:
mock_http = MagicMock(return_value=http_ret)
patch_http = patch("salt.utils.http.query", mock_http)
conn_args["connection_verify_ssl"] = verify
if verify is None:
conn_args.pop("connection_verify_ssl")
verify = True
with patch_http:
ret = keystone.api_version(**conn_args)
self.assertEqual(
mock_http.call_args_list,
[
call(
"https://127.0.0.1/v2.0/",
decode=True,
decode_type="json",
verify_ssl=verify,
)
],
)