Fix #240: log responses objects (#276)

* Fix #240: log responses objects

* Fix usage of markers and remove warnings

* Update secrets baseline

Author: leplatrem

.secrets.baseline

@@ -122,9 +122,9 @@
         "filename": "README.md",
         "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
         "is_verified": false,
-        "line_number": 242
+        "line_number": 245
       }
     ]
   },
-  "generated_at": "2022-09-28T11:04:17Z"
+  "generated_at": "2022-10-07T13:12:35Z"
 }

jbi/actions/default.py

@@ -96,6 +96,15 @@ def __call__(self, context: ActionContext) -> ActionResult:
 
         for step in self.steps[context.operation]:
             context, step_responses = step(context=context, **self.parameters)
+            for response in step_responses:
+                logger.debug(
+                    "Received %s",
+                    response,
+                    extra={
+                        "response": response,
+                        **context.dict(),
+                    },
+                )
             responses += step_responses
 
         return True, {"responses": responses}

pyproject.toml

@@ -47,6 +47,10 @@ env_override_existing_values = true
 env_files = [
     ".env.example"
 ]
+markers = [
+    "no_mocked_bugzilla",
+    "no_mocked_jira",
+]
 
 [tool.pylint]
     [tool.pylint.'MESSAGES CONTROL']

tests/conftest.py

@@ -46,6 +46,7 @@ def settings():
 def mocked_bugzilla(request):
     if "no_mocked_bugzilla" in request.keywords:
         yield None
+        bugzilla.get_client.cache_clear()
     else:
         with mock.patch("jbi.services.bugzilla.BugzillaClient") as mocked_bz:
             yield mocked_bz()
@@ -56,6 +57,7 @@ def mocked_bugzilla(request):
 def mocked_jira(request):
     if "no_mocked_jira" in request.keywords:
         yield None
+        jira.get_client.cache_clear()
     else:
         with mock.patch("jbi.services.jira.Jira") as mocked_jira:
             yield mocked_jira()

tests/unit/actions/test_default.py

@@ -1,8 +1,11 @@
+import logging
 from unittest import mock
 
 import pytest
+import responses
 
 from jbi.actions import default
+from jbi.environment import get_settings
 from jbi.models import ActionContext
 
 
@@ -36,13 +39,55 @@ def test_default_returns_callable_without_data():
     assert "missing 1 required positional argument: 'context'" in str(exc_info.value)
 
 
+@pytest.mark.no_mocked_bugzilla
+@pytest.mark.no_mocked_jira
+def test_default_logs_all_received_responses(
+    mocked_responses, caplog, context_comment_example: ActionContext
+):
+    # In this test, we don't mock the Jira and Bugzilla clients
+    # because we want to make sure that actual responses objects are logged
+    # successfully.
+    settings = get_settings()
+    url = f"{settings.jira_base_url}rest/api/2/issue/JBI-234/comment"
+    mocked_responses.add(
+        responses.POST,
+        url,
+        json={
+            "id": "10000",
+            "key": "ED-24",
+        },
+    )
+
+    action = default.init(
+        jira_project_key="",
+        steps={"new": [], "existing": [], "comment": ["create_comment"]},
+    )
+
+    with caplog.at_level(logging.DEBUG):
+        action(context=context_comment_example)
+
+    captured_log_msgs = [
+        (r.msg % r.args, r.response)
+        for r in caplog.records
+        if r.name == "jbi.actions.default"
+    ]
+
+    assert captured_log_msgs == [
+        (
+            "Received {'id': '10000', 'key': 'ED-24'}",
+            {"id": "10000", "key": "ED-24"},
+        )
+    ]
+
+
 def test_default_returns_callable_with_data(
     context_create_example: ActionContext, mocked_jira, mocked_bugzilla
 ):
     sentinel = mock.sentinel
     mocked_jira.create_issue.return_value = {"key": "k"}
     mocked_jira.create_or_update_issue_remote_links.return_value = sentinel
     mocked_bugzilla.get_bug.return_value = context_create_example.bug
+    mocked_bugzilla.get_comments.return_value = []
     callable_object = default.init(jira_project_key=context_create_example.jira.project)
 
     handled, details = callable_object(context=context_create_example)