Merge pull request #105 from kikkomep/doc/issue-98

cli: improve description of the `skip-checks` option

Author: kikkomep

rocrate_validator/cli/commands/validate.py

@@ -157,6 +157,7 @@ def get_single_char(console: Optional[Console] = None, end: str = "\n",
     type=click.STRING,
     default=None,
     show_default=True,
+    metavar="Profile-ID",
     help="Identifier of the profile to use for validation",
 )
 @click.option(
@@ -198,7 +199,17 @@ def get_single_char(console: Optional[Console] = None, end: str = "\n",
     type=click.STRING,
     default=None,
     show_default=True,
-    help="List of checks to skip"
+    metavar="Fully-Qualified-Check-IDs",
+    help=(
+        "[bold yellow]Fully-Qualified-Check-IDs[/bold yellow] is a comma-separated list of checks to skip "
+        "(may be specified multiple times). Each check must be specified by its "
+        "Fully Qualified Identifier, e.g., [bold cyan]ro-crate-1.1_12.1[/bold cyan]. The fully qualified "
+        "check identifier has the format <Profile-ID>_<Requirement_#>.<RequirementCheck_#>, "
+        "where <Requirement_#> is the position number of the Requirement in the profile, "
+        "and <RequirementCheck_#> is the position number of the RequirementCheck within that Requirement. "
+        "You can find the Fully-Qualified-Check IDs using: "
+        "[bold orange1]rocrate-validator profiles describe <Profile-ID> -v[/bold orange1]"
+    ),
 )
 @click.option(
     '-v',
@@ -281,6 +292,25 @@ def validate(ctx,
     if rocrate_uri:
         logger.debug("rocrate_path: %s", os.path.abspath(rocrate_uri))
 
+    # Parse the skip_checks option
+    logger.debug("skip_checks: %s", skip_checks)
+    # Parse the skip_checks option
+    skip_checks_list = []
+    if skip_checks:
+        try:
+            for s in skip_checks:
+                skip_checks_list.extend(_.strip() for _ in s.split(",") if _.strip())
+            logger.debug("skip_checks_list: %s", skip_checks_list)
+        except Exception as e:
+            logger.error("Error parsing skip_checks: %s", e)
+            if logger.isEnabledFor(logging.DEBUG):
+                logger.exception("Error parsing skip_checks: %s", e)
+            raise ValueError(
+                f"Invalid skip_checks value: {s}. "
+                "It must be a comma-separated list of Fully Qualified Check IDs."
+            )
+    logger.debug("Skip checks: %s", skip_checks_list)
+
     try:
         # Validation settings
         validation_settings = {
@@ -291,7 +321,7 @@ def validate(ctx,
             "enable_profile_inheritance": not disable_profile_inheritance,
             "rocrate_uri": rocrate_uri,
             "abort_on_first": fail_fast,
-            "skip_checks": skip_checks
+            "skip_checks": skip_checks_list
         }
 
         # Print the application header

tests/test_cli.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import re
+from unittest.mock import patch
 
 from click.testing import CliRunner
 from pytest import fixture
@@ -66,3 +67,45 @@ def test_validate_subcmd_invalid_local_archive_rocrate(cli_runner: CliRunner):
                                      '--skip-checks', SKIP_LOCAL_DATA_ENTITY_EXISTENCE_CHECK_IDENTIFIER])
     assert result.exit_code == 0
     assert re.search(r'RO-Crate.*is a valid', result.output)
+
+
+def test_validate_skip_checks_option(cli_runner: CliRunner):
+    # Patch the validation service to capture the skip_checks argument
+    called_args = {}
+
+    def mock_validate(*args, **kwargs):
+        nonlocal called_args  # noqa: F824
+
+        for arg in args:
+            if isinstance(arg, dict):
+                called_args.update(arg)
+
+        called_args.update(kwargs)
+        logger.debug(f"Args: {args}")
+        logger.debug(f"Kwargs: {kwargs}")
+        logger.debug(f"Called args: {called_args}")
+
+    with patch('rocrate_validator.cli.commands.validate.services.validate') as mock_validate_rocrate:
+        mock_validate_rocrate.return_value = None
+        mock_validate_rocrate.side_effect = mock_validate
+
+        skip_checks_1 = ("a", "b", "c")
+        skip_checks_2 = ("d", "e", "f")
+        result = cli_runner.invoke(
+            cli, [
+                '--no-interactive',
+                'validate', str(ValidROC().sort_and_change_remote),
+                '--skip-checks', ','.join(skip_checks_1),
+                '--skip-checks', ','.join(skip_checks_2),
+                '--no-paging'
+            ]
+        )
+
+        # Check the exit code which should be 2
+        # because the validation service is mocked and does not return a valid result
+        assert result.exit_code == 2
+        # Check if 'skip_checks' is in the called arguments
+        assert 'skip_checks' in called_args
+        logger.debug(f"Called args: {called_args}")
+        # Check if the skip_checks value matches the expected value
+        assert list(skip_checks_1 + skip_checks_2) == called_args['skip_checks']