From 080531037fe7f5d0f7cff0ae8f6ac91e4f730b09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20Mac=C3=ADk?= Date: Thu, 3 Oct 2024 13:41:16 +0200 Subject: [PATCH] fix(RHIDP-4302): fix test user names introduced in #91 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Pavel Macík --- scenarios/mvp-1dot1.py | 2 +- scenarios/mvp-1dot2.metrics.yaml | 51 +++++ scenarios/mvp-1dot2.py | 339 +++++++++++++++++++++++++++++++ scenarios/mvp.py | 4 +- 4 files changed, 393 insertions(+), 3 deletions(-) create mode 100644 scenarios/mvp-1dot2.metrics.yaml create mode 100644 scenarios/mvp-1dot2.py diff --git a/scenarios/mvp-1dot1.py b/scenarios/mvp-1dot1.py index 532ef5e..4e50eb6 100644 --- a/scenarios/mvp-1dot1.py +++ b/scenarios/mvp-1dot1.py @@ -111,7 +111,7 @@ def on_test_start(environment, **_kwargs): if not isinstance(environment.runner, WorkerRunner): users = [] for i in range(1, int(environment.runner.target_user_count)+1): - users.append(f"test{i}") + users.append(f"t{i}") worker_count = environment.runner.worker_count chunk_size = int(len(users) / worker_count) diff --git a/scenarios/mvp-1dot2.metrics.yaml b/scenarios/mvp-1dot2.metrics.yaml new file mode 100644 index 0000000..2e593bc --- /dev/null +++ b/scenarios/mvp-1dot2.metrics.yaml @@ -0,0 +1,51 @@ +# Results +{%macro results_scenario(name) -%} +- name: results.{{name | replace('.', '_')}}.locust_requests_avg_response_time + monitoring_query: max(locust_requests_avg_response_time{name=~"{{name}}"}) + monitoring_step: 15 +- name: results.{{name | replace('.', '_')}}.locust_requests_avg_content_length + monitoring_query: max(locust_requests_avg_content_length{name=~"{{name}}"}) + monitoring_step: 15 +- name: results.{{name | replace('.', '_')}}.locust_requests_current_rps + monitoring_query: max(locust_requests_current_rps{name=~"{{name}}"}) + monitoring_step: 15 +- name: results.{{name | replace('.', '_')}}.locust_requests_current_fail_per_sec + monitoring_query: max(locust_requests_current_fail_per_sec{name=~"{{name}}"}) + monitoring_step: 15 +- name: results.{{name | replace('.', '_')}}.locust_requests_num_failures + monitoring_query: sum(locust_requests_num_failures{name=~"{{name}}"}) + monitoring_step: 15 +- name: results.{{name | replace('.', '_')}}.locust_errors + monitoring_query: sum(locust_errors{name=~"{{name}}"}) + monitoring_step: 15 +{%- endmacro %} + +{{ results_scenario('/api/auth/oauth2Proxy/refresh') }} +{{ results_scenario('/auth/realms/backstage/login-actions/authenticate\\\\?session_code=.*&.*&client_id=backstage&.*&execution=.*')}} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dapi') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dapi%2Crelations\\\\.ownedBy%3D.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dcomponent') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Duser%3A.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Duser%3A.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+%2Cspec_type%3Dlibrary') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=0&filter=kind%3Dcomponent%2Cspec_type%3Dlibrary') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&cursor=.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&filter=kind%3Dapi%2Crelations\\\\.ownedBy%3Duser%3A.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&filter=kind%3Dcomponent') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Duser%3A.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+') }} +{{ results_scenario('/api/catalog/entities/by-query\\\\?limit=20&orderField=metadata\\\\.name%2Casc&filter=kind%3Dcomponent%2Crelations\\\\.ownedBy%3Duser%3A.+%2Crelations\\\\.ownedBy%3Dgroup%3A.+%2Cspec_type%3Dlibrary') }} +{{ results_scenario('/api/catalog/entities/by-refs') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=kind') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.namespace') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.namespace&filter=kind%3Dapi') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.namespace&filter=kind%3Dcomponent') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.tags') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.tags&filter=kind%3Dapi') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=metadata\\\\.tags&filter=kind%3Dcomponent') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=relations\\\\.ownedBy') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=spec\\\\.lifecycle') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=spec\\\\.lifecycle&filter=kind%3Dapi') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=spec\\\\.lifecycle&filter=kind%3Dcomponent') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=spec\\\\.type&filter=kind%3Dapi') }} +{{ results_scenario('/api/catalog/entity-facets\\\\?facet=spec\\\\.type&filter=kind%3Dcomponent') }} diff --git a/scenarios/mvp-1dot2.py b/scenarios/mvp-1dot2.py new file mode 100644 index 0000000..99ef35c --- /dev/null +++ b/scenarios/mvp-1dot2.py @@ -0,0 +1,339 @@ +from locust import HttpUser, events, task +from locust.runners import MasterRunner, WorkerRunner +from urllib3.exceptions import InsecureRequestWarning +import urllib.parse +import json +import re +import urllib3 + +urllib3.disable_warnings(InsecureRequestWarning) + +__version__ = "1" + +usernames = [] + +entity_facets_params = {} + +entity_facets_params["kind"] = { + "facet": "kind", +} + +entity_facets_params["relations.ownedBy"] = { + "facet": "relations.ownedBy", +} + +entity_facets_params["metadata.namespace"] = { + "facet": "metadata.namespace", +} + +entity_facets_params["spec.lifecycle"] = { + "facet": "spec.lifecycle", +} + +entity_facets_params["metadata.tags"] = { + "facet": "metadata.tags", +} + +entity_facets_params["component/spec.lifecycle"] = { + "facet": "spec.lifecycle", + "filter": "kind=component" +} + +entity_facets_params["component/spec.type"] = { + "facet": "spec.type", + "filter": "kind=component" +} + +entity_facets_params["component/metadata.namespace"] = { + "facet": "metadata.namespace", + "filter": "kind=component" +} + +entity_facets_params["component/metadata.tags"] = { + "facet": "metadata.tags", + "filter": "kind=component" +} + +entity_facets_params["api/spec.lifecycle"] = { + "facet": "spec.lifecycle", + "filter": "kind=api" +} + +entity_facets_params["api/spec.type"] = { + "facet": "spec.type", + "filter": "kind=api" +} + +entity_facets_params["api/metadata.namespace"] = { + "facet": "metadata.namespace", + "filter": "kind=api" +} + +entity_facets_params["api/metadata.tags"] = { + "facet": "metadata.tags", + "filter": "kind=api" +} + + +def get_entities_by_query_params(kind=None, limit=0, user_ref=None, group_ref=None, additional_filter={}, additional_params={}): + params = {} + params["limit"] = limit + if limit > 0: + params["orderField"] = "metadata.name,asc" + filter = "" + if kind is not None: + filter = f"kind={kind}" + if user_ref is not None: + filter += f",relations.ownedBy={user_ref}" + if group_ref is not None: + filter += f",relations.ownedBy={group_ref}" + if len(additional_filter) > 0: + for k, v in additional_filter.items(): + filter += f",{k}={v}" + if len(filter) > 0: + params["filter"] = filter + + params.update(additional_params) + return params + + +base_path_facets = "/api/catalog/entity-facets" +base_path_entities = "/api/catalog/entities" + + +def setup_test_users(environment, msg, **kwargs): + # Fired when the worker receives a message of type 'test_users' + usernames.extend(map(lambda u: u, msg.data)) + + +@events.init.add_listener +def on_locust_init(environment, **_kwargs): + if not isinstance(environment.runner, MasterRunner): + environment.runner.register_message("test_users", setup_test_users) + + +@events.test_start.add_listener +def on_test_start(environment, **_kwargs): + # When the test is started, evenly divides list between + # worker nodes to ensure unique data across threads + if not isinstance(environment.runner, WorkerRunner): + users = [] + for i in range(1, int(environment.runner.target_user_count)+1): + users.append(f"t{i}") + + worker_count = environment.runner.worker_count + chunk_size = int(len(users) / worker_count) + + for i, worker in enumerate(environment.runner.clients): + start_index = i * chunk_size + + if i + 1 < worker_count: + end_index = start_index + chunk_size + else: + end_index = len(users) + + data = users[start_index:end_index] + environment.runner.send_message("test_users", data, worker) + + +@events.init_command_line_parser.add_listener +def _(parser): + parser.add_argument("--keycloak-host", type=str, default="") + parser.add_argument("--keycloak-password", is_secret=True, default="") + parser.add_argument("--debug", type=bool, default=False) + + +class MVP1dot2Test(HttpUser): + + def on_start(self): + self.client.verify = False + if self.environment.parsed_options.keycloak_host: + r = self.client.get('/api/auth/oauth2Proxy/refresh', verify=False) + qs_str = urllib.parse.parse_qs(r.url) + STATE = qs_str['state'] + login_cookies = r.cookies + pattern = r'action="([^"]*)"' + LOGIN_URL_tmp = re.findall(pattern, str(r.content))[0] + LOGIN_URL = LOGIN_URL_tmp.replace("&", "&") + qs_str = urllib.parse.parse_qs(LOGIN_URL) + TAB_ID = qs_str['tab_id'] + EXECUTION = qs_str['execution'] + + param = {'client_id': self.CLIENTID, + 'tab_id': TAB_ID, 'execution': EXECUTION} + form = {'username': self.USERNAME, + 'password': self.PASSWORD, 'credentialId': ''} + r = self.client.post(LOGIN_URL, verify=False, + data=form, params=param) + + r = self.client.get(self.REFRESH_URL, verify=False) + json_dict = json.loads(r.content) + TOKEN = json_dict['backstageIdentity']['token'] + idetity_refs = json_dict['backstageIdentity']['identity']['ownershipEntityRefs'] + for id_ref in idetity_refs: + if str(id_ref).startswith("group"): + self.GROUP_REF = id_ref + continue + if str(id_ref).startswith("user"): + self.USER_REF = id_ref + + self.HEADER = {'Authorization': 'Bearer ' + TOKEN} + else: + r = self.client.get('/api/auth/guest/refresh', verify=False) + json_dict = json.loads(r.content) + TOKEN = json_dict['backstageIdentity']['token'] + + idetity_refs = json_dict['backstageIdentity']['identity']['ownershipEntityRefs'] + for id_ref in idetity_refs: + if str(id_ref).startswith("user"): + self.USER_REF = id_ref + if "guest" in str(id_ref): + self.GROUP_REF = None + break + continue + if str(id_ref).startswith("group"): + self.GROUP_REF = id_ref + + self.HEADER = {'Authorization': 'Bearer ' + TOKEN} + + def __init__(self, parent): + super().__init__(parent) + self.HEADER = '' + if self.environment.parsed_options.keycloak_host: + self.USERNAME = usernames.pop() + kc_host = self.environment.parsed_options.keycloak_host + self.KEYCLOAK_URL = f'https://{kc_host}/auth' + bs_host = self.environment.host + self.REDIRECT_URL = f'{bs_host}/oauth2/callback' + self.REFRESH_URL = f'{bs_host}/api/auth/oauth2Proxy/refresh' + + self.PASSWORD = self.environment.parsed_options.keycloak_password + self.REALM = "backstage" + self.CLIENTID = "backstage" + + def entitiy_facets(self, query) -> None: + self.client.get(base_path_facets, + verify=False, + headers=self.HEADER, + params=entity_facets_params[query]) + + def entities_by_query(self, kind=None, limit=0, user_ref=None, group_ref=None, additional_filter={}, additional_params={}): + r = self.client.get(f"{base_path_entities}/by-query", + verify=False, + headers=self.HEADER, + params=get_entities_by_query_params(kind, limit, user_ref, group_ref, additional_filter, additional_params)) + if self.environment.parsed_options.debug: + size = sum(len(chunk) for chunk in r.iter_content(8196)) + debug_output = f"\n[DEBUG][entities_by_query]" + debug_output += f" kind={kind}" + debug_output += f", limit={limit}" + debug_output += f", user_ref={user_ref}" + debug_output += f", group_ref={group_ref}" + debug_output += f", additional_filter={additional_filter}" + debug_output += f", additional_params={additional_params}" + debug_output += f", response_size={size}" + debug_output += f", response={r.content}\n" + print(debug_output) + return r + + def entities_by_refs(self, refs=[]): + entity_refs = {"entityRefs": refs} + r = self.client.post(f"{base_path_entities}/by-refs", + verify=False, + headers=self.HEADER, + json=entity_refs) + if self.environment.parsed_options.debug: + size = sum(len(chunk) for chunk in r.iter_content(8196)) + debug_output = f"\n[DEBUG][entities_by_refs]" + debug_output += f", refs={refs}" + debug_output += f", response_size={size}" + debug_output += f", response={r.content}\n" + print(debug_output) + + @task + def execute(self) -> None: + # Load Catalog + group_ref = self.GROUP_REF + if "guest" in self.USER_REF: + group_ref = "group:default/group1" + self.entitiy_facets("relations.ownedBy") + self.entitiy_facets("kind") + self.entitiy_facets("spec.lifecycle") + self.entitiy_facets("metadata.tags") + self.entitiy_facets("metadata.namespace") + self.entities_by_query(kind="component", limit=20) + self.entities_by_query(kind="component", limit=20) + self.entitiy_facets("component/spec.type") + self.entities_by_query( + kind="component", limit=0, + user_ref=self.USER_REF, group_ref=group_ref) + self.entities_by_query(kind="component", limit=0) + self.entitiy_facets("component/spec.lifecycle") + self.entitiy_facets("component/metadata.tags") + self.entitiy_facets("component/metadata.namespace") + self.entities_by_refs([group_ref]) + self.entities_by_query( + kind="component", limit=20, + user_ref=self.USER_REF, group_ref=group_ref) + + # Switch to API + self.entities_by_query( + kind="api", limit=20, + user_ref=self.USER_REF, group_ref=group_ref) + self.entitiy_facets("api/spec.type") + self.entities_by_query( + kind="api", limit=0, + user_ref=self.USER_REF, group_ref=group_ref) + self.entities_by_query(kind="api", limit=0) + self.entitiy_facets("api/spec.lifecycle") + self.entitiy_facets("api/metadata.tags") + self.entitiy_facets("api/metadata.namespace") + + # Switch to Component + self.entities_by_query( + kind="component", limit=20, + user_ref=self.USER_REF, group_ref=group_ref) + self.entitiy_facets("component/spec.lifecycle") + self.entities_by_query( + kind="component", limit=0, + user_ref=self.USER_REF, group_ref=group_ref) + self.entities_by_query(kind="component", limit=0) + self.entitiy_facets("component/spec.lifecycle") + self.entitiy_facets("component/metadata.tags") + self.entitiy_facets("component/metadata.namespace") + self.entities_by_refs([group_ref]) + + # Select "library" + self.entities_by_query( + kind="component", limit=20, + user_ref=self.USER_REF, group_ref=group_ref, + additional_filter={"spec_type": "library"}) + self.entities_by_query( + kind="component", limit=0, + user_ref=self.USER_REF, group_ref=group_ref, + additional_filter={"spec_type": "library"}) + self.entities_by_query( + kind="component", limit=0, + additional_filter={"spec_type": "library"}) + self.entities_by_query(kind="component", limit=20) + self.entities_by_refs([group_ref]) + + # Select "all" + self.entities_by_query( + kind="component", limit=20, + group_ref=group_ref) + self.entities_by_query( + kind="component", limit=0, + group_ref=group_ref) + self.entities_by_refs([group_ref]) + + # Select/Load next page + r = self.entities_by_query( + kind="component", limit=20, + group_ref=group_ref) + json_dict = json.loads(r.content) + page_info = json_dict["pageInfo"] + if len(page_info) > 0: + self.entities_by_query( + limit=20, + additional_params={"cursor": page_info["nextCursor"]}) diff --git a/scenarios/mvp.py b/scenarios/mvp.py index 95b525e..e978be3 100644 --- a/scenarios/mvp.py +++ b/scenarios/mvp.py @@ -119,7 +119,7 @@ def on_test_start(environment, **_kwargs): if not isinstance(environment.runner, WorkerRunner): users = [] for i in range(1, int(environment.runner.target_user_count)+1): - users.append(f"test{i}") + users.append(f"t{i}") worker_count = environment.runner.worker_count chunk_size = int(len(users) / worker_count) @@ -143,7 +143,7 @@ def _(parser): parser.add_argument("--debug", type=bool, default=False) -class MVP1dot2Test(HttpUser): +class MVP1dot3Test(HttpUser): def on_start(self): self.client.verify = False