Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix galaxy url use everywhere when url is set in config. #63286

Merged
merged 1 commit into from
Oct 9, 2019
Merged

Fix galaxy url use everywhere when url is set in config. #63286

merged 1 commit into from
Oct 9, 2019

Conversation

alikins
Copy link
Contributor

@alikins alikins commented Oct 9, 2019

SUMMARY

Fix galaxy url use everywhere when url is set in config.

In addition to trying the configured url (for ex, a migrated
'https://galaxy.ansible.com/') there is an attempt at that
URL with '/api' postpended.

If the extended URL works, update GalaxyAPI.api_server to
use the extended URL. Previously it only used it for finding
the API root info ('available_versions', etc)

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

ansible-galaxy

ADDITIONAL INFORMATION

If there is configuration (config file, env var, etc) that specify a galaxy server that
doesn't include the path to the galaxy API root, ansible-galaxy tries appending
a '/api/' to it. But it wasn't doing that for other calls.

Example config pointing at the imcomplete galaxy api URL, that is automatically
also tried with '/api/' appended to it.

[galaxy]
# server_list = local_hub, local_galaxy, galaxy, automation_hub, automation_hub_ci
server_list = galaxy


[galaxy_server.galaxy]
url=https://galaxy-dev.ansible.com/

Before:

(ansible-py3) [newswoop:F29:ansible (devel % u=)]$ rm -rf /tmp/collections/* && ALOGGING_STACK_INFO=1 HTTP_PROXY=127.0.0.1:8080 HTTPS_PROXY=127.0.0.1:8080 ANSIBLE_GALAXY_IGNORE=true ANSIBLE_CONFIG=ansible-galaxy.cfg ansible-galaxy-alog collection install   -vvvvv alikins.collection_inspect -p /tmp/collections/
12:09:25,745 D root MainProcess:14088 <module>:93 - fffffffffffffff None
ansible-galaxy-alog 2.10.0.dev0
  config file = /home/adrian/src/ansible/ansible-galaxy.cfg
  configured module search path = ['/home/adrian/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/adrian/src/ansible/lib/ansible
  executable location = /home/adrian/src/ansible/bin/ansible-galaxy-alog
  python version = 3.6.9 (default, Jul  3 2019, 17:57:57) [GCC 8.3.1 20190223 (Red Hat 8.3.1-2)]
Using /home/adrian/src/ansible/ansible-galaxy.cfg as config file

Process install dependency map
Initial connection to galaxy_server: https://galaxy-dev.ansible.com/
Opened /home/adrian/.ansible/galaxy_token
Calling Galaxy at https://galaxy-dev.ansible.com/
Processing requirement collection 'alikins.collection_inspect'
Collection requirement 'alikins.collection_inspect' is the name of a collection
Calling Galaxy at https://galaxy-dev.ansible.com/api
Found API version 'v1, v2' with Galaxy server galaxy (https://galaxy-dev.ansible.com/)
Calling Galaxy at https://galaxy-dev.ansible.com/v2/collections/alikins/collection_inspect/versions
ERROR! Failed to parse Galaxy response from 'https://galaxy-dev.ansible.com/v2/collections/alikins/collection_inspect/versions' as JSON:
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Ansible Galaxy</title>
  <base href="/">

  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="shortcut icon" type="image/x-icon" href="/assets/favicon.ico">
<link rel="stylesheet" href="styles.7bb982775d17919a33dd.css"></head>
<body>
  <galaxy-nav></galaxy-nav>
<script type="text/javascript" src="runtime.1ac76353d3406eb84d6a.js"></script><script type="text/javascript" src="polyfills.b630969cd11aa76bda54.js"></script><script type="text/javascript" src="main.95fdde42895545fd6626.js"></script></body>
</html>

ERROR! Failed to parse Galaxy response from 'https://galaxy-dev.ansible.com/v2/collections/alikins/collection_inspect/versions' as JSON:
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Ansible Galaxy</title>
  <base href="/">

  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="shortcut icon" type="image/x-icon" href="/assets/favicon.ico">
<link rel="stylesheet" href="styles.7bb982775d17919a33dd.css"></head>
<body>
  <galaxy-nav></galaxy-nav>
<script type="text/javascript" src="runtime.1ac76353d3406eb84d6a.js"></script><script type="text/javascript" src="polyfills.b630969cd11aa76bda54.js"></script><script type="text/javascript" src="main.95fdde42895545fd6626.js"></script></body>
</html>

After:

(ansible-py3) [newswoop:F29:ansible (galaxy_api_path_migrate %)]$ rm -rf /tmp/collections/* && ALOGGING_STACK_INFO=1 HTTP_PROXY=127.0.0.1:8080 HTTPS_PROXY=127.0.0.1:8080 ANSIBLE_GALAXY_IGNORE=true ANSIBLE_CONFIG=ansible-galaxy.cfg ansible-galaxy-alog collection install   -vvvvv alikins.collection_inspect -p /tmp/collections/
12:10:44,633 D root MainProcess:14250 <module>:93 - fffffffffffffff None
ansible-galaxy-alog 2.10.0.dev0
  config file = /home/adrian/src/ansible/ansible-galaxy.cfg
  configured module search path = ['/home/adrian/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/adrian/src/ansible/lib/ansible
  executable location = /home/adrian/src/ansible/bin/ansible-galaxy-alog
  python version = 3.6.9 (default, Jul  3 2019, 17:57:57) [GCC 8.3.1 20190223 (Red Hat 8.3.1-2)]
Using /home/adrian/src/ansible/ansible-galaxy.cfg as config file

Process install dependency map
Initial connection to galaxy_server: https://galaxy-dev.ansible.com/
Opened /home/adrian/.ansible/galaxy_token
Calling Galaxy at https://galaxy-dev.ansible.com/
Processing requirement collection 'alikins.collection_inspect'
Collection requirement 'alikins.collection_inspect' is the name of a collection
Calling Galaxy at https://galaxy-dev.ansible.com/api
Found API version 'v1, v2' with Galaxy server galaxy (https://galaxy-dev.ansible.com/api)
Calling Galaxy at https://galaxy-dev.ansible.com/api/v2/collections/alikins/collection_inspect/versions
Calling Galaxy at https://galaxy-dev.ansible.com/api/v2/collections/alikins/collection_inspect/versions/0.0.38
Collection 'alikins.collection_inspect' obtained from server galaxy https://galaxy-dev.ansible.com/api
Starting collection install process
Installing 'alikins.collection_inspect:0.0.38' to '/tmp/collections/ansible_collections/alikins/collection_inspect'
Downloading https://galaxy-dev.ansible.com/download/alikins-collection_inspect-0.0.38.tar.gz to /home/adrian/.ansible/tmp/ansible-local-14250nm0af0h3/tmps39i0sns
Validating downloaded file hash c6a69797cb04fa768acb74431ef7ea090e9c9d3e81044feeda65cdd020fbfffd with expected hash c6a69797cb04fa768acb74431ef7ea090e9c9d3e81044feeda65cdd020fbfffd

@alikins
Fix galaxy url use everywhere when url is set in config.
aa319a5 
In addition to trying the configured url (for ex, a migrated
'https://galaxy.ansible.com/') there is an attempt at that
URL with '/api' postpended.

If the extended URL works, update GalaxyAPI.api_server to
use the extended URL. Previously it only used it for finding
the API root info ('available_versions', etc)
@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 bug This issue/PR relates to a bug. core_review In order to be merged, this PR must follow the core review workflow. needs_triage Needs a first human triage before being processed. python3 small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Oct 9, 2019
@chouseknecht chouseknecht self-requested a review October 9, 2019 17:35
@chouseknecht
Copy link
Contributor

Test failures are related to yum and not this PR.

@alikins alikins added bug This issue/PR relates to a bug. and removed bug This issue/PR relates to a bug. labels Oct 9, 2019
@samdoran samdoran merged commit ed203c5 into ansible:devel Oct 9, 2019
@abadger abadger mentioned this pull request Oct 9, 2019
Merged
@alikins alikins mentioned this pull request Oct 9, 2019
Closed
@s-hertel s-hertel removed the needs_triage Needs a first human triage before being processed. label Oct 10, 2019
abadger pushed a commit that referenced this pull request Oct 10, 2019
@alikins @abadger
backport of galaxy trailing api fix (63238) to stable-2.9 (#63293)
ae3a79f 
* Stop appending '/api' to galaxy server url (#63238)

* Stop appending '/api' to configured galaxy server url

Since not all galaxy REST api server URLs live
at '/api', stop always appending it to the
'url' value loaded from config.

* Add note about manually migrated galaxy configs and /api

* Add '/api/' to galaxy url and guessing if galaxy API

* Fix most unit tests (update to expect /api/)

* Fix test_initialise_unknown unit test

Since we retry now with an added /api/, mock it as well.

* Update fallback default avail_ver to new format

(cherry picked from commit bad7269)

* Add changelog fragment galaxy_api_config

* Fix galaxy url use everywhere when url is set in config. (#63286)

In addition to trying the configured url (for ex, a migrated
'https://galaxy.ansible.com/') there is an attempt at that
URL with '/api' postpended.

If the extended URL works, update GalaxyAPI.api_server to
use the extended URL. Previously it only used it for finding
the API root info ('available_versions', etc)

(cherry picked from commit ed203c5)
@ansible ansible locked and limited conversation to collaborators Nov 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ironfroggy ironfroggy ironfroggy approved these changes

@chouseknecht chouseknecht chouseknecht approved these changes

@samdoran samdoran samdoran approved these changes

Assignees
No one assigned
Labels
affects_2.10 This issue/PR affects Ansible v2.10 bug This issue/PR relates to a bug. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. python3 small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@alikins @chouseknecht @ironfroggy @samdoran @ansibot @s-hertel