595413d113
PR #72591 This change: * Adds an artifacts manager that abstracts away extracting the metadata from artifacts, downloading and caching them in a temporary location. * Adds `resolvelib` to direct ansible-core dependencies[0]. * Implements a `resolvelib`-based dependency resolver for `collection` subcommands that replaces the legacy in-house code. This is a dependency resolution library that pip 20.3+ uses by default. It's now integrated for use for the collection dependency resolution in ansible-galaxy CLI. * Refactors of the `ansible-galaxy collection` CLI. In particular, it: - reimplements most of the `download`, `install`, `list` and `verify` subcommands from scratch; - reuses helper bits previously moved out into external modules; - replaces the old in-house resolver with a more clear implementation based on the resolvelib library[0][1][2]. * Adds a multi Galaxy API proxy layer that abstracts accessing the version and dependencies via API or local artifacts manager. * Makes `GalaxyAPI` instances sortable. * Adds string representation methods to `GalaxyAPI`. * Adds dev representation to `GalaxyAPI`. * Removes unnecessary integration and unit tests. * Aligns the tests with the new expectations. * Adds more tests, integration ones in particular. [0]: https://pypi.org/p/resolvelib [1]: https://github.com/sarugaku/resolvelib [2]: https://pradyunsg.me/blog/2020/03/27/pip-resolver-testing Co-Authored-By: Jordan Borean <jborean93@gmail.com> Co-Authored-By: Matt Clay <matt@mystile.com> Co-Authored-By: Sam Doran <sdoran@redhat.com> Co-Authored-By: Sloane Hertel <shertel@redhat.com> Co-Authored-By: Sviatoslav Sydorenko <webknjaz@redhat.com> Signed-Off-By: Sviatoslav Sydorenko <webknjaz@redhat.com>
108 lines
3.6 KiB
Python
108 lines
3.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright: (c) 2020-2021, Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
"""A facade for interfacing with multiple Galaxy instances."""
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
try:
|
|
from typing import TYPE_CHECKING
|
|
except ImportError:
|
|
TYPE_CHECKING = False
|
|
|
|
if TYPE_CHECKING:
|
|
from typing import Dict, Iterable, Tuple
|
|
from ansible.galaxy.api import CollectionVersionMetadata
|
|
from ansible.galaxy.collection.concrete_artifact_manager import (
|
|
ConcreteArtifactsManager,
|
|
)
|
|
from ansible.galaxy.dependency_resolution.dataclasses import (
|
|
Candidate, Requirement,
|
|
)
|
|
|
|
from ansible.galaxy.api import GalaxyAPI, GalaxyError
|
|
|
|
|
|
class MultiGalaxyAPIProxy:
|
|
"""A proxy that abstracts talking to multiple Galaxy instances."""
|
|
|
|
def __init__(self, apis, concrete_artifacts_manager):
|
|
# type: (Iterable[GalaxyAPI], ConcreteArtifactsManager) -> None
|
|
"""Initialize the target APIs list."""
|
|
self._apis = apis
|
|
self._concrete_art_mgr = concrete_artifacts_manager
|
|
|
|
def get_collection_versions(self, requirement):
|
|
# type: (Requirement) -> Iterable[Tuple[str, GalaxyAPI]]
|
|
"""Get a set of unique versions for FQCN on Galaxy servers."""
|
|
if requirement.is_concrete_artifact:
|
|
return {
|
|
(
|
|
self._concrete_art_mgr.
|
|
get_direct_collection_version(requirement),
|
|
requirement.src,
|
|
),
|
|
}
|
|
|
|
api_lookup_order = (
|
|
(requirement.src, )
|
|
if isinstance(requirement.src, GalaxyAPI)
|
|
else self._apis
|
|
)
|
|
return set(
|
|
(version, api)
|
|
for api in api_lookup_order
|
|
for version in api.get_collection_versions(
|
|
requirement.namespace, requirement.name,
|
|
)
|
|
)
|
|
|
|
def get_collection_version_metadata(self, collection_candidate):
|
|
# type: (Candidate) -> CollectionVersionMetadata
|
|
"""Retrieve collection metadata of a given candidate."""
|
|
|
|
api_lookup_order = (
|
|
(collection_candidate.src, )
|
|
if isinstance(collection_candidate.src, GalaxyAPI)
|
|
else self._apis
|
|
)
|
|
for api in api_lookup_order:
|
|
try:
|
|
version_metadata = api.get_collection_version_metadata(
|
|
collection_candidate.namespace,
|
|
collection_candidate.name,
|
|
collection_candidate.ver,
|
|
)
|
|
except GalaxyError as api_err:
|
|
last_err = api_err
|
|
else:
|
|
self._concrete_art_mgr.save_collection_source(
|
|
collection_candidate,
|
|
version_metadata.download_url,
|
|
version_metadata.artifact_sha256,
|
|
api.token,
|
|
)
|
|
return version_metadata
|
|
|
|
raise last_err
|
|
|
|
def get_collection_dependencies(self, collection_candidate):
|
|
# type: (Candidate) -> Dict[str, str]
|
|
# FIXME: return Requirement instances instead?
|
|
"""Retrieve collection dependencies of a given candidate."""
|
|
if collection_candidate.is_concrete_artifact:
|
|
return (
|
|
self.
|
|
_concrete_art_mgr.
|
|
get_direct_collection_dependencies
|
|
)(collection_candidate)
|
|
|
|
return (
|
|
self.
|
|
get_collection_version_metadata(collection_candidate).
|
|
dependencies
|
|
)
|