Jira cache entries are strings, not lists (#400)

In-line _matching_jira_issue_query into _get_existing_jira_issue

Author: webbnh

sync2jira/downstream_issue.py

@@ -234,26 +234,26 @@ def get_jira_client(issue, config):
     return client
 
 
-def _matching_jira_issue_query(client, issue, config):
+def _get_existing_jira_issue(client, issue, config):
     """
-    API calls that find matching JIRA tickets if any are present.
+    Get a jira issue by the linked remote issue.
 
     :param jira.client.JIRA client: JIRA client
     :param sync2jira.intermediary.Issue issue: Issue object
     :param Dict config: Config dict
-    :returns: results: Returns a list of matching JIRA issues if any are found
-    :rtype: List
+    :returns: Returns a list of matching JIRA issues if any are found
+    :rtype: str or None
     """
 
     # If there's an entry for the issue in our cache, fetch the issue key from it.
     if result := jira_cache.get(issue.url):
-        issue_keys = [result]
+        issue_keys = (result,)
     else:
         # Search for Jira issues with a "remote link" to the issue.url;
-        # if we find none, return an empty list.
+        # if we find none, return None.
         results = execute_snowflake_query(issue)
         if not results:
-            return []
+            return None
 
         # From the results returned by Snowflake, make an iterable of the
         # issues' keys.
@@ -307,7 +307,7 @@ def _matching_jira_issue_query(client, issue, config):
 
     # Cache the result for next time and return it.
     jira_cache[issue.url] = results[0].key
-    return results
+    return results[0]
 
 
 def find_username(_issue, config):
@@ -392,24 +392,6 @@ def _comment_matching(g_comments, j_comments):
     )
 
 
-def _get_existing_jira_issue(client, issue, config):
-    """
-    Get a jira issue by the linked remote issue. \
-    This is the new supported way of doing this.
-
-    :param jira.client.JIRA client: JIRA client
-    :param sync2jira.intermediary.Issue issue: Issue object
-    :param Dict config: Config dict
-    :returns: Returns a list of matching JIRA issues if any are found
-    :rtype: List
-    """
-    results = _matching_jira_issue_query(client, issue, config)
-    if results:
-        return results[0]
-    else:
-        return None
-
-
 def _get_existing_jira_issue_legacy(client, issue):
     """
     This is our old way of matching issues: use the special url field.
@@ -702,7 +684,7 @@ def _create_jira_issue(client, issue, config):
         return None
 
     downstream = client.create_issue(**kwargs)
-    jira_cache[issue.url] = [downstream.key]
+    jira_cache[issue.url] = downstream.key
 
     # Add values to the Epic link, QA, and EXD-Service fields if present
     if (

tests/test_downstream_issue.py

@@ -1420,12 +1420,12 @@ def test_matching_jira_issue_query(
         d.jira_cache = d.UrlCache()  # Clear the cache
 
         # Call the function
-        response = d._matching_jira_issue_query(
+        response = d._get_existing_jira_issue(
             client=mock_client, issue=self.mock_issue, config=self.mock_config
         )
 
         # Assert everything was called correctly
-        self.assertEqual(response, [mock_downstream_issue])
+        self.assertEqual(response, mock_downstream_issue)
         mock_client.search_issues.assert_called_with("key in (SYNC2JIRA-123)")
         mock_check_comments_for_duplicates.assert_called_with(
             mock_client, mock_downstream_issue, "mock_username"