From f8ec660e62c6797d6f2fce2a173d96684d8a9b42 Mon Sep 17 00:00:00 2001
From: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
Date: Tue, 29 Mar 2022 15:18:06 -0400
Subject: [PATCH] [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
---
 ...-list-fix-null-metadata-namespace-name.yml |  2 ++
 .../dependency_resolution/dataclasses.py      | 18 +++++++++++++++++-
 .../ansible-galaxy-collection/tasks/list.yml  | 19 +++++++++++++++++--
 3 files changed, 36 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/fragments/77014-ansible-galaxy-list-fix-null-metadata-namespace-name.yml

diff --git a/changelogs/fragments/77014-ansible-galaxy-list-fix-null-metadata-namespace-name.yml b/changelogs/fragments/77014-ansible-galaxy-list-fix-null-metadata-namespace-name.yml
new file mode 100644
index 00000000000..b86492e58ca
--- /dev/null
+++ b/changelogs/fragments/77014-ansible-galaxy-list-fix-null-metadata-namespace-name.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - ansible-galaxy - fix listing collections that contains metadata but the namespace or name are not strings.
diff --git a/lib/ansible/galaxy/dependency_resolution/dataclasses.py b/lib/ansible/galaxy/dependency_resolution/dataclasses.py
index 372aa7befbb..ead07d85fb5 100644
--- a/lib/ansible/galaxy/dependency_resolution/dataclasses.py
+++ b/lib/ansible/galaxy/dependency_resolution/dataclasses.py
@@ -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)
 
diff --git a/test/integration/targets/ansible-galaxy-collection/tasks/list.yml b/test/integration/targets/ansible-galaxy-collection/tasks/list.yml
index 331e0a1c49c..f4d0f51bbe4 100644
--- a/test/integration/targets/ansible-galaxy-collection/tasks/list.yml
+++ b/test/integration/targets/ansible-galaxy-collection/tasks/list.yml
@@ -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 == '*'"