Add: standalone plugin for evaluating dependencies with a graph

.gitignore

@@ -136,3 +136,4 @@ link.sh
 
 # vts/nasl folder used for testing
 nasl
+!tests/standalone_plugins/nasl/

pyproject.toml

@@ -32,6 +32,7 @@ chardet = ">=4,<6"
 validators = "^0.34.0"
 gitpython = "^3.1.31"
 charset-normalizer = "^3.2.0"
+networkx = "^3.4.2"
 
 [tool.poetry.group.dev.dependencies]
 autohooks = ">=21.7.0"
@@ -81,6 +82,7 @@ troubadix-changed-cves = 'troubadix.standalone_plugins.changed_cves:main'
 troubadix-allowed-rev-diff = 'troubadix.standalone_plugins.allowed_rev_diff:main'
 troubadix-file-extensions = 'troubadix.standalone_plugins.file_extensions:main'
 troubadix-deprecate-vts = 'troubadix.standalone_plugins.deprecate_vts:main'
+troubadix-dependency-graph = 'troubadix.standalone_plugins.dependency_graph:main'
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/standalone_plugins/nasl/21.04/21_script.nasl

@@ -0,0 +1,6 @@
+if(description)
+{
+  script_category(ACT_GATHER_INFO);
+  script_dependencies( "foo.nasl" );
+  exit(0);
+}

tests/standalone_plugins/nasl/22.04/22_script.nasl

@@ -0,0 +1,6 @@
+if(description)
+{
+  script_category(ACT_GATHER_INFO);
+  script_dependencies( "foo.nasl" );
+  exit(0);
+}

tests/standalone_plugins/nasl/common/bar.nasl

@@ -0,0 +1,10 @@
+if(description)
+{
+  script_category(ACT_GATHER_INFO);
+  script_dependencies( "foo.nasl", "foo.nasl" );
+
+  if(FEED_NAME == "GSF" || FEED_NAME == "GEF" || FEED_NAME == "SCM")
+    script_dependencies("gsf/enterprise_script.nasl");
+
+  exit(0);
+}

tests/standalone_plugins/nasl/common/foo.nasl

@@ -0,0 +1,8 @@
+if(description)
+{
+  script_category(ACT_ATTACK);
+  script_dependencies( "foobar.nasl", "gsf/enterprise_script.nasl" );
+  exit(0);
+}
+
+script_dependencies( "missing.nasl" );

tests/standalone_plugins/nasl/common/foobar.nasl

@@ -0,0 +1,7 @@
+if(description)
+{
+  script_category(ACT_GATHER_INFO);
+  script_dependencies( "bar.nasl" );
+  exit(0);
+  script_tag(name:"deprecated", value:TRUE);
+}

tests/standalone_plugins/nasl/common/gsf/enterprise_script.nasl

@@ -0,0 +1,5 @@
+if(description)
+{
+  script_category(ACT_GATHER_INFO);
+  exit(0);
+}

tests/standalone_plugins/test_dependency_graph.py

@@ -0,0 +1,72 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2024 Greenbone AG
+import sys
+import unittest
+from contextlib import redirect_stderr, redirect_stdout
+from io import StringIO
+from pathlib import Path
+from unittest.mock import patch
+
+from troubadix.standalone_plugins.dependency_graph import (
+    Feed,
+    Script,
+    create_graph,
+    get_feed,
+    main,
+    parse_args,
+)
+
+NASL_DIR = "tests/standalone_plugins/nasl"
+
+
+class TestDependencyGraph(unittest.TestCase):
+
+    def test_parse_args_ok(self):
+        test_args = [
+            "prog",
+            NASL_DIR,
+            "--feed",
+            "feed_22_04",
+            "--log",
+            "info",
+        ]
+        with patch.object(sys, "argv", test_args):
+            args = parse_args()
+            self.assertTrue(args)
+            self.assertEqual(args.root, Path(NASL_DIR))
+            self.assertEqual(args.feed, [Feed.FEED_22_04])
+            self.assertEqual(args.log, "info")
+
+    @patch("sys.stderr", new_callable=StringIO)
+    def test_parse_args_no_dir(self, mock_stderr):
+        test_args = ["prog", "not_real_dir"]
+        with patch.object(sys, "argv", test_args):
+            with self.assertRaises(SystemExit):
+                parse_args()
+            self.assertRegex(mock_stderr.getvalue(), "invalid directory_type")
+
+    def test_get_feed(self):
+        feed = [Feed.FULL]
+        scripts = get_feed(Path(NASL_DIR), feed)
+        self.assertEqual(len(scripts), 6)
+
+    def test_create_graph(self):
+        scripts = [
+            Script("foo.nasl", "community", [("bar.nasl", False)], 0, False),
+            Script("bar.nasl", "enterprise", [], 0, False),
+        ]
+        graph = create_graph(scripts)
+        self.assertEqual(len(list(graph.nodes)), 2)
+
+    def test_full_run(self):
+        test_args = [
+            "prog",
+            NASL_DIR,
+        ]
+        with (
+            redirect_stdout(StringIO()),
+            redirect_stderr(StringIO()),
+            patch.object(sys, "argv", test_args),
+        ):
+            return_code = main()
+            self.assertEqual(return_code, 1)

tests/test_naslinter.py

@@ -44,6 +44,7 @@ def test_generate_file_list_with_exclude_patterns(self):
                 "**/templates/*/*.nasl",
                 "**/test_files/*",
                 "**/test_files/**/*.nasl",
+                "**/tests/standalone_plugins/**/*.nasl",
             ],
             include_patterns=["**/*.nasl", "**/*.inc"],
         )