enable smoke test with CRD 3scale client

Makefile

@@ -67,6 +67,9 @@ speedrun: ## Bigger than smoke faster than test
 speedrun: pipenv check-secrets.yaml
 	$(PYTEST) -n4 --dist loadfile -m 'not flaky' --drop-sandbag $(flags) testsuite
 
+capabilities-speedrun: pipenv check-secrets.yaml
+	$(PYTEST) -n1 -m 'not flaky' --drop-sandbag --capabilities $(flags) testsuite
+
 sandbag:  ## Complemetary set to speedrun that makes the rest of test target (speedrun+sandbag == test)
 sandbag: pipenv
 	$(PYTEST) -n4 --dist loadfile -m 'not flaky' --sandbag $(flags) testsuite
@@ -86,6 +89,9 @@ debug: test
 smoke: pipenv check-secrets.yaml
 	$(PYTEST) -n6 -msmoke $(flags) testsuite
 
+capabilities-smoke: pipenv check-secrets.yaml
+	$(PYTEST) -n3 -msmoke --capabilities $(flags) testsuite
+
 flaky: pipenv check-secrets.yaml
 	$(PYTEST) -mflaky $(flags) testsuite
 

Pipfile

@@ -61,5 +61,8 @@ pytest-metadata = ">=3.0.0"
 pytest-html = "*"
 ansi2html = "*"
 
+# 3scale Capabilities API client 
+3scale-api-crd = "*"
+
 [requires]
 python_version = "3"

README.md

@@ -160,6 +160,12 @@ Alternatively it can be set in the configuration.
 `make disruptive NAMESPACE=3scale`
  - tests with side-effect
 
+`make capabilities-smoke NAMESPACE=3scale`
+ - smoke tests using 3scale Capabilities client instead of 3scale API client
+
+`make capabilities-speedrun NAMESPACE=3scale`
+ - speedrun tests using 3scale Capabilities client instead of 3scale API client
+
 Targets can be combined
 
 `make test flaky NAMESPACE=3scale`
@@ -171,6 +177,13 @@ Targets can be combined
 `make ./testsuite/tests/apicast/auth/test_basic_auth_user_key.py NAMESPACE=3scale`
  - to run particular test standalone
 
+### 3scale Capabilities
+
+By default 3scale REST API client is used. 3scale Capabilities client can be used
+instead of 3scale REST API client by using `--capabilities` argument. This argument
+unlock running of specific Capabilities tests. For more information about 3scale Capabilities
+see https://github.com/3scale/3scale-operator/blob/master/doc/operator-application-capabilities.md
+
 ### Test Selection, Marks and Custom Arguments
 
 Selection of tests in the targets described above is based on pytest marks and

pytest.ini

@@ -9,6 +9,7 @@ markers =
 	issue: Reference to covered issue
 	nopersistence: Tests incompatible with persistence plugin
 	skipif_devrelease: Mark tests that should not run on alpha builds
+  nocrcap: Tests which are not compatible with CR capabilities API client
 filterwarnings =
     ignore: WARNING the new order is not taken into account:UserWarning
     ignore::urllib3.exceptions.InsecureRequestWarning

testsuite/rawobj.py

@@ -49,22 +49,35 @@ def Method(system_name: str, friendly_name: str = None, unit: str = "hit"):
 
     if friendly_name is None:
         friendly_name = system_name
+    # pylint: disable=possibly-unused-variable
+    name = system_name
     return locals()
 
 
 # pylint: disable=unused-argument
-def Mapping(metric: dict, pattern: str = "/", http_method: str = "GET", delta: int = 1, last: str = "false"):
+# pylint: disable=too-many-arguments
+def Mapping(
+    metric: dict,
+    pattern: str = "/",
+    http_method: str = "GET",
+    delta: int = 1,
+    last: str = "false",
+    position: int = None,
+):
     """Builder of parameters to create Mapping
     Args:
         :param metric: Metric to be mapped
         :param pattern: URL pattern to map; deafult: /
         :param http_method: Method to map; default: GET
         :param delta: Incremental unit; default: 1
         :param last: If true, no other rules will be processed after
-                     matching this one; default: false"""
+                     matching this one; default: false
+        :param position: position in list of mapping rules"""
 
     metric_id = metric["id"]  # pylint: disable=possibly-unused-variable
     del metric
+    if position is None:
+        del position
     return locals()
 
 
@@ -83,7 +96,12 @@ def Application(
     if description is None:
         description = f"application {name}"
 
-    obj = {"name": name, "plan_id": application_plan["id"], "description": description}
+    obj = {
+        "name": name,
+        "plan_id": application_plan["id"],
+        "description": description,
+        "service_id": application_plan.service["id"],
+    }
 
     if account is not None:
         obj["account_id"] = account["id"]

testsuite/rhsso/__init__.py

@@ -181,7 +181,12 @@ def __init__(self, rhsso_service_info, credentials_location="authorization", oid
         self.credentials_location = credentials_location
         self.oidc_configuration = oidc_configuration
         if self.oidc_configuration is None:
-            self.oidc_configuration = {"standard_flow_enabled": False, "direct_access_grants_enabled": True}
+            self.oidc_configuration = {
+                "standard_flow_enabled": False,
+                "direct_access_grants_enabled": True,
+                "implicit_flow_enabled": False,
+                "service_accounts_enabled": False,
+            }
 
     # pylint: disable=no-self-use
     def before_service(self, service_params: dict) -> dict:

testsuite/tests/apicast/apiap/test_apiap_routing_to_backend.py

@@ -46,7 +46,7 @@ def mapping_rules(service, backend_bin, backend_echo):
         - Add mapping rule with path "/anything/bin"
     """
     proxy = service.proxy.list()
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     test_metric = backend_echo.metrics.list()[0]
     bin_metric = backend_bin.metrics.list()[0]

testsuite/tests/apicast/apiap/test_apiap_routing_with_backend_metrics.py

@@ -51,7 +51,7 @@ def client(api_client, service):
     assert api_client().get("/get").status_code == 200
 
     proxy = service.proxy.list()
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
     proxy.deploy()
 
     return api_client(disable_retry_status_list={404})

testsuite/tests/apicast/apiap/test_apiap_routing_with_product_mapping.py

@@ -45,7 +45,7 @@ def api_client(api_client, service):
 
     assert api_client().get("/bin/anything").status_code == 200
 
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
     proxy.deploy()
 
     return api_client(disable_retry_status_list={404})

testsuite/tests/apicast/apiap/test_backend_routing.py

@@ -44,7 +44,7 @@ def client(api_client, proxy):
 
     assert api_client().get("/echo/anything").status_code == 200
 
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
     proxy.deploy()
 
     return api_client(disable_retry_status_list={404})

testsuite/tests/apicast/apiap/test_proxy_config.py

@@ -19,7 +19,7 @@ def service(custom_service, service_settings):
     """
     Create a custom service without backend
     """
-    return custom_service(service_settings)
+    return custom_service(service_settings, proxy_params={}, backends={})
 
 
 def test_proxy_config(service, private_base_url):

testsuite/tests/apicast/parameters/apicast_path_routing/conftest.py

@@ -10,7 +10,7 @@ def delete_all_mapping_rules(proxy):
     """Deletes all mapping rules in a given proxy."""
     mapping_rules = proxy.mapping_rules.list()
     for mapping_rule in mapping_rules:
-        proxy.mapping_rules.delete(mapping_rule["id"])
+        mapping_rule.delete()
 
 
 @pytest.fixture(scope="module")

testsuite/tests/apicast/parameters/test_proxy_config.py

@@ -44,7 +44,7 @@ def test_proxy_config(service, api_client):
     metric = service.metrics.list()[0]
     mapping_rules = service.proxy.mapping_rules
 
-    mapping_rules.delete(mapping_rules.list()[0]["id"])
+    mapping_rules.list()[0].delete()
     mapping_rules.create(rawobj.Mapping(metric, pattern="/foo"))
     service.proxy.deploy()
 

testsuite/tests/apicast/policy/batcher/test_batcher_policy_mapping_rules.py

@@ -32,7 +32,7 @@ def service(service):
     metric = service.metrics.list()[0]
 
     # delete implicit '/' rule
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     proxy.mapping_rules.create(rawobj.Mapping(metric, pattern="/get"))
 

testsuite/tests/apicast/policy/batcher/test_batcher_policy_nonalphanum_metric.py

@@ -43,7 +43,7 @@ def service(service, metric_name):
     metric = service.metrics.create(rawobj.Metric(metric_name))
 
     # delete implicit '/' rule
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     service.proxy.list().mapping_rules.create(rawobj.Mapping(metric, "/", "GET"))
     service.proxy.list().update()

testsuite/tests/apicast/policy/maintenance_mode/test_maintenance_mode_policy_host.py

@@ -57,7 +57,7 @@ def mapping_rules(service, backend_bin, backend_echo):
         - Add mapping rule with path "/anything/bin"
     """
     proxy = service.proxy.list()
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     test_metric = backend_echo.metrics.list()[0]
     bin_metric = backend_bin.metrics.list()[0]

testsuite/tests/apicast/policy/test_policy_registry.py

@@ -57,7 +57,7 @@ def custom_policies(threescale, schema, request, testconfig):
 
         def _cleanup():
             for policy in policies:
-                threescale.policy_registry.delete(policy["id"])
+                policy.delete()
 
         if not testconfig["skip_cleanup"]:
             request.addfinalizer(_cleanup)

testsuite/tests/apicast/policy/tls/test_tls_path_routing.py

@@ -49,7 +49,7 @@ def delete_all_mapping_rules(proxy):
     """Deletes all mapping rules in a given proxy."""
     mapping_rules = proxy.mapping_rules.list()
     for mapping_rule in mapping_rules:
-        proxy.mapping_rules.delete(mapping_rule["id"])
+        mapping_rule.delete()
 
 
 @pytest.fixture(scope="module")

testsuite/tests/apicast/policy/tls/tls_upstream/tls_passthrough_connection_reuse/conftest.py

@@ -104,7 +104,7 @@ def mapping_rules(service, backend_orig, backend_new):
     Adds the "/" mapping rule to both backends.
     """
     proxy = service.proxy.list()
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     orig_metric = backend_orig.metrics.list()[0]
     new_metric = backend_new.metrics.list()[0]

testsuite/tests/conftest.py

@@ -17,7 +17,9 @@
 import pytest
 from dynaconf.vendor.box.exceptions import BoxKeyError
 from pytest_metadata.plugin import metadata_key
-from threescale_api import client, errors
+from threescale_api_crd import client as crd_client
+from threescale_api import client as rest_client
+from threescale_api import errors
 from weakget import weakget
 
 # to actually initialize all the providers
@@ -51,6 +53,13 @@ def term_handler():
     signal.signal(signal.SIGTERM, orig)
 
 
+@pytest.fixture(scope="session")
+def api_client_type(pytestconfig):
+    """Do tests use REST API client(False) or CR Capabilities client(True)?"""
+
+    return pytestconfig.getoption("capabilities")
+
+
 def pytest_addoption(parser):
     """Add option to include disruptive tests in testrun"""
 
@@ -78,6 +87,9 @@ def pytest_addoption(parser):
         help="Skip tests incompatible with persistence " "plugin (default: False)",
     )
     parser.addoption("--images", action="store_true", default=False, help="Run also image check tests (default: False)")
+    parser.addoption(
+        "--capabilities", action="store_true", default=False, help="Run tests with CR api client (default: False)"
+    )
 
 
 # there are many branches as there are many options to influence test selection
@@ -125,6 +137,10 @@ def pytest_runtest_setup(item):
     else:
         if Capability.APICAST not in CapabilityRegistry():
             pytest.skip(f"Skipping test because current gateway doesn't have implicit capability {Capability.APICAST}")
+    if "/cr_capabilities/" in item.nodeid and not item.config.getoption("--capabilities"):
+        pytest.skip("Excluding CR Capabilities tests")
+    if "nocrcap" in marks and item.config.getoption("--capabilities"):
+        pytest.skip("Excluding tests incompatible with CR capabilities")
 
 
 @pytest.hookimpl(hookwrapper=True)
@@ -374,9 +390,8 @@ def testconfig():
 
 
 @pytest.fixture(scope="session", autouse=True)
-def threescale(testconfig, request):
+def threescale(testconfig, request, api_client_type):
     "Threescale client"
-
     if weakget(testconfig)["fixtures"]["threescale"]["private_tenant"] % False:
         custom_tenant = request.getfixturevalue("custom_tenant")
         password = secrets.token_urlsafe(16)
@@ -399,7 +414,16 @@ def threescale(testconfig, request):
 
         return admin
 
-    return client.ThreeScaleClient(
+    if api_client_type:
+        return crd_client.ThreeScaleClientCRD(
+            testconfig["threescale"]["admin"]["url"],
+            testconfig["threescale"]["admin"]["token"],
+            ssl_verify=testconfig["ssl_verify"],
+            ocp_namespace=testconfig["openshift"]["projects"]["threescale"]["name"],
+            wait=0,
+        )
+
+    return rest_client.ThreeScaleClient(
         testconfig["threescale"]["admin"]["url"],
         testconfig["threescale"]["admin"]["token"],
         ssl_verify=testconfig["ssl_verify"],
@@ -408,10 +432,18 @@ def threescale(testconfig, request):
 
 
 @pytest.fixture(scope="session")
-def master_threescale(testconfig):
+def master_threescale(testconfig, api_client_type):
     """Threescale client using master url and token"""
 
-    return client.ThreeScaleClient(
+    if api_client_type:
+        return crd_client.ThreeScaleClientCRD(
+            testconfig["threescale"]["master"]["url"],
+            testconfig["threescale"]["master"]["token"],
+            ssl_verify=testconfig["ssl_verify"],
+            ocp_namespace=testconfig["openshift"]["projects"]["threescale"]["name"],
+        )
+
+    return rest_client.ThreeScaleClient(
         testconfig["threescale"]["master"]["url"],
         testconfig["threescale"]["master"]["token"],
         ssl_verify=testconfig["ssl_verify"],
@@ -841,6 +873,8 @@ def _custom_service(
                 params["description"] = blame_desc(request, params.get("description"))
 
             svc = threescale_client.services.create(params=params)
+            if len(svc.mapping_rules.list()) == 0:
+                svc.mapping_rules.create(rawobj.Mapping(svc.metrics.list()[0], pattern="/"))
 
             self._autoclean = autoclean
             if not testconfig["skip_cleanup"]:
@@ -851,7 +885,6 @@ def finalizer():
                             hook(svc)
                         except Exception:  # pylint: disable=broad-except
                             pass
-
                     svc.delete()
 
                 with self._lock:

testsuite/tests/system/mapping/test_delete_mapping_rules.py

@@ -9,7 +9,7 @@
 @pytest.fixture(scope="module")
 def service(service):
     """Removes default mapping rule from service"""
-    service.mapping_rules.delete(service.mapping_rules.list()[0].entity_id)
+    service.mapping_rules.list()[0].delete()
     service.proxy.deploy()
     return service
 

testsuite/tests/system/mapping/test_mapping_rules.py

@@ -43,7 +43,7 @@ def service(service, endpoints_and_methods):
     metric = service.metrics.create(rawobj.Metric("metric"))
 
     # delete implicit '/' rule
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
 
     for url, method in endpoints_and_methods:
         proxy.mapping_rules.create(rawobj.Mapping(metric, pattern=url, http_method=method))

testsuite/tests/system/mapping/test_mapping_rules_matching_order_multiple_backends.py

@@ -44,7 +44,7 @@ def proxy(service):
 def delete_mapping(proxy):
     """Deletes all current mapping on the product level"""
     proxy.deploy()
-    proxy.mapping_rules.delete(proxy.mapping_rules.list()[0]["id"])
+    proxy.mapping_rules.list()[0].delete()
     proxy.deploy()
 
 

testsuite/tests/toolbox/test_proxycfg.py

@@ -134,7 +134,7 @@ def test_list1(service, hits, empty_list_staging, create_cmd):
 
     mapping_rules = proxy.mapping_rules.list()
     for mapping_rule in mapping_rules:
-        proxy.mapping_rules.delete(mapping_rule["id"])
+        mapping_rule.delete()
 
     proxy.mapping_rules.create(rawobj.Mapping(hits, "/ip"))
     proxy.mapping_rules.create(rawobj.Mapping(hits, "/anything", "POST"))