Merge branch 'release/0.26.0'

Author: oren0e

.github/workflows/ci-workflow.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ${{ matrix.image }}
     strategy:
       matrix:
-        python_version: [3.5, 3.6, 3.7, 3.8]
+        python_version: [3.6, 3.7, 3.8, 3.9]
         image: [ubuntu-18.04]
 
     steps:
@@ -18,8 +18,7 @@ jobs:
       - name: Install requirements
         run: pip install -e . -r unittests/requirements.txt pylint mypy
       - name: Format
-        if: matrix.python_version == '3.8'
-        run: pip install black "isort<5" && make format
+        run: pip install black isort && make format
       - name: Lint
         run: make lint
       - name: Unittest

.isort.cfg

@@ -3,4 +3,4 @@ combine_as_imports = true
 line_length = 100
 multi_line_output = 3
 include_trailing_comma = true
-known_third_party = capacity
+known_third_party = capacity,flask_loopback

.pylintrc

@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable=R,broad-except,protected-access,unused-argument,redefined-builtin,missing-docstring,invalid-name,ungrouped-imports,wrong-import-order,bad-continuation
+disable=R,broad-except,protected-access,unused-argument,redefined-builtin,missing-docstring,invalid-name,ungrouped-imports,wrong-import-order,bad-continuation,consider-using-f-string,unspecified-encoding
 
 [FORMAT]
 max-line-length=150

Makefile

@@ -2,9 +2,9 @@ default: check
 
 
 format:
-	isort -df -rc scottypy unittests
+	isort --df -rc scottypy unittests
 	isort -c -rc scottypy unittests
-	black --check scottypy unittests
+	black --check --diff scottypy unittests
 
 do_format:
 	isort -rc scottypy unittests
@@ -14,7 +14,7 @@ test:
 	pytest unittests/
 
 lint:
-	MYPYPATH=stubs mypy scottypy --strict
+	MYPYPATH=stubs mypy scottypy --strict --install-types --non-interactive
 	pylint --rcfile .pylintrc -j $(shell nproc) scottypy unittests
 
 check: format lint test

README.md

@@ -1,4 +1,3 @@
-
 # Scotty Client Library
 
 ## Notes For Developers
@@ -7,6 +6,7 @@
 
 1. Update changelog in `README.md` file
 1. Run the following:
+
 ```
 VERSION=...
 git flow release start "$VERSION"
@@ -17,37 +17,40 @@ git flow release finish "$VERSION"
 git push origin : --tags
 ```
 
-
 ## ChangeLog
 
+### 0.26.0
+
+- Add option to link beam to issue when uploading a beam
+
 ### 0.25.2
 
-* Increase timeout to 30 seconds
+- Increase timeout to 30 seconds
 
 ### 0.25.1
 
-* Fix get_beams_by_issue so that it will use pagination
+- Fix get_beams_by_issue so that it will use pagination
 
 ### 0.25.0
 
-* Use combadge v2 by default (which supports windows hosts)
+- Use combadge v2 by default (which supports windows hosts)
 
 ### 0.24.0
 
-* Add filtering by issue
-* Add delete method to beam
+- Add filtering by issue
+- Add delete method to beam
 
 ### 0.23.1
 
-* Provide more information on exceptions
-* Add type hinting
-* Fix bug with downloading windows paths on linux
+- Provide more information on exceptions
+- Add type hinting
+- Fix bug with downloading windows paths on linux
 
 ### 0.22.1
 
-* Fix bug with prefetch and then beam up without explicitly setting version
+- Fix bug with prefetch and then beam up without explicitly setting version
 
 ### 0.22.0
 
-* Support python3.8
-* Support Rust Combadge (v2)
+- Support python3.8
+- Support Rust Combadge (v2)

scottypy/__version__.py

@@ -1 +1 @@
-__version__ = "0.25.2"
+__version__ = "0.26.0"

scottypy/app.py

@@ -196,22 +196,28 @@ def up() -> None:
 @up.command()
 @click.argument("directory")
 @click.option("--url", default=_get_url, help="Base URL of Scotty")
+@click.option("--issue", help="Associated issue ticket name")
+@click.option("--tracker", default="JIRA", help="Issue tracker name")
 @click.option(
     "-t",
     "--tag",
     "tags",
     multiple=True,
     help="Tag to be associated with the beam. Can be specified multiple times",
 )
-def local(directory: str, url: str, tags: typing.List[str]) -> None:
+def local(
+    directory: str, url: str, tags: typing.List[str], issue: str, tracker: str
+) -> None:
     logging.basicConfig(
         format="%(name)s:%(levelname)s:%(message)s", level=logging.DEBUG
     )
 
     scotty = Scotty(url)
 
     click.echo("Beaming up {}".format(directory))
-    beam_id = scotty.beam_up(directory, tags=tags)
+    beam_id = scotty.beam_up(
+        directory, tags=tags, associated_issue=issue, tracker_name=tracker
+    )
     click.echo("Successfully beamed beam #{}".format(beam_id))
 
 

scottypy/beam.py

@@ -128,7 +128,7 @@ def set_comment(self, comment: str) -> None:
         raise_for_status(response)
         self._comment = comment
 
-    def set_issue_association(self, issue_id: str, associated: bool) -> None:
+    def set_issue_association(self, issue_id: int, associated: bool) -> None:
         raise_for_status(
             self._scotty.session.request(
                 "POST" if associated else "DELETE",

scottypy/file.py

@@ -12,7 +12,7 @@
     from requests import Session
 
 
-_CHUNK_SIZE = 1024 ** 2 * 4
+_CHUNK_SIZE = 1024**2 * 4
 _EPOCH = datetime.utcfromtimestamp(0)
 
 

scottypy/scotty.py

@@ -1,5 +1,6 @@
 import abc
 import errno
+import itertools
 import json
 import logging
 import os
@@ -16,7 +17,7 @@
 import emport
 import requests
 from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
+from requests.packages.urllib3.util.retry import Retry  # type: ignore
 
 from .beam import Beam
 from .exc import PathNotExists
@@ -26,7 +27,7 @@
 
 _SLEEP_TIME = 10
 _NUM_OF_RETRIES = (60 // _SLEEP_TIME) * 15
-_TIMEOUT = 5
+_TIMEOUT = 30
 _DEFAULT_COMBADGE_VERSION = "v2"
 logger = logging.getLogger("scotty")  # type: logging.Logger
 
@@ -65,10 +66,11 @@ def from_response(cls, response: requests.Response) -> "CombadgePython":
         return cls(emport.import_file(combadge_file.name))
 
     def remove(self) -> None:
-        os.remove(self._combadge_module.__file__)
+        if self._combadge_module.__file__ is not None:
+            os.remove(self._combadge_module.__file__)
 
     def run(self, *, beam_id: int, directory: str, transporter_host: str) -> None:
-        self._combadge_module.beam_up(beam_id, directory, transporter_host)  # type: ignore
+        self._combadge_module.beam_up(beam_id, directory, transporter_host)
 
 
 class CombadgeRust(Combadge):
@@ -197,13 +199,17 @@ def beam_up(
         beam_type: typing.Optional[str] = None,
         tags: typing.Optional[typing.List[str]] = None,
         return_beam_object: bool = False,
+        tracker_name: str = "JIRA",
+        associated_issue: typing.Optional[str] = None,
     ) -> typing.Union["Beam", int]:
         """Beam up the specified local directory to Scotty.
 
         :param str directory: Local directory to beam.
         :param str email: Your email. If unspecified, the initiator of the beam will be anonymous.
         :param list tags: An optional list of tags to be associated with the beam.
         :param bool return_beam_object: If set to True, return a :class:`.Beam` instance.
+        :param str associated_issue: An optional associated issue ticket.
+        :param str tracker_name: Name of the issues tracker.
 
         :return: the beam id."""
         if not os.path.exists(directory):
@@ -238,14 +244,22 @@ def beam_up(
 
         beam_data = response.json()
         beam_id = beam_data["beam"]["id"]  # type: int
+        beam_obj = Beam.from_json(self, beam_data["beam"])
+
+        if associated_issue:
+            tracker_id = self.get_tracker_id(name=tracker_name)
+            issue_id = self.create_issue(
+                tracker_id=tracker_id, id_in_tracker=associated_issue
+            )
+            beam_obj.set_issue_association(issue_id=issue_id, associated=True)
 
         combadge = self._get_combadge(combadge_version)
         combadge.run(
             beam_id=beam_id, directory=directory, transporter_host=transporter_host
         )
 
         if return_beam_object:
-            return Beam.from_json(self, beam_data["beam"])
+            return beam_obj
         else:
             return beam_id
 
@@ -415,14 +429,23 @@ def get_beams_by_issue(self, issue: str) -> typing.List[Beam]:
         :param str issue: The name of the issue.
         :return: a list of :class:`.Beam` objects.
         """
+        beams = []  # type: typing.List[Beam]
+        per_page = 50
+        for page in itertools.count(1):
+            response = self._session.get(
+                "{0}/beams?issue={1}&page={2}&per_page={3}".format(
+                    self._url, issue, page, per_page
+                ),
+                timeout=_TIMEOUT,
+            )
+            raise_for_status(response)
 
-        response = self._session.get(
-            "{0}/beams?issue={1}".format(self._url, issue), timeout=_TIMEOUT
-        )
-        raise_for_status(response)
-
-        ids = (b["id"] for b in response.json()["beams"])
-        return [self.get_beam(id_) for id_ in ids]
+            response_json = response.json()
+            ids = (b["id"] for b in response_json["beams"])
+            beams.extend(self.get_beam(id_) for id_ in ids)
+            if page >= response_json["meta"]["total_pages"]:
+                break
+        return beams
 
     def sanity_check(self) -> None:
         """Check if this instance of Scotty is functioning. Raise an exception if something's wrong"""
@@ -491,7 +514,7 @@ def delete_issue(self, issue_id: int) -> None:
     def get_issue_by_tracker(
         self, tracker_id: int, id_in_tracker: str
     ) -> typing.Optional[JSON]:
-        params = {
+        params: typing.Dict[str, typing.Union[str, int]] = {
             "tracker_id": tracker_id,
             "id_in_tracker": id_in_tracker,
         }