troubadix 25.1.0__tar.gz → 25.1.1__tar.gz

{troubadix-25.1.0 → troubadix-25.1.1}/PKG-INFO

@@ -1,8 +1,7 @@
 Metadata-Version: 2.3
 Name: troubadix
-Version: 25.1.0
+Version: 25.1.1
 Summary: A linting and QA check tool for NASL files
-Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later
 Author: Greenbone
 Author-email: info@greenbone.net
@@ -22,9 +21,10 @@ Requires-Dist: chardet (>=4,<6)
 Requires-Dist: charset-normalizer (>=3.2.0,<4.0.0)
 Requires-Dist: codespell (>=2.0.0,<3.0.0)
 Requires-Dist: gitpython (>=3.1.31,<4.0.0)
-Requires-Dist: pontos (>=22.7,<25.0)
+Requires-Dist: pontos (>=22.7,<26.0)
 Requires-Dist: python-magic (>=0.4.25,<0.5.0)
 Requires-Dist: validators (>=0.34.0,<0.35.0)
+Project-URL: Homepage, https://github.com/greenbone/troubadix
 Project-URL: Repository, https://github.com/greenbone/troubadix
 Description-Content-Type: text/markdown
 

{troubadix-25.1.0 → troubadix-25.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.1.0"
+version = "25.1.1"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"
@@ -25,7 +25,7 @@ packages = [{ include = "troubadix" }, { include = "tests", format = "sdist" }]
 
 [tool.poetry.dependencies]
 python = "^3.10"
-pontos = ">=22.7,<25.0"
+pontos = ">=22.7,<26.0"
 codespell = "^2.0.0"
 python-magic = "^0.4.25"
 chardet = ">=4,<6"
@@ -36,7 +36,7 @@ charset-normalizer = "^3.2.0"
 [tool.poetry.group.dev.dependencies]
 autohooks = ">=21.7.0"
 autohooks-plugin-black = ">=21.12.0"
-ruff = ">=0.5.6,<0.9.0"
+ruff = ">=0.5.6,<0.10.0"
 autohooks-plugin-ruff = "^24.1.0"
 
 [tool.black]

{troubadix-25.1.0 → troubadix-25.1.1}/tests/plugins/test_overlong_description_lines.py

@@ -25,7 +25,7 @@ from troubadix.plugins.overlong_description_lines import (
 
 
 class CheckOverlongDescriptionLinesTestCase(PluginTestCase):
-    def test_ok(self):
+    def test_ok_generic(self):
         nasl_file = Path(__file__).parent / "test.nasl"
         content = (
             "ignored line that is not part of description"
@@ -61,6 +61,30 @@ class CheckOverlongDescriptionLinesTestCase(PluginTestCase):
 
         self.assertEqual(len(results), 0)
 
+    def test_ok_urls_in_comments(self):
+        nasl_file = Path(__file__).parent / "test.nasl"
+        content = (
+            "if (description)\n"
+            "{\n"
+            '  script_version("2021-09-02T14:01:33+0000");\n'
+            "  # https://overlongurlisokxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+            'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");\n'
+            "  # > https://anothervariantwhichisokxxxxxxxxxxxxxxxxxxx"
+            'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");\n'
+            "  # - https://anothervariantwhichisalsookxxxxxxxxxxxxxxx"
+            'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");\n'
+            "  exit(0);\n"
+            "}\n"
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=nasl_file, file_content=content
+        )
+        plugin = CheckOverlongDescriptionLines(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)
+
     def test_line_too_long(self):
         nasl_file = Path(__file__).parent / "test.nasl"
         content = (

{troubadix-25.1.0 → troubadix-25.1.1}/tests/standalone_plugins/test_deprecate_vts.py

@@ -189,7 +189,7 @@ class DeprecateVTsTestCase(unittest.TestCase):
         result = _finalize_content(NASL_CONTENT)
         expected = (
             '...if(description)\n{\n  script_oid("1.3.6.1.4.1.25623.1.0.910673");\n  '
-            'script_version("2024-03-12T14:15:13+0000");\n  script_name("RedHat: Security Advisory for gd (RHSA-2020:5443-01)");\n  script_family("Red Hat Local Security Checks");\n  script_dependencies("gather-package-list.nasl");\n  script_mandatory_keys("ssh/login/rhel", "ssh/login/rpms", re:"ssh/login/release=RHENT_7");\n\n  script_xref(name:"RHSA", value:"2020:5443-01");\n  script_xref(name:"URL", value:"https://www.redhat.com/archives/rhsa-announce/2020-December/msg00044.html");\n\n  script_tag(name:"summary", value:"The remote host is missing an update for the \'gd\'\n  package(s) announced via the RHSA-2020:5443-01 advisory.");\n\n  script_tag(name:"deprecated", value:TRUE);\n\nexit(0);\n}\n\nexit(66);\n'  # noqa: E501
+            'script_version("2024-03-12T14:15:13+0000");\n  script_name("RedHat: Security Advisory for gd (RHSA-2020:5443-01)");\n  script_family("Red Hat Local Security Checks");\n  script_dependencies("gather-package-list.nasl");\n  script_mandatory_keys("ssh/login/rhel", "ssh/login/rpms", re:"ssh/login/release=RHENT_7");\n\n  script_xref(name:"RHSA", value:"2020:5443-01");\n  script_xref(name:"URL", value:"https://www.redhat.com/archives/rhsa-announce/2020-December/msg00044.html");\n\n  script_tag(name:"summary", value:"The remote host is missing an update for the \'gd\'\n  package(s) announced via the RHSA-2020:5443-01 advisory.");\n\n  script_tag(name:"deprecated", value:TRUE);\n\n  exit(0);\n}\n\nexit(66);\n'  # noqa: E501
         )
         self.assertEqual(result, expected)
 

{troubadix-25.1.0 → troubadix-25.1.1}/troubadix/__version__.py

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

{troubadix-25.1.0 → troubadix-25.1.1}/troubadix/plugins/overlong_description_lines.py

@@ -32,6 +32,14 @@ IGNORE_TAGS = [
     "script_name",
     "script_xref",
     "script_add_preference",
+    # nb: Various variants of URLs in comments which we can't / shouldn't
+    # trim down
+    "  # http://",
+    "  # https://",
+    "  # - http://",
+    "  # - https://",
+    "  # > http://",
+    "  # > https://",
     # nb: Special cases we should ignore (at least for now) as these are
     # commonly used like this and is only two chars "too long".
     'script_tag(name:"vuldetect", value:"Checks if a vulnerable version is '

{troubadix-25.1.0 → troubadix-25.1.1}/troubadix/standalone_plugins/deprecate_vts.py

@@ -81,7 +81,7 @@ def _finalize_content(content: str) -> str:
     content_to_keep = content.split("exit(0);")[0]
     return content_to_keep + (
         'script_tag(name:"deprecated", value:TRUE);'
-        "\n\nexit(0);\n}\n\nexit(66);\n"
+        "\n\n  exit(0);\n}\n\nexit(66);\n"
     )