Added Zephyr Squad Server support

This commit introduces initial support for the Zephyr Squad (server)
variant. Only a number of the available Zephyr API calls are introduced
by this commit.

All testing for this commit was done on a self-hosted Zephyr Squad instance.

Author: crapitea

examples/server.py renamed to examples/scale-server.py

@@ -0,0 +1,113 @@
+"""
+Usage examples of Zephyr Squad Server API wrappers.
+"""
+import logging
+
+from zephyr import ZephyrSquad
+
+# Enable logging with level Debug for more verbosity
+logging.basicConfig(level=logging.DEBUG)
+
+
+# Specify your Jira context to operate with:
+base_url = "https://jira.hosted.com/"
+
+# Use the Jira certificate for TLS connections
+session_params = {
+    "verify": "<path-to-certificate>"
+}
+
+# Create an instance of Zephyr Squad
+zsquad = ZephyrSquad(
+    base_url=base_url,
+    token="<your_token>",
+    session_attrs=session_params
+)
+
+# Now we can start playing with the Zephyr API!
+
+# Obtain a project's information
+project_info = zsquad.api.project.get_project_info("<your_project_key>")
+
+# Obtain a project's versions/releases
+project_versions = zsquad.api.project.get_project_versions_by_id("<your_project_id>")
+
+# Get the data of a testcase
+test_case = zsquad.api.test_cases.get_test_case("<your_case_key>", fields="id")
+
+# Get the test steps from a testcase
+test_steps = zsquad.api.test_cases.get_test_steps("<your_step_id>")
+
+# Get the list of all test cycles for a specific release
+test_cycle = zsquad.api.test_cycles.get_test_cycle(project_id="<your_project_id>", version_id="<your_version_id>")
+
+# Get all folders from a test cycle
+test_cycle_folders = zsquad.api.folder.get_folder(cycle_id="<your_cycle_id>", project_id="<your_project_id>", version_id="<your_version_id>")
+
+# Get all test executions from a test case
+test_executions = zsquad.api.test_executions.get_test_execution(test_id_or_key="<your_case_id_or_key>")
+
+# Create a new test case for a project
+data = {
+    "fields": {
+        "assignee": {
+            "name": "<jira_username>"
+        },
+        "description": "<your_case_description>"
+    }
+}
+ret_data = zsquad.api.test_cases.create_test_case(project_id="<your_project_id>", summary="<your_case_summary>", data=data)
+
+# Execute ZQL search query
+demo_query = "project = '<your_project_id>' AND cycleName = '<your_cycle_name>'"
+zql_search_res = zsquad.api.utils.run_zql_search(query=demo_query, maxRecords=200)
+
+# Create a new test cycle for a project based on an existing test case
+data = {
+    "clonedCycleId": "<your_cycle_id>",
+    "description": "<your_cycle_description>",
+    "build": "",
+    "startDate": "29/Nov/22",
+    "endDate": "4/Dec/22",
+    "environment": ""
+}
+ret_data = zsquad.api.test_cycles.create_test_cycle(project_id="<your_project_id>", version_id="<your_version_id>", cycle_name="<your_cycle_name>", data=data)
+
+# Create a new test folder for a test cycle
+data = {
+    "cycleId": 1508,  # it will be rewritten by the function
+    "name": "<your_folder_name>",
+    "description": "<your_folder_description>",
+    "projectId": 10600,  # it will be rewritten by the function
+    "versionId": -1,  # it will be rewritten by the function
+    "clonedFolderId": -1
+}
+ret_data = zsquad.api.folder.create_folder(project_id="<your_project_id>", version_id="<your_version_id>", cycle_id="<your_cycle_id>", data=data)
+
+# Add a new test case for a test cycle
+data = {
+    "issues":["<your_case_key>"],
+}
+ret_data = zsquad.api.test_cases.add_test_to_cycle(project_id="<your_project_id>", cycle_id="<your_cycle_id>", method="1", data=data)
+
+# Obtain the execution details
+exec_details = zsquad.api.test_executions.get_execution_properties(exec_id="<execution_id>")
+# print(exec_details)
+
+# Obtain the execution steps from an execution
+exec_steps = zsquad.api.test_executions.get_test_steps(exec_id="<execution_id>")
+
+# Update the status of an execution step
+step_status = zsquad.api.test_executions.update_test_step_status(step_id="<execution_step_id>", status=2)
+
+# Update the status of an execution step
+exec_status = zsquad.api.test_executions.update_execution_status(exec_id="<execution_id>", status=2)
+
+# Update a folder name and description
+data = {
+    "description": "<new_folder_decription>"
+}
+ret_data = zsquad.api.folder.update_folder(project_id="<your_project_id>", version_id="<your_version_id>", cycle_id="<your_cycle_id>", folder_id="<your_folder_id>", name="<your_new_folder_name>")
+
+# Delete 3 test executions
+delete_status = zsquad.api.test_executions.delete_bulk_execution(execution_id=["<your_exec_id_1>", "<your_exec_id_2>", "<your_exec_id_3>"])

examples/squad-server.py

@@ -1,6 +1,6 @@
 [metadata]
 name = zephyr-python-api
-version = 0.0.3
+version = 0.0.4
 author = Petr Sharapenko
 author_email = [email protected]
 description = Zephyr (TM4J) Python REST API wrapper

setup.cfg

@@ -2,7 +2,7 @@
 from requests import Session
 
 from zephyr.scale.scale import DEFAULT_BASE_URL, ZephyrSession
-from zephyr.scale.zephyr_session import INIT_SESSION_MSG, InvalidAuthData
+from zephyr.common.zephyr_session import INIT_SESSION_MSG, InvalidAuthData
 
 REQUESTS_SESSION_PATH = "requests.sessions.Session"
 GETLOGGER_PATH = "logging.getLogger"
@@ -20,7 +20,7 @@ def test_creation(self, mocker):
         assert zsession.base_url == DEFAULT_BASE_URL, (f"Attribute base_url expected to be {DEFAULT_BASE_URL}, "
                                                        f"not {zsession.base_url}")
         assert isinstance(zsession._session, Session)
-        logger_mock.assert_called_with("zephyr.scale.zephyr_session")
+        logger_mock.assert_called_with("zephyr.common.zephyr_session")
 
     def test_token_auth(self, mocker):
         """Test token auth"""

tests/unit/test_zephyr_session.py

@@ -1,2 +1,3 @@
 from zephyr.scale import API_V1, API_V2, ZephyrScale
+from zephyr.squad import ZephyrSquad
 from zephyr.utils.common import cookie_str_to_dict

zephyr/__init__.py

@@ -13,7 +13,7 @@ class InvalidAuthData(Exception):
 
 class ZephyrSession:
     """
-    Zephyr Scale basic session object.
+    Zephyr basic session object.
 
     :param base_url: url to make requests to
     :param token: auth token

zephyr/scale/zephyr_session.py renamed to zephyr/common/zephyr_session.py

@@ -1,6 +1,6 @@
 import logging
 
-from zephyr.scale.zephyr_session import ZephyrSession
+from zephyr.common.zephyr_session import ZephyrSession
 from zephyr.scale.cloud.endpoints import (AutomationEndpoints,
                                           EnvironmentEndpoints,
                                           FolderEndpoints,

zephyr/scale/cloud/cloud_api.py

@@ -1,6 +1,6 @@
 from json import dumps
 
-from ...zephyr_session import ZephyrSession
+from zephyr.common.zephyr_session import ZephyrSession
 
 
 class AutomationEndpoints:

zephyr/scale/cloud/endpoints/automations.py

@@ -1,4 +1,4 @@
-from ...zephyr_session import ZephyrSession
+from zephyr.common.zephyr_session import ZephyrSession
 
 
 class EnvironmentEndpoints:

zephyr/scale/cloud/endpoints/environments.py

@@ -1,4 +1,4 @@
-from ...zephyr_session import ZephyrSession
+from zephyr.common.zephyr_session import ZephyrSession
 
 
 class FolderEndpoints: