1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/tests/unit/plugins/modules/web_infrastructure/test_jenkins_plugin.py
patchback[bot] d827601c95
Add fallback url for jenkins plugin () ()
* uncoupled updates_url from plugin download urls
added new parameters: versioned_plugins_url, latest_plugins_url

* parameters updates_url, latest_plugins_url and versioned_plugins_url changed type to list of strings to implement fallback URLs usage
added type conversion if they are string (backward compatibility)

* removed type conversion this is handled by ansible validation
fix: dont fail if first url fails

* added fallback: if installation from plugin manager fails, try downloading the plugin manually

* fixed test failures

* PEP8 indent fix

* changelog fragment

* added debug outputs for new url fallback behavior

* added version_added in description for latest_plugins_url

Co-authored-by: Felix Fontein <felix@fontein.de>

* added version_added in description for versioned_plugins_url

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update changelogs/fragments/1334-jenkins-plugin-fallback-urls.yaml

Co-authored-by: Felix Fontein <felix@fontein.de>

* improve backwards-compatibility
add optional arg to allow custom update-center.json targets

* pep8 fixes

* fix inconsistency in argument documentation

* Apply suggestions from code review

Co-authored-by: Amin Vakil <info@aminvakil.com>

* add unit tests

* fix pep8

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Amin Vakil <info@aminvakil.com>
(cherry picked from commit 9c7b539ef6)

Co-authored-by: NivKeidan <51288016+NivKeidan@users.noreply.github.com>
2021-06-29 09:02:35 +00:00

190 lines
8.4 KiB
Python

# 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
from io import BytesIO
from ansible_collections.community.general.plugins.modules.web_infrastructure.jenkins_plugin import JenkinsPlugin
from ansible.module_utils.common._collections_compat import Mapping
def pass_function(*args, **kwargs):
pass
GITHUB_DATA = {"url": u'https://api.github.com/repos/ansible/ansible',
"response": b"""
{
"id": 3638964,
"name": "ansible",
"full_name": "ansible/ansible",
"owner": {
"login": "ansible",
"id": 1507452,
"avatar_url": "https://avatars2.githubusercontent.com/u/1507452?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/ansible",
"html_url": "https://github.com/ansible",
"followers_url": "https://api.github.com/users/ansible/followers",
"following_url": "https://api.github.com/users/ansible/following{/other_user}",
"gists_url": "https://api.github.com/users/ansible/gists{/gist_id}",
"starred_url": "https://api.github.com/users/ansible/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/ansible/subscriptions",
"organizations_url": "https://api.github.com/users/ansible/orgs",
"repos_url": "https://api.github.com/users/ansible/repos",
"events_url": "https://api.github.com/users/ansible/events{/privacy}",
"received_events_url": "https://api.github.com/users/ansible/received_events",
"type": "Organization",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/ansible/ansible",
"description": "Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy.",
"fork": false,
"url": "https://api.github.com/repos/ansible/ansible",
"forks_url": "https://api.github.com/repos/ansible/ansible/forks",
"keys_url": "https://api.github.com/repos/ansible/ansible/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/ansible/ansible/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/ansible/ansible/teams",
"hooks_url": "https://api.github.com/repos/ansible/ansible/hooks",
"issue_events_url": "https://api.github.com/repos/ansible/ansible/issues/events{/number}",
"events_url": "https://api.github.com/repos/ansible/ansible/events",
"assignees_url": "https://api.github.com/repos/ansible/ansible/assignees{/user}",
"branches_url": "https://api.github.com/repos/ansible/ansible/branches{/branch}",
"tags_url": "https://api.github.com/repos/ansible/ansible/tags",
"blobs_url": "https://api.github.com/repos/ansible/ansible/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/ansible/ansible/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/ansible/ansible/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/ansible/ansible/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/ansible/ansible/statuses/{sha}",
"languages_url": "https://api.github.com/repos/ansible/ansible/languages",
"stargazers_url": "https://api.github.com/repos/ansible/ansible/stargazers",
"contributors_url": "https://api.github.com/repos/ansible/ansible/contributors",
"subscribers_url": "https://api.github.com/repos/ansible/ansible/subscribers",
"subscription_url": "https://api.github.com/repos/ansible/ansible/subscription",
"commits_url": "https://api.github.com/repos/ansible/ansible/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/ansible/ansible/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/ansible/ansible/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/ansible/ansible/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/ansible/ansible/contents/{+path}",
"compare_url": "https://api.github.com/repos/ansible/ansible/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/ansible/ansible/merges",
"archive_url": "https://api.github.com/repos/ansible/ansible/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/ansible/ansible/downloads",
"issues_url": "https://api.github.com/repos/ansible/ansible/issues{/number}",
"pulls_url": "https://api.github.com/repos/ansible/ansible/pulls{/number}",
"milestones_url": "https://api.github.com/repos/ansible/ansible/milestones{/number}",
"notifications_url": "https://api.github.com/repos/ansible/ansible/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/ansible/ansible/labels{/name}",
"releases_url": "https://api.github.com/repos/ansible/ansible/releases{/id}",
"deployments_url": "https://api.github.com/repos/ansible/ansible/deployments",
"created_at": "2012-03-06T14:58:02Z",
"updated_at": "2017-09-19T18:10:54Z",
"pushed_at": "2017-09-19T18:04:51Z",
"git_url": "git://github.com/ansible/ansible.git",
"ssh_url": "git@github.com:ansible/ansible.git",
"clone_url": "https://github.com/ansible/ansible.git",
"svn_url": "https://github.com/ansible/ansible",
"homepage": "https://www.ansible.com/",
"size": 91174,
"stargazers_count": 25552,
"watchers_count": 25552,
"language": "Python",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": false,
"has_pages": false,
"forks_count": 8893,
"mirror_url": null,
"open_issues_count": 4283,
"forks": 8893,
"open_issues": 4283,
"watchers": 25552,
"default_branch": "devel",
"organization": {
"login": "ansible",
"id": 1507452,
"avatar_url": "https://avatars2.githubusercontent.com/u/1507452?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/ansible",
"html_url": "https://github.com/ansible",
"followers_url": "https://api.github.com/users/ansible/followers",
"following_url": "https://api.github.com/users/ansible/following{/other_user}",
"gists_url": "https://api.github.com/users/ansible/gists{/gist_id}",
"starred_url": "https://api.github.com/users/ansible/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/ansible/subscriptions",
"organizations_url": "https://api.github.com/users/ansible/orgs",
"repos_url": "https://api.github.com/users/ansible/repos",
"events_url": "https://api.github.com/users/ansible/events{/privacy}",
"received_events_url": "https://api.github.com/users/ansible/received_events",
"type": "Organization",
"site_admin": false
},
"network_count": 8893,
"subscribers_count": 1733
}
"""
}
def test__get_json_data(mocker):
"test the json conversion of _get_url_data"
timeout = 30
params = {
'url': GITHUB_DATA['url'],
'timeout': timeout
}
module = mocker.Mock()
module.params = params
JenkinsPlugin._csrf_enabled = pass_function
JenkinsPlugin._get_installed_plugins = pass_function
JenkinsPlugin._get_url_data = mocker.Mock()
JenkinsPlugin._get_url_data.return_value = BytesIO(GITHUB_DATA['response'])
jenkins_plugin = JenkinsPlugin(module)
json_data = jenkins_plugin._get_json_data(
"{url}".format(url=GITHUB_DATA['url']),
'CSRF')
assert isinstance(json_data, Mapping)
def test__new_fallback_urls(mocker):
"test generation of new fallback URLs"
params = {
"url": "http://fake.jenkins.server",
"timeout": 30,
"name": "test-plugin",
"version": "1.2.3",
"updates_url": ["https://some.base.url"],
"latest_plugins_url_segments": ["test_latest"],
"versioned_plugins_url_segments": ["ansible", "versioned_plugins"],
"update_json_url_segment": ["unreachable", "updates/update-center.json"],
}
module = mocker.Mock()
module.params = params
JenkinsPlugin._csrf_enabled = pass_function
JenkinsPlugin._get_installed_plugins = pass_function
jenkins_plugin = JenkinsPlugin(module)
latest_urls = jenkins_plugin._get_latest_plugin_urls()
assert isInList(latest_urls, "https://some.base.url/test_latest/test-plugin.hpi")
versioned_urls = jenkins_plugin._get_versioned_plugin_urls()
assert isInList(versioned_urls, "https://some.base.url/versioned_plugins/test-plugin/1.2.3/test-plugin.hpi")
json_urls = jenkins_plugin._get_update_center_urls()
assert isInList(json_urls, "https://some.base.url/updates/update-center.json")
def isInList(l, i):
print("checking if %s in %s" % (i, l))
for item in l:
if item == i:
return True
return False