Support plugins with sidecar documentation

Author: sivel

galaxy_importer/constants.py

@@ -75,15 +75,15 @@
 LEGACY_NAMESPACE_REGEXP = re.compile("^([a-zA-Z0-9.]+[-_]?)+$")
 
 
-class ContentCategory(enum.Enum):
+class ContentCategory(str, enum.Enum):
     MODULE = "module"
     ROLE = "role"
     PLUGIN = "plugin"
     PLAYBOOK = "playbook"
     EXTENSION = "extension"
 
 
-class ContentType(enum.Enum):
+class ContentType(str, enum.Enum):
     PLAYBOOK = "playbook"
     ROLE = "role"
     MODULE = "module"

galaxy_importer/loaders/collection.py

@@ -28,7 +28,7 @@
     from ansible_builder._target_scripts import introspect
 
 from galaxy_importer import exceptions as exc
-from galaxy_importer.finder import ContentFinder, FileWalker
+from galaxy_importer.finder import ContentFinder, FileWalker, Result
 from galaxy_importer import constants
 from galaxy_importer import loaders, file_parser, schema
 from galaxy_importer.utils import markup as markup_utils
@@ -370,8 +370,21 @@ def _check_filename_matches_manifest(self):
 
     def _load_contents(self):
         """Find and load data for each content inside the collection."""
-        found_contents = ContentFinder().find_contents(self.path, self.log)
-        for content_type, rel_path in found_contents:
+        found_contents = set()
+        if self.doc_strings:
+            # This block adds paths found by ansible-doc, which does not currently
+            # include extensions (eda) as of ansible-core 2.19
+            for content_type, contents in self.doc_strings.items():
+                content_type = constants.ContentType(content_type)
+                for _, content in contents.items():
+                    rel_path = os.path.relpath(content["doc"]["filename"], self.path)
+                    found_contents.add(Result(content_type, rel_path))
+        # This adds all .py and .ps1 paths in a collection. The effect is finding content
+        # in collections such as extensions (eda). Once ansible-doc supports enumerating
+        # extensions this could be made conditional
+        found_contents.update(ContentFinder().find_contents(self.path, self.log))
+
+        for content_type, rel_path in sorted(found_contents):
             loader_cls = loaders.get_loader_cls(content_type)
             loader = loader_cls(
                 content_type, rel_path, self.path, self.doc_strings, self.cfg, self.log

tests/integration/test_collections.py

@@ -50,7 +50,7 @@ def test_collection_community_general_import(workdir, local_fast_config):
 
     # make sure it found all the files
     contents = {(x["content_type"], x["name"]): x for x in results["contents"]}
-    assert len(contents.keys()) == 831
+    assert len(contents.keys()) == 842
 
     # check a small sample
     assert ("test", "a_module") in contents
@@ -69,7 +69,7 @@ def test_collection_community_general_import(workdir, local_fast_config):
     docs_contents = {
         (x["content_type"], x["content_name"]): x for x in results["docs_blob"]["contents"]
     }
-    assert len(docs_contents.keys()) == 831
+    assert len(docs_contents.keys()) == 842
 
     # check a small sample
     assert ("test", "a_module") in docs_contents

tests/integration/test_eda.py

@@ -50,13 +50,13 @@ def test_eda_import(workdir, local_image_config):
 
     # the data should have all the relevant bits
     assert results["contents"] == [
-        {"content_type": "playbook", "description": None, "name": "hello.yml"},
-        {"content_type": "role", "description": "your role description", "name": "test_role"},
         {
             "content_type": "module",
             "description": "Upper cases a passed in string",
             "name": "upcase",
         },
+        {"content_type": "playbook", "description": None, "name": "hello.yml"},
+        {"content_type": "role", "description": "your role description", "name": "test_role"},
     ]
     assert results["docs_blob"]["contents"] != []
     assert results["docs_blob"]["collection_readme"]["name"] == "README.md"