Merge "Glance tests - Image Member"
diff --git a/MANIFEST.in b/MANIFEST.in
deleted file mode 100644
index c978a52..0000000
--- a/MANIFEST.in
+++ /dev/null
@@ -1,6 +0,0 @@
-include AUTHORS
-include ChangeLog
-exclude .gitignore
-exclude .gitreview
-
-global-exclude *.pyc
diff --git a/README.rst b/README.rst
index 6be7812..d9a6507 100644
--- a/README.rst
+++ b/README.rst
@@ -17,4 +17,16 @@
Features
--------
-* TODO
+Patrole offers RBAC testing for various OpenStack RBAC policies. It includes
+a decorator that wraps around tests which verifies that when the test calls the
+corresponding api endpoint, access is only granted for correct roles.
+
+There are several possible test flows.
+
+If the rbac_test_role is allowed to access the endpoint
+ - The test passes if no 403 forbidden or RbacActionFailed exception is raised.
+
+If the rbac_test_role is not allowed to access the endpoint
+ - If the endpoint returns a 403 forbidden exception the test will pass
+ - If the endpoint returns something other than a 403 forbidden to indicate
+ that the role is not allowed, the test will raise an RbacActionFailed exception.
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 9bfe14e..b0a6f33 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -14,6 +14,11 @@
$ mkvirtualenv patrole
$ pip install patrole
+Or to install from the source::
+
+ $ navigate to patrole directory
+ $ pip install -e .
+
Configuration Information
#########################
@@ -44,6 +49,11 @@
# The role that you want the RBAC tests to use for RBAC testing
# This needs to be edited to run the test as a different role.
- rbac_role=_member_
+ rbac_test_role=_member_
+
+ # The list of roles that your system contains.
+ # This needs to be updated as new roles are added.
+ rbac_roles=admin,_member_
+
# Tell standard RBAC test cases to run other wise it they are skipped.
rbac_flag=true
diff --git a/patrole_tempest_plugin/rbac_rule_validation.py b/patrole_tempest_plugin/rbac_rule_validation.py
index 7785eea..e11ae4c 100644
--- a/patrole_tempest_plugin/rbac_rule_validation.py
+++ b/patrole_tempest_plugin/rbac_rule_validation.py
@@ -13,8 +13,7 @@
# License for the specific language governing permissions and limitations
# under the License.
-import logging
-
+from oslo_log import log as logging
from tempest import config
from tempest.lib import exceptions
diff --git a/patrole_tempest_plugin/rbac_utils.py b/patrole_tempest_plugin/rbac_utils.py
index 7792cbd..1150416 100644
--- a/patrole_tempest_plugin/rbac_utils.py
+++ b/patrole_tempest_plugin/rbac_utils.py
@@ -14,11 +14,11 @@
# under the License.
import json
-import logging
import six
import time
import urllib3
+from oslo_log import log as logging
from tempest import config
from patrole_tempest_plugin import rbac_exceptions as rbac_exc
diff --git a/patrole_tempest_plugin/tests/api/image/test_images_rbac.py b/patrole_tempest_plugin/tests/api/image/test_images_rbac.py
index 9d257c0..7df5461 100644
--- a/patrole_tempest_plugin/tests/api/image/test_images_rbac.py
+++ b/patrole_tempest_plugin/tests/api/image/test_images_rbac.py
@@ -13,9 +13,9 @@
# License for the specific language governing permissions and limitations
# under the License.
-import logging
from six import moves
+from oslo_log import log as logging
from tempest import config
from tempest.lib.common.utils import data_utils
from tempest.lib import decorators
diff --git a/patrole_tempest_plugin/tests/api/rbac_base.py b/patrole_tempest_plugin/tests/api/rbac_base.py
index 786927f..fee24b8 100644
--- a/patrole_tempest_plugin/tests/api/rbac_base.py
+++ b/patrole_tempest_plugin/tests/api/rbac_base.py
@@ -13,6 +13,7 @@
# Maybe these should be in lib or recreated?
from tempest.api.image import base as image_base
+from tempest.api.volume import base as vol_base
from tempest import config
CONF = config.CONF
@@ -37,3 +38,45 @@
super(BaseV2ImageRbacTest, cls).setup_clients()
cls.auth_provider = cls.os.auth_provider
cls.admin_client = cls.os_adm.image_client_v2
+
+
+class BaseVolumeRbacTest(vol_base.BaseVolumeTest):
+
+ credentials = ['primary', 'admin']
+
+ @classmethod
+ def skip_checks(cls):
+ super(BaseVolumeRbacTest, cls).skip_checks()
+ if not CONF.rbac.rbac_flag:
+ raise cls.skipException(
+ "%s skipped as RBAC Flag not enabled" % cls.__name__)
+ if 'admin' not in CONF.auth.tempest_roles:
+ raise cls.skipException(
+ "%s skipped because tempest roles is not admin" % cls.__name__)
+
+ @classmethod
+ def setup_clients(cls):
+ super(BaseVolumeRbacTest, cls).setup_clients()
+ cls.auth_provider = cls.os.auth_provider
+ cls.admin_client = cls.os_adm.volumes_client
+
+
+class BaseVolumeAdminRbacTest(vol_base.BaseVolumeAdminTest):
+
+ credentials = ['primary', 'admin']
+
+ @classmethod
+ def skip_checks(cls):
+ super(BaseVolumeAdminRbacTest, cls).skip_checks()
+ if not CONF.rbac.rbac_flag:
+ raise cls.skipException(
+ "%s skipped as RBAC Flag not enabled" % cls.__name__)
+ if 'admin' not in CONF.auth.tempest_roles:
+ raise cls.skipException(
+ "%s skipped because tempest roles is not admin" % cls.__name__)
+
+ @classmethod
+ def setup_clients(cls):
+ super(BaseVolumeAdminRbacTest, cls).setup_clients()
+ cls.auth_provider = cls.os.auth_provider
+ cls.admin_client = cls.os_adm.volumes_client
diff --git a/patrole_tempest_plugin/tests/api/volume/__init__.py b/patrole_tempest_plugin/tests/api/volume/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/__init__.py
diff --git a/patrole_tempest_plugin/tests/api/volume/admin/__init__.py b/patrole_tempest_plugin/tests/api/volume/admin/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/admin/__init__.py
diff --git a/patrole_tempest_plugin/tests/api/volume/admin/test_volume_quotas_rbac.py b/patrole_tempest_plugin/tests/api/volume/admin/test_volume_quotas_rbac.py
new file mode 100644
index 0000000..1595eac
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/admin/test_volume_quotas_rbac.py
@@ -0,0 +1,70 @@
+# Copyright 2017 AT&T Corp
+# 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 logging
+
+from tempest import config
+from tempest.lib import decorators
+
+from patrole_tempest_plugin import rbac_rule_validation
+from patrole_tempest_plugin.rbac_utils import rbac_utils
+from patrole_tempest_plugin.tests.api import rbac_base
+
+QUOTA_KEYS = ['gigabytes', 'snapshots', 'volumes']
+QUOTA_USAGE_KEYS = ['reserved', 'limit', 'in_use']
+CONF = config.CONF
+LOG = logging.getLogger(__name__)
+
+
+class VolumeQuotasAdminRbacTest(rbac_base.BaseVolumeAdminRbacTest):
+
+ @classmethod
+ def setup_credentials(cls):
+ super(VolumeQuotasAdminRbacTest, cls).setup_credentials()
+ cls.demo_tenant_id = cls.os.credentials.tenant_id
+
+ @classmethod
+ def setup_clients(cls):
+ super(VolumeQuotasAdminRbacTest, cls).setup_clients()
+ cls.client = cls.os.volume_quotas_client
+
+ def tearDown(self):
+ rbac_utils.switch_role(self, switchToRbacRole=False)
+ super(VolumeQuotasAdminRbacTest, self).tearDown()
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume_extension:quotas:show")
+ @decorators.idempotent_id('b3c7177e-b6b1-4d0f-810a-fc95606964dd')
+ def test_list_default_quotas(self):
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.show_default_quota_set(
+ self.demo_tenant_id)['quota_set']
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume_extension:quotas:update")
+ @decorators.idempotent_id('60f8f421-1630-4953-b449-b22af32265c7')
+ def test_update_all_quota_resources_for_tenant(self):
+ new_quota_set = {'gigabytes': 1009,
+ 'volumes': 11,
+ 'snapshots': 11}
+ # Update limits for all quota resources
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.update_quota_set(
+ self.demo_tenant_id,
+ **new_quota_set)['quota_set']
+
+
+class VolumeQuotasAdminV3RbacTest(VolumeQuotasAdminRbacTest):
+ _api_version = 3
diff --git a/patrole_tempest_plugin/tests/api/volume/test_snapshots_actions_rbac.py b/patrole_tempest_plugin/tests/api/volume/test_snapshots_actions_rbac.py
new file mode 100644
index 0000000..9718bfc
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/test_snapshots_actions_rbac.py
@@ -0,0 +1,82 @@
+# Copyright 2016 AT&T Corp
+# 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.
+
+from oslo_log import log as logging
+
+from tempest import config
+from tempest.lib import decorators
+
+from patrole_tempest_plugin import rbac_rule_validation
+from patrole_tempest_plugin.rbac_utils import rbac_utils
+from patrole_tempest_plugin.tests.api import rbac_base
+
+CONF = config.CONF
+LOG = logging.getLogger(__name__)
+
+
+class SnapshotsActionsRbacTest(rbac_base.BaseVolumeRbacTest):
+
+ @classmethod
+ def skip_checks(cls):
+ super(SnapshotsActionsRbacTest, cls).skip_checks()
+ if not CONF.volume_feature_enabled.snapshot:
+ raise cls.skipException("Cinder snapshot feature disabled")
+
+ @classmethod
+ def setup_clients(cls):
+ super(SnapshotsActionsRbacTest, cls).setup_clients()
+ cls.client = cls.os.snapshots_client
+
+ def tearDown(self):
+ rbac_utils.switch_role(self, switchToRbacRole=False)
+ super(SnapshotsActionsRbacTest, self).tearDown()
+
+ @classmethod
+ def resource_setup(cls):
+ super(SnapshotsActionsRbacTest, cls).resource_setup()
+ # Create a volume
+ cls.volume = cls.create_volume()
+ # Create a snapshot
+ cls.snapshot = cls.create_snapshot(volume_id=cls.volume['id'])
+ cls.snapshot_id = cls.snapshot['id']
+
+ @rbac_rule_validation.action(
+ component="Volume", service="cinder",
+ rule="volume_extension:snapshot_admin_actions:reset_status")
+ @decorators.idempotent_id('ea430145-34ef-408d-b678-95d5ae5f46eb')
+ def test_reset_snapshot_status(self):
+ # Reset snapshot status to error
+ status = 'error'
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.\
+ reset_snapshot_status(self.snapshot['id'], status)
+
+ @rbac_rule_validation.action(
+ component="Volume", service="cinder",
+ rule="volume_extension:volume_admin_actions:force_delete")
+ @decorators.idempotent_id('a8b0f7d8-4c00-4645-b8d5-33ab4eecc6cb')
+ def test_snapshot_force_delete(self):
+ # Test force delete of snapshot
+ # Create snapshot,
+ # and force delete temp snapshot
+ temp_snapshot = self.create_snapshot(self.volume['id'])
+ # Force delete the snapshot
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.force_delete_snapshot(temp_snapshot['id'])
+ self.client.wait_for_resource_deletion(temp_snapshot['id'])
+
+
+class SnapshotsActionsV3RbacTest(SnapshotsActionsRbacTest):
+ _api_version = 3
diff --git a/patrole_tempest_plugin/tests/api/volume/test_volume_create_delete_rbac.py b/patrole_tempest_plugin/tests/api/volume/test_volume_create_delete_rbac.py
new file mode 100644
index 0000000..e535f96
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/test_volume_create_delete_rbac.py
@@ -0,0 +1,67 @@
+# Copyright 2016 AT&T Corp
+# 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.
+
+from oslo_log import log as logging
+
+from tempest import config
+from tempest.lib import decorators
+from tempest.lib import exceptions
+
+from patrole_tempest_plugin import rbac_exceptions
+from patrole_tempest_plugin import rbac_rule_validation
+from patrole_tempest_plugin.rbac_utils import rbac_utils
+from patrole_tempest_plugin.tests.api import rbac_base
+
+CONF = config.CONF
+LOG = logging.getLogger(__name__)
+
+
+class CreateDeleteVolumeRbacTest(rbac_base.BaseVolumeRbacTest):
+
+ def tearDown(self):
+ rbac_utils.switch_role(self, switchToRbacRole=False)
+ super(CreateDeleteVolumeRbacTest, self).tearDown()
+
+ def _create_volume(self):
+ # create_volume waits for volume status to be
+ # "available" before returning and automatically
+ # cleans up at the end of testing
+ volume = self.create_volume()
+ return volume
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:create")
+ @decorators.idempotent_id('426b08ef-6394-4d06-9128-965d5a6c38ef')
+ def test_create_volume(self):
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ # Create a volume
+ self._create_volume()
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:delete")
+ @decorators.idempotent_id('6de9f9c2-509f-4558-867b-af21c7163be4')
+ def test_delete_volume(self):
+ try:
+ # Create a volume
+ volume = self._create_volume()
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ # Delete a volume
+ self.volumes_client.delete_volume(volume['id'])
+ except exceptions.NotFound as e:
+ raise rbac_exceptions.RbacActionFailed(e)
+
+
+class CreateDeleteVolumeV3RbacTest(CreateDeleteVolumeRbacTest):
+ _api_version = 3
diff --git a/patrole_tempest_plugin/tests/api/volume/test_volume_metadata_rbac.py b/patrole_tempest_plugin/tests/api/volume/test_volume_metadata_rbac.py
new file mode 100644
index 0000000..9c5d2d9
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/test_volume_metadata_rbac.py
@@ -0,0 +1,89 @@
+# Copyright 2017 AT&T Corp
+# 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.
+
+from oslo_log import log as logging
+
+from tempest import config
+from tempest.lib import decorators
+
+from patrole_tempest_plugin import rbac_rule_validation
+from patrole_tempest_plugin.rbac_utils import rbac_utils
+from patrole_tempest_plugin.tests.api import rbac_base
+
+CONF = config.CONF
+LOG = logging.getLogger(__name__)
+
+
+class VolumeMetadataRbacTest(rbac_base.BaseVolumeRbacTest):
+ @classmethod
+ def setup_clients(cls):
+ super(VolumeMetadataRbacTest, cls).setup_clients()
+ cls.client = cls.os.volumes_client
+
+ def tearDown(self):
+ rbac_utils.switch_role(self, switchToRbacRole=False)
+ super(VolumeMetadataRbacTest, self).tearDown()
+
+ def _add_metadata(self, volume):
+ # Create metadata for the volume
+ metadata = {"key1": "value1",
+ "key2": "value2",
+ "key3": "value3",
+ "key4": "<value&special_chars>"}
+ self.volumes_client.create_volume_metadata(volume['id'],
+ metadata)['metadata']
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:update_volume_metadata")
+ @decorators.idempotent_id('232bbb8b-4c29-44dc-9077-b1398c20b738')
+ def test_create_volume_metadata(self):
+ volume = self.create_volume()
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self._add_metadata(volume)
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:get")
+ @decorators.idempotent_id('87ea37d9-23ab-47b2-a59c-16fc4d2c6dfa')
+ def test_get_volume_metadata(self):
+ volume = self.create_volume()
+ self._add_metadata(volume)
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.volumes_client.show_volume_metadata(volume['id'])['metadata']
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:delete_volume_metadata")
+ @decorators.idempotent_id('7498dfc1-9db2-4423-ad20-e6dcb25d1beb')
+ def test_delete_volume_metadata(self):
+ volume = self.create_volume()
+ self._add_metadata(volume)
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.volumes_client.delete_volume_metadata_item(volume['id'],
+ "key1")
+
+ @rbac_rule_validation.action(component="Volume", service="cinder",
+ rule="volume:update_volume_metadata")
+ @decorators.idempotent_id('8ce2ff80-99ba-49ae-9bb1-7e96729ee5af')
+ def test_update_volume_metadata(self):
+ volume = self.create_volume()
+ self._add_metadata(volume)
+ # Metadata to update
+ update_item = {"key3": "value3_update"}
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.volumes_client.update_volume_metadata_item(
+ volume['id'], "key3", update_item)['meta']
+
+
+class VolumeMetadataV3RbacTest(VolumeMetadataRbacTest):
+ _api_version = 3
diff --git a/patrole_tempest_plugin/tests/api/volume/test_volumes_rbac.py b/patrole_tempest_plugin/tests/api/volume/test_volumes_rbac.py
new file mode 100644
index 0000000..632abdd
--- /dev/null
+++ b/patrole_tempest_plugin/tests/api/volume/test_volumes_rbac.py
@@ -0,0 +1,65 @@
+# Copyright 2016 AT&T Corp
+# 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.
+
+from oslo_log import log as logging
+
+from tempest import config
+from tempest.lib import decorators
+
+from patrole_tempest_plugin import rbac_rule_validation
+from patrole_tempest_plugin.rbac_utils import rbac_utils
+from patrole_tempest_plugin.tests.api import rbac_base
+
+CONF = config.CONF
+LOG = logging.getLogger(__name__)
+
+
+class VolumesRbacTest(rbac_base.BaseVolumeRbacTest):
+
+ @classmethod
+ def setup_clients(cls):
+ super(VolumesRbacTest, cls).setup_clients()
+ cls.client = cls.volumes_client
+
+ def tearDown(self):
+ rbac_utils.switch_role(self, switchToRbacRole=False)
+ super(VolumesRbacTest, self).tearDown()
+
+ @rbac_rule_validation.action(
+ component="Volume", service="cinder",
+ rule="volume_extension:volume_admin_actions:reset_status")
+ @decorators.idempotent_id('4b3dad7d-0e73-4839-8781-796dd3d7af1d')
+ def test_volume_reset_status(self):
+ volume = self.create_volume()
+ # Test volume reset status : available->error->available
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.reset_volume_status(volume['id'], status='error')
+ self.client.reset_volume_status(volume['id'], status='availble')
+
+ @rbac_rule_validation.action(
+ component="Volume", service="cinder",
+ rule="volume_extension:volume_admin_actions:force_delete")
+ @decorators.idempotent_id('a312a937-6abf-4b91-a950-747086cbce48')
+ def test_volume_force_delete_when_volume_is_error(self):
+ volume = self.create_volume()
+ self.client.reset_volume_status(volume['id'], status='error')
+ # Test force delete when status of volume is error
+ rbac_utils.switch_role(self, switchToRbacRole=True)
+ self.client.force_delete_volume(volume['id'])
+ self.client.wait_for_resource_deletion(volume['id'])
+
+
+class VolumesV3RbacTest(VolumesRbacTest):
+ _api_version = 3
diff --git a/requirements.txt b/requirements.txt
index 29091ac..b22bec8 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -4,3 +4,4 @@
pbr>=1.8 # Apache-2.0
urllib3>=1.15.1 # MIT
+oslo.log>=3.11.0 # Apache-2.0
diff --git a/setup.cfg b/setup.cfg
index c174fca..a8732dc 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -5,7 +5,7 @@
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
-home-page = http://www.openstack.org/
+home-page = http://docs.openstack.org/developer/patrole/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
diff --git a/test-requirements.txt b/test-requirements.txt
index cbb75b1..dddb31f 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,4 +10,5 @@
coverage>=4.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
oslo.policy>=1.17.0 # Apache-2.0
+oslo.log>=3.11.0 # Apache-2.0
tempest>=12.1.0 # Apache-2.0