troubadix 24.8.1__tar.gz → 24.9.0__tar.gz

{troubadix-24.8.1 → troubadix-24.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.8.1
+Version: 24.9.0
 Summary: A linting and QA check tool for NASL files
 Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later
@@ -44,9 +44,19 @@ A linting and QA check tool for NASL files
 
 Python 3.9 and later is supported.
 
+### Install using pipx
+
+You can install the latest stable release of **troubadix** from the Python
+Package Index (pypi) using [pipx]
+
+    python3 -m pipx install troubadix
+
 ### Install using pip
 
-pip 19.0 or later is required.
+> [!NOTE]
+> The `pip install` command does no longer work out-of-the-box in newer
+> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
+> Please use the [installation via pipx](#install-using-pipx) instead.
 
 You can install the latest stable release of **troubadix** from the Python
 Package Index (pypi) using [pip]
@@ -71,9 +81,7 @@ For installation via pipenv please take a look at their [documentation][pipenv].
 **troubadix** uses [poetry] for its own dependency management and build
 process.
 
-First install poetry via pip
-
-    python3 -m pip install --user poetry
+First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).
 
 Afterwards run
 
@@ -113,6 +121,7 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 [Greenbone]: https://www.greenbone.net/
 [poetry]: https://python-poetry.org/
 [pip]: https://pip.pypa.io/
+[pipx]: https://pypa.github.io/pipx/
 [pipenv]: https://pipenv.pypa.io/
 [autohooks]: https://github.com/greenbone/autohooks
 

{troubadix-24.8.1 → troubadix-24.9.0}/README.md

@@ -15,9 +15,19 @@ A linting and QA check tool for NASL files
 
 Python 3.9 and later is supported.
 
+### Install using pipx
+
+You can install the latest stable release of **troubadix** from the Python
+Package Index (pypi) using [pipx]
+
+    python3 -m pipx install troubadix
+
 ### Install using pip
 
-pip 19.0 or later is required.
+> [!NOTE]
+> The `pip install` command does no longer work out-of-the-box in newer
+> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
+> Please use the [installation via pipx](#install-using-pipx) instead.
 
 You can install the latest stable release of **troubadix** from the Python
 Package Index (pypi) using [pip]
@@ -42,9 +52,7 @@ For installation via pipenv please take a look at their [documentation][pipenv].
 **troubadix** uses [poetry] for its own dependency management and build
 process.
 
-First install poetry via pip
-
-    python3 -m pip install --user poetry
+First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).
 
 Afterwards run
 
@@ -84,5 +92,6 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 [Greenbone]: https://www.greenbone.net/
 [poetry]: https://python-poetry.org/
 [pip]: https://pip.pypa.io/
+[pipx]: https://pypa.github.io/pipx/
 [pipenv]: https://pipenv.pypa.io/
 [autohooks]: https://github.com/greenbone/autohooks

{troubadix-24.8.1 → troubadix-24.9.0}/pyproject.toml

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

{troubadix-24.8.1 → troubadix-24.9.0}/tests/plugins/test_copyright_year.py

@@ -26,13 +26,15 @@ class CheckCopyrightYearTestCase(PluginTestCase):
     def test_ok_new_header(self):
         path = Path("some/file.nasl")
         content = (
-            "# SPDX-FileCopyrightText: 2022 Greenbone AG",
+            "# SPDX-FileCopyrightText: 2022 Greenbone AG\n"
+            "# SPDX-FileCopyrightText: 2022 some other person\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2022)");',
-            '  script_copyright("Copyright (C) 2022 Greenbone AG");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 2022 Greenbone AG");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
@@ -42,153 +44,188 @@ class CheckCopyrightYearTestCase(PluginTestCase):
     def test_ok_old_header(self):
         path = Path("some/file.nasl")
         content = (
-            "# Copyright (C) 2022 Greenbone AG",
+            "# Copyright (C) 2022 Greenbone AG\n"
+            "# Copyright (C) 2022 some other Person\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2022)");',
-            '  script_copyright("Copyright (C) 2022 Greenbone AG");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 2022 Greenbone AG");\n'
         )
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(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 = CheckCopyrightYear(fake_context)
-
-        results = list(plugin.run())
-
-        self.assertEqual(len(results), 0)
-
-    def test_pre_ok_new_header(self):
+    def test_pre2008_ok_new_header(self):
+        # tests that special cases pass:
+        # copyright < creation year for pre2008
+        # additional copyright that is newer but ok
         path = Path("some/pre2008/file.nasl")
         content = (
-            "# SPDX-FileCopyrightText: 2020 Greenbone AG",
+            "# SPDX-FileCopyrightText: 2010 Greenbone AG\n"
+            "# SPDX-FileCopyrightText: New code since 2022 Greenbone AG\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2022)");',
-            '  script_copyright("Copyright (C) 2020 Greenbone AG");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 2020 Greenbone AG");\n'
         )
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 0)
 
-    def test_pre_ok_old_header(self):
+    def test_pre2008_ok_old_header(self):
         path = Path("some/pre2008/file.nasl")
         content = (
-            "# Copyright (C) 2020 Greenbone AG",
+            "# Copyright (C) 2020 Greenbone AG\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2022)");',
-            '  script_copyright("Copyright (C) 2020 Greenbone AG");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 2020 Greenbone AG");\n'
         )
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 0)
 
-    def test_pre_fail(self):
-        path = Path("some/pre2008/file.nasl")
+    def test_exclude_inc_file(self):
+        path = Path("some/file.inc")
+        fake_context = self.create_file_plugin_context(nasl_file=path)
+        plugin = CheckCopyrightYear(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:"creation_date", value:"2020-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2020)");',
-            '  script_copyright("Copyright (C) 2021 Greenbone AG");',
+            "# SPDX-FileCopyrightText: 2022 Greenbone AG\n"
+            '  script_copyright("Copyright (C) 2022 Greenbone AG");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            "VT contains a Copyright year not matching "
-            "the creation year 2020 at line 2",
-            results[0].message,
+            "Missing creation_date statement in VT", results[0].message
         )
 
-    def test_missing_creation_date(self):
+    def test_missing_copyright_tag(self):
         path = Path("some/file.nasl")
         content = (
-            '  script_tag(name:"qod_type", value:"remote_banner");',
-            '  script_family("Product detection");',
+            "# SPDX-FileCopyrightText: 2022 Greenbone AG\n"
+            '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
+            '+0200 (Tue, 14 May 2022)");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 1)
-        self.assertEqual(
-            "Missing creation_date statement in VT", results[0].message
-        )
+        self.assertEqual("Missing copyright tag in VT", results[0].message)
 
-    def test_creation_date_not_script_copyright_year(self):
+    def test_regex_fail_copyright_tag(self):
         path = Path("some/file.nasl")
         content = (
+            "# SPDX-FileCopyrightText: 2022 Greenbone AG\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2013)");',
-            '  script_copyright("Copyright (C) 2020 Greenbone AG");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) Greenbone AG");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            "VT contains a Copyright year not matching "
-            "the creation year 2022 at line 2",
+            "Unable to extract year from script_copyright tag in VT",
             results[0].message,
         )
 
-    def test_creation_date_not_old_header_year(self):
+    def test_missing_header_copyright(self):
         path = Path("some/file.nasl")
         content = (
-            "# Copyright (C) 2020 Greenbone AG",
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2013)");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 2022 Greenbone AG");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
         self.assertEqual(len(results), 1)
         self.assertEqual(
-            "VT contains a Copyright year not matching "
-            "the creation year 2022 at line 1",
+            "VT header is missing a copyright text",
+            results[0].message,
+        )
+        return
+
+    def test_pre2008_fail(self):
+        path = Path("some/pre2008/file.nasl")
+        content = (
+            "# Copyright (C) 2021 Greenbone AG\n"
+            '  script_tag(name:"creation_date", value:"2020-05-14 11:24:55 '
+            '+0200 (Tue, 14 May 2020)");\n'
+            '  script_copyright("Copyright (C) 2021 Greenbone AG");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckCopyrightYear(fake_context)
+
+        results = list(plugin.run())
+        self.assertEqual(len(results), 2)
+        self.assertEqual(
+            "a pre2008 vt has a copyright tag year newer than the creation_year",
             results[0].message,
         )
+        self.assertEqual(
+            "a pre2008 vt has a copyright value in the fileheader"
+            " newer than the creation_year",
+            results[1].message,
+        )
 
-    def test_creation_date_not_new_header_year(self):
+    def test_fail(self):
         path = Path("some/file.nasl")
         content = (
-            "# SPDX-FileCopyrightText: 2020 Greenbone AG",
+            "# SPDX-FileCopyrightText: 3000 Greenbone AG\n"
             '  script_tag(name:"creation_date", value:"2022-05-14 11:24:55 '
-            '+0200 (Tue, 14 May 2013)");',
+            '+0200 (Tue, 14 May 2022)");\n'
+            '  script_copyright("Copyright (C) 1000 Greenbone AG");\n'
         )
+
         fake_context = self.create_file_plugin_context(
-            nasl_file=path, lines=content
+            nasl_file=path, file_content=content
         )
         plugin = CheckCopyrightYear(fake_context)
 
         results = list(plugin.run())
-        self.assertEqual(len(results), 1)
+        self.assertEqual(len(results), 2)
         self.assertEqual(
-            "VT contains a Copyright year not matching "
-            "the creation year 2022 at line 1",
+            "script_copyright tag does not match the creation year",
             results[0].message,
         )
+        self.assertEqual(
+            "a copyright in the fileheader does not match the creation year",
+            results[1].message,
+        )

{troubadix-24.8.1 → troubadix-24.9.0}/tests/plugins/test_script_calls_recommended.py

@@ -67,11 +67,10 @@ class CheckScriptCallsRecommendedTestCase(PluginTestCase):
 
     def test_dependencies_multiline(self):
         content = (
+            # tests group1
             '  script_dependencies("123",\n"456");\n'
-            "  script_require_ports();\n"
-            "  script_require_udp_ports();\n"
-            "  script_require_keys();\n"
-            "  script_mandatory_keys();\n"
+            # tests group2
+            '  script_mandatory_keys("foo",\n"bar");\n'
         )
         fake_context = self.create_file_plugin_context(
             nasl_file=self.path, file_content=content

{troubadix-24.8.1 → troubadix-24.9.0}/troubadix/__version__.py

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

{troubadix-24.8.1 → troubadix-24.9.0}/troubadix/argparser.py

@@ -19,9 +19,9 @@
 
 import sys
 from argparse import ArgumentParser, Namespace
+from collections.abc import Sequence
 from multiprocessing import cpu_count
 from pathlib import Path
-from typing import Iterable
 
 from pontos.terminal import Terminal
 
@@ -56,7 +56,7 @@ def check_cpu_count(number: str) -> int:
 
 def parse_args(
     terminal: Terminal,
-    args: Iterable[str] = None,
+    args: Sequence[str],
 ) -> Namespace:
     """Parsing args for troubadix
 

{troubadix-24.8.1 → troubadix-24.9.0}/troubadix/plugin.py

@@ -16,9 +16,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from abc import ABC, abstractmethod
+from collections.abc import Iterable, Iterator
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Iterable, Iterator, Optional
+from typing import Optional
 
 from troubadix.helper import CURRENT_ENCODING
 
@@ -50,13 +51,13 @@ class FilePluginContext:
         self,
         *,
         root: Path,
-        nasl_file: Path = None,
+        nasl_file: Path,
     ) -> None:
         self.root = root
         self.nasl_file = nasl_file
 
-        self._file_content = None
-        self._lines = None
+        self._file_content: str | None = None
+        self._lines: list[str] | None = None
 
     @property
     def file_content(self) -> str:
@@ -67,7 +68,7 @@ class FilePluginContext:
         return self._file_content
 
     @property
-    def lines(self) -> Iterable[str]:
+    def lines(self) -> list[str]:
         if not self._lines:
             self._lines = self.file_content.splitlines()
         return self._lines
@@ -82,15 +83,14 @@ class FilesPluginContext:
 class Plugin(ABC):
     """A linter plugin"""
 
-    name: str = None
-    description: str = None
+    name: str
 
     @abstractmethod
     def run(self) -> Iterator[LinterResult]:
         pass
 
     def fix(self) -> Iterator[LinterResult]:
-        return []
+        return iter([])
 
 
 class FilesPlugin(Plugin):

troubadix-24.9.0/troubadix/plugins/copyright_year.py

@@ -0,0 +1,152 @@
+# SPDX-FileCopyrightText: 2021 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import re
+from pathlib import Path
+from typing import Iterator
+
+from troubadix.helper import is_ignore_file
+from troubadix.helper.patterns import (
+    ScriptTag,
+    SpecialScriptTag,
+    get_script_tag_pattern,
+    get_special_script_tag_pattern,
+)
+from troubadix.plugin import (
+    FileContentPlugin,
+    LinterError,
+    LinterResult,
+)
+
+_IGNORE_FILES = ()
+
+
+SPDX_OR_COPYRIGHT_PATTERN = re.compile(
+    r"(SPDX-FileCopyrightText:|Copyright \(C\))\s*(?P<year>\d{4})"
+)
+
+
+def _generate_header_lines(file_content: str):
+    for line in file_content.splitlines():
+        if line.startswith("#"):
+            yield line
+        else:
+            break
+
+
+class CheckCopyrightYear(FileContentPlugin):
+    """This steps checks if a VT contains a Copyright statement containing a
+    year not matching the year defined in the creation_date statement.
+
+    pre2008 script copyright are allowed to predate the creation_year
+
+    For scripts that contain multiple copyrights with different dates,
+    like gather-package-list.nasl, it is important that the newer one,
+    which is only valid as of a certain year, has information about
+    what it covers in the place where the year would normally be.
+    Then that line will be automatically ignored
+    without having to add it to the ignore list due to not matching the regex.
+    Example:
+        if creation year = 2008
+    ok:
+    # SPDX-FileCopyrightText: 2008 Tim Brown
+    # SPDX-FileCopyrightText: New detection methods / pattern / code since 2009 Greenbone AG
+    not ok / needs ignore entry:
+    # New NASL / detection code since 2018 Copyright (C) 2018 Greenbone AG
+
+    """
+
+    name = "check_copyright_year"
+
+    def check_content(
+        self, nasl_file: Path, file_content: str
+    ) -> Iterator[LinterResult]:
+        if nasl_file.suffix == ".inc" or is_ignore_file(
+            nasl_file, _IGNORE_FILES
+        ):
+            return
+        # extract creation year from script tag
+        creation_date_pattern = get_script_tag_pattern(ScriptTag.CREATION_DATE)
+        creation_date_match = creation_date_pattern.search(file_content)
+        if not creation_date_match:
+            yield LinterError(
+                "Missing creation_date statement in VT",
+                file=nasl_file,
+                plugin=self.name,
+            )
+            return
+        creation_year = int(creation_date_match.group("value")[:4])
+
+        # extract year in value of script_copyright tag
+        script_copyright_pattern = get_special_script_tag_pattern(
+            SpecialScriptTag.COPYRIGHT
+        )
+        script_copyright_match = script_copyright_pattern.search(file_content)
+        if not script_copyright_match:
+            yield LinterError(
+                "Missing copyright tag in VT",
+                file=nasl_file,
+                plugin=self.name,
+            )
+            return
+        copyright_tag_value = script_copyright_match.group("value")
+        copyright_tag_match = SPDX_OR_COPYRIGHT_PATTERN.search(
+            copyright_tag_value
+        )
+        if not copyright_tag_match:
+            yield LinterError(
+                "Unable to extract year from script_copyright tag in VT",
+                file=nasl_file,
+                plugin=self.name,
+            )
+            return
+        copyright_tag_year = int(copyright_tag_match.group("year"))
+
+        # list comprehension to collect copy right matches from header
+        header_lines = _generate_header_lines(file_content)
+        header_copyright_years = [
+            int(match.group("year"))
+            for line in header_lines
+            if (match := SPDX_OR_COPYRIGHT_PATTERN.search(line))
+        ]
+
+        if not header_copyright_years:
+            yield LinterError(
+                "VT header is missing a copyright text",
+                file=nasl_file,
+                plugin=self.name,
+            )
+
+        # check if the copyrights years match the creation year
+        # pre2008 VTs are allowed to have a copyright that predates the year of creation.
+        if copyright_tag_year != creation_year:
+            if "pre2008" in str(nasl_file):
+                if copyright_tag_year > creation_year:
+                    yield LinterError(
+                        "a pre2008 vt has a copyright tag year newer than the creation_year",
+                        file=nasl_file,
+                        plugin=self.name,
+                    )
+            else:
+                yield LinterError(
+                    "script_copyright tag does not match the creation year",
+                    file=nasl_file,
+                    plugin=self.name,
+                )
+        for copyright_year in header_copyright_years:
+            if creation_year != copyright_year:
+                if "pre2008" in str(nasl_file):
+                    if copyright_year > creation_year:
+                        yield LinterError(
+                            "a pre2008 vt has a copyright value in the fileheader"
+                            " newer than the creation_year",
+                            file=nasl_file,
+                            plugin=self.name,
+                        )
+                else:
+                    yield LinterError(
+                        "a copyright in the fileheader does not match the creation year",
+                        file=nasl_file,
+                        plugin=self.name,
+                    )

{troubadix-24.8.1 → troubadix-24.9.0}/troubadix/plugins/script_calls_recommended.py

@@ -73,7 +73,9 @@ class CheckScriptCallsRecommended(FileContentPlugin):
         ]
 
         if not _get_special_script_tag_pattern(
-            name=rf"({'|'.join(recommended_many_call)})", value=".*"
+            name=rf"({'|'.join(recommended_many_call)})",
+            value=".*?",
+            flags=re.DOTALL,
         ).search(file_content):
             yield LinterWarning(
                 "VT contains none of the following recommended calls: "

{troubadix-24.8.1 → troubadix-24.9.0}/troubadix/reporter.py

@@ -15,8 +15,8 @@
 # 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 collections.abc import Iterable
 from pathlib import Path
-from typing import Iterable, List
 
 from pontos.terminal import Terminal
 
@@ -33,8 +33,8 @@ class Reporter:
         root: Path,
         *,
         fix: bool = False,
-        log_file: Path = None,
-        log_file_statistic: Path = None,
+        log_file: Path | None = None,
+        log_file_statistic: Path | None = None,
         statistic: bool = True,
         verbose: int = 0,
         ignore_warnings: bool = False,
@@ -78,7 +78,7 @@ class Reporter:
         self._log_append(f"\t\t{message}".replace("\n", "\n\t\t"))
 
     def _process_plugin_results(
-        self, plugin_name: str, plugin_results: List[LinterResult]
+        self, plugin_name: str, plugin_results: Iterable[LinterResult]
     ):
         """Process the results of a plugin: Print/Log results if
         verbosity/logging fits and count the results"""