INFRADEV-15413: Add an option in scottypy to link beam to Jira ticket (#37)

* INFRADEV-15413: Add associated issue creation to beam_up

* INFRADEV-15413: Add associated issue to up local command

* INFRADEV-15413: Associate the created issue to the beam

* INFRADEV-15413: Add check for associated_issue is not None

* INFRADEV-15413: Don't hardcode tracker name

* INFRADEV-15413: Fix typo

* INFRADEV-15413: Fix format

* INFRADEV-15413: Change type to int from str

Author: oren0e

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/scotty.py

@@ -199,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):
@@ -240,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