Functional tests: Use a configurable url pattern

This removes the append_version_to_url config option in favor of
a pattern that will build the request url by interpolating arguments.

Change-Id: I0b1152d518a5f4ddfcfc5d5a7b28606932a86c4b

doc/source/functional-tests.rst

@@ -76,8 +76,14 @@ The config file should look like the following:
     nameservers = 127.0.0.1:53,127.0.0.2:53
 
     [testconfig]
-    # if true, make requests to {url}/v2/zones instead of {url}/zones
-    append_version_to_url = True
+    # Specify how build the path for the request. This will be appended
+    # directly to the url from the service catalog (or the override url).
+    #     {tenant_id} - the tenant id
+    #     {tenant_name} - the tenant name
+    #     {user} - the username of the tenant
+    #     {user_id} - the user_id of the tenant
+    #     {path} - the versionless resource path, e.g. /zones/ID"),
+    v2_path_pattern = '/v2/{path}'
     # if true, skip doing admin actions like increasing quotas in test setups
     no_admin_setup = False
 

functionaltests/api/v2/clients/blacklist_client.py

@@ -21,13 +21,11 @@ from functionaltests.common.client import ClientMixin
 
 class BlacklistClient(ClientMixin):
 
-    @classmethod
-    def blacklists_uri(cls, filters=None):
-        return cls.create_uri("/blacklists", filters=filters)
+    def blacklists_uri(self, filters=None):
+        return self.create_uri("/blacklists", filters=filters)
 
-    @classmethod
-    def blacklist_uri(cls, blacklist_id):
-        return "{0}/{1}".format(cls.blacklists_uri(), blacklist_id)
+    def blacklist_uri(self, blacklist_id):
+        return "{0}/{1}".format(self.blacklists_uri(), blacklist_id)
 
     def list_blacklists(self, filters=None, **kwargs):
         resp, body = self.client.get(self.blacklists_uri(filters), **kwargs)

functionaltests/api/v2/clients/pool_client.py

@@ -21,13 +21,11 @@ from functionaltests.common.client import ClientMixin
 
 class PoolClient(ClientMixin):
 
-    @classmethod
-    def pools_uri(cls, filters=None):
-        return cls.create_uri("/pools", filters=filters)
+    def pools_uri(self, filters=None):
+        return self.create_uri("/pools", filters=filters)
 
-    @classmethod
-    def pool_uri(cls, pool_id):
-        return "{0}/{1}".format(cls.pools_uri(), pool_id)
+    def pool_uri(self, pool_id):
+        return "{0}/{1}".format(self.pools_uri(), pool_id)
 
     def list_pools(self, filters=None, **kwargs):
         resp, body = self.client.get(self.pools_uri(filters), **kwargs)

functionaltests/api/v2/clients/quotas_client.py

@@ -20,11 +20,10 @@ from functionaltests.common.client import ClientMixin
 
 class QuotasClient(ClientMixin):
 
-    @classmethod
-    def quotas_uri(cls, tenant_id, filters=None):
+    def quotas_uri(self, tenant_id, filters=None):
         url = "/admin/quotas/{0}".format(tenant_id)
         if filters:
-            url = cls.add_filters(url, filters)
+            url = self.add_filters(url, filters)
         return url
 
     def get_quotas(self, tenant_id, filters=None, **kwargs):

functionaltests/api/v2/clients/recordset_client.py

@@ -24,14 +24,12 @@ from functionaltests.common import utils
 
 class RecordsetClient(ClientMixin):
 
-    @classmethod
-    def recordsets_uri(cls, zone_id, filters=None):
-        return cls.create_uri("/zones/{0}/recordsets".format(zone_id),
-                              filters=filters)
+    def recordsets_uri(self, zone_id, filters=None):
+        return self.create_uri("/zones/{0}/recordsets".format(zone_id),
+                               filters=filters)
 
-    @classmethod
-    def recordset_uri(cls, zone_id, recordset_id):
-        return "{0}/{1}".format(cls.recordsets_uri(zone_id), recordset_id)
+    def recordset_uri(self, zone_id, recordset_id):
+        return "{0}/{1}".format(self.recordsets_uri(zone_id), recordset_id)
 
     def list_recordsets(self, zone_id, filters=None, **kwargs):
         resp, body = self.client.get(

functionaltests/api/v2/clients/transfer_accepts_client.py

@@ -23,14 +23,12 @@ from functionaltests.common.client import ClientMixin
 
 class TransferAcceptClient(ClientMixin):
 
-    @classmethod
-    def transfer_accepts_uri(cls, filters=None):
-        return cls.create_uri("/zones/tasks/transfer_accepts",
-                              filters=filters)
+    def transfer_accepts_uri(self, filters=None):
+        return self.create_uri("/zones/tasks/transfer_accepts",
+                               filters=filters)
 
-    @classmethod
-    def transfer_accept_uri(cls, transfer_request_id):
-        return "{0}/{1}".format(cls.transfer_accepts_uri(),
+    def transfer_accept_uri(self, transfer_request_id):
+        return "{0}/{1}".format(self.transfer_accepts_uri(),
                                 transfer_request_id)
 
     def list_transfer_accepts(self, zone_id, filters=None, **kwargs):

functionaltests/api/v2/clients/transfer_requests_client.py

@@ -23,23 +23,20 @@ from functionaltests.common.client import ClientMixin
 
 class TransferRequestClient(ClientMixin):
 
-    @classmethod
-    def create_transfer_requests_uri(cls, zone_id, filters=None):
-        return cls.create_uri(
+    def create_transfer_requests_uri(self, zone_id, filters=None):
+        return self.create_uri(
             "/zones/{0}/tasks/transfer_requests".format(zone_id),
             filters=filters,
         )
 
-    @classmethod
-    def transfer_requests_uri(cls, filters=None):
-        return cls.create_uri(
+    def transfer_requests_uri(self, filters=None):
+        return self.create_uri(
             "/zones/tasks/transfer_requests",
             filters=filters,
         )
 
-    @classmethod
-    def transfer_request_uri(cls, transfer_request_id):
-        return cls.create_uri(
+    def transfer_request_uri(self, transfer_request_id):
+        return self.create_uri(
             "/zones/tasks/transfer_requests/{0}".format(transfer_request_id)
         )
 

functionaltests/api/v2/clients/zone_client.py

@@ -24,13 +24,11 @@ from functionaltests.common import utils
 
 class ZoneClient(ClientMixin):
 
-    @classmethod
-    def zones_uri(cls, filters=None):
-        return cls.create_uri("/zones", filters=filters)
+    def zones_uri(self, filters=None):
+        return self.create_uri("/zones", filters=filters)
 
-    @classmethod
-    def zone_uri(cls, id):
-        return "{0}/{1}".format(cls.zones_uri(), id)
+    def zone_uri(self, id):
+        return "{0}/{1}".format(self.zones_uri(), id)
 
     def list_zones(self, filters=None, **kwargs):
         resp, body = self.client.get(self.zones_uri(filters), **kwargs)

functionaltests/api/v2/clients/zone_export_client.py

@@ -22,20 +22,17 @@ from functionaltests.common.models import ZoneFile
 
 class ZoneExportClient(ClientMixin):
 
-    @classmethod
-    def zone_exports_uri(cls, filters=None):
-        return cls.create_uri("/zones/tasks/exports", filters=filters)
+    def zone_exports_uri(self, filters=None):
+        return self.create_uri("/zones/tasks/exports", filters=filters)
 
-    @classmethod
-    def create_zone_export_uri(cls, zone_id, filters=None):
-        return cls.create_uri(
+    def create_zone_export_uri(self, zone_id, filters=None):
+        return self.create_uri(
             "/zones/{0}/tasks/export".format(zone_id),
             filters=filters,
         )
 
-    @classmethod
-    def zone_export_uri(cls, id):
-        return "{0}/{1}".format(cls.zone_exports_uri(), id)
+    def zone_export_uri(self, id):
+        return "{0}/{1}".format(self.zone_exports_uri(), id)
 
     def list_zone_exports(self, filters=None, **kwargs):
         resp, body = self.client.get(

functionaltests/api/v2/clients/zone_import_client.py

@@ -21,13 +21,11 @@ from functionaltests.common import utils
 
 class ZoneImportClient(ClientMixin):
 
-    @classmethod
-    def zone_imports_uri(cls, filters=None):
-        return cls.create_uri("/zones/tasks/imports", filters=filters)
+    def zone_imports_uri(self, filters=None):
+        return self.create_uri("/zones/tasks/imports", filters=filters)
 
-    @classmethod
-    def zone_import_uri(cls, id):
-        return "{0}/{1}".format(cls.zone_imports_uri(), id)
+    def zone_import_uri(self, id):
+        return "{0}/{1}".format(self.zone_imports_uri(), id)
 
     def list_zone_imports(self, filters=None, **kwargs):
         resp, body = self.client.get(

functionaltests/common/client.py

@@ -185,12 +185,17 @@ class ClientMixin(object):
             first = False
         return url
 
-    @classmethod
-    def create_uri(cls, path, filters=None):
-        if cfg.CONF.testconfig.append_version_to_url:
-            uri = "/v2/{0}".format(path)
-        else:
-            uri = path
+    def create_uri(self, path, filters=None):
+        url_pattern = cfg.CONF.testconfig.v2_path_pattern
+        params = {
+            'path': path,
+            'tenant_id': self.client.tenant_id,
+            'tenant_name': self.client.tenant_name,
+            'user': self.client.user,
+            'user_id': self.client.user_id,
+        }
+        uri = url_pattern.format(**params)
+        uri.replace('//', '/')
         if filters:
-            uri = cls.add_filters(uri, filters)
+            uri = self.add_filters(uri, filters)
         return uri

functionaltests/common/config.py

@@ -69,8 +69,8 @@ cfg.CONF.register_opts([
 
 
 cfg.CONF.register_opts([
-    cfg.BoolOpt('append_version_to_url', default=True,
-               help="Post to url + /v2/zones instead of url + /zones"),
+    cfg.StrOpt('v2_path_pattern', default='/v2/{path}',
+               help="Specifies how to build the path for the request"),
     cfg.BoolOpt('no_admin_setup', default=False,
                 help="Skip admin actions (like increasing quotas) in setUp()")
 ], group='testconfig')