Merge "Support /auth routes for list projects and domains"

keystoneclient/tests/unit/v3/test_auth_manager.py

@@ -0,0 +1,72 @@
+# 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 uuid
+
+from keystoneclient.auth.identity import v3
+from keystoneclient import fixture
+from keystoneclient import session
+from keystoneclient.tests.unit.v3 import utils
+from keystoneclient.v3 import auth
+from keystoneclient.v3 import client
+
+
+class AuthProjectsTest(utils.TestCase):
+
+    def setUp(self):
+        super(AuthProjectsTest, self).setUp()
+
+        self.v3token = fixture.V3Token()
+        self.stub_auth(json=self.v3token)
+
+        self.stub_url('GET',
+                      [],
+                      json={'version': fixture.V3Discovery(self.TEST_URL)})
+
+        self.auth = v3.Password(auth_url=self.TEST_URL,
+                                user_id=self.v3token.user_id,
+                                password=uuid.uuid4().hex)
+        self.session = session.Session(auth=self.auth)
+        self.client = client.Client(session=self.session)
+
+    def create_resource(self, id=None, name=None, **kwargs):
+        kwargs['id'] = id or uuid.uuid4().hex
+        kwargs['name'] = name or uuid.uuid4().hex
+        return kwargs
+
+    def test_get_projects(self):
+        body = {'projects': [self.create_resource(),
+                             self.create_resource(),
+                             self.create_resource()]}
+
+        self.stub_url('GET', ['auth', 'projects'], json=body)
+
+        projects = self.client.auth.projects()
+
+        self.assertEqual(3, len(projects))
+
+        for p in projects:
+            self.assertIsInstance(p, auth.Project)
+
+    def test_get_domains(self):
+        body = {'domains': [self.create_resource(),
+                            self.create_resource(),
+                            self.create_resource()]}
+
+        self.stub_url('GET', ['auth', 'domains'], json=body)
+
+        domains = self.client.auth.domains()
+
+        self.assertEqual(3, len(domains))
+
+        for d in domains:
+            self.assertIsInstance(d, auth.Domain)

keystoneclient/v3/auth.py

@@ -0,0 +1,81 @@
+# 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 keystoneclient import auth
+from keystoneclient import base
+from keystoneclient import exceptions
+
+
+class Project(base.Resource):
+    """Represents an Identity project.
+
+    Attributes:
+        * id: a uuid that identifies the project
+        * name: project name
+        * description: project description
+        * enabled: boolean to indicate if project is enabled
+        * parent_id: a uuid representing this project's parent in hierarchy
+        * parents: a list or a structured dict containing the parents of this
+                   project in the hierarchy
+        * subtree: a list or a structured dict containing the subtree of this
+                   project in the hierarchy
+
+    """
+
+
+class Domain(base.Resource):
+    """Represents an Identity domain.
+
+    Attributes:
+        * id: a uuid that identifies the domain
+
+    """
+    pass
+
+
+class AuthManager(base.Manager):
+    """Retrieve auth context specific information.
+
+    The information returned by the /auth routes are entirely dependant on the
+    authentication information provided by the user.
+    """
+
+    _PROJECTS_URL = '/auth/projects'
+    _DOMAINS_URL = '/auth/domains'
+
+    def projects(self):
+        """List projects that this token can be rescoped to.
+        """
+        try:
+            return self._list(self._PROJECTS_URL,
+                              'projects',
+                              obj_class=Project)
+        except exceptions.EndpointNotFound:
+            endpoint_filter = {'interface': auth.AUTH_INTERFACE}
+            return self._list(self._PROJECTS_URL,
+                              'projects',
+                              obj_class=Project,
+                              endpoint_filter=endpoint_filter)
+
+    def domains(self):
+        """List Domains that this token can be rescoped to.
+        """
+        try:
+            return self._list(self._DOMAINS_URL,
+                              'domains',
+                              obj_class=Domain)
+        except exceptions.EndpointNotFound:
+            endpoint_filter = {'interface': auth.AUTH_INTERFACE}
+            return self._list(self._DOMAINS_URL,
+                              'domains',
+                              obj_class=Domain,
+                              endpoint_filter=endpoint_filter)

keystoneclient/v3/client.py

@@ -21,6 +21,7 @@ from keystoneclient.auth.identity import v3 as v3_auth
 from keystoneclient import exceptions
 from keystoneclient import httpclient
 from keystoneclient.i18n import _
+from keystoneclient.v3 import auth
 from keystoneclient.v3.contrib import endpoint_filter
 from keystoneclient.v3.contrib import endpoint_policy
 from keystoneclient.v3.contrib import federation
@@ -179,6 +180,7 @@ EndpointPolicyManager`
         """Initialize a new client for the Keystone v3 API."""
         super(Client, self).__init__(**kwargs)
 
+        self.auth = auth.AuthManager(self._adapter)
         self.credentials = credentials.CredentialManager(self._adapter)
         self.ec2 = ec2.EC2Manager(self._adapter)
         self.endpoint_filter = endpoint_filter.EndpointFilterManager(