[PR #10011/c2480730 backport][stable-10] fix: github_deploy_key check key exists on 422 (#10036)

fix: github_deploy_key check key exists on 422 (#10011)

* fix: github_deploy_key check key exists on 422

If we get a 422 response code as we add a key, check if it's because the key already exists or for another reason.

fixes: #6718

* chore: add changelog 10011-github_deploy_key-check-key-present

* chore: fix changelog fragment

* chore: fix changelog fragment

* Update changelog fragment.

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit c248073)

Co-authored-by: Alex Garel <[email protected]>

Author: patchback[bot]

changelogs/fragments/10011-github_deploy_key-check-key-present.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - "github_deploy_key - check that key really exists on 422 to avoid masking other errors (https://github.com/ansible-collections/community.general/issues/6718, https://github.com/ansible-collections/community.general/pull/10011)."

plugins/modules/github_deploy_key.py

@@ -259,7 +259,12 @@ def add_new_key(self):
             key_id = response_body["id"]
             self.module.exit_json(changed=True, msg="Deploy key successfully added", id=key_id)
         elif status_code == 422:
-            self.module.exit_json(changed=False, msg="Deploy key already exists")
+            # there might be multiple reasons for a 422
+            # so we must check if the reason is that the key already exists
+            if self.get_existing_key():
+                self.module.exit_json(changed=False, msg="Deploy key already exists")
+            else:
+                self.handle_error(method="POST", info=info)
         else:
             self.handle_error(method="POST", info=info)