alita-sdk 0.3.257__py3-none-any.whl → 0.3.562__py3-none-any.whl

alita_sdk/tools/zephyr_essential/api_wrapper.py

@@ -1,15 +1,17 @@
+import hashlib
 import json
 import logging
 from typing import Optional, Generator, Literal
 from pydantic import model_validator, create_model, Field, SecretStr, PrivateAttr
 
 from .client import ZephyrEssentialAPI
-from ..elitea_base import extend_with_vector_tools, BaseVectorStoreToolApiWrapper
 from langchain_core.documents import Document
 from langchain_core.tools import ToolException
 
 from ..non_code_indexer_toolkit import NonCodeIndexerToolkit
 from ..utils.available_tools_decorator import extend_with_parent_available_tools
+from ..utils.content_parser import file_extension_by_chunker
+from ...runtime.utils.utils import IndexerKeywords
 
 
 class ZephyrEssentialApiWrapper(NonCodeIndexerToolkit):
@@ -180,12 +182,43 @@ class ZephyrEssentialApiWrapper(NonCodeIndexerToolkit):
     def create_folder(self, json: str):
         """Create a new folder."""
         folder_data = self._parse_json(json)
+        if 'parentId' not in folder_data:
+            if 'parentName' in folder_data:
+                parent_folder_name = folder_data['parentName']
+
+                parent_folder = self.find_folder_by_name(parent_folder_name)
+
+                if isinstance(parent_folder, ToolException):
+                    return ToolException(f"Folder with name '{parent_folder_name}' not found.")
+                else:
+                    folder_data['parentId'] = parent_folder['id']
+
         return self._client.create_folder(folder_data)
 
     def get_folder(self, folder_id: str):
         """Retrieve details of a specific folder."""
         return self._client.get_folder(folder_id)
 
+    def find_folder_by_name(self, name: str, project_key: Optional[str] = None, folder_type: Optional[str] = None):
+        """
+        Find a folder by its name, ignoring case.
+
+        :param name: The name of the folder to search for.
+        :param project_key: Optional filter by project key.
+        :param folder_type: Optional filter by folder type.
+        :return: The folder details if found, otherwise None.
+        """
+        # Fetch all folders with optional filters
+        folders = self.list_folders(project_key=project_key, folder_type=folder_type)
+
+        # Iterate through the folders and search for the matching name
+        for folder in folders['values']:
+            if folder.get('name', '').lower() == name.lower():
+                return folder
+
+        # Return None if no folder is found
+        return ToolException(f"Folder with name {name} was not found")
+
     def delete_link(self, link_id: str):
         """Delete a specific link."""
         return self._client.delete_link(link_id)
@@ -236,11 +269,11 @@ class ZephyrEssentialApiWrapper(NonCodeIndexerToolkit):
 
     def _index_tool_params(self):
         return {
-            'chunking_tool':(Literal[None, 'json'],
-                           Field(description="Name of chunking tool", default='json'))
+            'chunking_tool':(Literal['json', ''], Field(description="Name of chunking tool", default='json'))
         }
 
     def _base_loader(self, **kwargs) -> Generator[Document, None, None]:
+        self._chunking_tool = kwargs.get('chunking_tool', None)
         try:
             test_cases = self.list_test_cases()
         except Exception as e:
@@ -252,27 +285,29 @@ class ZephyrEssentialApiWrapper(NonCodeIndexerToolkit):
                 if isinstance(v, (str, int, float, bool, list, dict))
             }
             metadata['type'] = "TEST_CASE"
-
+            #
+            try:
+                additional_content = self._process_test_case(metadata['key'])
+                for steps_type, content in additional_content.items():
+                    if content:
+                        page_content = json.dumps(content)
+                        content_hash = hashlib.sha256(page_content.encode('utf-8')).hexdigest()
+                        metadata[IndexerKeywords.UPDATED_ON.value] = content_hash
+                        metadata[IndexerKeywords.CONTENT_IN_BYTES.value] = page_content.encode('utf-8')
+                        metadata["steps_type"] = steps_type
+            except Exception as e:
+                logging.error(f"Failed to process document: {e}")
+            #
             yield Document(page_content="", metadata=metadata)
 
-    def _extend_data(self, documents: Generator[Document, None, None]) -> Generator[Document, None, None]:
-        for document in documents:
-            try:
-                if document.metadata['type'] and document.metadata['type'] == "TEST_CASE":
-                    additional_content = self._process_test_case(document.metadata['key'])
-                    document.page_content = json.dumps(additional_content)
-            except json.JSONDecodeError as e:
-                logging.error(f"Failed to decode JSON from document: {e}")
-            yield document
-
-    def _process_test_case(self, key):
+    def _process_test_case(self, key) -> dict:
         steps = self.get_test_case_test_steps(key)
+        if steps and not isinstance(steps, ToolException):
+            return {"steps": steps}
         script = self.get_test_case_test_script(key)
-        additional_content = {
-            "steps": "" if isinstance(steps, ToolException) else steps,
-            "script": "" if isinstance(script, ToolException) else script,
-        }
-        return additional_content
+        if script and not isinstance(script, ToolException):
+            return {"script": script}
+        return {"empty": ""}
 
     @extend_with_parent_available_tools
     def get_available_tools(self):
@@ -481,6 +516,12 @@ class ZephyrEssentialApiWrapper(NonCodeIndexerToolkit):
                 "args_schema": GetFolder,
                 "ref": self.get_folder,
             },
+            {
+                "name": "find_folder_by_name",
+                "description": self.find_folder_by_name.__doc__,
+                "args_schema": FindFolderByName,
+                "ref": self.find_folder_by_name,
+            },
             {
                 "name": "delete_link",
                 "description": self.delete_link.__doc__,
@@ -576,8 +617,74 @@ UpdateTestCase = create_model(
     json=(str, Field(description=("""
         JSON body to update a test case. Example:
         {
-          "name": "Updated Test Case Name",
-          "description": "Updated Test Case Description"
+          "id": 1,
+          "key": "SA-T10",
+          "name": "Check axial pump",
+          "project": {
+            "id": 10005,
+            "self": "https://<api-base-url>/projects/10005"
+          },
+          "createdOn": "2018-05-15T13:15:13Z",
+          "objective": "To ensure the axial pump can be enabled",
+          "precondition": "Latest version of the axial pump available",
+          "estimatedTime": 138000,
+          "labels": [
+            "Regression",
+            "Performance",
+            "Automated"
+          ],
+          "component": {
+            "id": 10001,
+            "self": "https://<jira-instance>.atlassian.net/rest/api/2/component/10001"
+          },
+          "priority": {
+            "id": 10002,
+            "self": "https://<api-base-url>/priorities/10002"
+          },
+          "status": {
+            "id": 10000,
+            "self": "https://<api-base-url>/statuses/10000"
+          },
+          "folder": {
+            "id": 100006,
+            "self": "https://<api-base-url>/folders/10006"
+          },
+          "owner": {
+            "self": "https://<jira-instance>.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g",
+            "accountId": "5b10a2844c20165700ede21g"
+          },
+          "testScript": {
+            "self": "https://<api-base-url>/testCases/PROJ-T1/testscript"
+          },
+          "customFields": {
+            "Build Number": 20,
+            "Release Date": "2020-01-01",
+            "Pre-Condition(s)": "User should have logged in. <br> User should have navigated to the administration panel.",
+            "Implemented": false,
+            "Category": [
+              "Performance",
+              "Regression"
+            ],
+            "Tester": "fa2e582e-5e15-521e-92e3-47e6ca2e7256"
+          },
+          "links": {
+            "self": "string",
+            "issues": [
+              {
+                "self": "string",
+                "issueId": 10100,
+                "id": 1,
+                "target": "https://<jira-instance>.atlassian.net/rest/api/2/issue/10000",
+                "type": "COVERAGE"
+              }
+            ],
+            "webLinks": [
+              {
+                "self": "string",
+                "description": "A link to atlassian.com",
+                "url": "https://atlassian.com",
+                "id": 1,
+                "type": "COVERAGE"
         }
         """
     )))
@@ -594,9 +701,9 @@ CreateTestCaseIssueLink = create_model(
     json=(str, Field(description=("""
         JSON body to create an issue link. Example:
         {
-          "issueKey": "ISSUE_KEY",
-          "description": "Link Description"
+          "issueId": 10100
         }
+        where issueId - Jira issue id
         """
     )))
 )
@@ -638,8 +745,10 @@ CreateTestCaseTestScript = create_model(
     json=(str, Field(description=("""
         JSON body to create a test script. Example:
         {
-          "script": "Test Script Content"
+          "type": "bdd",
+          "text": "Attempt to login to the application"
         }
+        Where type - Test script type. Allowed: plain, bdd
         """
     )))
 )
@@ -656,13 +765,43 @@ CreateTestCaseTestSteps = create_model(
     test_case_key=(str, Field(description="Key of the test case to create test steps for.")),
     json=(str, Field(description=("""
         JSON body to create test steps. Example:
-        [
-          {
-            "step": "Step 1",
-            "data": "Test Data",
-            "result": "Expected Result"
-          }
-        ]
+        {
+          "mode": "APPEND",
+          "items": [
+            {
+              "inline": {
+                "description": "Attempt to login to the application",
+                "testData": "Username = SmartBear Password = weLoveAtlassian",
+                "expectedResult": "Login succeeds, web-app redirects to the dashboard view",
+                "customFields": {
+                  "Build Number": 20,
+                  "Release Date": "2020-01-01",
+                  "Pre-Condition(s)": "User should have logged in. <br> User should have navigated to the administration panel.",
+                  "Implemented": false,
+                  "Category": [
+                    "Performance",
+                    "Regression"
+                  ],
+                  "Tester": "fa2e582e-5e15-521e-92e3-47e6ca2e7256"
+                }
+              },
+              "testCase": {
+                "self": "string",
+                "testCaseKey": "PROJ-T123",
+                "parameters": [
+                  {
+                    "name": "username",
+                    "type": "DEFAULT_VALUE",
+                    "value": "admin"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+        Where:
+        mode: str - required - Valid values: "APPEND", "OVERWRITE",
+        items - The list of test steps. Each step should be an object containing inline or testCase. They should only include one of these fields at a time.
         """
     )))
 )
@@ -700,9 +839,71 @@ UpdateTestCycle = create_model(
     json=(str, Field(description=("""
         JSON body to update a test cycle. Example:
         {
-          "name": "Updated Test Cycle Name",
-          "description": "Updated Test Cycle Description"
-        }
+          "id": 1,
+          "key": "SA-R40",
+          "name": "Sprint 1 Regression Test Cycle",
+          "project": {
+            "id": 10005,
+            "self": "https://<api-base-url>/projects/10005"
+          },
+          "jiraProjectVersion": {
+            "id": 10000,
+            "self": "https://<jira-instance>.atlassian.net/rest/api/2/version/10000"
+          },
+          "status": {
+            "id": 10000,
+            "self": "https://<api-base-url>/statuses/10000"
+          },
+          "folder": {
+            "id": 100006,
+            "self": "https://<api-base-url>/folders/10006"
+          },
+          "description": "Regression test cycle 1 to ensure no breaking changes",
+          "plannedStartDate": "2018-05-19T13:15:13Z",
+          "plannedEndDate": "2018-05-20T13:15:13Z",
+          "owner": {
+            "self": "https://<jira-instance>.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g",
+            "accountId": "5b10a2844c20165700ede21g"
+          },
+          "customFields": {
+            "Build Number": 20,
+            "Release Date": "2020-01-01",
+            "Pre-Condition(s)": "User should have logged in. <br> User should have navigated to the administration panel.",
+            "Implemented": false,
+            "Category": [
+              "Performance",
+              "Regression"
+            ],
+            "Tester": "fa2e582e-5e15-521e-92e3-47e6ca2e7256"
+          },
+          "links": {
+            "self": "string",
+            "issues": [
+              {
+                "self": "string",
+                "issueId": 10100,
+                "id": 1,
+                "target": "https://<jira-instance>.atlassian.net/rest/api/2/issue/10000",
+                "type": "COVERAGE"
+              }
+            ],
+            "webLinks": [
+              {
+                "self": "string",
+                "description": "A link to atlassian.com",
+                "url": "https://atlassian.com",
+                "id": 1,
+                "type": "COVERAGE"
+              }
+            ],
+            "testPlans": [
+              {
+                "id": 1,
+                "self": "https://<api-base-url>/links/1",
+                "type": "RELATED",
+                "testPlanId": 2,
+                "target": "https://<jira-instance>.atlassian.net/rest/api/2/testplan/123"
+              }
         """
     )))
 )
@@ -718,9 +919,9 @@ CreateTestCycleIssueLink = create_model(
     json=(str, Field(description=("""
         JSON body to create an issue link. Example:
         {
-          "issueKey": "ISSUE_KEY",
-          "description": "Link Description"
+          "issueId": 10100
         }
+        where issueId - Jira issue id
         """
     )))
 )
@@ -752,10 +953,34 @@ CreateTestExecution = create_model(
     json=(str, Field(description=("""
         JSON body to create a test execution. Example:
         {
-          "testCaseKey": "TEST_CASE_KEY",
-          "testCycleKey": "TEST_CYCLE_KEY",
-          "status": "PASS"
-        }
+          "projectKey": "TIS",
+          "testCaseKey": "SA-T10",
+          "testCycleKey": "SA-R10",
+          "statusName": "In Progress",
+          "testScriptResults": [
+            {
+              "statusName": "In Progress",
+              "actualEndDate": "2018-05-20T13:15:13Z",
+              "actualResult": "User logged in successfully"
+            }
+          ],
+          "environmentName": "Chrome Latest Version",
+          "actualEndDate": "2018-05-20T13:15:13Z",
+          "executionTime": 120000,
+          "executedById": "5b10a2844c20165700ede21g",
+          "assignedToId": "5b10a2844c20165700ede21g",
+          "comment": "Test failed user could not login",
+          "customFields": {
+            "Build Number": 20,
+            "Release Date": "2020-01-01",
+            "Pre-Condition(s)": "User should have logged in. <br> User should have navigated to the administration panel.",
+            "Implemented": false,
+            "Category": [
+              "Performance",
+              "Regression"
+            ],
+            "Tester": "fa2e582e-5e15-521e-92e3-47e6ca2e7256"
+          }
         """
     )))
 )
@@ -771,8 +996,13 @@ UpdateTestExecution = create_model(
     json=(str, Field(description=("""
         JSON body to update a test execution. Example:
         {
-          "status": "FAIL",
-          "comment": "Updated comment"
+          "statusName": "In Progress",
+          "environmentName": "Chrome Latest Version",
+          "actualEndDate": "2018-05-20T13:15:13Z",
+          "executionTime": 120000,
+          "executedById": "5b10a2844c20165700ede21g",
+          "assignedToId": "5b10a2844c20165700ede21g",
+          "comment": "Test failed user could not login"
         }
         """
     )))
@@ -790,12 +1020,14 @@ UpdateTestExecutionTestSteps = create_model(
     test_execution_id_or_key=(str, Field(description="ID or key of the test execution to update test steps for.")),
     json=(str, Field(description=("""
         "JSON body to update test steps. Example:
-        ["
-          {"
-            "step": "Step 1",
-            "status": "PASS"
-          }
-        ]
+        {
+          "steps": [
+            {
+              "actualResult": "User logged in successfully",
+              "statusName": "In Progress"
+            }
+          ]
+        }
         """
     )))
 )
@@ -816,9 +1048,9 @@ CreateTestExecutionIssueLink = create_model(
     json=(str, Field(description=("""
         JSON body to create an issue link. Example:
         {
-          "issueKey": "ISSUE_KEY",
-          "description": "Link Description"
+          "issueId": 10100
         }
+        where issueId - Jira issue id
         """
     )))
 )
@@ -847,10 +1079,13 @@ CreateFolder = create_model(
     json=(str, Field(description=("""
         JSON body to create a folder. Example:
         {
-          "name": "Folder Name",
-          "description": "Folder Description",
-          "projectKey": "PROJECT_KEY"
+            "parentId": 123456,
+            "parentName": "parentFolder",
+            "name": "ZephyrEssential_test",
+            "projectKey": "PRJ",
+            "folderType": "TEST_CASE"
         }
+        Possible folder types: "TEST_CASE", "TEST_PLAN", "TEST_CYCLE",
         """
     )))
 )
@@ -860,6 +1095,14 @@ GetFolder = create_model(
     folder_id=(str, Field(description="ID of the folder to retrieve."))
 )
 
+FindFolderByName = create_model(
+    "GetFolder",
+    name=(str, Field(description="Name of the folder to retrieve.")),
+    project_key=(Optional[str], Field(description="Project key", default=None)),
+    folder_type=(Optional[str], Field(description="""Folder type. Possible values: "TEST_CASE", "TEST_PLAN", "TEST_CYCLE" """,
+                                      default=None)),
+)
+
 DeleteLink = create_model(
     "DeleteLink",
     link_id=(str, Field(description="ID of the link to delete."))

alita_sdk/tools/zephyr_essential/client.py

@@ -1,4 +1,5 @@
 import requests
+from langchain_core.tools import ToolException
 
 class ZephyrEssentialAPI:
     def __init__(self, base_url: str, token: str):
@@ -14,10 +15,11 @@ class ZephyrEssentialAPI:
         })
         try:
             resp = requests.request(method=method, url=url, headers=headers, json=json, params=params, files=files)
-            resp.raise_for_status()
-            if resp.headers.get("Content-Type", "").startswith("application/json"):
-                return resp.json()
-            return resp.text
+            if resp.status_code < 300:
+                if resp.headers.get("Content-Type", "").startswith("application/json"):
+                    return resp.json()
+                return resp.text
+            return ToolException(f"Error performing request {method} {api_path}: {resp.content}")
         except requests.RequestException as e:
             raise Exception(f"Error performing request {method} {api_path}: {str(e)}")
 

alita_sdk/tools/zephyr_scale/__init__.py

@@ -6,7 +6,8 @@ from pydantic import create_model, BaseModel, Field
 
 from .api_wrapper import ZephyrScaleApiWrapper
 from ..base.tool import BaseAction
-from ..utils import clean_string, get_max_toolkit_length, TOOLKIT_SPLITTER
+from ..elitea_base import filter_missconfigured_index_tools
+from ..utils import clean_string, get_max_toolkit_length
 from ...configurations.pgvector import PgVectorConfiguration
 from ...configurations.zephyr import ZephyrConfiguration
 
@@ -31,16 +32,14 @@ def get_tools(tool):
 
 class ZephyrScaleToolkit(BaseToolkit):
     tools: List[BaseTool] = []
-    toolkit_max_length: int = 0
 
     @staticmethod
     def toolkit_config_schema() -> BaseModel:
         selected_tools = {x['name']: x['args_schema'].schema() for x in ZephyrScaleApiWrapper.model_construct().get_available_tools()}
-        ZephyrScaleToolkit.toolkit_max_length = get_max_toolkit_length(selected_tools)
         return create_model(
             name,
             max_results=(int, Field(default=100, description="Results count to show")),
-            zephyr_configuration=(Optional[ZephyrConfiguration], Field(description="Zephyr Configuration",
+            zephyr_configuration=(ZephyrConfiguration, Field(description="Zephyr Configuration",
                                                                        json_schema_extra={'configuration_types': ['zephyr']})),
             pgvector_configuration=(Optional[PgVectorConfiguration], Field(default=None, description="PgVector Configuration",
                                                                            json_schema_extra={
@@ -63,6 +62,7 @@ class ZephyrScaleToolkit(BaseToolkit):
         )
 
     @classmethod
+    @filter_missconfigured_index_tools
     def get_toolkit(cls, selected_tools: list[str] | None = None, toolkit_name: Optional[str] = None, **kwargs):
         if selected_tools is None:
             selected_tools = []
@@ -73,18 +73,22 @@ class ZephyrScaleToolkit(BaseToolkit):
             **(kwargs.get('pgvector_configuration') or {}),
         }
         zephyr_wrapper = ZephyrScaleApiWrapper(**wrapper_payload)
-        prefix = clean_string(toolkit_name, cls.toolkit_max_length) + TOOLKIT_SPLITTER if toolkit_name else ''
         available_tools = zephyr_wrapper.get_available_tools()
         tools = []
         for tool in available_tools:
             if selected_tools:
                 if tool["name"] not in selected_tools:
                     continue
+            description = tool["description"]
+            if toolkit_name:
+                description = f"Toolkit: {toolkit_name}\n{description}"
+            description = description[:1000]
             tools.append(BaseAction(
                 api_wrapper=zephyr_wrapper,
-                name=prefix + tool["name"],
-                description=tool["description"],
-                args_schema=tool["args_schema"]
+                name=tool["name"],
+                description=description,
+                args_schema=tool["args_schema"],
+                metadata={"toolkit_name": toolkit_name} if toolkit_name else {}
             ))
         return cls(tools=tools)