troubadix 25.6.0__tar.gz → 25.6.1__tar.gz

{troubadix-25.6.0 → troubadix-25.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: troubadix
-Version: 25.6.0
+Version: 25.6.1
 Summary: A linting and QA check tool for NASL files
 License: GPL-3.0-or-later
 Author: Greenbone

{troubadix-25.6.0 → troubadix-25.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.6.0"
+version = "25.6.1"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"
@@ -37,7 +37,7 @@ networkx = "^3.4.2"
 [tool.poetry.group.dev.dependencies]
 autohooks = ">=21.7.0"
 autohooks-plugin-black = ">=21.12.0"
-ruff = ">=0.5.6,<0.12.0"
+ruff = ">=0.5.6,<0.13.0"
 autohooks-plugin-ruff = ">=24.1,<26.0"
 
 [tool.black]

troubadix-25.6.1/tests/helper/test_date_format.py

@@ -0,0 +1,140 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+from unittest import TestCase
+
+from troubadix.helper.date_format import check_date
+
+
+class CheckCreationDateTestCase(TestCase):
+
+    def test_ok(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55 +0200 (Tue, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(results, [])
+
+    def test_missing(self):
+        results = list(
+            check_date(
+                None,
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "No test_date has been found.",
+            results[0].message,
+        )
+
+    def test_wrong_weekday(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55 +0200 (Mon, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "Wrong day of week. Please change it from 'Mon' to 'Tue'.",
+            results[0].message,
+        )
+
+    def test_no_timezone(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55 (Tue, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "Missing or incorrectly formatted test_date.",
+            results[0].message,
+        )
+
+    def test_different_dates(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55 +0200 (Wed, 15 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "The test_date consists of two different dates.",
+            results[0].message,
+        )
+
+    def test_wrong_length(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55 +0200 (Wed, 15 May 2013) ",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "The test_date consists of two different dates.",
+            results[0].message,
+        )
+
+    def test_malformed_second(self):
+        results = list(
+            check_date(
+                "2013-05-14 11:24:55s +0200 (Tue, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "Missing or incorrectly formatted test_date.",
+            results[0].message,
+        )
+
+    def test_malformed_hour(self):
+        results = list(
+            check_date(
+                "2013-05-14 111:24:55 +0200 (Tue, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "Missing or incorrectly formatted test_date.",
+            results[0].message,
+        )
+
+    def test_malformed_day(self):
+        results = list(
+            check_date(
+                "2013-05-14d 11:24:55 +0200 (Tue, 14 May 2013)",
+                "test_date",
+                "test_file",
+                "test_plugin",
+            )
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(
+            "Missing or incorrectly formatted test_date.",
+            results[0].message,
+        )

troubadix-25.6.1/tests/plugins/test_creation_date.py

@@ -0,0 +1,129 @@
+# Copyright (C) 2021 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from pathlib import Path
+
+from troubadix.plugin import LinterError
+from troubadix.plugins.creation_date import CheckCreationDate
+
+from . import PluginTestCase
+
+
+class CheckCreationDateTestCase(PluginTestCase):
+
+    def test_ok(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"creation_date", value:"2013-05-14 11:24:55 '
+            '+0200 (Tue, 14 May 2013)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+        self.assertEqual(len(results), 0)
+
+    def test_exclude_inc_file(self):
+        path = Path("some/file.inc")
+        fake_context = self.create_file_plugin_context(nasl_file=path)
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_missing_creation_date(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"cvss_base", value:"7.5");\n'
+            '  script_tag(name:"cvss_base_vector", '
+            'value:"AV:N/AC:L/Au:N/C:P/I:P/A:P");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "No creation_date has been found.",
+            results[0].message,
+        )
+
+    def test_missing_last_modification_date(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"creation_date", value:"2013-05-14 11:24:55 '
+            '+0200 (Tue, 14 May 2013)");\n'
+            '  script_tag(name:"cvss_base", value:"7.5");\n'
+            '  script_tag(name:"cvss_base_vector", '
+            'value:"AV:N/AC:L/Au:N/C:P/I:P/A:P");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(results, [])
+
+    def test_creation_date_greater_than_last_modification(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"creation_date", value:"2025-01-01 00:00:01 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+            '  script_tag(name:"last_modification", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "The creation_date must not be greater than last_modification date.",
+            results[0].message,
+        )
+
+    def test_creation_date_equal_last_modification(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"creation_date", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+            '  script_tag(name:"last_modification", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCreationDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)

{troubadix-25.6.0 → troubadix-25.6.1}/tests/plugins/test_cvss_format.py

@@ -66,7 +66,7 @@ class CheckCVSSFormatTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT has an invalid cvss_base value.",
+            "VT has a missing or invalid cvss_base value.",
             results[0].message,
         )
 
@@ -86,7 +86,7 @@ class CheckCVSSFormatTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT has an invalid cvss_base value.",
+            "VT has a missing or invalid cvss_base value.",
             results[0].message,
         )
 
@@ -145,6 +145,6 @@ class CheckCVSSFormatTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
 
         self.assertEqual(
-            "VT has a missing cvss_base value.",
+            "VT has a missing or invalid cvss_base value.",
             results[0].message,
         )

{troubadix-25.6.0 → troubadix-25.6.1}/tests/plugins/test_script_tags_mandatory.py

@@ -27,12 +27,14 @@ class CheckScriptTagsMandatoryTestCase(PluginTestCase):
 
     def test_ok(self):
         content = (
-            "  script_name('foo');\n"
+            '  script_name("foo");\n'
             "  script_version(1234-56-78T90:98:76+5432);\n"
             "  script_category(ACT_INIT);\n"
             "  script_family(FAMILY);\n"
             '  script_copyright("COPYRIGHT");\n'
             '  script_tag(name:"summary", value:"foo");\n'
+            '  script_tag(name:"cvss_base", value:"10.0");\n'
+            '  script_tag(name:"cvss_base_vector", value:"AV:N/AC:L/Au:N/C:C/I:C/A:C");\n'
         )
         fake_context = self.create_file_plugin_context(
             nasl_file=self.path, file_content=content
@@ -61,7 +63,7 @@ class CheckScriptTagsMandatoryTestCase(PluginTestCase):
 
         results = list(plugin.run())
 
-        self.assertEqual(len(results), 6)
+        self.assertEqual(len(results), 8)
         self.assertIsInstance(results[0], LinterError)
 
     def test_missing_tags(self):
@@ -79,7 +81,7 @@ class CheckScriptTagsMandatoryTestCase(PluginTestCase):
 
         results = list(plugin.run())
 
-        self.assertEqual(len(results), 1)
+        self.assertEqual(len(results), 3)
         self.assertIsInstance(results[0], LinterError)
 
     def test_missing_calls(self):
@@ -91,5 +93,5 @@ class CheckScriptTagsMandatoryTestCase(PluginTestCase):
 
         results = list(plugin.run())
 
-        self.assertEqual(len(results), 5)
+        self.assertEqual(len(results), 7)
         self.assertIsInstance(results[0], LinterError)

troubadix-25.6.1/tests/plugins/test_severity_date.py

@@ -0,0 +1,87 @@
+# 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.severity_date import CheckSeverityDate
+
+from . import PluginTestCase
+
+
+class CheckSeverityDateTestCase(PluginTestCase):
+
+    def test_severity_date_ok(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_date", value:"2013-05-14 11:24:55 '
+            '+0200 (Tue, 14 May 2013)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityDate(fake_context)
+
+        results = list(plugin.run())
+        self.assertEqual(len(results), 0)
+
+    def test_exclude_inc_file(self):
+        path = Path("some/file.inc")
+        fake_context = self.create_file_plugin_context(nasl_file=path)
+        plugin = CheckSeverityDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_missing_severity_date(self):
+        path = Path("some/file.nasl")
+        content = ""
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_severity_date_greater_than_last_modification(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_date", value:"2025-01-01 00:00:01 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+            '  script_tag(name:"last_modification", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "The severity_date must not be greater than last_modification date.",
+            results[0].message,
+        )
+
+    def test_severity_date_equal_last_modification(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_date", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+            '  script_tag(name:"last_modification", value:"2025-01-01 00:00:00 '
+            '+0200 (Wed, 01 Jan 2025)");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityDate(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)

troubadix-25.6.1/tests/plugins/test_severity_format.py

@@ -0,0 +1,148 @@
+# 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.severity_format import CheckSeverityFormat
+
+from . import PluginTestCase
+
+
+class CheckSeverityFormatTestCase(PluginTestCase):
+
+    def test_cvss_3_0_vector_ok(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:3.0/AV:N/AC:L/PR:L/UI:R/S:C/C:H/I:H/A:H");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(results, [])
+
+    def test_invalid_cvss_3_0_vector(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:3.0/AV:N/AC:N/PR:L/UI:R/S:H/C:H/I:H/A:H");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_vector value.",
+            results[0].message,
+        )
+
+    def test_cvss_3_1_vector_ok(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:3.1/AV:N/AC:L/PR:L/UI:R/S:C/C:H/I:H/A:H");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(results, [])
+
+    def test_invalid_cvss_3_1_vector(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:3.1/AV:N/AC:N/PR:L/UI:R/S:H/C:H/I:H/A:H");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_vector value.",
+            results[0].message,
+        )
+
+    def test_cvss_4_0_vector_ok(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:4.0/AV:N/AC:L/AT:N/PR:L/UI:A'
+            '/VC:H/VI:H/VA:H/SC:L/SI:L/SA:N");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(results, [])
+
+    def test_invalid_cvss_4_0_vector(self):
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"severity_vector", '
+            'value:"CVSS:4.0/AV:N/AC:N/AT:N/PR:L/UI:N'
+            '/VC:H/VI:H/VA:H/SC:L/SI:L/SA:N");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_vector value.",
+            results[0].message,
+        )
+
+    def test_missing_severity_vector(self):
+        path = Path("some/file.nasl")
+        content = ""
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(results, [])
+
+    def test_empty_severity_vector(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_vector", value:"");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityFormat(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_vector value.",
+            results[0].message,
+        )

troubadix-25.6.1/tests/plugins/test_severity_origin.py

@@ -0,0 +1,94 @@
+# 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.severity_origin import CheckSeverityOrigin
+
+from . import PluginTestCase
+
+
+class CheckSeverityOriginTestCase(PluginTestCase):
+
+    def test_severity_origin_nvd(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"NVD");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_severity_origin_vendor(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"Vendor");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_severity_origin_third_party(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"Third Party");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_severity_origin_greenbone(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"Greenbone");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
+    def test_severity_origin_other(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"Other");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_origin value.",
+            results[0].message,
+        )
+
+    def test_severity_origin_empty(self):
+        path = Path("some/file.nasl")
+        content = '  script_tag(name:"severity_origin", value:"");\n'
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckSeverityOrigin(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT has an invalid severity_origin value.",
+            results[0].message,
+        )