mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
3.1 KiB
Python
86 lines
3.1 KiB
Python
# (c) 2019 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from collections import defaultdict
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.cli.galaxy import with_collection_artifacts_manager
|
|
from ansible.galaxy.collection import find_existing_collections
|
|
from ansible.module_utils._text import to_bytes
|
|
from ansible.utils.collection_loader import AnsibleCollectionConfig
|
|
from ansible.utils.collection_loader._collection_finder import _get_collection_name_from_path
|
|
from ansible.utils.display import Display
|
|
|
|
display = Display()
|
|
|
|
|
|
@with_collection_artifacts_manager
|
|
def list_collections(coll_filter=None, search_paths=None, dedupe=True, artifacts_manager=None):
|
|
|
|
collections = {}
|
|
for candidate in list_collection_dirs(search_paths=search_paths, coll_filter=coll_filter, artifacts_manager=artifacts_manager, dedupe=dedupe):
|
|
collection = _get_collection_name_from_path(candidate)
|
|
collections[collection] = candidate
|
|
return collections
|
|
|
|
|
|
def list_valid_collection_paths(search_paths=None, warn=False):
|
|
"""
|
|
Filter out non existing or invalid search_paths for collections
|
|
:param search_paths: list of text-string paths, if none load default config
|
|
:param warn: display warning if search_path does not exist
|
|
:return: subset of original list
|
|
"""
|
|
|
|
if search_paths is None:
|
|
search_paths = []
|
|
|
|
search_paths.extend(AnsibleCollectionConfig.collection_paths)
|
|
|
|
for path in search_paths:
|
|
|
|
b_path = to_bytes(path)
|
|
if not os.path.exists(b_path):
|
|
# warn for missing, but not if default
|
|
if warn:
|
|
display.warning("The configured collection path {0} does not exist.".format(path))
|
|
continue
|
|
|
|
if not os.path.isdir(b_path):
|
|
if warn:
|
|
display.warning("The configured collection path {0}, exists, but it is not a directory.".format(path))
|
|
continue
|
|
|
|
yield path
|
|
|
|
|
|
@with_collection_artifacts_manager
|
|
def list_collection_dirs(search_paths=None, coll_filter=None, artifacts_manager=None, dedupe=True):
|
|
"""
|
|
Return paths for the specific collections found in passed or configured search paths
|
|
:param search_paths: list of text-string paths, if none load default config
|
|
:param coll_filter: limit collections to just the specific namespace or collection, if None all are returned
|
|
:return: list of collection directory paths
|
|
"""
|
|
|
|
namespace_filter = None
|
|
collection_filter = None
|
|
if coll_filter is not None:
|
|
if '.' in coll_filter:
|
|
try:
|
|
namespace_filter, collection_filter = coll_filter.split('.')
|
|
except ValueError:
|
|
raise AnsibleError("Invalid collection pattern supplied: %s" % coll_filter)
|
|
else:
|
|
namespace_filter = coll_filter
|
|
|
|
for req in find_existing_collections(search_paths, artifacts_manager, namespace_filter=namespace_filter,
|
|
collection_filter=collection_filter, dedupe=dedupe):
|
|
|
|
yield to_bytes(req.src)
|