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.
259 lines
10 KiB
Python
259 lines
10 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2020 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 pathlib
|
|
|
|
import pytest
|
|
|
|
from ansible import constants as C
|
|
from ansible import context
|
|
from ansible.cli.galaxy import GalaxyCLI
|
|
from ansible.errors import AnsibleError, AnsibleOptionsError
|
|
from ansible.galaxy import collection
|
|
from ansible.galaxy.dependency_resolution.dataclasses import Requirement
|
|
from ansible.module_utils._text import to_native
|
|
from ansible.plugins.loader import init_plugin_loader
|
|
|
|
|
|
def path_exists(path):
|
|
if to_native(path) == '/root/.ansible/collections/ansible_collections/sandwiches/ham':
|
|
return False
|
|
elif to_native(path) == '/usr/share/ansible/collections/ansible_collections/sandwiches/reuben':
|
|
return False
|
|
elif to_native(path) == 'nope':
|
|
return False
|
|
return True
|
|
|
|
|
|
def isdir(path):
|
|
if to_native(path) == 'nope':
|
|
return False
|
|
return True
|
|
|
|
|
|
def cliargs(collections_paths=None, collection_name=None):
|
|
if collections_paths is None:
|
|
collections_paths = ['/root/.ansible/collections', '/usr/share/ansible/collections']
|
|
|
|
context.CLIARGS._store = {
|
|
'collections_path': collections_paths,
|
|
'collection': collection_name,
|
|
'type': 'collection',
|
|
'output_format': 'human'
|
|
}
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_from_path(mocker, monkeypatch):
|
|
collection_args = {
|
|
'/usr/share/ansible/collections/ansible_collections/sandwiches/pbj': (
|
|
'sandwiches.pbj',
|
|
'1.0.0',
|
|
'/usr/share/ansible/collections/ansible_collections/sandwiches/pbj',
|
|
'dir',
|
|
None,
|
|
),
|
|
'/usr/share/ansible/collections/ansible_collections/sandwiches/ham': (
|
|
'sandwiches.ham',
|
|
'1.0.0',
|
|
'/usr/share/ansible/collections/ansible_collections/sandwiches/ham',
|
|
'dir',
|
|
None,
|
|
),
|
|
'/root/.ansible/collections/ansible_collections/sandwiches/pbj': (
|
|
'sandwiches.pbj',
|
|
'1.5.0',
|
|
'/root/.ansible/collections/ansible_collections/sandwiches/pbj',
|
|
'dir',
|
|
None,
|
|
),
|
|
'/root/.ansible/collections/ansible_collections/sandwiches/reuben': (
|
|
'sandwiches.reuben',
|
|
'2.5.0',
|
|
'/root/.ansible/collections/ansible_collections/sandwiches/reuben',
|
|
'dir',
|
|
None,
|
|
),
|
|
}
|
|
|
|
def dispatch_requirement(path, am):
|
|
return Requirement(*collection_args[to_native(path)])
|
|
|
|
files_mock = mocker.MagicMock()
|
|
mocker.patch('ansible.galaxy.collection.files', return_value=files_mock)
|
|
files_mock.glob.return_value = []
|
|
|
|
mocker.patch.object(pathlib.Path, 'is_dir', return_value=True)
|
|
for path, args in collection_args.items():
|
|
files_mock.glob.return_value.append(pathlib.Path(args[2]))
|
|
|
|
mocker.patch('ansible.galaxy.collection.Candidate.from_dir_path_as_unknown', side_effect=dispatch_requirement)
|
|
|
|
monkeypatch.setattr(C, 'COLLECTIONS_PATHS', ['/root/.ansible/collections', '/usr/share/ansible/collections'])
|
|
|
|
|
|
def test_execute_list_collection_all(mocker, capsys, mock_from_path, tmp_path_factory):
|
|
"""Test listing all collections from multiple paths"""
|
|
|
|
cliargs()
|
|
init_plugin_loader()
|
|
|
|
mocker.patch('os.path.exists', return_value=True)
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list'])
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
out, err = capsys.readouterr()
|
|
out_lines = out.splitlines()
|
|
|
|
assert len(out_lines) == 12
|
|
assert out_lines[0] == ''
|
|
assert out_lines[1] == '# /root/.ansible/collections/ansible_collections'
|
|
assert out_lines[2] == 'Collection Version'
|
|
assert out_lines[3] == '----------------- -------'
|
|
assert out_lines[4] == 'sandwiches.pbj 1.5.0 '
|
|
assert out_lines[5] == 'sandwiches.reuben 2.5.0 '
|
|
assert out_lines[6] == ''
|
|
assert out_lines[7] == '# /usr/share/ansible/collections/ansible_collections'
|
|
assert out_lines[8] == 'Collection Version'
|
|
assert out_lines[9] == '----------------- -------'
|
|
assert out_lines[10] == 'sandwiches.ham 1.0.0 '
|
|
assert out_lines[11] == 'sandwiches.pbj 1.0.0 '
|
|
|
|
|
|
def test_execute_list_collection_specific(mocker, capsys, mock_from_path, tmp_path_factory):
|
|
"""Test listing a specific collection"""
|
|
|
|
collection_name = 'sandwiches.ham'
|
|
|
|
cliargs(collection_name=collection_name)
|
|
init_plugin_loader()
|
|
|
|
mocker.patch('os.path.exists', path_exists)
|
|
# mocker.patch.object(pathlib.Path, 'is_dir', return_value=True)
|
|
mocker.patch('ansible.galaxy.collection.validate_collection_name', collection_name)
|
|
mocker.patch('ansible.cli.galaxy._get_collection_widths', return_value=(14, 5))
|
|
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', collection_name])
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
out, err = capsys.readouterr()
|
|
out_lines = out.splitlines()
|
|
|
|
assert len(out_lines) == 5
|
|
assert out_lines[0] == ''
|
|
assert out_lines[1] == '# /usr/share/ansible/collections/ansible_collections'
|
|
assert out_lines[2] == 'Collection Version'
|
|
assert out_lines[3] == '-------------- -------'
|
|
assert out_lines[4] == 'sandwiches.ham 1.0.0 '
|
|
|
|
|
|
def test_execute_list_collection_specific_duplicate(mocker, capsys, mock_from_path, tmp_path_factory):
|
|
"""Test listing a specific collection that exists at multiple paths"""
|
|
|
|
collection_name = 'sandwiches.pbj'
|
|
|
|
cliargs(collection_name=collection_name)
|
|
init_plugin_loader()
|
|
|
|
mocker.patch('os.path.exists', path_exists)
|
|
# mocker.patch.object(pathlib.Path, 'is_dir', return_value=True)
|
|
mocker.patch('ansible.galaxy.collection.validate_collection_name', collection_name)
|
|
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', collection_name])
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
out, err = capsys.readouterr()
|
|
out_lines = out.splitlines()
|
|
|
|
assert len(out_lines) == 10
|
|
assert out_lines[0] == ''
|
|
assert out_lines[1] == '# /root/.ansible/collections/ansible_collections'
|
|
assert out_lines[2] == 'Collection Version'
|
|
assert out_lines[3] == '-------------- -------'
|
|
assert out_lines[4] == 'sandwiches.pbj 1.5.0 '
|
|
assert out_lines[5] == ''
|
|
assert out_lines[6] == '# /usr/share/ansible/collections/ansible_collections'
|
|
assert out_lines[7] == 'Collection Version'
|
|
assert out_lines[8] == '-------------- -------'
|
|
assert out_lines[9] == 'sandwiches.pbj 1.0.0 '
|
|
|
|
|
|
def test_execute_list_collection_specific_invalid_fqcn(mocker, tmp_path_factory):
|
|
"""Test an invalid fully qualified collection name (FQCN)"""
|
|
|
|
init_plugin_loader()
|
|
|
|
collection_name = 'no.good.name'
|
|
|
|
cliargs(collection_name=collection_name)
|
|
mocker.patch('os.path.exists', return_value=True)
|
|
mocker.patch('os.path.isdir', return_value=True)
|
|
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', collection_name])
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
with pytest.raises(AnsibleError, match='Invalid collection name'):
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
|
|
def test_execute_list_collection_no_valid_paths(mocker, capsys, tmp_path_factory):
|
|
"""Test listing collections when no valid paths are given"""
|
|
|
|
cliargs()
|
|
init_plugin_loader()
|
|
|
|
mocker.patch('os.path.exists', return_value=True)
|
|
mocker.patch('os.path.isdir', return_value=False)
|
|
mocker.patch('ansible.utils.color.ANSIBLE_COLOR', False)
|
|
mocker.patch('ansible.cli.galaxy.display.columns', 79)
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list'])
|
|
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
|
|
with pytest.raises(AnsibleOptionsError, match=r'None of the provided paths were usable.'):
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
out, err = capsys.readouterr()
|
|
|
|
assert '[WARNING]: - the configured path' in err
|
|
assert 'exists, but it\nis not a directory.' in err
|
|
|
|
|
|
def test_execute_list_collection_one_invalid_path(mocker, capsys, mock_from_path, tmp_path_factory):
|
|
"""Test listing all collections when one invalid path is given"""
|
|
|
|
cliargs(collections_paths=['nope'])
|
|
init_plugin_loader()
|
|
|
|
mocker.patch('os.path.exists', return_value=True)
|
|
mocker.patch('os.path.isdir', isdir)
|
|
mocker.patch('ansible.utils.color.ANSIBLE_COLOR', False)
|
|
|
|
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', '-p', 'nope'])
|
|
tmp_path = tmp_path_factory.mktemp('test-ÅÑŚÌβŁÈ Collections')
|
|
concrete_artifact_cm = collection.concrete_artifact_manager.ConcreteArtifactsManager(tmp_path, validate_certs=False)
|
|
gc.execute_list_collection(artifacts_manager=concrete_artifact_cm)
|
|
|
|
out, err = capsys.readouterr()
|
|
out_lines = out.splitlines()
|
|
|
|
assert out_lines[0] == ''
|
|
assert out_lines[1] == '# /root/.ansible/collections/ansible_collections'
|
|
assert out_lines[2] == 'Collection Version'
|
|
assert out_lines[3] == '----------------- -------'
|
|
assert out_lines[4] == 'sandwiches.pbj 1.5.0 '
|
|
# Only a partial test of the output
|
|
|
|
assert err == '[WARNING]: - the configured path nope, exists, but it is not a directory.\n'
|