feat: loads user datas before and after cli params

src/rougail/cli/__main__.py

@@ -16,11 +16,13 @@ You should have received a copy of the GNU General Public License
 along with Mtools.  If not, see <http://www.gnu.org/licenses/>.
 """
 
+from warnings import warn
+from pathlib import Path
+from sys import exit
+
 from tiramisu_cmdline_parser import TiramisuCmdlineParser
 from tiramisu.error import PropertiesOptionError
 from tiramisu import Config
-from pathlib import Path
-from sys import exit
 
 from rougail import Rougail
 from rougail.config import get_rougail_config
@@ -76,38 +78,44 @@ def _main(arguments, do_not_print):
             ).run()
         )
     if fake_user_datas:
-        user_data = UserDatas(cmd_config).user_datas(fake_user_datas)
+        user_datas = UserDatas(cmd_config).user_datas(fake_user_datas, return_values_not_error=True)
-        if user_data["errors"]:
+    else:
-            raise Exception(user_data["errors"][0])
+        user_datas = {}
-    #        if user_data["warnings"]:
-    #            raise Exception(user_data["warnings"][0])
     parser = TiramisuCmdlineParser(
         cmd_config,
         #        add_extra_options=False,
         short_name_max_len=2,
     )
     parser.parse_args(arguments)
+    if user_datas:
+        user_data = UserDatas(cmd_config).user_datas(user_datas, user_datas_type="values")
+        if user_data["warnings"]:
+            for warning in user_data["warnings"]:
+                warn(warning)
+        if user_data["errors"]:
+            raise Exception(user_data["errors"][0])
     global print_traceback
     print_traceback = rougailconfig["cli.debug"]
     cmd_config.property.setdefault(origin_prop, "read_write", "append")
     cmd_config.property.remove("not_for_commandline")
     cmd_config.property.read_only()
     if rougailconfig["cli.versions"]:
+        versions = []
         from tiramisu import __version__
 
-        print(f"tiramisu: {__version__}")
+        versions.append(f"tiramisu: {__version__}")
         from tiramisu_cmdline_parser import __version__
 
-        print(f"tiramisu-cmdline-parser: {__version__}")
+        versions.append(f"tiramisu-cmdline-parser: {__version__}")
         from rougail import __version__
 
-        print(f"rougail: {__version__}")
+        versions.append(f"rougail: {__version__}")
         from . import __version__
 
-        print(f"rougail-cli: {__version__}")
+        versions.append(f"rougail-cli: {__version__}")
         for step in ["structural", "user_data", "output"]:
             display_step = step.replace("_", "-")
-            for step_name in sorted(cmd_config.option(f"step.{step}").value.list()):
+            for step_name in sorted(cmd_config.unrestraint.option(f"step.{step}").value.list()):
                 path = (
                     Path(__file__).parent.parent
                     / (step + "_" + step_name)
@@ -118,11 +126,15 @@ def _main(arguments, do_not_print):
                         module = load_modules(
                             "rougail." + step + "_" + step_name, str(path)
                         )
-                        print(
+                        versions.append(
                             f"rougail-{display_step}-{step_name}: {module.__version__}"
                         )
                     except Exception as err:
                         pass
+        if do_not_print:
+            return versions
+        for version in versions:
+            print(version)
         return
     try:
         user_data_names = rougailconfig["step.user_data"]

tests/cli/result.txt

@@ -2,4 +2,4 @@
 │ Variable Default value │
 ╰────────────────────────╯
 Variables:
-┗━━ 📓 my_variable: my_value
+┗━━ 📓 a description: my_value

tests/cli/structures/file.yml

@@ -1,4 +1,4 @@
 ---
 version: 1.1
 
-my_variable: my_value
+my_variable: my_value  # a description

tests/cli/versions.txt

@@ -0,0 +1 @@
+["tiramisu: 5.2.0a9", "tiramisu-cmdline-parser: 0.7.0a1", "rougail: 1.2.0a24", "rougail-cli: 0.2.0a17", "rougail-structural-bitwarden: 0.1.0a4", "rougail-user-data-ansible: 0.1.0a3", "rougail-user-data-bitwarden: 0.1.0a20", "rougail-user-data-environment: 0.1.0a8", "rougail-user-data-yaml: 0.2.0a9", "rougail-output-ansible: 0.2.0a8", "rougail-output-console: 0.2.0a11", "rougail-output-doc: 0.2.0a21", "rougail-output-json: 0.2.0a8"]

tests/second_step/.rougailcli.yml

@@ -0,0 +1,3 @@
+---
+doc:
+  output_format: json

tests/second_step/structures/file.yml

@@ -0,0 +1,4 @@
+---
+version: 1.1
+
+my_variable: my_value  # a description

tests/second_step/yaml.txt

@@ -0,0 +1 @@
+"{\n  \"my_variable\": {\n    \"type\": \"variable\",\n    \"default\": \"my_value\",\n    \"properties\": [\n      {\n        \"type\": \"type\",\n        \"name\": \"string\"\n      },\n      {\n        \"type\": \"property\",\n        \"name\": \"mandatory\"\n      }\n    ],\n    \"paths\": [\n      \"my_variable\"\n    ],\n    \"names\": [\n      \"my_variable\"\n    ],\n    \"descriptions\": [\n      \"A description.\"\n    ]\n  }\n}"

tests/test_load.py

@@ -1,5 +1,6 @@
 from pathlib import Path
-from os import chdir
+from contextlib import chdir
+from json import dumps, loads
 
 from rougail.cli.__main__ import main
 
@@ -8,36 +9,72 @@ test_dir = Path(__file__).parent
 
 
 def test_cli():
-    chdir(test_dir / 'cli')
+    with chdir(test_dir / 'cli'):
-    ret = main(['--main_dictionaries', 'structures'], do_not_print=True)
+        ret = main(['--main_dictionaries', 'structures'], do_not_print=True)
-    filename = Path('result.txt')
+        filename = Path('result.txt')
-    if not filename.is_file():
+        if not filename.is_file():
-        with filename.open('w') as fh:
+            with filename.open('w') as fh:
-            fh.write(ret[1])
+                fh.write(ret[1])
-    with filename.open() as fh:
+        with filename.open() as fh:
-        data = fh.read()
+            data = fh.read()
-    assert ret == (True, data)
+        assert ret == (True, data)
 
 
 def test_cli_boolean():
-    chdir(test_dir / 'cli')
+    with chdir(test_dir / 'cli'):
-    ret = main(['--main_dictionaries', 'structures', '--console.mandatory'], do_not_print=True)
+        ret = main(['--main_dictionaries', 'structures', '--console.mandatory'], do_not_print=True)
-    filename = Path('result.txt')
+        filename = Path('result.txt')
-    if not filename.is_file():
+        if not filename.is_file():
-        with filename.open('w') as fh:
+            with filename.open('w') as fh:
-            fh.write(ret[1])
+                fh.write(ret[1])
-    with filename.open() as fh:
+        with filename.open() as fh:
-        data = fh.read()
+            data = fh.read()
-    assert ret == (True, data)
+        assert ret == (True, data)
 
 
-def test_cli_boolean_2():
+def test_cli_boolean_no():
-    chdir(test_dir / 'cli')
+    with chdir(test_dir / 'cli'):
-    ret = main(['--main_dictionaries', 'structures', '--console.no-mandatory'], do_not_print=True)
+        ret = main(['--main_dictionaries', 'structures', '--console.no-mandatory'], do_not_print=True)
-    filename = Path('result.txt')
+        filename = Path('result.txt')
-    if not filename.is_file():
+        if not filename.is_file():
-        with filename.open('w') as fh:
+            with filename.open('w') as fh:
-            fh.write(ret[1])
+                fh.write(ret[1])
-    with filename.open() as fh:
+        with filename.open() as fh:
-        data = fh.read()
+            data = fh.read()
-    assert ret == (True, data)
+        assert ret == (True, data)
+
+
+def test_cli_version():
+    with chdir(test_dir / 'cli'):
+        ret = main(['--cli.version'], do_not_print=True)
+        filename = Path('versions.txt')
+        if not filename.is_file():
+            with filename.open('w') as fh:
+                fh.write(dumps(ret))
+        with filename.open() as fh:
+            data = loads(fh.read())
+        assert ret == data
+
+
+def test_cli_version_user_data_disabled():
+    with chdir(test_dir / 'cli'):
+        ret = main(['--cli.version', '--step.output', 'doc'], do_not_print=True)
+        filename = Path('versions.txt')
+        if not filename.is_file():
+            with filename.open('w') as fh:
+                fh.write(dumps(ret))
+        with filename.open() as fh:
+            data = loads(fh.read())
+        assert ret == data
+
+
+def test_cli_version_user_data_disabled():
+    with chdir(test_dir / 'second_step'):
+        ret = main(['--main_dictionaries', 'structures', '--step.output', 'doc'], do_not_print=True)
+        filename = Path('yaml.txt')
+        if not filename.is_file():
+            with filename.open('w') as fh:
+                fh.write(dumps(ret[1]))
+        with filename.open() as fh:
+            data = loads(fh.read())
+        assert ret == (True, data)