[ansible-galaxy] Fix listing collections with null namespace/name/version metadata (#77014)

* Fall back to implicit namespace.name from the path if the metadata is invalid

* Test listing a collection with null namespace/name/version fields in its galaxy.yml
pull/77400/head
Sloane Hertel 3 years ago committed by GitHub
parent 4ccc4c5aeb
commit f8ec660e62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,2 @@
bugfixes:
- ansible-galaxy - fix listing collections that contains metadata but the namespace or name are not strings.

@ -227,8 +227,24 @@ class _ComputedReqKindsMixin:
)
tmp_inst_req = cls(None, None, dir_path, 'dir', None)
req_name = art_mgr.get_direct_collection_fqcn(tmp_inst_req)
req_version = art_mgr.get_direct_collection_version(tmp_inst_req)
try:
req_name = art_mgr.get_direct_collection_fqcn(tmp_inst_req)
except TypeError as err:
# Looks like installed/source dir but isn't: doesn't have valid metadata.
display.warning(
u"Collection at '{path!s}' has a {manifest_json!s} "
u"or {galaxy_yml!s} file but it contains invalid metadata.".
format(
galaxy_yml=to_text(_GALAXY_YAML),
manifest_json=to_text(_MANIFEST_JSON),
path=to_text(dir_path, errors='surrogate_or_strict'),
),
)
raise ValueError(
"Collection at '{path!s}' has invalid metadata".
format(path=to_text(dir_path, errors='surrogate_or_strict'))
) from err
return cls(req_name, req_version, dir_path, 'dir', None)

@ -4,6 +4,7 @@
- 'dev.collection1'
- 'dev.collection2'
- 'dev.collection3'
- 'dev.collection4'
- name: replace the default version of the collections
lineinfile:
@ -18,6 +19,19 @@
- name: "collection3"
version: "version: ''"
- name: set the namespace, name, and version keys to None
lineinfile:
path: "{{ galaxy_dir }}/dev/ansible_collections/dev/collection4/galaxy.yml"
line: "{{ item.after }}"
regexp: "{{ item.before }}"
loop:
- before: "^namespace: dev"
after: "namespace:"
- before: "^name: collection4"
after: "name:"
- before: "^version: 1.0.0"
after: "version:"
- name: list collections in development without semver versions
command: ansible-galaxy collection list {{ galaxy_verbosity }}
register: list_result
@ -30,6 +44,7 @@
# Note the version displayed is the 'placeholder' string rather than "*" since it is not falsey
- "'dev.collection2 placeholder' in list_result.stdout"
- "'dev.collection3 *' in list_result.stdout"
- "'dev.collection4 *' in list_result.stdout"
- name: list collections in human format
command: ansible-galaxy collection list --format human
@ -52,7 +67,7 @@
- assert:
that:
- "item.value | length == 3"
- "item.value | length == 4"
- "item.value['dev.collection1'].version == '*'"
- "item.value['dev.collection2'].version == 'placeholder'"
- "item.value['dev.collection3'].version == '*'"
@ -66,7 +81,7 @@
- assert:
that:
- "item.value | length == 3"
- "item.value | length == 4"
- "item.value['dev.collection1'].version == '*'"
- "item.value['dev.collection2'].version == 'placeholder'"
- "item.value['dev.collection3'].version == '*'"

Loading…
Cancel
Save