Actions from labeling issues with synced-to-jira are ignored

github_jira_sync_app/main.py

@@ -189,6 +189,15 @@ async def bot(request: Request, payload: dict = Body(...)):
                     )
                 }
 
+        if payload["action"] == "labeled":
+            if payload["label"]["name"] == gh_synced_label_name:
+                return {
+                    "msg": (
+                        f"Action was triggered by Issue being labeled with {gh_synced_label_name}."
+                        " Purposefully ignored as caused by this bot."
+                    )
+                }
+
     owner = payload["repository"]["owner"]["login"]
     repo_name = payload["repository"]["name"]
 

tests/unit/payloads/issue_labeled_synced_to_jira.json

@@ -0,0 +1,210 @@
+{
+  "action": "labeled",
+  "issue": {
+    "url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30",
+    "repository_url": "https://api.github.com/repos/beliaev-maksim/test-ci",
+    "labels_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30/labels{/name}",
+    "comments_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30/comments",
+    "events_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30/events",
+    "html_url": "https://github.com/beliaev-maksim/test-ci/issues/30",
+    "id": 1745060534,
+    "node_id": "I_kwDOI-HsRM5oA4K2",
+    "number": 30,
+    "title": "day after",
+    "user": {
+      "login": "beliaev-maksim",
+      "id": 51964909,
+      "node_id": "MDQ6VXNlcjUxOTY0OTA5",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51964909?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/beliaev-maksim",
+      "html_url": "https://github.com/beliaev-maksim",
+      "followers_url": "https://api.github.com/users/beliaev-maksim/followers",
+      "following_url": "https://api.github.com/users/beliaev-maksim/following{/other_user}",
+      "gists_url": "https://api.github.com/users/beliaev-maksim/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/beliaev-maksim/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/beliaev-maksim/subscriptions",
+      "organizations_url": "https://api.github.com/users/beliaev-maksim/orgs",
+      "repos_url": "https://api.github.com/users/beliaev-maksim/repos",
+      "events_url": "https://api.github.com/users/beliaev-maksim/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/beliaev-maksim/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "labels": [
+      {
+        "id": 5157325446,
+        "node_id": "LA_kwDOI-HsRM8AAAABM2aKhg",
+        "url": "https://api.github.com/repos/beliaev-maksim/test-ci/labels/bug",
+        "name": "bug",
+        "color": "d73a4a",
+        "default": true,
+        "description": "Something isn't working"
+      }
+    ],
+    "state": "open",
+    "locked": false,
+    "assignee": null,
+    "assignees": [
+
+    ],
+    "milestone": null,
+    "comments": 0,
+    "created_at": "2023-06-07T05:19:14Z",
+    "updated_at": "2023-06-07T05:19:14Z",
+    "closed_at": null,
+    "author_association": "OWNER",
+    "active_lock_reason": null,
+    "body": null,
+    "reactions": {
+      "url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30/reactions",
+      "total_count": 0,
+      "+1": 0,
+      "-1": 0,
+      "laugh": 0,
+      "hooray": 0,
+      "confused": 0,
+      "heart": 0,
+      "rocket": 0,
+      "eyes": 0
+    },
+    "timeline_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/30/timeline",
+    "performed_via_github_app": null,
+    "state_reason": null
+  },
+  "label": {
+    "id": 5157325446,
+    "node_id": "LA_kwDOI-HsRM8AAAABM2aKhg",
+    "url": "https://api.github.com/repos/beliaev-maksim/test-ci/labels/synced-to-jira",
+    "name": "synced-to-jira",
+    "color": "d73a4a",
+    "default": false,
+    "description": "Ticket in Jira has been created for this issue"
+  },
+  "repository": {
+    "id": 602008644,
+    "node_id": "R_kgDOI-HsRA",
+    "name": "test-ci",
+    "full_name": "beliaev-maksim/test-ci",
+    "private": false,
+    "owner": {
+      "login": "beliaev-maksim",
+      "id": 51964909,
+      "node_id": "MDQ6VXNlcjUxOTY0OTA5",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51964909?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/beliaev-maksim",
+      "html_url": "https://github.com/beliaev-maksim",
+      "followers_url": "https://api.github.com/users/beliaev-maksim/followers",
+      "following_url": "https://api.github.com/users/beliaev-maksim/following{/other_user}",
+      "gists_url": "https://api.github.com/users/beliaev-maksim/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/beliaev-maksim/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/beliaev-maksim/subscriptions",
+      "organizations_url": "https://api.github.com/users/beliaev-maksim/orgs",
+      "repos_url": "https://api.github.com/users/beliaev-maksim/repos",
+      "events_url": "https://api.github.com/users/beliaev-maksim/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/beliaev-maksim/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "html_url": "https://github.com/beliaev-maksim/test-ci",
+    "description": null,
+    "fork": false,
+    "url": "https://api.github.com/repos/beliaev-maksim/test-ci",
+    "forks_url": "https://api.github.com/repos/beliaev-maksim/test-ci/forks",
+    "keys_url": "https://api.github.com/repos/beliaev-maksim/test-ci/keys{/key_id}",
+    "collaborators_url": "https://api.github.com/repos/beliaev-maksim/test-ci/collaborators{/collaborator}",
+    "teams_url": "https://api.github.com/repos/beliaev-maksim/test-ci/teams",
+    "hooks_url": "https://api.github.com/repos/beliaev-maksim/test-ci/hooks",
+    "issue_events_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/events{/number}",
+    "events_url": "https://api.github.com/repos/beliaev-maksim/test-ci/events",
+    "assignees_url": "https://api.github.com/repos/beliaev-maksim/test-ci/assignees{/user}",
+    "branches_url": "https://api.github.com/repos/beliaev-maksim/test-ci/branches{/branch}",
+    "tags_url": "https://api.github.com/repos/beliaev-maksim/test-ci/tags",
+    "blobs_url": "https://api.github.com/repos/beliaev-maksim/test-ci/git/blobs{/sha}",
+    "git_tags_url": "https://api.github.com/repos/beliaev-maksim/test-ci/git/tags{/sha}",
+    "git_refs_url": "https://api.github.com/repos/beliaev-maksim/test-ci/git/refs{/sha}",
+    "trees_url": "https://api.github.com/repos/beliaev-maksim/test-ci/git/trees{/sha}",
+    "statuses_url": "https://api.github.com/repos/beliaev-maksim/test-ci/statuses/{sha}",
+    "languages_url": "https://api.github.com/repos/beliaev-maksim/test-ci/languages",
+    "stargazers_url": "https://api.github.com/repos/beliaev-maksim/test-ci/stargazers",
+    "contributors_url": "https://api.github.com/repos/beliaev-maksim/test-ci/contributors",
+    "subscribers_url": "https://api.github.com/repos/beliaev-maksim/test-ci/subscribers",
+    "subscription_url": "https://api.github.com/repos/beliaev-maksim/test-ci/subscription",
+    "commits_url": "https://api.github.com/repos/beliaev-maksim/test-ci/commits{/sha}",
+    "git_commits_url": "https://api.github.com/repos/beliaev-maksim/test-ci/git/commits{/sha}",
+    "comments_url": "https://api.github.com/repos/beliaev-maksim/test-ci/comments{/number}",
+    "issue_comment_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues/comments{/number}",
+    "contents_url": "https://api.github.com/repos/beliaev-maksim/test-ci/contents/{+path}",
+    "compare_url": "https://api.github.com/repos/beliaev-maksim/test-ci/compare/{base}...{head}",
+    "merges_url": "https://api.github.com/repos/beliaev-maksim/test-ci/merges",
+    "archive_url": "https://api.github.com/repos/beliaev-maksim/test-ci/{archive_format}{/ref}",
+    "downloads_url": "https://api.github.com/repos/beliaev-maksim/test-ci/downloads",
+    "issues_url": "https://api.github.com/repos/beliaev-maksim/test-ci/issues{/number}",
+    "pulls_url": "https://api.github.com/repos/beliaev-maksim/test-ci/pulls{/number}",
+    "milestones_url": "https://api.github.com/repos/beliaev-maksim/test-ci/milestones{/number}",
+    "notifications_url": "https://api.github.com/repos/beliaev-maksim/test-ci/notifications{?since,all,participating}",
+    "labels_url": "https://api.github.com/repos/beliaev-maksim/test-ci/labels{/name}",
+    "releases_url": "https://api.github.com/repos/beliaev-maksim/test-ci/releases{/id}",
+    "deployments_url": "https://api.github.com/repos/beliaev-maksim/test-ci/deployments",
+    "created_at": "2023-02-15T09:57:53Z",
+    "updated_at": "2023-05-15T09:25:41Z",
+    "pushed_at": "2023-05-15T09:29:16Z",
+    "git_url": "git://github.com/beliaev-maksim/test-ci.git",
+    "ssh_url": "[email protected]:beliaev-maksim/test-ci.git",
+    "clone_url": "https://github.com/beliaev-maksim/test-ci.git",
+    "svn_url": "https://github.com/beliaev-maksim/test-ci",
+    "homepage": null,
+    "size": 10,
+    "stargazers_count": 0,
+    "watchers_count": 0,
+    "language": "Python",
+    "has_issues": true,
+    "has_projects": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "has_pages": false,
+    "has_discussions": false,
+    "forks_count": 0,
+    "mirror_url": null,
+    "archived": false,
+    "disabled": false,
+    "open_issues_count": 2,
+    "license": null,
+    "allow_forking": true,
+    "is_template": false,
+    "web_commit_signoff_required": false,
+    "topics": [
+
+    ],
+    "visibility": "public",
+    "forks": 0,
+    "open_issues": 2,
+    "watchers": 0,
+    "default_branch": "master"
+  },
+  "sender": {
+    "login": "beliaev-maksim",
+    "id": 51964909,
+    "node_id": "MDQ6VXNlcjUxOTY0OTA5",
+    "avatar_url": "https://avatars.githubusercontent.com/u/51964909?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/beliaev-maksim",
+    "html_url": "https://github.com/beliaev-maksim",
+    "followers_url": "https://api.github.com/users/beliaev-maksim/followers",
+    "following_url": "https://api.github.com/users/beliaev-maksim/following{/other_user}",
+    "gists_url": "https://api.github.com/users/beliaev-maksim/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/beliaev-maksim/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/beliaev-maksim/subscriptions",
+    "organizations_url": "https://api.github.com/users/beliaev-maksim/orgs",
+    "repos_url": "https://api.github.com/users/beliaev-maksim/repos",
+    "events_url": "https://api.github.com/users/beliaev-maksim/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/beliaev-maksim/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "installation": {
+    "id": 35534068,
+    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzU1MzQwNjg="
+  }
+}

tests/unit/test_server.py

@@ -247,6 +247,8 @@ def test_issue_created_and_synced_label(signature_mock):
         7. Create new issue in Jira
         8. Add synced-to-jira label to the issue. If it doesn't exist it is created
            automatically by GitHub and then added
+        9. The new webhook sent by GitHub for labeling the Issue with synced-to-jira
+           is immediately ignored
     """
 
     responses._add_from_file(UNITTESTS_DIR / "url_responses" / "github_auth.yaml")
@@ -266,3 +268,13 @@ def test_issue_created_and_synced_label(signature_mock):
 
     assert response.status_code == 200
     assert response.json() == {"msg": "Issue was created in Jira. "}
+
+    response = client.post("/", json=_get_json("issue_labeled_synced_to_jira.json"))
+
+    assert response.status_code == 200
+    assert response.json() == {
+        "msg": (
+            "Action was triggered by Issue being labeled with synced-to-jira. "
+            "Purposefully ignored as caused by this bot."
+        )
+    }

tests/unit/url_responses/github_responses_add_synced_label.yaml

@@ -3,7 +3,7 @@ responses:
 # add the synced-to-jira label to the new issue
 - response:
     auto_calculate_content_length: false
-    body: '[{"id":208045946,"node_id":"MDU6TGFiZWwyMDgwNDU5NDY=","url":"https://api.github.com:443/repos/beliaev-maksim/test-ci/labels/synced-to-jira","name":"synced-to-jira","description":"TicketinJirahasbeencreatedforthisissue","color":"f29513","default":false}]'
+    body: '[{"id":208045946,"node_id":"MDU6TGFiZWwyMDgwNDU5NDY=","url":"https://api.github.com:443/repos/beliaev-maksim/test-ci/labels/synced-to-jira","name":"synced-to-jira","description":"Ticket in Jira has been created for this issue","color":"f29513","default":false}]'
     content_type: text/plain
     method: POST
     status: 200