add faas_list unit tests

Author: mschuchard

plugins/modules/faas_list.py

@@ -72,7 +72,7 @@
 
 from pathlib import Path
 from ansible.module_utils.basic import AnsibleModule
-from mschuchard.general.plugins.module_utils import faas
+from mschuchard.general.plugins.module_utils import faas, universal
 
 
 def main() -> None:
@@ -96,9 +96,7 @@ def main() -> None:
     sort: str = module.params.get('sort')
 
     # check on optional flags
-    flags: set[str] = set()
-    if module.params.get('verbose'):
-        flags.add('verbose')
+    flags_args: tuple[set[str], dict] = universal.params_to_flags_args(module.params, module.argument_spec)
 
     # check args
     args: dict = {}
@@ -112,7 +110,7 @@ def main() -> None:
         args.update({'sort': sort})
 
     # determine faas command
-    command: list[str] = faas.cmd(action='list', flags=flags, args=args)
+    command: list[str] = faas.cmd(action='list', flags=flags_args[0], args=args)
 
     # exit early for check mode
     if module.check_mode:

tests/unit/plugins/modules/test_faas_list.py

@@ -0,0 +1,66 @@
+"""unit test for faas list module"""
+
+__metaclass__ = type
+
+
+import json
+import pytest
+from mschuchard.general.tests.unit.plugins.modules import utils
+from mschuchard.general.plugins.modules import faas_list
+
+
+def test_faas_list_defaults(capfd):
+    """test faas list with defaults"""
+    utils.set_module_args({'config_file': f'{str(utils.fixtures_dir())}/stack.yaml'})
+    with pytest.raises(SystemExit, match='1'):
+        faas_list.main()
+
+    stdout, stderr = capfd.readouterr()
+    assert not stderr
+
+    info = json.loads(stdout)
+    assert 'faas-cli' in info['cmd']
+    assert 'list' in info['cmd']
+    assert '-f' in info['cmd']
+    assert f'{str(utils.fixtures_dir())}/stack.yaml' in info['cmd']
+    assert '[\'openfaas\'] is the only valid "provider.name" for the OpenFaaS CLI, but you gave: \n' == info['stdout']
+
+
+def test_faas_list_config_file(capfd):
+    """test faas list with config file"""
+    utils.set_module_args({'config_file': f'{str(utils.fixtures_dir())}/stack.yaml', 'filter': '*gif*', 'regex': 'fn[0-9]_.*'})
+    with pytest.raises(SystemExit, match='1'):
+        faas_list.main()
+
+    stdout, stderr = capfd.readouterr()
+    assert not stderr
+
+    info = json.loads(stdout)
+    assert 'faas-cli' in info['cmd']
+    assert 'list' in info['cmd']
+    assert '-f' in info['cmd']
+    assert '--filter' in info['cmd']
+    assert '*gif*' in info['cmd']
+    assert '--regex' in info['cmd']
+    assert 'fn[0-9]_.*' in info['cmd']
+    assert f'{str(utils.fixtures_dir())}/stack.yaml' in info['cmd']
+    assert '[\'openfaas\'] is the only valid "provider.name" for the OpenFaaS CLI, but you gave: \n' == info['stdout']
+
+
+def test_faas_list_sort_invocations_verbose(capfd):
+    """test faas list sorted by invocations"""
+    utils.set_module_args({'config_file': f'{str(utils.fixtures_dir())}/stack.yaml', 'sort': 'invocations', 'verbose': True})
+    with pytest.raises(SystemExit, match='1'):
+        faas_list.main()
+
+    stdout, stderr = capfd.readouterr()
+    assert not stderr
+
+    info = json.loads(stdout)
+    assert 'faas-cli' in info['cmd']
+    assert 'list' in info['cmd']
+    assert '--sort' in info['cmd']
+    assert 'invocations' in info['cmd']
+    assert '-v' in info['cmd']
+    assert f'{str(utils.fixtures_dir())}/stack.yaml' in info['cmd']
+    assert '[\'openfaas\'] is the only valid "provider.name" for the OpenFaaS CLI, but you gave: \n' == info['stdout']