alita-sdk 0.3.215__py3-none-any.whl → 0.3.216__py3-none-any.whl

alita_sdk/tools/zephyr_essential/client.py

@@ -0,0 +1,219 @@
+import requests
+
+class ZephyrEssentialAPI:
+    def __init__(self, base_url: str, token: str):
+        self.base_url = base_url.rstrip("/")
+        self.token = token
+
+    def _do_request(self, method: str, api_path: str, json: dict = None, params: dict = None, headers: dict = None, files=None):
+        url = f"{self.base_url}{api_path}"
+        headers = headers or {}
+        headers.update({
+            "Authorization": f"Bearer {self.token}",
+            **({"Content-Type": "application/json"} if json else {})
+        })
+        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
+        except requests.RequestException as e:
+            raise Exception(f"Error performing request {method} {api_path}: {str(e)}")
+
+    # Test Cases
+    def list_test_cases(self, project_key=None, folder_id=None, max_results=10, start_at=0):
+        params = {
+            "projectKey": project_key,
+            "folderId": folder_id,
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", "/testcases", params=params)
+
+    def create_test_case(self, test_case_data):
+        return self._do_request("POST", "/testcases", json=test_case_data)
+
+    def get_test_case(self, test_case_key):
+        return self._do_request("GET", f"/testcases/{test_case_key}")
+
+    def update_test_case(self, test_case_key, test_case_data):
+        return self._do_request("PUT", f"/testcases/{test_case_key}", json=test_case_data)
+
+    def get_test_case_links(self, test_case_key):
+        return self._do_request("GET", f"/testcases/{test_case_key}/links")
+
+    def create_test_case_issue_link(self, test_case_key, issue_link_data):
+        return self._do_request("POST", f"/testcases/{test_case_key}/links/issues", json=issue_link_data)
+
+    def create_test_case_web_link(self, test_case_key, web_link_data):
+        return self._do_request("POST", f"/testcases/{test_case_key}/links/weblinks", json=web_link_data)
+
+    def list_test_case_versions(self, test_case_key, max_results=10, start_at=0):
+        params = {
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", f"/testcases/{test_case_key}/versions", params=params)
+
+    def get_test_case_version(self, test_case_key, version):
+        return self._do_request("GET", f"/testcases/{test_case_key}/versions/{version}")
+
+    def get_test_case_test_script(self, test_case_key):
+        return self._do_request("GET", f"/testcases/{test_case_key}/testscript")
+
+    def create_test_case_test_script(self, test_case_key, test_script_data):
+        return self._do_request("POST", f"/testcases/{test_case_key}/testscript", json=test_script_data)
+
+    def get_test_case_test_steps(self, test_case_key, max_results=10, start_at=0):
+        params = {
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", f"/testcases/{test_case_key}/teststeps", params=params)
+
+    def create_test_case_test_steps(self, test_case_key, test_steps_data):
+        return self._do_request("POST", f"/testcases/{test_case_key}/teststeps", json=test_steps_data)
+
+    # Test Cycles
+    def list_test_cycles(self, project_key=None, folder_id=None, jira_project_version_id=None, max_results=10, start_at=0):
+        params = {
+            "projectKey": project_key,
+            "folderId": folder_id,
+            "jiraProjectVersionId": jira_project_version_id,
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", "/testcycles", params=params)
+
+    def create_test_cycle(self, test_cycle_data):
+        return self._do_request("POST", "/testcycles", json=test_cycle_data)
+
+    def get_test_cycle(self, test_cycle_id_or_key):
+        return self._do_request("GET", f"/testcycles/{test_cycle_id_or_key}")
+
+    def update_test_cycle(self, test_cycle_id_or_key, test_cycle_data):
+        return self._do_request("PUT", f"/testcycles/{test_cycle_id_or_key}", json=test_cycle_data)
+
+    def get_test_cycle_links(self, test_cycle_id_or_key):
+        return self._do_request("GET", f"/testcycles/{test_cycle_id_or_key}/links")
+
+    def create_test_cycle_issue_link(self, test_cycle_id_or_key, issue_link_data):
+        return self._do_request("POST", f"/testcycles/{test_cycle_id_or_key}/links/issues", json=issue_link_data)
+
+    def create_test_cycle_web_link(self, test_cycle_id_or_key, web_link_data):
+        return self._do_request("POST", f"/testcycles/{test_cycle_id_or_key}/links/weblinks", json=web_link_data)
+
+    # Test Executions
+    def list_test_executions(self, project_key=None, test_cycle=None, test_case=None, max_results=10, start_at=0):
+        params = {
+            "projectKey": project_key,
+            "testCycle": test_cycle,
+            "testCase": test_case,
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", "/testexecutions", params=params)
+
+    def create_test_execution(self, test_execution_data):
+        return self._do_request("POST", "/testexecutions", json=test_execution_data)
+
+    def get_test_execution(self, test_execution_id_or_key):
+        return self._do_request("GET", f"/testexecutions/{test_execution_id_or_key}")
+
+    def update_test_execution(self, test_execution_id_or_key, test_execution_data):
+        return self._do_request("PUT", f"/testexecutions/{test_execution_id_or_key}", json=test_execution_data)
+
+    def get_test_execution_test_steps(self, test_execution_id_or_key, max_results=10, start_at=0):
+        params = {
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", f"/testexecutions/{test_execution_id_or_key}/teststeps", params=params)
+
+    def update_test_execution_test_steps(self, test_execution_id_or_key, test_steps_data):
+        return self._do_request("PUT", f"/testexecutions/{test_execution_id_or_key}/teststeps", json=test_steps_data)
+
+    def sync_test_execution_script(self, test_execution_id_or_key):
+        return self._do_request("POST", f"/testexecutions/{test_execution_id_or_key}/teststeps/sync")
+
+    def list_test_execution_links(self, test_execution_id_or_key):
+        return self._do_request("GET", f"/testexecutions/{test_execution_id_or_key}/links")
+
+    def create_test_execution_issue_link(self, test_execution_id_or_key, issue_link_data):
+        return self._do_request("POST", f"/testexecutions/{test_execution_id_or_key}/links/issues", json=issue_link_data)
+
+    # Projects
+    def list_projects(self, max_results=10, start_at=0):
+        params = {
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", "/projects", params=params)
+
+    def get_project(self, project_id_or_key):
+        return self._do_request("GET", f"/projects/{project_id_or_key}")
+
+    # Folders
+    def list_folders(self, project_key=None, folder_type=None, max_results=10, start_at=0):
+        params = {
+            "projectKey": project_key,
+            "folderType": folder_type,
+            "maxResults": max_results,
+            "startAt": start_at,
+        }
+        return self._do_request("GET", "/folders", params=params)
+
+    def create_folder(self, folder_data):
+        return self._do_request("POST", "/folders", json=folder_data)
+
+    def get_folder(self, folder_id):
+        return self._do_request("GET", f"/folders/{folder_id}")
+
+    # Links
+    def delete_link(self, link_id):
+        return self._do_request("DELETE", f"/links/{link_id}")
+
+    # Issue Links
+    def get_issue_link_test_cases(self, issue_key):
+        return self._do_request("GET", f"/issuelinks/{issue_key}/testcases")
+
+    def get_issue_link_test_cycles(self, issue_key):
+        return self._do_request("GET", f"/issuelinks/{issue_key}/testcycles")
+
+    def get_issue_link_test_plans(self, issue_key):
+        return self._do_request("GET", f"/issuelinks/{issue_key}/testplans")
+
+    def get_issue_link_test_executions(self, issue_key):
+        return self._do_request("GET", f"/issuelinks/{issue_key}/executions")
+
+    # Automations
+    def create_custom_executions(self, project_key, files, auto_create_test_cases=False):
+        params = {
+            "projectKey": project_key,
+            "autoCreateTestCases": auto_create_test_cases,
+        }
+        return self._do_request("POST", "/automations/executions/custom", params=params, files=files)
+
+    def create_cucumber_executions(self, project_key, files, auto_create_test_cases=False):
+        params = {
+            "projectKey": project_key,
+            "autoCreateTestCases": auto_create_test_cases,
+        }
+        return self._do_request("POST", "/automations/executions/cucumber", params=params, files=files)
+
+    def create_junit_executions(self, project_key, files, auto_create_test_cases=False):
+        params = {
+            "projectKey": project_key,
+            "autoCreateTestCases": auto_create_test_cases,
+        }
+        return self._do_request("POST", "/automations/executions/junit", params=params, files=files)
+
+    def retrieve_bdd_test_cases(self, project_key):
+        headers = {"Accept": "application/zip"}
+        params = {"projectKey": project_key}
+        return self._do_request("GET", "/automations/testcases", params=params, headers=headers)
+
+    # Healthcheck
+    def healthcheck(self):
+        return self._do_request("GET", "/healthcheck")

alita_sdk/tools/zephyr_scale/api_wrapper.py

@@ -248,35 +248,6 @@ ZephyrUpdateTestSteps = create_model(
     steps_updates=(str, Field(description="JSON string representing the test steps to update. Format: [{\"index\": 0, \"description\": \"Updated step description\", \"testData\": \"Updated test data\", \"expectedResult\": \"Updated expected result\"}]"))
 )
 
-# Schema for indexing Zephyr scale data into vector store
-indexData = create_model(
-    "indexData",
-    __base__=BaseIndexParams,
-    project_key=(str, Field(description="Jira project key filter")),
-    jql=(str, Field(description="""JQL-like query for searching test cases.
-
-    Supported fields:
-    - folder: exact folder name (e.g., folder = "Login Tests")
-    - folderPath: full folder path (e.g., folderPath = "Root/Subfolder")
-    - label: one or more labels (e.g., label in ("Smoke", "Critical"))
-    - text: full-text search in name/description (e.g., text ~ "login")
-    - customFields: JSON string with key-value pairs to filter by custom fields
-    - steps: search within test steps (e.g., steps ~ "click submit")
-    - orderBy: sort field (e.g., orderBy = "name")
-    - orderDirection: ASC or DESC (e.g., orderDirection = "DESC")
-    - limit: maximum number of results (e.g., limit = 100)
-    - includeSubfolders: whether to include subfolders (e.g., includeSubfolders = false)
-    - exactFolderMatch: match folder name exactly (e.g., exactFolderMatch = true)
-
-    Example:
-        'folder = "Authentication" AND label in ("Smoke", "Critical") AND text ~ "login" AND orderBy = "name" AND orderDirection = "ASC"'
-    """)),
-    progress_step=(Optional[int], Field(default=None, ge=0, le=100,
-                         description="Optional step size for progress reporting during indexing")),
-    clean_index=(Optional[bool], Field(default=False,
-                       description="Optional flag to enforce clean existing index before indexing new data")),
-)
-
 
 class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
     # url for a Zephyr server
@@ -295,14 +266,6 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
     _is_cloud: bool = False
     _api: Any = PrivateAttr()
 
-    llm: Any = None
-
-    connection_string: Optional[SecretStr] = None
-    collection_name: Optional[str] = None
-    embedding_model: Optional[str] = "HuggingFaceEmbeddings"
-    embedding_model_params: Optional[Dict[str, Any]] = {"model_name": "sentence-transformers/all-MiniLM-L6-v2"}
-    vectorstore_type: Optional[str] = "PGVector"
-
     class Config:
         arbitrary_types_allowed = True
 
@@ -1225,26 +1188,36 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
 
         return result
 
-    def index_data(self, project_key: str,
-                   jql: str,
-                   collection_suffix: str = '',
-                   progress_step: int = None,
-                   clean_index: bool = False) -> str:
+    def _index_tool_params(self, **kwargs) -> dict[str, tuple[type, Field]]:
         """
-        Search test cases using a JQL-like query with explicit project_key.
-
-        Example:
-            jql = 'folder = "Authentication" AND label in ("Smoke", "Critical") AND text ~ "login"'
+        Returns a list of fields for index_data args schema.
         """
-        docs = self._base_loader(project_key, jql)
-        embedding = get_embeddings(self.embedding_model, self.embedding_model_params)
-        vs = self._init_vector_store(collection_suffix, embeddings=embedding)
-        return vs.index_documents(docs, progress_step=progress_step, clean_index=clean_index)
+        return {
+            "project_key": (str, Field(description="Jira project key filter")),
+            "jql":(str, Field(description="""JQL-like query for searching test cases.
+            Supported fields:
+            - folder: exact folder name (e.g., folder = "Login Tests")
+            - folderPath: full folder path (e.g., folderPath = "Root/Subfolder")
+            - label: one or more labels (e.g., label in ("Smoke", "Critical"))
+            - text: full-text search in name/description (e.g., text ~ "login")
+            - customFields: JSON string with key-value pairs to filter by custom fields
+            - steps: search within test steps (e.g., steps ~ "click submit")
+            - orderBy: sort field (e.g., orderBy = "name")
+            - orderDirection: ASC or DESC (e.g., orderDirection = "DESC")
+            - limit: maximum number of results (e.g., limit = 100)
+            - includeSubfolders: whether to include subfolders (e.g., includeSubfolders = false)
+            - exactFolderMatch: match folder name exactly (e.g., exactFolderMatch = true)
+        
+            Example:
+                'folder = "Authentication" AND label in ("Smoke", "Critical") AND text ~ "login" AND orderBy = "name" AND orderDirection = "ASC"'
+            """))
+        }
 
-    def _base_loader(self, project_key: str, jql: str):
-        test_cases_docs = self._get_test_cases_docs(project_key, jql)
-        folders_docs = self._get_folders_docs(project_key)
-        return test_cases_docs + folders_docs
+    def _base_loader(self, project_key: str, jql: str) -> Generator[Document, None, None]:
+        for test_case_doc in self._get_test_cases_docs(project_key, jql):
+            yield test_case_doc
+        for folder_doc in self._get_folders_docs(project_key):
+            yield folder_doc
 
     def _get_all_folders(self, project_key: str, folder_type:str, step: int = 10):
         max_iterations = 50
@@ -1262,7 +1235,7 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
                 break
         return all_folders
 
-    def _get_folders_docs(self, project_key: str):
+    def _get_folders_docs(self, project_key: str) -> Generator[Document, None, None]:
         folder_types = ['TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE']
         folders = []
         for folder_type in folder_types:
@@ -1271,7 +1244,6 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
             except Exception as e:
                 raise ToolException(f"Unable to extract folders for folder type '{folder_type}': {e}")
         page_content = {}
-        docs: List[Document] = []
         for folder in folders:
             page_content['name'] = folder['name']
             metadata = {}
@@ -1279,16 +1251,14 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
                 if value is not None:
                     metadata[key] = value
             page_content['type'] = "FOLDER"
-            docs.append(Document(page_content=json.dumps(page_content), metadata=metadata))
-        return docs
+            yield Document(page_content=json.dumps(page_content), metadata=metadata)
 
-    def _get_test_cases_docs(self, project_key: str, jql: str):
+    def _get_test_cases_docs(self, project_key: str, jql: str) -> Generator[Document, None, None]:
         try:
             test_cases = self._search_test_cases_by_jql(project_key, jql)
         except Exception as e:
             raise ToolException(f"Unable to extract test cases: {e}")
 
-        docs: List[Document] = []
         for case in test_cases:
             last_version = self._get_last_version(case['key'], step=100)
             metadata = {
@@ -1302,8 +1272,7 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
 
             case['type'] = "TEST_CASE"
 
-            docs.append(Document(page_content=json.dumps(case), metadata=metadata))
-        return docs
+            yield Document(page_content=json.dumps(case), metadata=metadata)
 
     def _process_document(self, document: Document) -> Generator[Document, None, None]:
         try:
@@ -1706,11 +1675,5 @@ class ZephyrScaleApiWrapper(BaseVectorStoreToolApiWrapper):
                 "description": self.get_tests_by_folder_path.__doc__,
                 "args_schema": ZephyrGetTestsByFolderPath,
                 "ref": self.get_tests_by_folder_path,
-            },
-            {
-                "name": "index_data",
-                "ref": self.index_data,
-                "description": self.index_data.__doc__,
-                "args_schema": indexData,
             }
         ]

{alita_sdk-0.3.215.dist-info → alita_sdk-0.3.216.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alita_sdk
-Version: 0.3.215
+Version: 0.3.216
 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>, Artem Dubrovskiy <ad13box@gmail.com>
 License-Expression: Apache-2.0

{alita_sdk-0.3.215.dist-info → alita_sdk-0.3.216.dist-info}/RECORD

@@ -93,8 +93,8 @@ alita_sdk/runtime/utils/streamlit.py,sha256=ZgHpibL2ARHt6qrWj5JhK6HNZv2UjxQ04qTk
 alita_sdk/runtime/utils/toolkit_runtime.py,sha256=MU63Fpxj0b5_r1IUUc0Q3-PN9VwL7rUxp2MRR4tmYR8,5136
 alita_sdk/runtime/utils/toolkit_utils.py,sha256=I9QFqnaqfVgN26LUr6s3XlBlG6y0CoHURnCzG7XcwVs,5311
 alita_sdk/runtime/utils/utils.py,sha256=CpEl3LCeLbhzQySz08lkKPm7Auac6IiLF7WB8wmArMI,589
-alita_sdk/tools/__init__.py,sha256=kTw83lzfWf4HWlvGzfwwHhQlRhpPAbfCAhKkMWCzLFo,10324
-alita_sdk/tools/elitea_base.py,sha256=K5ejMrOZQ566y_D9nH0f2RRbXHctZaV8vOSc78d7jTs,29359
+alita_sdk/tools/__init__.py,sha256=1AHqP2xyLjn92xVm70l9XIke6FkfHkLo5OoQVe4BuP8,10421
+alita_sdk/tools/elitea_base.py,sha256=4_OWvTlvJwEZaRC1rB5NpD6BcTbKSXsutGrb4BBsR1A,30245
 alita_sdk/tools/ado/__init__.py,sha256=2NMQwt2pjIukSC9nSZ7CLocdGpK7002x7ixKr_wunxk,1313
 alita_sdk/tools/ado/utils.py,sha256=PTCludvaQmPLakF2EbCGy66Mro4-rjDtavVP-xcB2Wc,1252
 alita_sdk/tools/ado/repos/__init__.py,sha256=guYY95Gtyb0S4Jj0V1qO0x2jlRoH0H1cKjHXNwmShow,6388
@@ -297,13 +297,16 @@ alita_sdk/tools/zephyr/rest_client.py,sha256=7vSD3oYIX-3KbAFed-mphSQif_VRuXrq5O0
 alita_sdk/tools/zephyr_enterprise/__init__.py,sha256=y9KDJS3E3D22xc0l08AUuhmGSjS6195XKrSlrDrJ-Zs,2807
 alita_sdk/tools/zephyr_enterprise/api_wrapper.py,sha256=Ir3zHljhbZQJRJJQOBzS_GL5xvxb3-Vq5VF8XIMkxck,9348
 alita_sdk/tools/zephyr_enterprise/zephyr_enterprise.py,sha256=hV9LIrYfJT6oYp-ZfQR0YHflqBFPsUw2Oc55HwK0H48,6809
+alita_sdk/tools/zephyr_essential/__init__.py,sha256=3_v1F31YM1VovDe6rzeLtPbZ6fropmrcPXddbPMkSzc,2540
+alita_sdk/tools/zephyr_essential/api_wrapper.py,sha256=ksg-2j_w74pt2pdoWuuSU-gF3E6IlNtv4wxPf8sJMWg,36812
+alita_sdk/tools/zephyr_essential/client.py,sha256=bfNcUKNqj9MFWTludGbbqD4qZlxrBaC2JtWsCfZMqSY,9722
 alita_sdk/tools/zephyr_scale/__init__.py,sha256=2NTcdrfkx4GSegqyXhsPLsEpc4FlACuDy85b0fk6cAo,4572
-alita_sdk/tools/zephyr_scale/api_wrapper.py,sha256=kYYOJX15VLRcuEFpobpW2JHw_WND2Gb28TJocH4YXzs,79445
+alita_sdk/tools/zephyr_scale/api_wrapper.py,sha256=9CzQqQKv45LqZCmwSe4zzEXvBtStIcGQ1b51EQG5rhQ,78032
 alita_sdk/tools/zephyr_squad/__init__.py,sha256=0AI_j27xVO5Gk5HQMFrqPTd4uvuVTpiZUicBrdfEpKg,2796
 alita_sdk/tools/zephyr_squad/api_wrapper.py,sha256=kmw_xol8YIYFplBLWTqP_VKPRhL_1ItDD0_vXTe_UuI,14906
 alita_sdk/tools/zephyr_squad/zephyr_squad_cloud_client.py,sha256=R371waHsms4sllHCbijKYs90C-9Yu0sSR3N4SUfQOgU,5066
-alita_sdk-0.3.215.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-alita_sdk-0.3.215.dist-info/METADATA,sha256=ex-fUvLuk6WJYDqw9-7Iirp52FvANnetlFYCt51m7D0,18917
-alita_sdk-0.3.215.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-alita_sdk-0.3.215.dist-info/top_level.txt,sha256=0vJYy5p_jK6AwVb1aqXr7Kgqgk3WDtQ6t5C-XI9zkmg,10
-alita_sdk-0.3.215.dist-info/RECORD,,
+alita_sdk-0.3.216.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+alita_sdk-0.3.216.dist-info/METADATA,sha256=UtT_lnvEsUcDTZTITervx85djwHpVdoLnJmhwuQjZYw,18917
+alita_sdk-0.3.216.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+alita_sdk-0.3.216.dist-info/top_level.txt,sha256=0vJYy5p_jK6AwVb1aqXr7Kgqgk3WDtQ6t5C-XI9zkmg,10
+alita_sdk-0.3.216.dist-info/RECORD,,