Apply multiple fixes (#18)

## Added

* Mark package as typed
* Methods to get attachments

## Changed

* Test steps in test results are now sorted by index

## Fixed

* Fixed uppercase-lowercase in constants
* If a test case is created without dedicated status, it is set to "Not Executed" now

Author: Shutgun

.github/workflows/pythonpackage.yml

@@ -0,0 +1,67 @@
+name: Python package
+
+on: [push]
+
+jobs:
+
+  format:
+    name: Check formatting
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Check formatting
+      uses: pre-commit/action@v2.0.0
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Lint with flake8
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8
+        flake8 adaptavist --count --show-source --statistics --max-line-length 160
+        flake8 . --count --exit-zero --statistics --max-line-length 160
+    - name: Lint with pylint
+      run: |
+        python -m pip install pylint pytest
+        python -m pip install -e .
+        pylint --errors-only --score=n adaptavist
+        pylint --exit-zero --score=n --disable=C,E,R --enable=useless-suppression adaptavist
+    - name: Lint with mypy
+      run: |
+        python -m pip install mypy types-requests
+        mypy --ignore-missing-imports adaptavist
+
+  test:
+    name: Test with Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pytest-cov
+        python -m pip install .[test]
+    - name: Test with pytest
+      run: |
+        pytest --cov=adaptavist

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/pre-commit/mirrors-yapf
+    rev: 'v0.31.0'
+    hooks:
+    -   id: yapf
+-   repo: https://github.com/pycqa/isort
+    rev: '5.9.3'
+    hooks:
+        - id: isort
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 'v4.0.1'
+    hooks:
+        - id: end-of-file-fixer
+        - id: trailing-whitespace

CHANGELOG.md

@@ -4,16 +4,21 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.1.0] - 2021/11/17
 
-## Added
+### Added
 
 - Mark package as typed
 - Methods to get attachments
 
-## Fixed
+### Changed
+
+- Test steps in test results are now sorted by index
+
+### Fixed
 
 - Fixed uppercase-lowercase in constants
+- If a test case is created without dedicated status, it is set to "Not Executed" now
 
 ## [2.0.0] - 2021/05/31
 
@@ -54,4 +59,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-- Python package providing functionality for Jira Test Management.
+- Python package providing functionality for Jira Test Management.

LICENSE.md

@@ -1,21 +1,21 @@
-Copyright (c) 2019 Stephan Steinberg <stephan.steinberg@devolo.de>
+Copyright (c) 2019 devolo AG
 
 The MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy 
-of this software and associated documentation files (the "Software"), to deal 
-in the Software without restriction, including without limitation the rights 
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
-copies of the Software, and to permit persons to whom the Software is 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in 
+The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
-THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.

adaptavist/__init__.py

@@ -7,7 +7,7 @@
 try:
     from importlib.metadata import PackageNotFoundError, version
 except ImportError:
-    from importlib_metadata import PackageNotFoundError, version  # type: ignore[misc]
+    from importlib_metadata import PackageNotFoundError, version  # type: ignore
 
 try:
     __version__ = version("adaptavist")

adaptavist/adaptavist.py

@@ -9,7 +9,7 @@
 import requests_toolbelt
 
 from ._helper import build_folder_names, get_executor, raise_on_kwargs_not_empty, update_field, update_multiline_field
-from .const import PRIORITY_NORMAL, STATUS_APPROVED, STEP_TYPE_BY_STEP, TEST_CASE, TEST_PLAN, TEST_RUN
+from .const import PRIORITY_NORMAL, STATUS_APPROVED, STATUS_NOT_EXECUTED, STEP_TYPE_BY_STEP, TEST_CASE, TEST_PLAN, TEST_RUN
 
 
 class Adaptavist:
@@ -29,15 +29,15 @@ def __init__(self, jira_server: str, jira_username: str, jira_password: str):
         self._adaptavist_api_url = self.jira_server + "/rest/atm/1.0"
         self._authentication = requests.auth.HTTPBasicAuth(self.jira_username, jira_password)
         self._headers = {"Accept": "application/json", "Content-type": "application/json"}
-        self._logger = logging.getLogger(self.__class__.__name__)
+        self._logger = logging.getLogger(__name__)
 
     def get_users(self) -> List[str]:
         """
         Get a list of users known to Adaptavist/Jira.
 
         :returns: List of user keys
         """
-        users: List = []
+        users: List[Dict[str, Any]] = []
         i = 0
         while True:
             request_url = f"{self.jira_server}/rest/api/2/user/search?username=.&startAt={i}&maxResults=200"
@@ -73,7 +73,7 @@ def get_environments(self, project_key: str) -> List[Dict[str, Any]]:
         request = self._get(request_url)
         return request.json() if request else []
 
-    def create_environment(self, project_key: str, environment_name: str, **kwargs) -> Optional[int]:
+    def create_environment(self, project_key: str, environment_name: str, **kwargs: Any) -> Optional[int]:
         """
         Create a new environment.
 
@@ -157,7 +157,7 @@ def get_test_cases(self, search_mask: str = "folder <= \"/\"") -> List[Dict[str,
         :param search_mask: Search mask to match test cases
         :returns: List of test cases
         """
-        test_cases: List = []
+        test_cases: List[Dict[str, Any]] = []
         i = 0
         while True:
             request_url = f"{self._adaptavist_api_url}/testcase/search?query={quote_plus(search_mask)}&startAt={i}"
@@ -171,7 +171,7 @@ def get_test_cases(self, search_mask: str = "folder <= \"/\"") -> List[Dict[str,
 
         return test_cases
 
-    def create_test_case(self, project_key: str, test_case_name: str, **kwargs) -> Optional[int]:
+    def create_test_case(self, project_key: str, test_case_name: str, **kwargs: Any) -> Optional[int]:
         """
         Create a new test case.
 
@@ -221,7 +221,7 @@ def create_test_case(self, project_key: str, test_case_name: str, **kwargs) -> O
         request = self._post(request_url, request_data)
         return request.json()["key"] if request else None
 
-    def edit_test_case(self, test_case_key: str, **kwargs) -> bool:
+    def edit_test_case(self, test_case_key: str, **kwargs: Any) -> bool:
         """
         Edit given test case.
 
@@ -379,7 +379,7 @@ def get_test_plans(self, search_mask: str = "folder <= \"/\"") -> List[Dict[str,
         :param search_mask: Search mask to match test plans
         :returns: List of test plans
         """
-        test_plans: List = []
+        test_plans: List[Dict[str, Any]] = []
         i = 0
         while True:
             request_url = f"{self._adaptavist_api_url}/testplan/search?query={quote_plus(search_mask)}&startAt={i}"
@@ -392,7 +392,7 @@ def get_test_plans(self, search_mask: str = "folder <= \"/\"") -> List[Dict[str,
             i += len(result)
         return test_plans
 
-    def create_test_plan(self, project_key: str, test_plan_name: str, **kwargs) -> Optional[str]:
+    def create_test_plan(self, project_key: str, test_plan_name: str, **kwargs: Any) -> Optional[str]:
         """
         Create a new test plan.
 
@@ -432,7 +432,7 @@ def create_test_plan(self, project_key: str, test_plan_name: str, **kwargs) -> O
         request = self._post(request_url, request_data)
         return request.json()["key"] if request else None
 
-    def edit_test_plan(self, test_plan_key: str, **kwargs) -> bool:
+    def edit_test_plan(self, test_plan_key: str, **kwargs: Any) -> bool:
         """
         Edit given test plan.
 
@@ -500,7 +500,7 @@ def get_test_run_by_name(self, test_run_name: str) -> Dict[str, Any]:
         :param test_run_name: Test run name to look for
         :returns: Info about the test run
         """
-        test_runs: List = []
+        test_runs: List[Dict[str, Any]] = []
         i = 0
         search_mask = quote_plus(f"testRun.name = \"{test_run_name}\"")
         while True:
@@ -514,7 +514,7 @@ def get_test_run_by_name(self, test_run_name: str) -> Dict[str, Any]:
             i += len(results)
         return {key: test_runs[-1][key] for key in ["key", "name"]} if test_runs else {}
 
-    def get_test_runs(self, search_mask: str = "folder = \"/\"", **kwargs) -> List[Dict[str, Any]]:
+    def get_test_runs(self, search_mask: str = "folder = \"/\"", **kwargs: Any) -> List[Dict[str, Any]]:
         """
         Get a list of test runs matching the search mask.
         Unfortunately, /testrun/search does not support empty query, so we use a basic filter here to get all test runs, if no search mask is given.
@@ -529,7 +529,7 @@ def get_test_runs(self, search_mask: str = "folder = \"/\"", **kwargs) -> List[D
         fields: str = kwargs.pop("fields", "")
         raise_on_kwargs_not_empty(kwargs)
 
-        test_runs: List = []
+        test_runs: List[Dict[str, Any]] = []
         i = 0
         while True:
             request_url = f"{self._adaptavist_api_url}/testrun/search?query={quote_plus(search_mask)}&startAt={i}&maxResults=1000&fields={quote_plus(fields)}"
@@ -553,7 +553,7 @@ def get_test_run_links(self, issue_key: str) -> List[Dict[str, str]]:
         self._logger.debug("Looking for test runs linked to %s", issue_key)
         return [test_run for test_run in test_runs if test_run["issueKey"] == issue_key]
 
-    def create_test_run(self, project_key: str, test_run_name: str, **kwargs) -> Optional[str]:
+    def create_test_run(self, project_key: str, test_run_name: str, **kwargs: Any) -> Optional[str]:
         """
         Create a new test run.
 
@@ -575,12 +575,10 @@ def create_test_run(self, project_key: str, test_run_name: str, **kwargs) -> Opt
 
         self.create_folder(project_key=project_key, folder_type=TEST_RUN, folder_name=folder)
 
-        test_cases_list_of_dicts = [
-            {
-                "testCaseKey": test_case_key,
-                "environment": environment or None,
-            } for test_case_key in test_cases
-        ]
+        test_cases_list_of_dicts = [{
+            "testCaseKey": test_case_key,
+            "environment": environment or None,
+        } for test_case_key in test_cases]
 
         request_url = f"{self._adaptavist_api_url}/testrun"
         request_data = {
@@ -591,11 +589,11 @@ def create_test_run(self, project_key: str, test_run_name: str, **kwargs) -> Opt
             "issueKey": issue_key or None,
             "items": test_cases_list_of_dicts,
         }
-        self._logger.debug("Creating new test run in project %s with name '%s'", test_plan_key, test_run_name)
+        self._logger.debug("Creating new test run in project %s with name '%s'", project_key, test_run_name)
         request = self._post(request_url, request_data)
         return request.json()["key"] if request else None
 
-    def clone_test_run(self, test_run_key: str, test_run_name: str = "", **kwargs) -> Optional[str]:
+    def clone_test_run(self, test_run_key: str, test_run_name: str = "", **kwargs: Any) -> Optional[str]:
         """
         Clone a given test run.
 
@@ -647,7 +645,7 @@ def get_test_execution_results(self, last_result_only: bool = True) -> List[Dict
                                  If false, returns all test results, i.e. even those ones that have been overwritten
         :returns: Test results
         """
-        test_results: List = []
+        test_results: List[Dict[str, Any]] = []
         i = 0
         while True:
             request_url = f"{self.jira_server}/rest/tests/1.0/reports/testresults?startAt={i}&maxResults=10000"
@@ -686,9 +684,14 @@ def get_test_results(self, test_run_key: str) -> List[Dict[str, Any]]:
         request_url = f"{self._adaptavist_api_url}/testrun/{test_run_key}/testresults"
         self._logger.debug("Getting all test results for run %s", test_run_key)
         request = self._get(request_url)
-        return request.json() if request else []
+        if not request:
+            return []
+        results = request.json()
+        for result in results:
+            result["scriptResults"] = sorted(result["scriptResults"], key=lambda result: result["index"])
+        return results
 
-    def create_test_results(self, test_run_key: str, results: List[Dict[str, Any]], exclude_existing_test_cases: bool = True, **kwargs) -> List[int]:
+    def create_test_results(self, test_run_key: str, results: List[Dict[str, Any]], exclude_existing_test_cases: bool = True, **kwargs: Any) -> List[int]:
         """
         Create new test results for a given test run.
 
@@ -744,7 +747,7 @@ def get_test_result(self, test_run_key: str, test_case_key: str) -> Dict[str, An
                 return item
         return {}
 
-    def create_test_result(self, test_run_key: str, test_case_key: str, status: str = "", **kwargs) -> Optional[int]:
+    def create_test_result(self, test_run_key: str, test_case_key: str, status: str = STATUS_NOT_EXECUTED, **kwargs: Any) -> Optional[int]:
         """
         Create a new test result for a given test run and test case with the given status.
 
@@ -787,7 +790,7 @@ def create_test_result(self, test_run_key: str, test_case_key: str, status: str
         request = self._post(request_url, request_data)
         return request.json()["id"] if request else None
 
-    def edit_test_result_status(self, test_run_key: str, test_case_key: str, status: str, **kwargs) -> bool:
+    def edit_test_result_status(self, test_run_key: str, test_case_key: str, status: str, **kwargs: Any) -> bool:
         """
         Edit the last existing test result for a given test run and test case with the given status.
 
@@ -859,7 +862,7 @@ def add_test_result_attachment(self, test_run_key: str, test_case_key: str, atta
             if isinstance(attachment, str) \
             else self._upload_file(request_url, attachment, filename)
 
-    def edit_test_script_status(self, test_run_key: str, test_case_key: str, step: int, status: str, **kwargs) -> bool:
+    def edit_test_script_status(self, test_run_key: str, test_case_key: str, step: int, status: str, **kwargs: Any) -> bool:
         """
         Edit test script result for a given test run and test case with the given status.