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

Stop appending '/api' to galaxy server url #63238

Merged
merged 8 commits into from
Oct 8, 2019
Merged

Stop appending '/api' to galaxy server url #63238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d5e4d8e
Stop appending '/api' to configured galaxy server url
alikins Oct 7, 2019
b0b86b4
Add note about manually migrated galaxy configs and /api
alikins Oct 8, 2019
363da2d
Add '/api/' to galaxy url and guessing if galaxy API
alikins Oct 8, 2019
c6c16cf
Flake8
alikins Oct 8, 2019
09661e3
Remove comments
alikins Oct 8, 2019
e0ace14
Fix most unit tests (update to expect /api/)
alikins Oct 8, 2019
d40da6f
Fix test_initialise_unknown unit test
alikins Oct 8, 2019
b5c9a49
Update fallback default avail_ver to new format
alikins Oct 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 18 additions & 4 deletions lib/ansible/galaxy/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,30 @@ def wrapped(self, *args, **kwargs):

# Determine the type of Galaxy server we are talking to. First try it unauthenticated then with Bearer
# auth for Automation Hub.
n_url = _urljoin(self.api_server, 'api')
n_url = self.api_server
error_context_msg = 'Error when finding available api versions from %s (%s)' % (self.name, n_url)

data = self._call_galaxy(n_url, method='GET', error_context_msg=error_context_msg)
if self.api_server == 'https://galaxy.ansible.com' or self.api_server == 'https://galaxy.ansible.com/':
n_url = 'https://galaxy.ansible.com/api/'

try:
data = self._call_galaxy(n_url, method='GET', error_context_msg=error_context_msg)
except (AnsibleError, GalaxyError, ValueError, KeyError):
# Either the URL doesnt exist, or other error. Or the URL exists, but isn't a galaxy API
# root (not JSON, no 'available_versions') so try appending '/api/'
n_url = _urljoin(n_url, '/api/')

# let exceptions here bubble up
data = self._call_galaxy(n_url, method='GET', error_context_msg=error_context_msg)
if 'available_versions' not in data:
raise AnsibleError("Tried to find galaxy API root at %s but no 'available_versions' are available on %s"
% (n_url, self.api_server))

# Default to only supporting v1, if only v1 is returned we also assume that v2 is available even though
# it isn't returned in the available_versions dict.
available_versions = data.get('available_versions', {u'v1': u'/api/v1'})
available_versions = data.get('available_versions', {u'v1': u'v1/'})
if list(available_versions.keys()) == [u'v1']:
available_versions[u'v2'] = u'/api/v2'
available_versions[u'v2'] = u'v2/'

self._available_api_versions = available_versions
display.vvvv("Found API version '%s' with Galaxy server %s (%s)"
Expand Down
93 changes: 47 additions & 46 deletions test/units/galaxy/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ def get_test_galaxy_api(url, version, token_ins=None, token_value=None):
token_value = token_value or "my token"
token_ins = token_ins or GalaxyToken(token_value)
api = GalaxyAPI(None, "test", url)
api._available_api_versions = {version: '/api/%s' % version}
api._available_api_versions = {version: '%s' % version}
api.token = token_ins

return api


def test_api_no_auth():
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/")
actual = {}
api._add_auth_token(actual, "")
assert actual == {}
Expand All @@ -74,12 +74,12 @@ def test_api_no_auth_but_required():
expected = "No access token or username set. A token can be set with --api-key, with 'ansible-galaxy login', " \
"or set in ansible.cfg."
with pytest.raises(AnsibleError, match=expected):
GalaxyAPI(None, "test", "https://galaxy.ansible.com")._add_auth_token({}, "", required=True)
GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/")._add_auth_token({}, "", required=True)


def test_api_token_auth():
token = GalaxyToken(token=u"my_token")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
api._add_auth_token(actual, "", required=True)
assert actual == {'Authorization': 'Token my_token'}
Expand All @@ -90,7 +90,7 @@ def test_api_token_auth_with_token_type(monkeypatch):
mock_token_get = MagicMock()
mock_token_get.return_value = 'my_token'
monkeypatch.setattr(token, 'get', mock_token_get)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
api._add_auth_token(actual, "", token_type="Bearer", required=True)
assert actual == {'Authorization': 'Bearer my_token'}
Expand All @@ -101,15 +101,15 @@ def test_api_token_auth_with_v3_url(monkeypatch):
mock_token_get = MagicMock()
mock_token_get.return_value = 'my_token'
monkeypatch.setattr(token, 'get', mock_token_get)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
api._add_auth_token(actual, "https://galaxy.ansible.com/api/v3/resource/name", required=True)
assert actual == {'Authorization': 'Bearer my_token'}


def test_api_token_auth_with_v2_url():
token = GalaxyToken(token=u"my_token")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
# Add v3 to random part of URL but response should only see the v2 as the full URI path segment.
api._add_auth_token(actual, "https://galaxy.ansible.com/api/v2/resourcev3/name", required=True)
Expand All @@ -118,22 +118,22 @@ def test_api_token_auth_with_v2_url():

def test_api_basic_auth_password():
token = BasicAuthToken(username=u"user", password=u"pass")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
api._add_auth_token(actual, "", required=True)
assert actual == {'Authorization': 'Basic dXNlcjpwYXNz'}


def test_api_basic_auth_no_password():
token = BasicAuthToken(username=u"user")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)
actual = {}
api._add_auth_token(actual, "", required=True)
assert actual == {'Authorization': 'Basic dXNlcjo='}


def test_api_dont_override_auth_header():
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/")
actual = {'Authorization': 'Custom token'}
api._add_auth_token(actual, "", required=True)
assert actual == {'Authorization': 'Custom token'}
Expand All @@ -142,41 +142,41 @@ def test_api_dont_override_auth_header():
def test_initialise_galaxy(monkeypatch):
mock_open = MagicMock()
mock_open.side_effect = [
StringIO(u'{"available_versions":{"v1":"/api/v1"}}'),
StringIO(u'{"available_versions":{"v1":"v1/"}}'),
StringIO(u'{"token":"my token"}'),
]
monkeypatch.setattr(galaxy_api, 'open_url', mock_open)

api = GalaxyAPI(None, "test", "https://galaxy.ansible.com")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/")
actual = api.authenticate("github_token")

assert len(api.available_api_versions) == 2
assert api.available_api_versions['v1'] == u'/api/v1'
assert api.available_api_versions['v2'] == u'/api/v2'
assert api.available_api_versions['v1'] == u'v1/'
assert api.available_api_versions['v2'] == u'v2/'
assert actual == {u'token': u'my token'}
assert mock_open.call_count == 2
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api'
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api/'
assert mock_open.mock_calls[1][1][0] == 'https://galaxy.ansible.com/api/v1/tokens/'
assert mock_open.mock_calls[1][2]['data'] == 'github_token=github_token'


def test_initialise_galaxy_with_auth(monkeypatch):
mock_open = MagicMock()
mock_open.side_effect = [
StringIO(u'{"available_versions":{"v1":"/api/v1"}}'),
StringIO(u'{"available_versions":{"v1":"v1/"}}'),
StringIO(u'{"token":"my token"}'),
]
monkeypatch.setattr(galaxy_api, 'open_url', mock_open)

api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=GalaxyToken(token='my_token'))
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=GalaxyToken(token='my_token'))
actual = api.authenticate("github_token")

assert len(api.available_api_versions) == 2
assert api.available_api_versions['v1'] == u'/api/v1'
assert api.available_api_versions['v2'] == u'/api/v2'
assert api.available_api_versions['v1'] == u'v1/'
assert api.available_api_versions['v2'] == u'v2/'
assert actual == {u'token': u'my token'}
assert mock_open.call_count == 2
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api'
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api/'
assert mock_open.mock_calls[1][1][0] == 'https://galaxy.ansible.com/api/v1/tokens/'
assert mock_open.mock_calls[1][2]['data'] == 'github_token=github_token'

Expand All @@ -192,53 +192,54 @@ def test_initialise_automation_hub(monkeypatch):
mock_token_get.return_value = 'my_token'
monkeypatch.setattr(token, 'get', mock_token_get)

api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=token)
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=token)

assert len(api.available_api_versions) == 2
assert api.available_api_versions['v2'] == u'v2/'
assert api.available_api_versions['v3'] == u'v3/'

assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api'
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api/'
assert mock_open.mock_calls[0][2]['headers'] == {'Authorization': 'Bearer my_token'}


def test_initialise_unknown(monkeypatch):
mock_open = MagicMock()
mock_open.side_effect = [
urllib_error.HTTPError('https://galaxy.ansible.com/api', 500, 'msg', {}, StringIO(u'{"msg":"raw error"}')),
urllib_error.HTTPError('https://galaxy.ansible.com/api/', 500, 'msg', {}, StringIO(u'{"msg":"raw error"}')),
urllib_error.HTTPError('https://galaxy.ansible.com/api/api/', 500, 'msg', {}, StringIO(u'{"msg":"raw error"}')),
]
monkeypatch.setattr(galaxy_api, 'open_url', mock_open)

api = GalaxyAPI(None, "test", "https://galaxy.ansible.com", token=GalaxyToken(token='my_token'))
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/", token=GalaxyToken(token='my_token'))

expected = "Error when finding available api versions from test (%s/api) (HTTP Code: 500, Message: Unknown " \
expected = "Error when finding available api versions from test (%s) (HTTP Code: 500, Message: Unknown " \
"error returned by Galaxy server.)" % api.api_server
with pytest.raises(GalaxyError, match=re.escape(expected)):
with pytest.raises(AnsibleError, match=re.escape(expected)):
api.authenticate("github_token")


def test_get_available_api_versions(monkeypatch):
mock_open = MagicMock()
mock_open.side_effect = [
StringIO(u'{"available_versions":{"v1":"/api/v1","v2":"/api/v2"}}'),
StringIO(u'{"available_versions":{"v1":"v1/","v2":"v2/"}}'),
]
monkeypatch.setattr(galaxy_api, 'open_url', mock_open)

api = GalaxyAPI(None, "test", "https://galaxy.ansible.com")
api = GalaxyAPI(None, "test", "https://galaxy.ansible.com/api/")
actual = api.available_api_versions
assert len(actual) == 2
assert actual['v1'] == u'/api/v1'
assert actual['v2'] == u'/api/v2'
assert actual['v1'] == u'v1/'
assert actual['v2'] == u'v2/'

assert mock_open.call_count == 1
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api'
assert mock_open.mock_calls[0][1][0] == 'https://galaxy.ansible.com/api/'


def test_publish_collection_missing_file():
fake_path = u'/fake/ÅÑŚÌβŁÈ/path'
expected = to_native("The collection path specified '%s' does not exist." % fake_path)

api = get_test_galaxy_api("https://galaxy.ansible.com", "v2")
api = get_test_galaxy_api("https://galaxy.ansible.com/api/", "v2")
with pytest.raises(AnsibleError, match=expected):
api.publish_collection(fake_path)

Expand All @@ -247,7 +248,7 @@ def test_publish_collection_not_a_tarball():
expected = "The collection path specified '{0}' is not a tarball, use 'ansible-galaxy collection build' to " \
"create a proper release artifact."

api = get_test_galaxy_api("https://galaxy.ansible.com", "v2")
api = get_test_galaxy_api("https://galaxy.ansible.com/api/", "v2")
with tempfile.NamedTemporaryFile(prefix=u'ÅÑŚÌβŁÈ') as temp_file:
temp_file.write(b"\x00")
temp_file.flush()
Expand All @@ -257,9 +258,9 @@ def test_publish_collection_not_a_tarball():

def test_publish_collection_unsupported_version():
expected = "Galaxy action publish_collection requires API versions 'v2, v3' but only 'v1' are available on test " \
"https://galaxy.ansible.com"
"https://galaxy.ansible.com/api/"

api = get_test_galaxy_api("https://galaxy.ansible.com", "v1")
api = get_test_galaxy_api("https://galaxy.ansible.com/api/", "v1")
with pytest.raises(AnsibleError, match=expected):
api.publish_collection("path")

Expand All @@ -269,7 +270,7 @@ def test_publish_collection_unsupported_version():
('v3', 'artifacts/collections'),
])
def test_publish_collection(api_version, collection_url, collection_artifact, monkeypatch):
api = get_test_galaxy_api("https://galaxy.ansible.com", api_version)
api = get_test_galaxy_api("https://galaxy.ansible.com/api/", api_version)

mock_call = MagicMock()
mock_call.return_value = {'task': 'http://task.url/'}
Expand Down Expand Up @@ -318,7 +319,7 @@ def test_publish_collection(api_version, collection_url, collection_artifact, mo
u'Message: Rändom(?) quantum improbability. Code: quantum_improbability)')
])
def test_publish_failure(api_version, collection_url, response, expected, collection_artifact, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version)

expected_url = '%s/api/%s/%s' % (api.api_server, api_version, collection_url)

Expand All @@ -336,7 +337,7 @@ def test_publish_failure(api_version, collection_url, response, expected, collec
('v3', 'Bearer', KeycloakToken(auth_url='https://api.test/')),
])
def test_wait_import_task(api_version, token_type, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)
import_uri = 'https://galaxy.server.com/api/%s/task/1234' % api_version

if token_ins:
Expand Down Expand Up @@ -366,7 +367,7 @@ def test_wait_import_task(api_version, token_type, token_ins, monkeypatch):
('v3', 'Bearer', KeycloakToken(auth_url='https://api.test/')),
])
def test_wait_import_task_multiple_requests(api_version, token_type, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)
import_uri = 'https://galaxy.server.com/api/%s/task/1234' % api_version

if token_ins:
Expand Down Expand Up @@ -410,7 +411,7 @@ def test_wait_import_task_multiple_requests(api_version, token_type, token_ins,
('v3', 'Bearer', KeycloakToken(auth_url='https://api.test/')),
])
def test_wait_import_task_with_failure(api_version, token_type, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)
import_uri = 'https://galaxy.server.com/api/%s/task/1234' % api_version

if token_ins:
Expand Down Expand Up @@ -484,7 +485,7 @@ def test_wait_import_task_with_failure(api_version, token_type, token_ins, monke
('v3', 'Bearer', KeycloakToken(auth_url='https://api.test/')),
])
def test_wait_import_task_with_failure_no_error(api_version, token_type, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)
import_uri = 'https://galaxy.server.com/api/%s/task/1234' % api_version

if token_ins:
Expand Down Expand Up @@ -554,7 +555,7 @@ def test_wait_import_task_with_failure_no_error(api_version, token_type, token_i
('v3', 'Bearer', KeycloakToken(auth_url='https://api.test/')),
])
def test_wait_import_task_timeout(api_version, token_type, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)
import_uri = 'https://galaxy.server.com/api/%s/task/1234' % api_version

if token_ins:
Expand Down Expand Up @@ -609,7 +610,7 @@ def return_response(*args, **kwargs):
('v3', 'Bearer', 'v1.0.0', KeycloakToken(auth_url='https://api.test/api/automation-hub/')),
])
def test_get_collection_version_metadata_no_version(api_version, token_type, version, token_ins, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)

if token_ins:
mock_token_get = MagicMock()
Expand Down Expand Up @@ -648,7 +649,7 @@ def test_get_collection_version_metadata_no_version(api_version, token_type, ver
assert actual.dependencies == {}

assert mock_open.call_count == 1
assert mock_open.mock_calls[0][1][0] == '%s/api/%s/collections/namespace/collection/versions/%s' \
assert mock_open.mock_calls[0][1][0] == '%s%s/collections/namespace/collection/versions/%s' \
% (api.api_server, api_version, version)

# v2 calls dont need auth, so no authz header or token_type
Expand Down Expand Up @@ -690,7 +691,7 @@ def test_get_collection_version_metadata_no_version(api_version, token_type, ver
}),
])
def test_get_collection_versions(api_version, token_type, token_ins, response, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)

if token_ins:
mock_token_get = MagicMock()
Expand Down Expand Up @@ -816,7 +817,7 @@ def test_get_collection_versions(api_version, token_type, token_ins, response, m
]),
])
def test_get_collection_versions_pagination(api_version, token_type, token_ins, responses, monkeypatch):
api = get_test_galaxy_api('https://galaxy.server.com', api_version, token_ins=token_ins)
api = get_test_galaxy_api('https://galaxy.server.com/api/', api_version, token_ins=token_ins)

if token_ins:
mock_token_get = MagicMock()
Expand Down