Merge pull request #6 from nassauwinter/cloud_automation_enpoints

Implement Cloud Automation endpoints

Author: nassauwinter

README.md

@@ -58,6 +58,10 @@ test_case = zapi.test_cases.get_test_case("<test_case_id>")
 creation_result = zapi.test_cases.create_test_case("<project_key>", "test_case_name")
 ```
 
+### Troubleshooting
+
+For troubleshooting see [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
+
 
 ### License
 

TROUBLESHOOTING.md

@@ -0,0 +1,5 @@
+## Reporting to Zephyr
+
+- The Cucumber format is different from Behave reporter format.
+In case you want to report test executions from output Behave file, 
+please use some custom formatter for Behave output, i.e. https://pypi.org/project/behave-cucumber-formatter/.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = zephyr-python-api
-version = 0.0.2
+version = 0.0.3
 author = Petr Sharapenko
 author_email = nassauwinter@gmail.com
 description = Zephyr (TM4J) Python REST API wrapper

zephyr/scale/cloud/endpoints/automations.py

@@ -1,3 +1,5 @@
+from json import dumps
+
 from ...zephyr_session import ZephyrSession
 
 
@@ -7,25 +9,99 @@ class AutomationEndpoints:
     def __init__(self, session: ZephyrSession):
         self.session = session
 
-    def post_custom_format(self):
+    def _post_reports(self,
+                      path,
+                      project_key,
+                      file_path,
+                      auto_create=False,
+                      test_cycle=None,
+                      **kwargs):
+        """
+        Post various reports logic.
+
+        :param path: str with resource path
+        :param project_key: str with project key
+        :param file_path: str with path to .zip archive with report files
+        :param auto_create: indicate if test cases should be created if non existent
+        :param test_cycle: dict with test cycle description data
+        """
+        params = {'projectKey': project_key}
+        to_files = None
+
+        if auto_create:
+            params.update({'autoCreateTestCases': True})
+
+        if test_cycle:
+            to_files = {'testCycle': (None, dumps(test_cycle), 'application/json')}
+
+        return self.session.post_file(path,
+                                      file_path,
+                                      to_files=to_files,
+                                      params=params,
+                                      **kwargs)
+
+    def post_custom_format(self,
+                           project_key,
+                           file_path,
+                           auto_create=False,
+                           test_cycle=None,
+                           **kwargs):
         """
         Create results using Zephyr Scale's custom results format.
+
+        :param project_key: str with project key
+        :param file_path: str with path to .zip archive with report files
+        :param auto_create: indicate if test cases should be created if non existent
+        :param test_cycle: dict with test cycle description data
         """
-        raise NotImplementedError
+        return self._post_reports('automations/executions/custom',
+                                  project_key=project_key,
+                                  file_path=file_path,
+                                  auto_create=auto_create,
+                                  test_cycle=test_cycle,
+                                  **kwargs)
 
-    def post_cucumber_format(self):
+    def post_cucumber_format(self,
+                             project_key,
+                             file_path,
+                             auto_create=False,
+                             test_cycle=None,
+                             **kwargs):
         """
         Create results using the Cucumber results format.
+
+        :param project_key: str with project key
+        :param file_path: str with path to .zip archive with report files
+        :param auto_create: indicate if test cases should be created if non existent
+        :param test_cycle: dict with test cycle description data
         """
-        raise NotImplementedError
+        return self._post_reports('automations/executions/cucumber',
+                                  project_key=project_key,
+                                  file_path=file_path,
+                                  auto_create=auto_create,
+                                  test_cycle=test_cycle,
+                                  **kwargs)
 
-    def post_junit_xml_format(self):
+    def post_junit_xml_format(self,
+                              project_key,
+                              file_path,
+                              auto_create=False,
+                              test_cycle=None,
+                              **kwargs):
         """
-        Create results using the JUnit XML results format. Optionally,
-        you can send a 'testCycle' part in your form data to customize
-        the created test cycle.
+        Create results using the JUnit XML results format.
+
+        :param project_key: str with project key
+        :param file_path: str with path to .zip archive with report files
+        :param auto_create: indicate if test cases should be created if non existent
+        :param test_cycle: dict with test cycle description data
         """
-        raise NotImplementedError
+        return self._post_reports('automations/executions/junit',
+                                  project_key=project_key,
+                                  file_path=file_path,
+                                  auto_create=auto_create,
+                                  test_cycle=test_cycle,
+                                  **kwargs)
 
     def get_testcases_zip(self, project_key):
         """

zephyr/scale/zephyr_session.py

@@ -101,11 +101,15 @@ def get_paginated(self, endpoint, params=None):
             params.update(parse_qs(params_str))
         return
 
-    def post_file(self, endpoint: str, file_path: str, **kwargs):
+    def post_file(self, endpoint: str, file_path: str, to_files=None, **kwargs):
         """
         Post wrapper to send a file. Handles single file opening,
         sending its content and closing
         """
         with open(file_path, "rb") as file:
             files = {"file": file}
+
+            if to_files:
+                files.update(to_files)
+
             return self._request("post", endpoint, files=files, **kwargs)