troubadix 25.10.10__tar.gz → 25.11.1__tar.gz

{troubadix-25.10.10 → troubadix-25.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: troubadix
-Version: 25.10.10
+Version: 25.11.1
 Summary: A linting and QA check tool for NASL files
 License: GPL-3.0-or-later
 License-File: LICENSE

{troubadix-25.10.10 → troubadix-25.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.10.10"
+version = "25.11.1"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"

troubadix-25.11.1/tests/plugins/test_script_add_preference_id.py

@@ -0,0 +1,165 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+from pathlib import Path
+
+from troubadix.plugin import LinterError
+from troubadix.plugins.script_add_preference_id import (
+    CheckScriptAddPreferenceId,
+    iter_script_add_preference_values,
+)
+
+from . import PluginTestCase
+
+
+class CheckScriptAddPreferenceIdTestCase(PluginTestCase):
+    def test_unique_ids(self):
+        path = Path("some/file.nasl")
+        contents = [
+            """
+script_add_preference(name:"Bar", type:"entry", value:"baz");
+script_add_preference(name:"Baz", type:"radio", value:"qux");
+script_add_preference(name:"Foo", type:"radio", value:"bar");
+""",
+            """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:1);
+script_add_preference(name:"Baz", type:"radio", value:"qux");
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+""",
+            """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:2);
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:1);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+""",
+            """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:1);
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:2);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+""",
+        ]
+
+        for content in contents:
+            with self.subTest(content=content):
+                fake_context = self.create_file_plugin_context(
+                    nasl_file=path, file_content=content
+                )
+                plugin = CheckScriptAddPreferenceId(fake_context)
+
+                results = list(plugin.run())
+
+                self.assertEqual(len(results), 0)
+
+    def test_duplicate_id(self):
+        path = Path("some/file.nasl")
+        contents = [
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:1);
+script_add_preference(name:"Baz", type:"radio", value:"qux");
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:2);
+""",
+                "2",
+            ),
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz");
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:1);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:2);
+""",
+                "1",
+            ),
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:1);
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:3);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:1);
+""",
+                "1",
+            ),
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:2);
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:1);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:1);
+""",
+                "1",
+            ),
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz");
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:1);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+""",
+                "1",
+            ),
+            (
+                """
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:2);
+script_add_preference(name:"Baz", type:"radio", value:"qux");
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+""",
+                "2",
+            ),
+        ]
+
+        for content, expected_id in contents:
+            with self.subTest(content=content):
+                fake_context = self.create_file_plugin_context(
+                    nasl_file=path, file_content=content
+                )
+                plugin = CheckScriptAddPreferenceId(fake_context)
+
+                results = list(plugin.run())
+
+                self.assertEqual(len(results), 1)
+                self.assertIsInstance(results[0], LinterError)
+                self.assertEqual(
+                    f"script_add_preference id {expected_id} is used multiple times",
+                    results[0].message,
+                )
+
+    def test_multiple_errors(self):
+        content = """
+script_add_preference(name:"Bar", type:"entry", value:"baz"); #1
+script_add_preference(name:"Baz", type:"radio", value:"qux"); #2
+script_add_preference(name:"Foo", type:"radio", value:"bar"); #3
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:2);
+script_add_preference(name:"Bar", type:"entry", value:"baz", id:2);
+script_add_preference(name:"Baz", type:"radio", value:"qux", id:1);
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:3);
+script_add_preference(name:"Foo", type:"radio", value:"bar"); #8
+script_add_preference(name:"Foo", type:"radio", value:"bar", id:8);
+"""
+        expected_ids = [2, 2, 1, 3, 8]
+        path = Path("some/file.nasl")
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckScriptAddPreferenceId(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 5)
+        self.assertIsInstance(results[0], LinterError)
+        for index, id in enumerate(expected_ids):
+            self.assertEqual(
+                f"script_add_preference id {id} is used multiple times",
+                results[index].message,
+            )
+
+    def test_iter_script_add_preference_values_handles_semicolon_in_value(self):
+        content = (
+            "script_add_preference("
+            'name:"Network type", type:"radio", '
+            'value:"Mixed (use RFC 1918);Private LAN;Public WAN (Internet);Public LAN", '
+            "id:8);"
+        )
+
+        values = list(iter_script_add_preference_values(content))
+
+        self.assertEqual(len(values), 1)
+        self.assertEqual(
+            values[0],
+            'name:"Network type", type:"radio", '
+            'value:"Mixed (use RFC 1918);Private LAN;Public WAN (Internet);Public LAN", '
+            "id:8",
+        )

{troubadix-25.10.10 → troubadix-25.11.1}/troubadix/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "25.10.10"
+__version__ = "25.11.1"

{troubadix-25.10.10 → troubadix-25.11.1}/troubadix/helper/text_utils.py

@@ -78,3 +78,29 @@ def is_position_in_string(text: str, position: int) -> bool:
         string_state.process_next_char(char)
 
     return string_state.in_string
+
+
+def find_matching_brace(
+    text: str, opening_pos: int, braces: tuple[str, str] = ("(", ")")
+) -> int | None:
+    """
+    Return the index of the matching closing brace for the brace at opening_pos.
+    """
+    opening, closing = braces
+    depth = 1
+    string_state = StringState()
+
+    for pos in range(opening_pos + 1, len(text)):
+        char = text[pos]
+        string_state.process_next_char(char)
+
+        if string_state.in_string:
+            continue
+
+        if char == opening:
+            depth += 1
+        elif char == closing:
+            depth -= 1
+            if depth == 0:
+                return pos
+    return None

{troubadix-25.10.10 → troubadix-25.11.1}/troubadix/plugins/__init__.py

@@ -53,6 +53,7 @@ from .overlong_script_tags import CheckOverlongScriptTags
 from .prod_svc_detect_in_vulnvt import CheckProdSvcDetectInVulnvt
 from .qod import CheckQod
 from .reporting_consistency import CheckReportingConsistency
+from .script_add_preference_id import CheckScriptAddPreferenceId
 from .script_add_preference_type import CheckScriptAddPreferenceType
 from .script_calls_empty_values import CheckScriptCallsEmptyValues
 from .script_calls_recommended import CheckScriptCallsRecommended
@@ -151,6 +152,7 @@ _FILE_PLUGINS = [
     CheckWrongSetGetKBCalls,
     CheckSpacesBeforeDots,
     CheckIfStatementSyntax,
+    CheckScriptAddPreferenceId,
 ]
 
 # plugins checking all files

{troubadix-25.10.10 → troubadix-25.11.1}/troubadix/plugins/http_links_in_tags.py

@@ -176,6 +176,8 @@ class CheckHttpLinksInTags(FilePlugin):
             # For example: 'http://[::1]/'.
             "http://[::1]/",
             "https://[::1]/",
+            "https://target",
+            "http://target",
         ]
 
         return any(

troubadix-25.11.1/troubadix/plugins/script_add_preference_id.py

@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+import re
+from collections.abc import Iterator
+from pathlib import Path
+
+from troubadix.helper.text_utils import find_matching_brace
+from troubadix.plugin import FileContentPlugin, LinterError, LinterResult
+
+SCRIPT_CALL_PATTERN = re.compile(r"script_add_preference\s*\(")
+ID_PATTERN = re.compile(r"id\s*:\s*(?P<id>\d+)")
+
+
+def iter_script_add_preference_values(
+    source: str,
+) -> Iterator[str]:
+    for match in SCRIPT_CALL_PATTERN.finditer(source):
+        opening_paren = match.end() - 1
+        closing_paren = find_matching_brace(source, opening_paren, ("(", ")"))
+        if closing_paren is None:
+            continue
+        yield source[opening_paren + 1 : closing_paren]
+
+
+class CheckScriptAddPreferenceId(FileContentPlugin):
+    name = "check_script_add_preference_id"
+
+    def check_content(
+        self, nasl_file: Path, file_content: str
+    ) -> Iterator[LinterResult]:
+        if (
+            nasl_file.suffix == ".inc"
+            or "script_add_preference" not in file_content
+        ):
+            return
+
+        seen_ids: set[int] = set()
+
+        for index, value in enumerate(
+            iter_script_add_preference_values(file_content), 1
+        ):
+            id_match = ID_PATTERN.search(value)
+            pref_id = int(id_match.group("id")) if id_match else index
+
+            if pref_id in seen_ids:
+                yield LinterError(
+                    f"script_add_preference id {pref_id} is used multiple times",
+                    file=nasl_file,
+                    plugin=self.name,
+                )
+
+            seen_ids.add(pref_id)