t-bug-catcher 0.2.1__tar.gz → 0.2.3__tar.gz

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.2.1
+Version: 0.2.3
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.1
+current_version = 0.2.3
 commit = True
 tag = False
 

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/setup.py

@@ -26,7 +26,7 @@ setup(
     packages=find_packages(include=["t_bug_catcher", "t_bug_catcher.*"]),
     test_suite="tests",
     url="https://www.thoughtful.ai/",
-    version="0.2.1",
+    version="0.2.3",
     zip_safe=False,
     install_requires=install_requirements,
 )

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/t_bug_catcher/__init__.py

@@ -3,7 +3,7 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.2.1'
+__version__ = '0.2.3'
 # fmt: on
 
 from .bug_catcher import (

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/t_bug_catcher/bug_catcher.py

@@ -98,7 +98,7 @@ class BugCatcher:
     def report_error(
         self,
         exception: Optional[Exception] = None,
-        description: Optional[str] = "",
+        description: Optional[str] = None,
         metadata: Optional[dict] = None,
         attachments: Optional[List] = None,
         assignee: Optional[str] = None,

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/t_bug_catcher/jira.py

@@ -33,7 +33,6 @@ def retry_if_bad_request(func):
             return func(*args, **kwargs)
         except BadRequestError as ex:
             nonlocal attempt
-            print(f"Bad request Attempt {attempt}...", "WARN")
             attempt = attempt + 1 if attempt < tries else 1
             raise ex
 
@@ -404,12 +403,8 @@ class Jira:
                             "text": "Run link: ",
                             "marks": [{"type": "strong"}],
                         },
-                        {
-                            "type": "text",
-                            "text": CONFIG.ENVIRONMENT,
-                            "marks": ([] + self.__link_markup()),
-                        },
-                    ],
+                    ]
+                    + self.__link_markup(),
                 }
             ]
             if CONFIG.ENVIRONMENT != "local"
@@ -529,19 +524,39 @@ class Jira:
         link_markup = {
             variables.get("environment"): [
                 {
-                    "type": "link",
-                    "attrs": {"href": variables.get("processRunUrl")},
-                },
-                {"type": "underline"},
+                    "type": "text",
+                    "text": variables.get("processRunUrl"),
+                    "marks": [
+                        {
+                            "type": "link",
+                            "attrs": {"href": variables.get("processRunUrl")},
+                        },
+                        {"type": "underline"},
+                    ],
+                }
             ],
             "robocloud": [
                 {
-                    "type": "link",
-                    "attrs": {"href": CONFIG.RC_RUN_LINK},
-                },
-                {"type": "underline"},
+                    "type": "text",
+                    "text": "https://cloud.robocorp.com",
+                    "marks": [
+                        {
+                            "type": "link",
+                            "attrs": {"href": CONFIG.RC_RUN_LINK},
+                        },
+                        {"type": "underline"},
+                    ],
+                }
+            ],
+            "local": [
+                {
+                    "type": "text",
+                    "text": "local run",
+                    "marks": [
+                        {"type": "underline"},
+                    ],
+                }
             ],
-            "local": [{"type": "underline"}],
         }
         return link_markup[CONFIG.ENVIRONMENT]
 
@@ -653,28 +668,33 @@ class Jira:
                 if len(error) < CONFIG.LIMITS.MAX_DESCRIPTION_LENGTH
                 else error[: CONFIG.LIMITS.MAX_DESCRIPTION_LENGTH] + "..."
             )
+        date_markup = [
+            {
+                "type": "text",
+                "text": f" at {str(datetime.datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
+            },
+            {"type": "hardBreak"},
+        ]
 
         error_markup = [
+            {
+                "type": "text",
+                "text": error,
+                "marks": [{"type": "code"}],
+            },
+        ]
+
+        comment_markup = [
             {
                 "type": "paragraph",
-                "content": [
-                    {"type": "text", "text": "Error occures again in "},
-                    {
-                        "type": "text",
-                        "text": CONFIG.ENVIRONMENT,
-                        "marks": ([] + self.__link_markup()),
-                    },
-                    {
-                        "type": "text",
-                        "text": f" at {str(datetime.datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
-                    },
-                    {"type": "hardBreak"},
-                    {
-                        "type": "text",
-                        "text": error,
-                        "marks": [{"type": "code"}],
-                    },
-                ],
+                "content": (
+                    [
+                        {"type": "text", "text": "Error occures again in "},
+                    ]
+                    + self.__link_markup()
+                    + date_markup
+                    + error_markup
+                ),
             }
         ]
 
@@ -711,7 +731,7 @@ class Jira:
                 "type": "doc",
                 "version": 1,
                 "content": []
-                + (error_markup if error else [])
+                + (comment_markup if error else [])
                 + (self.__description_markup(additional_info) if additional_info else [])
                 + (attach_markup if attachments else [])
                 + (self.__metadata_markup(metadata) if metadata else []),
@@ -759,10 +779,10 @@ class Jira:
         """
         issue_status = self.check_issue_status(existing_ticket["id"])
         self._transition_types = self.__get_transtion_types(issue_id=existing_ticket["id"])
-        if issue_status.lower() != "to do":
+        if issue_status.lower() not in ["to do", "open"]:
             self.issue_transition(
                 ticket_id=existing_ticket["id"],
-                transition_id=self._transition_types["to do"],
+                transition_id=self._transition_types.get("to do", "open"),
             )
             self.update_comment(
                 ticket_id=existing_ticket["id"],
@@ -780,7 +800,13 @@ class Jira:
             posted_attachments = []
         else:
             posted_attachments = (
-                [self.add_attachment(attachment, issue["id"]) for attachment in attachments] if attachments else []
+                [
+                    self.add_attachment(attachment, issue["id"])
+                    for attachment in attachments
+                    if os.path.exists(str(attachment))
+                ]
+                if attachments
+                else []
             )
 
         self.update_comment(
@@ -817,7 +843,7 @@ class Jira:
             summary=summary[:255].split("\n")[0],
             description=description,
             assignee=assignee_id,
-            issue_type=self._issue_types.get("bug", self._issue_types["task"]),
+            issue_type=self._issue_types.get("bug") or self._issue_types.get("task", "support"),
             labels=labels,
         )
         response = self.post_ticket(issue=issue)
@@ -834,7 +860,8 @@ class Jira:
         ticket_id = ticket["id"]
         if attachments:
             for attachment in attachments:
-                self.add_attachment(attachment, ticket_id)
+                if os.path.exists(str(attachment)):
+                    self.add_attachment(attachment, ticket_id)
         if self._webhook_url:
             self.move_ticket_to_board(ticket_id)
         return response
@@ -843,7 +870,7 @@ class Jira:
         self,
         exception: Optional[Exception] = None,
         assignee: Optional[str] = None,
-        attachments: Optional[List] = None,
+        attachments: Union[List, str, Path, None] = None,
         metadata: Optional[dict] = None,
         additional_info: Optional[str] = None,
     ) -> dict:
@@ -866,6 +893,9 @@ class Jira:
             if attachments is None:
                 attachments = []
 
+            if isinstance(attachments, (str, Path)):
+                attachments = [str(attachments)]
+
             if not isinstance(attachments, List):
                 logger.warning(f"Incorrect type of attachments: {type(attachments)}")
                 attachments = []

{t_bug_catcher-0.2.1 → t_bug_catcher-0.2.3}/t_bug_catcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.2.1
+Version: 0.2.3
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

t_bug_catcher-0.2.3/tests/test_t_bug_catcher.py

@@ -0,0 +1,72 @@
+import os
+import unittest
+from unittest.mock import PropertyMock, patch
+
+from t_bug_catcher.bug_catcher import BugCatcher
+from t_bug_catcher.config import CONFIG
+from t_bug_catcher.utils import logger
+
+
+class TestBugCatcher(unittest.TestCase):
+    """TestBugCatcher class."""
+
+    def setUp(self):
+        """Set up."""
+        self.bug_catcher = BugCatcher()
+
+    def test_report_error_with_local_environment(self):
+        """Test report_error function."""
+        with patch.object(logger, "warning") as mock_warning:
+            self.bug_catcher.report_error()
+            mock_warning.assert_called_once_with("Reporting an error is not supported in local environment.")
+
+    @patch.object(CONFIG, "ENVIRONMENT", "robocloud")
+    def test_report_error_with_no_configurations(self):
+        """Test report_error function."""
+        with patch.object(logger, "warning") as mock_warning:
+            self.bug_catcher.report_error()
+            mock_warning.assert_called_once_with(
+                "Jira and BugSnag are not configured. Please configure them before reporting an error."
+            )
+
+    def test_jira_configure(self):
+        """Test jira_configure function."""
+        self.bug_catcher.configure.jira(
+            login=os.getenv("JIRA_LOGIN"),
+            api_token=os.getenv("JIRA_API_TOKEN"),
+            project_key=os.getenv("JIRA_PROJECT_KEY"),
+        )
+        assert self.bug_catcher.configure.is_jira_configured
+
+    def test_bugsnag_configure(self):
+        """Test bugsnag_configure function."""
+        self.bug_catcher.configure.bugsnag(api_key=os.getenv("BUGSNAG_API_KEY"))
+        assert self.bug_catcher.configure.is_bugsnag_configured
+
+    def test_attach_file(self):
+        """Test attach_file function."""
+        ex = Exception("some error")
+        self.bug_catcher.attach_file_to_exception(exception=ex, attachment="test.txt")
+        assert hasattr(ex, "custom_attachments")
+
+    @patch.object(CONFIG, "ENVIRONMENT", "robocloud")
+    def test_report_error(self):
+        """Test report_error function."""
+        with patch.object(
+            self.bug_catcher, "_BugCatcher__configurator", new_callable=PropertyMock
+        ) as mock_configurator:
+            patch.object(mock_configurator, "is_jira_configured", return_value=True)
+            patch.object(mock_configurator, "is_bugsnag_configured", return_value=True)
+            try:
+                raise Exception("Test exception")
+            except Exception as ex:
+                with patch.object(logger, "warning") as mock_warning:
+                    self.bug_catcher.report_error(exception=ex)
+                    actual_call = mock_warning.call_args
+                    warning_message = actual_call[0][0]
+                    self.assertTrue(warning_message.startswith("Failed to create Jira issue due to"))
+                    self.assertEqual(mock_warning.call_count, 1)
+
+
+if __name__ == "__main__":
+    unittest.main()

t_bug_catcher-0.2.1/tests/test_t_bug_catcher.py

@@ -1,10 +0,0 @@
-#!/usr/bin/env python
-"""Tests for `t_bug_catcher` package."""
-
-
-class TestTBugCatcher:
-    """Smoke tests of the package."""
-
-    def test_example(self):
-        """Smoke test."""
-        assert True