summaryrefslogtreecommitdiff
path: root/test/units/cli/galaxy/test_execute_list_collection.py
diff options
context:
space:
mode:
Diffstat (limited to 'test/units/cli/galaxy/test_execute_list_collection.py')
-rw-r--r--test/units/cli/galaxy/test_execute_list_collection.py152
1 files changed, 96 insertions, 56 deletions
diff --git a/test/units/cli/galaxy/test_execute_list_collection.py b/test/units/cli/galaxy/test_execute_list_collection.py
index 5641cb86..e8a834d9 100644
--- a/test/units/cli/galaxy/test_execute_list_collection.py
+++ b/test/units/cli/galaxy/test_execute_list_collection.py
@@ -5,29 +5,37 @@
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.common.text.converters import to_native
-from ansible.plugins.loader import init_plugin_loader
+from ansible.module_utils._text import to_native
+
+
+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
+ else:
+ return True
def isdir(path):
if to_native(path) == 'nope':
return False
- return True
+ else:
+ return True
def cliargs(collections_paths=None, collection_name=None):
if collections_paths is None:
- collections_paths = ['/root/.ansible/collections', '/usr/share/ansible/collections']
+ collections_paths = ['~/root/.ansible/collections', '/usr/share/ansible/collections']
context.CLIARGS._store = {
'collections_path': collections_paths,
@@ -38,61 +46,95 @@ def cliargs(collections_paths=None, collection_name=None):
@pytest.fixture
-def mock_from_path(mocker, monkeypatch):
- collection_args = {
- '/usr/share/ansible/collections/ansible_collections/sandwiches/pbj': (
+def mock_collection_objects(mocker):
+ mocker.patch('ansible.cli.galaxy.GalaxyCLI._resolve_path', side_effect=['/root/.ansible/collections', '/usr/share/ansible/collections'])
+ mocker.patch('ansible.cli.galaxy.validate_collection_path',
+ side_effect=['/root/.ansible/collections/ansible_collections', '/usr/share/ansible/collections/ansible_collections'])
+
+ collection_args_1 = (
+ (
'sandwiches.pbj',
- '1.0.0',
- '/usr/share/ansible/collections/ansible_collections/sandwiches/pbj',
+ '1.5.0',
+ None,
'dir',
None,
),
- '/usr/share/ansible/collections/ansible_collections/sandwiches/ham': (
- 'sandwiches.ham',
- '1.0.0',
- '/usr/share/ansible/collections/ansible_collections/sandwiches/ham',
+ (
+ 'sandwiches.reuben',
+ '2.5.0',
+ None,
'dir',
None,
),
- '/root/.ansible/collections/ansible_collections/sandwiches/pbj': (
+ )
+
+ collection_args_2 = (
+ (
'sandwiches.pbj',
- '1.5.0',
- '/root/.ansible/collections/ansible_collections/sandwiches/pbj',
+ '1.0.0',
+ None,
'dir',
None,
),
- '/root/.ansible/collections/ansible_collections/sandwiches/reuben': (
- 'sandwiches.reuben',
- '2.5.0',
- '/root/.ansible/collections/ansible_collections/sandwiches/reuben',
+ (
+ 'sandwiches.ham',
+ '1.0.0',
+ None,
'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)
+ collections_path_1 = [Requirement(*cargs) for cargs in collection_args_1]
+ collections_path_2 = [Requirement(*cargs) for cargs in collection_args_2]
- monkeypatch.setattr(C, 'COLLECTIONS_PATHS', ['/root/.ansible/collections', '/usr/share/ansible/collections'])
+ mocker.patch('ansible.cli.galaxy.find_existing_collections', side_effect=[collections_path_1, collections_path_2])
-def test_execute_list_collection_all(mocker, capsys, mock_from_path, tmp_path_factory):
+@pytest.fixture
+def mock_from_path(mocker):
+ def _from_path(collection_name='pbj'):
+ collection_args = {
+ 'sandwiches.pbj': (
+ (
+ 'sandwiches.pbj',
+ '1.5.0',
+ None,
+ 'dir',
+ None,
+ ),
+ (
+ 'sandwiches.pbj',
+ '1.0.0',
+ None,
+ 'dir',
+ None,
+ ),
+ ),
+ 'sandwiches.ham': (
+ (
+ 'sandwiches.ham',
+ '1.0.0',
+ None,
+ 'dir',
+ None,
+ ),
+ ),
+ }
+
+ from_path_objects = [Requirement(*args) for args in collection_args[collection_name]]
+ mocker.patch('ansible.cli.galaxy.Requirement.from_dir_path_as_unknown', side_effect=from_path_objects)
+
+ return _from_path
+
+
+def test_execute_list_collection_all(mocker, capsys, mock_collection_objects, tmp_path_factory):
"""Test listing all collections from multiple paths"""
cliargs()
- init_plugin_loader()
mocker.patch('os.path.exists', return_value=True)
+ mocker.patch('os.path.isdir', 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)
@@ -110,20 +152,21 @@ def test_execute_list_collection_all(mocker, capsys, mock_from_path, tmp_path_fa
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 '
+ 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):
+def test_execute_list_collection_specific(mocker, capsys, mock_collection_objects, mock_from_path, tmp_path_factory):
"""Test listing a specific collection"""
collection_name = 'sandwiches.ham'
+ mock_from_path(collection_name)
cliargs(collection_name=collection_name)
- init_plugin_loader()
-
+ mocker.patch('os.path.exists', path_exists)
+ mocker.patch('os.path.isdir', 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))
@@ -143,14 +186,15 @@ def test_execute_list_collection_specific(mocker, capsys, mock_from_path, tmp_pa
assert out_lines[4] == 'sandwiches.ham 1.0.0 '
-def test_execute_list_collection_specific_duplicate(mocker, capsys, mock_from_path, tmp_path_factory):
+def test_execute_list_collection_specific_duplicate(mocker, capsys, mock_collection_objects, mock_from_path, tmp_path_factory):
"""Test listing a specific collection that exists at multiple paths"""
collection_name = 'sandwiches.pbj'
+ mock_from_path(collection_name)
cliargs(collection_name=collection_name)
- init_plugin_loader()
-
+ mocker.patch('os.path.exists', path_exists)
+ mocker.patch('os.path.isdir', return_value=True)
mocker.patch('ansible.galaxy.collection.validate_collection_name', collection_name)
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', collection_name])
@@ -177,8 +221,6 @@ def test_execute_list_collection_specific_duplicate(mocker, capsys, mock_from_pa
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)
@@ -196,7 +238,6 @@ 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)
@@ -216,14 +257,13 @@ def test_execute_list_collection_no_valid_paths(mocker, capsys, tmp_path_factory
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):
+def test_execute_list_collection_one_invalid_path(mocker, capsys, mock_collection_objects, tmp_path_factory):
"""Test listing all collections when one invalid path is given"""
- cliargs(collections_paths=['nope'])
- init_plugin_loader()
-
+ cliargs()
mocker.patch('os.path.exists', return_value=True)
mocker.patch('os.path.isdir', isdir)
+ mocker.patch('ansible.cli.galaxy.GalaxyCLI._resolve_path', side_effect=['/root/.ansible/collections', 'nope'])
mocker.patch('ansible.utils.color.ANSIBLE_COLOR', False)
gc = GalaxyCLI(['ansible-galaxy', 'collection', 'list', '-p', 'nope'])
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-02 17:40:37 +0000