troubadix 24.9.1__tar.gz → 24.9.2__tar.gz

{troubadix-24.9.1 → troubadix-24.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.9.1
+Version: 24.9.2
 Summary: A linting and QA check tool for NASL files
 Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later

{troubadix-24.9.1 → troubadix-24.9.2}/pyproject.toml

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

{troubadix-24.9.1 → troubadix-24.9.2}/tests/plugins/test_qod.py

@@ -30,7 +30,7 @@ class CheckQodTestCase(PluginTestCase):
     nasl_file = Path("some/file.nasl")
 
     def test_ok_qod_num(self):
-        content = '  script_tag(name:"qod", value:97);\n'
+        content = '  script_tag(name:"qod", value:"97");\n'
         fake_context = self.create_file_plugin_context(
             nasl_file=self.nasl_file, file_content=content
         )
@@ -75,7 +75,7 @@ class CheckQodTestCase(PluginTestCase):
     def test_too_many_qod(self):
         content = (
             '  script_tag(name:"qod_type", value:"exploit");\n'
-            '  script_tag(name:"qod", value:97);\n'
+            '  script_tag(name:"qod", value:"97");\n'
         )
         fake_context = self.create_file_plugin_context(
             nasl_file=self.nasl_file, file_content=content
@@ -87,7 +87,7 @@ class CheckQodTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertEqual("VT contains multiple QoD values", results[0].message)
 
-    def test_wrong_qod_num_str(self):
+    def test_wrong_qod_num(self):
         content = '  script_tag(name:"qod", value:"foo");\n'
         fake_context = self.create_file_plugin_context(
             nasl_file=self.nasl_file, file_content=content
@@ -98,14 +98,14 @@ class CheckQodTestCase(PluginTestCase):
 
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            'script_tag(name:"qod", value:"foo");: \'foo\' is an invalid QoD'
-            " number value. Allowed are"
+            'Invalid QOD value \'foo\' in script_tag(name:"qod", value:"foo");.'
+            " Allowed are"
             f" {', '.join(str(x) for x in VALID_QOD_NUM_VALUES)}",
             results[0].message,
         )
 
-    def test_wrong_qod_num_int(self):
-        content = '  script_tag(name:"qod", value:2);\n'
+    def test_wrong_qod_type(self):
+        content = '  script_tag(name:"qod_type", value:"foo");\n'
         fake_context = self.create_file_plugin_context(
             nasl_file=self.nasl_file, file_content=content
         )
@@ -115,14 +115,13 @@ class CheckQodTestCase(PluginTestCase):
 
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            "script_tag(name:\"qod\", value:2);: '2' is an invalid QoD"
-            " number value. Allowed are"
-            f" {', '.join(str(x) for x in VALID_QOD_NUM_VALUES)}",
+            'script_tag(name:"qod_type", value:"foo");: \'foo\' is an invalid'
+            f" QoD type. Allowed are {', '.join(VALID_QOD_TYPES)}",
             results[0].message,
         )
 
-    def test_wrong_qod_type(self):
-        content = '  script_tag(name:"qod_type", value:"foo");\n'
+    def test_improper_quotes(self):
+        content = '  script_tag(name:"qod", value:97);\n'
         fake_context = self.create_file_plugin_context(
             nasl_file=self.nasl_file, file_content=content
         )
@@ -132,7 +131,6 @@ class CheckQodTestCase(PluginTestCase):
 
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            'script_tag(name:"qod_type", value:"foo");: \'foo\' is an invalid'
-            f" QoD type. Allowed are {', '.join(VALID_QOD_TYPES)}",
+            'QOD value not properly enclosed in double quotes in script_tag(name:"qod", value:97);',
             results[0].message,
         )

{troubadix-24.9.1 → troubadix-24.9.2}/troubadix/__version__.py

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

{troubadix-24.9.1 → troubadix-24.9.2}/troubadix/plugins/qod.py

@@ -15,23 +15,24 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import re
 from typing import Iterator
 
 from troubadix.helper.patterns import ScriptTag, get_script_tag_pattern
 from troubadix.plugin import FilePlugin, LinterError, LinterResult
 
 VALID_QOD_NUM_VALUES = [
-    1,
-    30,
-    50,
-    70,
-    75,
-    80,
-    95,
-    97,
-    98,
-    99,
-    100,
+    "1",
+    "30",
+    "50",
+    "70",
+    "75",
+    "80",
+    "95",
+    "97",
+    "98",
+    "99",
+    "100",
 ]
 
 VALID_QOD_TYPES = [
@@ -51,6 +52,12 @@ VALID_QOD_TYPES = [
     "package_unreliable",
 ]
 
+# needed due to script_tag_pattern value not including the quotes
+QOD_WITH_QUOTES_PATTERN = re.compile(
+    r'script_tag\(\s*name\s*:\s*(?P<quote>[\'"])qod(?P=quote)\s*,'
+    r'\s*value\s*:\s*(?P<value_with_quotes>[\'"]?(?P<value>.+?)[\'"]?)\s*\)\s*;'
+)
+
 
 class CheckQod(FilePlugin):
     name = "check_qod"
@@ -68,10 +75,9 @@ class CheckQod(FilePlugin):
         if "# troubadix: disable=template_nd_test_files_fps" in file_content:
             return
 
-        qod_pattern = get_script_tag_pattern(ScriptTag.QOD)
         qod_type_pattern = get_script_tag_pattern(ScriptTag.QOD_TYPE)
 
-        match_qod = list(qod_pattern.finditer(file_content))
+        match_qod = list(QOD_WITH_QUOTES_PATTERN.finditer(file_content))
         match_qod_type = list(qod_type_pattern.finditer(file_content))
 
         num_matches = len(match_qod) + len(match_qod_type)
@@ -89,21 +95,25 @@ class CheckQod(FilePlugin):
             )
 
         for match in match_qod:
-            try:
-                qod = int(match.group("value"))
-                if qod not in VALID_QOD_NUM_VALUES:
+            full_match = match.group(0)
+            full_value = match.group("value_with_quotes")
+            value = match.group("value")
+
+            # Check if the value is enclosed in double quotes
+            if full_value.startswith('"') and full_value.endswith('"'):
+
+                # Compare against valid values
+                if value not in VALID_QOD_NUM_VALUES:
                     yield LinterError(
-                        f"{match.group(0)}: '{qod}' is an invalid QoD number"
-                        " value. Allowed are"
-                        f" {', '.join(str(x) for x in VALID_QOD_NUM_VALUES)}",
+                        f"Invalid QOD value '{value}' in {full_match}."
+                        " Allowed are"
+                        f" {', '.join(x for x in VALID_QOD_NUM_VALUES)}",
                         file=self.context.nasl_file,
                         plugin=self.name,
                     )
-            except ValueError:
+            else:
                 yield LinterError(
-                    f"{match.group(0)}: '{match.group('value')}' is an invalid"
-                    " QoD number value. Allowed are"
-                    f" {', '.join(str(x) for x in VALID_QOD_NUM_VALUES)}",
+                    f"QOD value not properly enclosed in double quotes in {full_match}",
                     file=self.context.nasl_file,
                     plugin=self.name,
                 )