alita-sdk 0.3.161__py3-none-any.whl → 0.3.163__py3-none-any.whl

alita_sdk/tools/zephyr_squad/api_wrapper.py

@@ -0,0 +1,135 @@
+from typing import List, Literal
+
+from pydantic import model_validator, create_model, Field, SecretStr, BaseModel, PrivateAttr
+
+from .zephyr_squad_cloud_client import ZephyrSquadCloud
+from ..elitea_base import BaseToolApiWrapper
+
+
+class ZephyrSquadApiWrapper(BaseToolApiWrapper):
+    account_id: str
+    access_key: str
+    secret_key: SecretStr
+    _client: ZephyrSquadCloud = PrivateAttr()
+
+    @model_validator(mode='before')
+    @classmethod
+    def validate_toolkit(cls, values):
+        account_id = values.get("account_id", None)
+        access_key = values.get("access_key", None)
+        secret_key = values.get("secret_key", None)
+        if not account_id:
+            raise ValueError("account_id is required.")
+        if not access_key:
+            raise ValueError("access_key is required.")
+        if not secret_key:
+            raise ValueError("secret_key is required.")
+        cls._client = ZephyrSquadCloud(
+            account_id=account_id,
+            access_key=access_key,
+            secret_key=secret_key
+        )
+        return values
+
+    def get_test_step(self, issue_id, step_id, project_id):
+        """Retrieve details for a specific test step in a Jira test case."""
+        return self._client.get_test_step(issue_id, step_id, project_id)
+
+    def update_test_step(self, issue_id, step_id, project_id, json):
+        """Update the content or a specific test step in a Jira test case."""
+        return self._client.update_test_step(issue_id, step_id, project_id, json)
+
+    def delete_test_step(self, issue_id, step_id, project_id):
+        """Remove a specific test step from a Jira test case."""
+        return self._client.delete_test_step(issue_id, step_id, project_id)
+
+    def create_new_test_step(self, issue_id, project_id, json):
+        """Add a new test step to a Jira test case."""
+        return self._client.create_new_test_step(issue_id, project_id, json)
+
+    def get_all_test_steps(self, issue_id, project_id):
+        """List all test steps associated with a Jira test case."""
+        return self._client.get_all_test_steps(issue_id, project_id)
+
+    def get_all_test_step_statuses(self):
+        """Retrieve all possible statuses for test steps in Jira."""
+        return self._client.get_all_test_step_statuses()
+
+    def get_available_tools(self):
+        return [
+            {
+                "name": "get_test_step",
+                "description": self.get_test_step.__doc__,
+                "args_schema": ProjectIssueStep,
+                "ref": self.get_test_step,
+            },
+            {
+                "name": "update_test_step",
+                "description": self.update_test_step.__doc__,
+                "args_schema": UpdateTestStep,
+                "ref": self.update_test_step,
+            },
+            {
+                "name": "delete_test_step",
+                "description": self.delete_test_step.__doc__,
+                "args_schema": ProjectIssueStep,
+                "ref": self.delete_test_step,
+            },
+            {
+                "name": "create_new_test_step",
+                "description": self.create_new_test_step.__doc__,
+                "args_schema": CreateNewTestStep,
+                "ref": self.create_new_test_step,
+            },
+            {
+                "name": "get_all_test_steps",
+                "description": self.get_all_test_steps.__doc__,
+                "args_schema": ProjectIssue,
+                "ref": self.get_all_test_steps,
+            },
+            {
+                "name": "get_all_test_step_statuses",
+                "description": self.get_all_test_step_statuses.__doc__,
+                "args_schema": create_model("NoInput"),
+                "ref": self.get_all_test_step_statuses,
+            }
+        ]
+
+
+ProjectIssue = create_model(
+    "ProjectIssue",
+    issue_id=(int, Field(description="Jira ticket id of test case to which the test step belongs.")),
+    project_id=(int, Field(description="Jira project id to which test case belongs."))
+)
+
+ProjectIssueStep = create_model(
+    "ProjectIssueStep",
+    step_id=(str, Field(description="Test step id to operate.")),
+    __base__=ProjectIssue
+)
+
+UpdateTestStep = create_model(
+    "UpdateTestStep",
+    json=(str, Field(description=(
+            "JSON body to update a Zephyr test step. Fields:\n"
+            "- id (string, required): Unique identifier for the test step. Example: \"0001481146115453-3a0480a3ffffc384-0001\"\n"
+            "- step (string, required): Description of the test step. Example: \"Sample Test Step\"\n"
+            "- data (string, optional): Test data used in this step. Example: \"Sample Test Data\"\n"
+            "- result (string, optional): Expected result after executing the step. Example: \"Expected Test Result\"\n"
+            "- customFieldValues (array[object], optional): List of custom field values for the test step. Each object contains:\n"
+            "    - customFieldId (string, required): ID of the custom field. Example: \"3ce1c679-7c43-4d37-89f6-757603379e31\"\n"
+            "    - value (object, required): Value for the custom field. Example: {\"value\": \"08/21/2018\"}\n"
+            "*IMPORTANT*: Use double quotes for all field names and string values."))),
+    __base__=ProjectIssueStep
+)
+
+CreateNewTestStep = create_model(
+    "CreateNewTestStep",
+    json=(str, Field(description=(
+            "JSON body to create a Zephyr test step. Fields:\n"
+            "- step (string, required): Description of the test step. Example: \"Sample Test Step\"\n"
+            "- data (string, optional): Test data used in this step. Example: \"Sample Test Data\"\n"
+            "- result (string, optional): Expected result after executing the step. Example: \"Expected Test Result\"\n"
+            "*IMPORTANT*: Use double quotes for all field names and string values."))),
+    __base__=ProjectIssue
+)

alita_sdk/tools/zephyr_squad/zephyr_squad_cloud_client.py

@@ -0,0 +1,79 @@
+import hashlib
+import time
+
+import jwt
+import requests
+from langchain_core.tools import ToolException
+
+
+class ZephyrSquadCloud(object):
+    """
+    Reference: https://zephyrsquad.docs.apiary.io//
+    """
+
+    def __init__(self, account_id, access_key, secret_key):
+        self.account_id = account_id
+        self.access_key = access_key
+        self.secret_key = secret_key
+        self.base_url = "https://prod-api.zephyr4jiracloud.com/connect"
+
+    def get_test_step(self, issue_id, step_id, project_id):
+        canonical_path = "/public/rest/api/1.0/teststep/issueId/id?projectId="
+        api_path = f"/public/rest/api/1.0/teststep/{issue_id}/{step_id}?projectId={project_id}"
+        return self._do_request(method="GET", api_path=api_path, canonical_path=canonical_path)
+
+    def update_test_step(self, issue_id, step_id, project_id, json):
+        canonical_path = "/public/rest/api/1.0/teststep/issueId/id?projectId="
+        api_path = f"/public/rest/api/1.0/teststep/{issue_id}/{step_id}?projectId={project_id}"
+        return self._do_request(method="PUT", api_path=api_path, canonical_path=canonical_path, json=json)
+
+    def delete_test_step(self, issue_id, step_id, project_id):
+        canonical_path = "/public/rest/api/1.0/teststep/issueId/id?projectId="
+        api_path = f"/public/rest/api/1.0/teststep/{issue_id}/{step_id}?projectId={project_id}"
+        return self._do_request(method="DELETE", api_path=api_path, canonical_path=canonical_path)
+
+    def create_new_test_step(self, issue_id, project_id, json):
+        canonical_path = "/public/rest/api/1.0/teststep/issueId?projectId="
+        api_path = f"/public/rest/api/1.0/teststep/{issue_id}?projectId={project_id}"
+        return self._do_request(method="POST", api_path=api_path, canonical_path=canonical_path, json=json)
+
+    def get_all_test_steps(self, issue_id, project_id):
+        canonical_path = "/public/rest/api/2.0/teststep/issueId?projectId="
+        api_path = f"/public/rest/api/2.0/teststep/{issue_id}?projectId={project_id}"
+        return self._do_request(method='GET', api_path=api_path, canonical_path=canonical_path)
+
+    def get_all_test_step_statuses(self):
+        api_path = "/public/rest/api/1.0/teststep/statuses"
+        return self._do_request(method='GET', api_path=api_path)
+
+    def _do_request(self, method, api_path, canonical_path=None, json=None):
+        url = f"{self.base_url}{api_path}"
+        headers = {
+            "Authorization": f"JWT {self._generate_jwt_token(method, canonical_path or api_path)}",
+            "zapiAccessKey": self.access_key,
+            "Content-Type": "application/json"
+        }
+
+        try:
+            resp = requests.request(method=method, url=url, json=json, headers=headers)
+
+            if resp.ok:
+                if resp.headers.get("Content-Type", "").startswith("application/json"):
+                    return str(resp.json())
+                else:
+                    return resp.text
+            else:
+                raise ToolException(f"Request failed with status {resp.status_code}: {resp.text}")
+        except Exception as e:
+            raise ToolException(f"Error performing request {method}:{api_path}: {e}")
+
+    def _generate_jwt_token(self, method, path):
+        canonical_path = f"{method}&{path}&"
+        payload_token = {
+            'sub': self.account_id,
+            'qsh': hashlib.sha256(canonical_path.encode('utf-8')).hexdigest(),
+            'iss': self.access_key,
+            'exp': int(time.time()) + 3600,
+            'iat': int(time.time())
+        }
+        return jwt.encode(payload_token, self.secret_key, algorithm='HS256').strip()

{alita_sdk-0.3.161.dist-info → alita_sdk-0.3.163.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alita_sdk
-Version: 0.3.161
+Version: 0.3.163
 Summary: SDK for building langchain agents using resources from Alita
 Author-email: Artem Rozumenko <artyom.rozumenko@gmail.com>, Mikalai Biazruchka <mikalai_biazruchka@epam.com>, Roman Mitusov <roman_mitusov@epam.com>, Ivan Krakhmaliuk <lifedjik@gmail.com>
 License-Expression: Apache-2.0

{alita_sdk-0.3.161.dist-info → alita_sdk-0.3.163.dist-info}/RECORD

@@ -129,7 +129,7 @@ alita_sdk/runtime/utils/logging.py,sha256=svPyiW8ztDfhqHFITv5FBCj8UhLxz6hWcqGIY6
 alita_sdk/runtime/utils/save_dataframe.py,sha256=i-E1wp-t4wb17Zq3nA3xYwgSILjoXNizaQAA9opWvxY,1576
 alita_sdk/runtime/utils/streamlit.py,sha256=z4J_bdxkA0zMROkvTB4u379YBRFCkKh-h7PD8RlnZWQ,85644
 alita_sdk/runtime/utils/utils.py,sha256=dM8whOJAuFJFe19qJ69-FLzrUp6d2G-G6L7d4ss2XqM,346
-alita_sdk/tools/__init__.py,sha256=qsF21SiBa7P5gcWybCLP4K3xqA34LW9TVuM1QKaU-xc,9716
+alita_sdk/tools/__init__.py,sha256=Ttjp6AVkjuh-WqGE_cc_nUwi4qvU1khf7_BVKdwO7gU,9801
 alita_sdk/tools/elitea_base.py,sha256=NQaIxPX6DVIerHCb18jwUR6maZxxk73NZaTsFHkBQWE,21119
 alita_sdk/tools/ado/__init__.py,sha256=mD6GHcYMTtffPJkJvFPe2rzvye_IRmXmWfI7xYuZhO4,912
 alita_sdk/tools/ado/utils.py,sha256=PTCludvaQmPLakF2EbCGy66Mro4-rjDtavVP-xcB2Wc,1252
@@ -160,14 +160,20 @@ alita_sdk/tools/browser/google_search_rag.py,sha256=QVHFbVwymiJGuno_HLSJOK1c_Mpg
 alita_sdk/tools/browser/utils.py,sha256=4k3YM_f1Kqlhjz9vt2pNsGkvCjhy-EmY3nvcwdFCsLA,2501
 alita_sdk/tools/browser/wiki.py,sha256=Qh3HBFd4dkS2VavXbFJOm4b8SjVSIe5xSD7CY1vEkKE,1126
 alita_sdk/tools/carrier/__init__.py,sha256=pP-nk-dpqOkrvwcRY_szgwqoowyVNl_GobD4Inp-Qus,4435
-alita_sdk/tools/carrier/api_wrapper.py,sha256=Ns0lGbtGKRGBTdOWseWtz4heyY3hP4AcnB9QEx_d5JU,5344
+alita_sdk/tools/carrier/api_wrapper.py,sha256=smcc1Q7H6U1_18qDYBFpeGnu5cX3OrsUoKaSn3s6vkw,8728
 alita_sdk/tools/carrier/backend_reports_tool.py,sha256=WNZVGBIZusakOdbd7lG6o6xL180VZfER-uDw_SSGupo,11005
 alita_sdk/tools/carrier/backend_tests_tool.py,sha256=arq275qiP9t3ST-MPn7FlxbLLSPiIGEnyPdgJ-AvOoQ,5917
-alita_sdk/tools/carrier/carrier_sdk.py,sha256=1QXbO3BrIYaZFd30GZzATXw9Wfh8ga7CfmUihD9ueks,9709
+alita_sdk/tools/carrier/cancel_ui_test_tool.py,sha256=pD1sKEcZGBWJqFpgjeohMk93uuUPWruVJRPVVg90rpo,6438
+alita_sdk/tools/carrier/carrier_sdk.py,sha256=sYdPWcpH8ti0MggOvU2pbsKYiaKR1zuXlbiCtcTfc3A,12913
+alita_sdk/tools/carrier/create_ui_excel_report_tool.py,sha256=sYAz54ILk8CIF_n76zH_hcmbW9xw7oTNnf_d9d-N-_Q,20171
+alita_sdk/tools/carrier/create_ui_test_tool.py,sha256=sHi7-D1uqIUHEyoywI92h6MdUVybKfBXs_XttTu-Ck4,8624
 alita_sdk/tools/carrier/excel_reporter.py,sha256=fXptz7iaBDBcFSc8Ah8nZ9CSgugTONc5JMC1XcQEnfM,21487
+alita_sdk/tools/carrier/lighthouse_excel_reporter.py,sha256=mVuU63tl2n-Gntx9RuedjEU0U5AP1APKsSx1DvJs7wk,6684
+alita_sdk/tools/carrier/run_ui_test_tool.py,sha256=vmEtP-cpnOCyLLZfbw9Nq2ItGUFlcnsf1LmI_XyLrM8,21053
 alita_sdk/tools/carrier/tickets_tool.py,sha256=d-wFyFWWTvV01o-hyssb2S-oLnr51b6tlNTUqA_CohY,8099
-alita_sdk/tools/carrier/tools.py,sha256=GeV5KtB3kfMygQ9y-z2Mgk2x0A2pg0SRoZkev3Dqx-M,996
-alita_sdk/tools/carrier/ui_reports_tool.py,sha256=haOZuGWYsLg2rj_dO1zaPpUmj77Rxjs8e4LyTaqeV1E,13525
+alita_sdk/tools/carrier/tools.py,sha256=cCLYcNzC_z0-AaqB46fyt7iOeP20LStVQKI5Dg1zWA4,1588
+alita_sdk/tools/carrier/ui_reports_tool.py,sha256=Y6EstTRCa9d11ipFUFGOYlpiEhFx7aOQcgZ_M5Gd1lQ,13708
+alita_sdk/tools/carrier/update_ui_test_schedule_tool.py,sha256=jh9Q86cMCEqpsFopJPNIP0wlr7sYVa_3lhlq6lRmkGg,11850
 alita_sdk/tools/carrier/utils.py,sha256=rl7aq-F6ed_PapDM15w8EtS0BkgsjpDrNdKYuDCMOaI,4376
 alita_sdk/tools/chunkers/__init__.py,sha256=myaBVvPbUsz6PXtBDpA4EiPQgLvIv3q_WPh86kxlccI,774
 alita_sdk/tools/chunkers/models.py,sha256=NNkLSljZboYDj6vbqeHmcjj9JrTHbkVWmoHGsL98q3k,3032
@@ -220,11 +226,11 @@ alita_sdk/tools/elastic/__init__.py,sha256=iwnSRppRpzvJ1da2K3Glu8Uu41MhBDCYbgubo
 alita_sdk/tools/elastic/api_wrapper.py,sha256=pl8CqQxteJAGwyOhMcld-ZgtOTFwwbv42OITQVe8rM0,1948
 alita_sdk/tools/figma/__init__.py,sha256=rtEebf9zj1zUD0bpkN-SupaYpjmHFM01gY8XZNE9TI0,4088
 alita_sdk/tools/figma/api_wrapper.py,sha256=G96pEp_qUOouwkM5xMqRg-Ywfx_kEey8NV8iO7YLodE,17190
-alita_sdk/tools/github/__init__.py,sha256=s-ejtyNXjQ3Wo-QhLMJkOSab-qY5ZJC6V_df0GuS3ro,6337
-alita_sdk/tools/github/api_wrapper.py,sha256=-98miPAF_JQMIEDT3g8KS6QJ7bHMUSlj4s38zXyFJ2M,8281
-alita_sdk/tools/github/github_client.py,sha256=bzVXim8U-QH6RzlkAzIUiTrhD4MDi3Xs4pKxVdghvhc,79465
+alita_sdk/tools/github/__init__.py,sha256=YPpZPPhRUHWKJ9aaMJnkjl9xrnAij1YB9C2TMRnlaTI,6388
+alita_sdk/tools/github/api_wrapper.py,sha256=qyIrwPg07TFsTB1l95soy1xsJIuxfKOWTWUdLZCmTA4,8365
+alita_sdk/tools/github/github_client.py,sha256=YKhLDMq0VF1KM_Get2JKj-YsipwozeSX8xdcCaM4XvI,85395
 alita_sdk/tools/github/graphql_client_wrapper.py,sha256=d3AGjzLGH_hdQV2V8HeAX92dJ4dlnE5OXqUlCO_PBr0,71539
-alita_sdk/tools/github/schemas.py,sha256=6BAzeGaXkyS-rde2gJDi3xqic161de1PBh-CrlOgK_4,12826
+alita_sdk/tools/github/schemas.py,sha256=9JfJ3nYdFeT30dOwZH6QZyZYMT8v8HrKq1jOv6Xn-Gs,13739
 alita_sdk/tools/github/tool.py,sha256=Jnnv5lenV5ds8AAdyo2m8hSzyJ117HZBjzHC6T1ck-M,1037
 alita_sdk/tools/github/tool_prompts.py,sha256=y6ZW_FpUCE87Uop3WuQAZVRnzxO5t7xjBOI5bCqiluw,30194
 alita_sdk/tools/gitlab/__init__.py,sha256=_nbp3tJviTZxfewyV3Hp9-TK1vCxTmqlxhpwv0f_x4Y,3602
@@ -317,8 +323,11 @@ alita_sdk/tools/zephyr_enterprise/api_wrapper.py,sha256=Ir3zHljhbZQJRJJQOBzS_GL5
 alita_sdk/tools/zephyr_enterprise/zephyr_enterprise.py,sha256=hV9LIrYfJT6oYp-ZfQR0YHflqBFPsUw2Oc55HwK0H48,6809
 alita_sdk/tools/zephyr_scale/__init__.py,sha256=2NTcdrfkx4GSegqyXhsPLsEpc4FlACuDy85b0fk6cAo,4572
 alita_sdk/tools/zephyr_scale/api_wrapper.py,sha256=UHVQUVqcBc3SZvDfO78HSuBzwAsRw2cCDQa-xMOzndE,68663
-alita_sdk-0.3.161.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-alita_sdk-0.3.161.dist-info/METADATA,sha256=ybWYeKeLOJiQcnasyPl7i0jE6OTcqEmuVfmid62TT3A,18667
-alita_sdk-0.3.161.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-alita_sdk-0.3.161.dist-info/top_level.txt,sha256=0vJYy5p_jK6AwVb1aqXr7Kgqgk3WDtQ6t5C-XI9zkmg,10
-alita_sdk-0.3.161.dist-info/RECORD,,
+alita_sdk/tools/zephyr_squad/__init__.py,sha256=rq4jOb3lRW2GXvAguk4H1KinO5f-zpygzhBJf-E1Ucw,2773
+alita_sdk/tools/zephyr_squad/api_wrapper.py,sha256=iOMxyE7vOc_LwFB_nBMiSFXkNtvbptA4i-BrTlo7M0A,5854
+alita_sdk/tools/zephyr_squad/zephyr_squad_cloud_client.py,sha256=IYUJoMFOMA70knLhLtAnuGoy3OK80RuqeQZ710oyIxE,3631
+alita_sdk-0.3.163.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+alita_sdk-0.3.163.dist-info/METADATA,sha256=3Fd8T3ods52lKrlnTjGDxEAn_svB00x64xg65cCi8rY,18667
+alita_sdk-0.3.163.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+alita_sdk-0.3.163.dist-info/top_level.txt,sha256=0vJYy5p_jK6AwVb1aqXr7Kgqgk3WDtQ6t5C-XI9zkmg,10
+alita_sdk-0.3.163.dist-info/RECORD,,