archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed error handling in github_issue module (#39652)

Browse Source 
* Fixed error handling in github_issue module

Due to recent changes in github3.py library module stopped working.
This fix adds extra error handling for new changes in library.

Fixes: #39627

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Check version

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Refactor github_issue

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/56436/head
Abhijeet Kasurde 5 years ago committed by ansibot
parent 107d9efef3
commit 5ef2c5314e
8 changed files with 34 additions and 97 deletions
Show Stats Download Patch File Download Diff File

63
lib/ansible/modules/source_control/github_issue.py
Unescape Escape View File

@ -1,21 +1,25 @@
#!/usr/bin/python
# (c) 2017, Abhijeet Kasurde <akasurde@redhat.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Copyright: (c) 2017-18, Abhijeet Kasurde <akasurde@redhat.com>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = '''
module: github_issue
short_description: View GitHub issue.
description:
- View GitHub issue for a given repository.
- View GitHub issue for a given repository and organization.
version_added: "2.4"
options:
repo:
@ -35,12 +39,9 @@ options:
- Get various details about issue depending upon action specified.
default: 'get_status'
choices:
- ['get_status']
- 'get_status'
author:
- Abhijeet Kasurde (@Akasurde)
requirements:
- "github3.py >= 1.0.0a4"
'''
RETURN = '''
@ -66,17 +67,10 @@ EXAMPLES = '''
when: r.issue_status == 'open'
'''
import traceback
import json
GITHUB_IMP_ERR = None
try:
import github3
HAS_GITHUB_PACKAGE = True
except ImportError:
GITHUB_IMP_ERR = traceback.format_exc()
HAS_GITHUB_PACKAGE = False
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
def main():
@ -84,16 +78,12 @@ def main():
argument_spec=dict(
organization=dict(required=True),
repo=dict(required=True),
issue=dict(required=True),
action=dict(required=False, choices=['get_status']),
issue=dict(type='int', required=True),
action=dict(choices=['get_status'], default='get_status'),
),
supports_check_mode=True,
)
if not HAS_GITHUB_PACKAGE:
module.fail_json(msg=missing_required_lib('github3.py >= 1.0.0a4'),
exception=GITHUB_IMP_ERR)
organization = module.params['organization']
repo = module.params['repo']
issue = module.params['issue']
@ -101,17 +91,26 @@ def main():
result = dict()
gh_obj = github3.issue(organization, repo, issue)
if gh_obj is None:
module.fail_json(msg="Failed to get details about issue specified. "
"Please check organization, repo and issue "
"details and try again.")
headers = {
'Content-Type': 'application/json',
'Accept': 'application/vnd.github.v3+json',
}
url = "https://api.github.com/repos/%s/%s/issues/%s" % (organization, repo, issue)
response, info = fetch_url(module, url, headers=headers)
if not (200 <= info['status'] < 400):
if info['status'] == 404:
module.fail_json(msg="Failed to find issue %s" % issue)
module.fail_json(msg="Failed to send request to %s: %s" % (url, info['msg']))
gh_obj = json.loads(response.read())
if action == 'get_status' or action is None:
if module.check_mode:
result.update(changed=True)
else:
result.update(changed=True, issue_status=gh_obj.state)
result.update(changed=True, issue_status=gh_obj['state'])
module.exit_json(**result)

1
test/integration/targets/github_issue/aliases
Unescape Escape View File

@ -1,3 +1,2 @@
destructive
shippable/posix/group1
disabled

3
test/integration/targets/github_issue/tasks/FreeBSD-python2.yml
Unescape Escape View File

@ -1,3 +0,0 @@
- name: install py27-requests to avoid install via pip later
package:
name: py27-requests

1
test/integration/targets/github_issue/tasks/MacOSX-python2.yml
Unescape Escape View File

@ -1 +0,0 @@
# nothing to do here, allow requests to be installed by pip later

3
test/integration/targets/github_issue/tasks/default-python2.yml
Unescape Escape View File

@ -1,3 +0,0 @@
- name: install python-requests to avoid install via pip later
package:
name: python-requests

3
test/integration/targets/github_issue/tasks/default-python3.yml
Unescape Escape View File

@ -1,3 +0,0 @@
- name: install python3-requests to avoid install via pip later
package:
name: python3-requests

53
test/integration/targets/github_issue/tasks/main.yml
Unescape Escape View File

@ -1,56 +1,8 @@
# Test code for the github_issue module.
# (c) 2017, Abhijeet Kasurde <akasurde@redhat.com>
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
- name: make sure github3.py is not installed
pip:
name: github3.py
state: absent
# Testcase 0001: Check if dependency is installed
- name: Check if github3.py is installed or not
github_issue:
organization: "{{ organization }}"
repo: "{{ repo }}"
issue: "{{ non_existent_issue }}"
action: get_status
register: lib_missing
ignore_errors: True
- assert:
that:
- "{{ lib_missing.failed == True }}"
- "{{ lib_missing.changed == False }}"
- "{{ 'Missing required github3 module.' in lib_missing.msg }}"
- include: '{{ item }}'
with_first_found:
- files:
- '{{ ansible_distribution }}-{{ ansible_distribution_version }}-python{{ ansible_python_version.split(".")[0] }}.yml'
- '{{ ansible_distribution }}-python{{ ansible_python_version.split(".")[0] }}.yml'
- '{{ ansible_os_family }}-python{{ ansible_python_version.split(".")[0] }}.yml'
- 'default-python{{ ansible_python_version.split(".")[0] }}.yml'
- name: make sure github3.py is installed
pip:
name: github3.py
# Copyright: (c) 2017-2018, Abhijeet Kasurde <akasurde@redhat.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Testcase 0002: Check if issue exists
- name: Check if GitHub issue is closed or not
github_issue:
organization: "{{ organization }}"
@ -64,7 +16,6 @@
- "{{ get_status_0002.changed == True }}"
- "{{ get_status_0002.issue_status == 'closed' }}"
# Testcase 0003: Check non-existent issue status
- name: Check if GitHub issue is closed or not
github_issue:
organization: "{{ organization }}"

4
test/sanity/validate-modules/ignore.txt
Unescape Escape View File

@ -738,8 +738,6 @@ lib/ansible/modules/remote_management/ucs/ucs_vsans.py E322
lib/ansible/modules/remote_management/ucs/ucs_wwn_pool.py E322
lib/ansible/modules/remote_management/ucs/ucs_wwn_pool.py E323
lib/ansible/modules/source_control/github_deploy_key.py E336
lib/ansible/modules/source_control/github_issue.py E324
lib/ansible/modules/source_control/github_issue.py E326
lib/ansible/modules/source_control/subversion.py E322
lib/ansible/modules/storage/infinidat/infini_export.py E323
lib/ansible/modules/storage/infinidat/infini_export.py E324
@ -800,4 +798,4 @@ lib/ansible/modules/web_infrastructure/gunicorn.py E322
lib/ansible/modules/web_infrastructure/htpasswd.py E326
lib/ansible/modules/web_infrastructure/jenkins_plugin.py E322
lib/ansible/modules/web_infrastructure/jenkins_plugin.py E324
lib/ansible/modules/web_infrastructure/jira.py E322
lib/ansible/modules/web_infrastructure/jira.py E322
Write Preview
Loading…
Cancel
Save