Fix #27: incorrect jing command arguments in validate_rng

bugfix: Fixes incorrect jing command arguments in validate_rng
(#80)

Signed-off-by: sushant-suse <[email protected]>

Author: sushant-suse

changelog.d/80.bugfix.rst

@@ -0,0 +1 @@
+Fixes incorrect jing command arguments in validate_rng function.

src/docbuild/cli/cmd_validate/process.py

@@ -106,6 +106,7 @@ async def validate_rng(
     rng_schema_path: Path = PRODUCT_CONFIG_SCHEMA,
     *,
     xinclude: bool = True,
+    idcheck: bool = True
 ) -> tuple[bool, str]:
     """Validate an XML file against a RELAX NG schema using jing.
 
@@ -114,12 +115,14 @@ async def validate_rng(
     more robust for complex XInclude statements, including those with XPointer.
 
     :param xmlfile: The path to the XML file to validate.
-    :param rng_schema_path: The path to the RELAX NG schema file. It supports
-        both RNC and RNG formats.
+    :param rng_schema_path: The path to the RELAX NG schema file. It supports both RNC and RNG formats.
     :param xinclude: If True, resolve XIncludes with `xmllint` before validation.
+    :param idcheck: If True, perform ID uniqueness checks.
     :return: A tuple containing a boolean success status and any output message.
     """
     jing_cmd = ['jing']
+    if idcheck: 
+        jing_cmd.append('-i')
     if rng_schema_path.suffix == '.rnc':
         jing_cmd.append('-c')
     jing_cmd.append(str(rng_schema_path))
@@ -262,7 +265,7 @@ async def process_file(
         )
     elif validation_method == 'jing':
         # Use existing jing-based validator (.rnc or .rng)
-        rng_success, rng_output = await validate_rng(path_obj)
+        rng_success, rng_output = await validate_rng(path_obj, idcheck=True)
     else:
         console_err.print(
             f'{shortname:<{max_len}}: RNG validation => [red]failed[/red]'

tests/cli/cmd_validate/test_process.py

@@ -12,6 +12,7 @@
     process_file,
     registry,
     run_python_checks,
+    validate_rng,
     validate_rng_lxml,
 )
 from docbuild.cli.context import DocBuildContext
@@ -113,3 +114,54 @@ async def test_process_file_with_unknown_validation_method(mock_context, tmp_pat
     exit_code = await process_file(xml_file, mock_context, max_len=20)
 
     assert exit_code == 11
+
+
+@patch.object(process_module, 'run_command', new_callable=AsyncMock)
+async def test_validate_rng_with_idcheck_success(mock_run_command, tmp_path):
+    """Test that validate_rng with idcheck=True succeeds for a valid XML."""
+    mock_run_command.return_value = (0, '', '')
+    xml_file = tmp_path / 'valid.xml'
+    xml_file.touch()
+    rng_schema = tmp_path / 'schema.rnc'
+    rng_schema.touch()
+
+    is_valid, message = await validate_rng(xml_file, rng_schema, xinclude=False, idcheck=True)
+
+    assert is_valid is True
+    assert message == ''
+    # Ensure -i flag is passed to jing
+    assert '-i' in mock_run_command.call_args[0]
+
+
+@patch.object(process_module, 'run_command', new_callable=AsyncMock)
+async def test_validate_rng_with_idcheck_duplicate_failure(mock_run_command, tmp_path):
+    """Test that validate_rng with idcheck=True fails for a duplicate ID."""
+    mock_run_command.return_value = (1, '', 'error: duplicate ID "test-id"')
+    xml_file = tmp_path / 'duplicate_id.xml'
+    xml_file.touch()
+    rng_schema = tmp_path / 'schema.rnc'
+    rng_schema.touch()
+
+    is_valid, message = await validate_rng(xml_file, rng_schema, xinclude=False, idcheck=True)
+
+    assert is_valid is False
+    assert 'duplicate ID' in message
+    # Ensure -i flag is passed to jing
+    assert '-i' in mock_run_command.call_args[0]
+
+
+@patch.object(process_module, 'run_command', new_callable=AsyncMock)
+async def test_validate_rng_without_idcheck_success(mock_run_command, tmp_path):
+    """Test that validate_rng with idcheck=False succeeds despite a duplicate ID."""
+    mock_run_command.return_value = (0, '', '')
+    xml_file = tmp_path / 'duplicate_id.xml'
+    xml_file.touch()
+    rng_schema = tmp_path / 'schema.rnc'
+    rng_schema.touch()
+
+    is_valid, message = await validate_rng(xml_file, rng_schema, xinclude=False, idcheck=False)
+
+    assert is_valid is True
+    assert message == ''
+    # Ensure -i flag is NOT passed to jing
+    assert '-i' not in mock_run_command.call_args[0]

tests/cli/cmd_validate/validate/test_process_validation.py

@@ -99,19 +99,19 @@ async def test_validate_rng_jing_failure():
     rng_schema = MagicMock(spec=Path)
     xmlfile.__str__.return_value = '/mocked/path/to/file.xml'
     rng_schema.__str__.return_value = '/mocked/path/to/schema.rng'
-
+ 
     with patch.object(
         process_mod,
         'run_command',
         new=AsyncMock(return_value=(1, 'Error in jing', '')),
     ) as mock_run_command:
         success, output = await process_mod.validate_rng(
-            xmlfile, rng_schema_path=rng_schema, xinclude=False
+            xmlfile, rng_schema_path=rng_schema, xinclude=False, idcheck=False
         )
-
+ 
         assert not success, 'Expected validation to fail.'
         assert output == 'Error in jing', f'Unexpected output: {output}'
-
+ 
         mock_run_command.assert_called_once_with('jing', str(rng_schema), str(xmlfile))