troubadix 25.3.2__tar.gz → 25.3.4__tar.gz

{troubadix-25.3.2 → troubadix-25.3.4}/PKG-INFO

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

{troubadix-25.3.2 → troubadix-25.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.3.2"
+version = "25.3.4"
 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.10.0"
+ruff = ">=0.5.6,<0.12.0"
 autohooks-plugin-ruff = ">=24.1,<26.0"
 
 [tool.black]

{troubadix-25.3.2 → troubadix-25.3.4}/tests/test_runner.py

@@ -35,7 +35,7 @@ from troubadix.plugins.script_version_and_last_modification_tags import (
     CheckScriptVersionAndLastModificationTags,
 )
 from troubadix.reporter import Reporter
-from troubadix.runner import Runner, TroubadixException
+from troubadix.runner import Runner
 
 _here = Path(__file__).parent
 
@@ -61,7 +61,7 @@ class TestRunner(unittest.TestCase):
     def test_runner_with_excluded_plugins(self):
         excluded_plugins = [
             "CheckBadwords",
-            "CheckCopyRightYearPlugin",
+            "CheckCopyrightYear",
         ]
         included_plugins = [
             plugin.__name__
@@ -342,18 +342,26 @@ class TestRunner(unittest.TestCase):
         # revert changes for the next time
         nasl_file.write_text(content, encoding=CURRENT_ENCODING)
 
-    def test_no_plugins(self):
-        runner = Runner(
-            n_jobs=1,
-            reporter=self._reporter,
-            included_plugins=["foo"],
-            root=self.root,
-        )
-
-        nasl_file = _here / "plugins" / "test.nasl"
-
-        with self.assertRaises(TroubadixException):
-            runner.run([nasl_file])
+    def test_unknown_plugins(self):
+        with self.assertRaisesRegex(ValueError, "Unknown plugins: 'foo'"):
+            Runner(
+                n_jobs=1,
+                reporter=self._reporter,
+                included_plugins=["foo"],
+                root=self.root,
+            )
+
+    def test_unknown_plugins_with_suggestion(self):
+        with self.assertRaisesRegex(
+            ValueError,
+            r"Unknown plugins: 'check_badwards' \(Did you mean 'check_badwords'\?\)",
+        ):
+            Runner(
+                n_jobs=1,
+                reporter=self._reporter,
+                included_plugins=["check_badwards"],
+                root=self.root,
+            )
 
     def test_runner_log_file(self):
         included_plugins = [

{troubadix-25.3.2 → troubadix-25.3.4}/troubadix/__version__.py

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

{troubadix-25.3.2 → troubadix-25.3.4}/troubadix/plugins/__init__.py

@@ -15,6 +15,7 @@
 # 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 difflib
 from typing import Iterable, List
 
 from troubadix.plugin import FilePlugin, FilesPlugin, Plugin
@@ -175,13 +176,18 @@ class StandardPlugins(Plugins):
     ) -> None:
         file_plugins = _FILE_PLUGINS
         files_plugins = _FILES_PLUGINS
+
         if excluded_plugins:
+            self._check_unknown_plugins(excluded_plugins)
+
             file_plugins = self._exclude_plugins(excluded_plugins, file_plugins)
             files_plugins = self._exclude_plugins(
                 excluded_plugins, files_plugins
             )
 
         if included_plugins:
+            self._check_unknown_plugins(included_plugins)
+
             file_plugins = self._include_plugins(included_plugins, file_plugins)
             files_plugins = self._include_plugins(
                 included_plugins, files_plugins
@@ -208,3 +214,27 @@ class StandardPlugins(Plugins):
             for plugin in plugins
             if plugin.__name__ in included or plugin.name in included
         ]
+
+    @staticmethod
+    def _check_unknown_plugins(selected_plugins: list[str]):
+        all_plugin_names = {
+            name
+            for plugin in _FILE_PLUGINS + _FILES_PLUGINS
+            for name in (plugin.name, plugin.__name__)
+        }
+
+        unknown_plugins = set(selected_plugins).difference(all_plugin_names)
+
+        if not unknown_plugins:
+            return
+
+        def build_message(plugin: str):
+            match = difflib.get_close_matches(plugin, all_plugin_names, n=1)
+            return (
+                f"'{plugin}' (Did you mean '{match[0]}'?)"
+                if match
+                else f"'{plugin}'"
+            )
+
+        messages = [build_message(plugin) for plugin in sorted(unknown_plugins)]
+        raise ValueError(f"Unknown plugins: {', '.join(messages)}")