troubadix 25.6.1__tar.gz → 25.7.0__tar.gz

{troubadix-25.6.1 → troubadix-25.7.0}/PKG-INFO

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

{troubadix-25.6.1 → troubadix-25.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.6.1"
+version = "25.7.0"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"
@@ -73,6 +73,7 @@ version-module-file = "troubadix/__version__.py"
 
 [tool.poetry.scripts]
 troubadix = 'troubadix.troubadix:main'
+troubadix-changed-creation-date = 'troubadix.standalone_plugins.changed_creation_date:main'
 troubadix-changed-oid = 'troubadix.standalone_plugins.changed_oid:main'
 troubadix-last-modification = 'troubadix.standalone_plugins.last_modification:main'
 troubadix-version-updated = 'troubadix.standalone_plugins.version_updated:main'

troubadix-25.7.0/tests/standalone_plugins/test_changed_creation_date.py

@@ -0,0 +1,173 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+import unittest
+from argparse import Namespace
+from os import chdir
+from pathlib import Path
+from subprocess import SubprocessError
+from tempfile import TemporaryDirectory
+from unittest.mock import patch
+
+from troubadix.standalone_plugins.changed_creation_date import (
+    check_changed_creation_date,
+    git,
+    main,
+    parse_arguments,
+)
+
+TEST_COMMIT_RANGE = "main..test"
+TEST_FILES = [Path("test.nasl")]
+
+
+class TestChangedCreationDate(unittest.TestCase):
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.Path.exists")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_check_creation_date_ok(self, mock_git, mock_exists):
+
+        mock_git.return_value = (
+            '-script_tag(name:"creation_date",'
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");\n'
+            '+script_tag(name:"creation_date",'
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");\n'
+            "+test"
+        )
+        mock_exists.return_value = True
+
+        self.assertFalse(
+            check_changed_creation_date(TEST_COMMIT_RANGE, TEST_FILES)
+        )
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.Path.exists")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_check_creation_date_fail(self, mock_git, mock_exists):
+
+        mock_git.return_value = (
+            '-script_tag(name:"creation_date",'
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");\n'
+            '+script_tag(name:"creation_date",'
+            ' value:"2020-03-04 10:00:00 +0200 (Wed, 04 Mar 2020)");'
+        )
+        mock_exists.return_value = True
+
+        self.assertTrue(
+            check_changed_creation_date(TEST_COMMIT_RANGE, TEST_FILES)
+        )
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.Path.exists")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_creation_date_not_modified_lines_added(
+        self, mock_git, mock_exists
+    ):
+
+        mock_git.return_value = (
+            '-script_tag(name:"creation_date",'
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");\n'
+            "test\n"
+            '+script_tag(name:"creation_date",'
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");'
+        )
+        mock_exists.return_value = True
+
+        self.assertFalse(
+            check_changed_creation_date(TEST_COMMIT_RANGE, TEST_FILES)
+        )
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.Path.exists")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_creation_date_not_modified_lines_removed(
+        self, mock_git, mock_exists
+    ):
+
+        mock_git.return_value = (
+            '-script_tag(name:"This got removed", value:"Nothing");'
+        )
+        mock_exists.return_value = True
+
+        self.assertFalse(
+            check_changed_creation_date(TEST_COMMIT_RANGE, TEST_FILES)
+        )
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.Path.exists")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_creation_date_added_not_removed(self, mock_git, mock_exists):
+
+        mock_git.return_value = (
+            '+script_tag(name:"This got added", value:"Something");\n'
+            '+script_tag(name:"creation_date", '
+            ' value:"2025-03-04 10:00:00 +0200 (Tue, 04 Mar 2025)");'
+        )
+        mock_exists.return_value = True
+
+        self.assertFalse(
+            check_changed_creation_date(TEST_COMMIT_RANGE, TEST_FILES)
+        )
+
+    def test_git_fail(self):
+        with self.assertRaises(SubprocessError):
+            git("blub")
+
+    def test_git_ok(self):
+        git("--version")
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    @patch(
+        "troubadix.standalone_plugins.changed_creation_date.ArgumentParser.parse_args"
+    )
+    def test_args_ok(self, mock_parse_args, mock_git):
+
+        mock_parse_args.return_value = Namespace(
+            commit_range="main..test", files=[]
+        )
+        mock_git.return_value = "test1.nasl\ntest2.nasl\ntest3.txt"
+
+        parsed_args = parse_arguments()
+
+        self.assertEqual(parsed_args.commit_range, "main..test")
+        self.assertEqual(
+            parsed_args.files, [Path("test1.nasl"), Path("test2.nasl")]
+        )
+
+    def test_main_no_git_repository(self):
+        cwd = Path.cwd()
+        with TemporaryDirectory() as tempdir:
+            try:
+                chdir(tempdir)
+                self.assertEqual(main(), 1)
+            finally:
+                chdir(cwd)
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.parse_arguments")
+    @patch(
+        "troubadix.standalone_plugins.changed_creation_date.check_changed_creation_date"
+    )
+    @patch("troubadix.standalone_plugins.changed_creation_date.os.chdir")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_main_check_creation_date_ok(
+        self, mock_git, _, mock_check_creation_date, __
+    ):
+
+        mock_git.return_value = "test_directory"
+        mock_check_creation_date.return_value = 0
+
+        self.assertEqual(main(), 0)
+
+    @patch("troubadix.standalone_plugins.changed_creation_date.parse_arguments")
+    @patch(
+        "troubadix.standalone_plugins.changed_creation_date.check_changed_creation_date"
+    )
+    @patch("troubadix.standalone_plugins.changed_creation_date.os.chdir")
+    @patch("troubadix.standalone_plugins.changed_creation_date.git")
+    def test_main_check_creation_date_fail(
+        self, mock_git, _, mock_check_creation_date, __
+    ):
+
+        mock_git.return_value = "test_directory"
+        mock_check_creation_date.return_value = 2
+
+        self.assertEqual(main(), 2)
+
+
+if __name__ == "__main__":
+    unittest.main()

{troubadix-25.6.1 → troubadix-25.7.0}/tests/standalone_plugins/test_changed_oid.py

@@ -15,29 +15,12 @@
 # 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 os
-import tempfile
 import unittest
-from contextlib import contextmanager
 from pathlib import Path
 from subprocess import SubprocessError
-from typing import Generator
 
 from troubadix.standalone_plugins.changed_oid import check_oid, git, parse_args
-
-
-@contextmanager
-def tempgitdir() -> Generator[Path, None, None]:
-    cwd = Path.cwd()
-    tempdir = tempfile.TemporaryDirectory()
-    temppath = Path(tempdir.name)
-    os.chdir(str(temppath))
-    git("init", "-b", "main")
-    git("config", "--local", "user.email", "max.mustermann@example.com")
-    git("config", "--local", "user.name", "Max Mustermann")
-    yield temppath
-    tempdir.cleanup()
-    os.chdir(str(cwd))
+from troubadix.standalone_plugins.util import temporary_git_directory
 
 
 def testgit(tmpdir: Path, ok: bool = False) -> None:
@@ -58,13 +41,13 @@ def testgit(tmpdir: Path, ok: bool = False) -> None:
 
 class TestChangedOid(unittest.TestCase):
     def test_check_oid_ok(self):
-        with tempgitdir() as tmpdir:
+        with temporary_git_directory() as tmpdir:
             testgit(tmpdir, True)
             parsed_args = parse_args(["-c", "main..test"])
             self.assertFalse(check_oid(parsed_args))
 
     def test_check_oid_fail(self):
-        with tempgitdir() as tmpdir:
+        with temporary_git_directory() as tmpdir:
             testgit(tmpdir)
             parsed_args = parse_args(["-c", "main..test"])
             self.assertTrue(check_oid(parsed_args))
@@ -77,7 +60,7 @@ class TestChangedOid(unittest.TestCase):
         git("--version")
 
     def test_args_ok(self):
-        with tempgitdir() as tmpdir:
+        with temporary_git_directory() as tmpdir:
             testgit(tmpdir)
             self.assertEqual(
                 parse_args(["-c", "main..test"]).commit_range, "main..test"

{troubadix-25.6.1 → troubadix-25.7.0}/troubadix/__version__.py

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

troubadix-25.7.0/troubadix/standalone_plugins/changed_creation_date.py

@@ -0,0 +1,141 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+import logging
+import os
+import re
+import subprocess
+import sys
+from argparse import ArgumentParser, Namespace
+from pathlib import Path
+
+from troubadix.argparser import file_type_existing
+from troubadix.standalone_plugins.common import git
+
+logger = logging.getLogger(__name__)
+
+CREATION_DATE_BASE_PATTERN = (
+    r"\s*script_tag\s*\(\s*name\s*:\s*\"creation_date\"\s*,"
+    r"\s*value\s*:\s*\"(?P<creation_date>.*)\"\s*\)\s*;"
+)
+
+
+def parse_arguments() -> Namespace:
+
+    parser = ArgumentParser(
+        description="Check for changed creation date",
+    )
+    parser.add_argument(
+        "-c",
+        "--commit_range",
+        type=str,
+        required=True,
+        help=(
+            "Git commit range to check e.g. "
+            "2c87f4b6062804231fd508411510ca07fd270380..HEAD or"
+            "YOUR_BRANCH..main"
+        ),
+    )
+    parser.add_argument(
+        "-f",
+        "--files",
+        nargs="+",
+        type=file_type_existing,
+        default=[],
+        help=(
+            "List of files to diff. "
+            "If empty use all files added or modified in the commit range."
+        ),
+    )
+    args = parser.parse_args()
+
+    if not args.files:
+        args.files += [
+            Path(filename)
+            for filename in git(
+                "diff", "--name-only", "--diff-filter=d", args.commit_range
+            ).splitlines()
+            if filename.endswith(".nasl")
+        ]
+
+    return args
+
+
+def check_changed_creation_date(
+    commit_range: str, nasl_files: list[Path]
+) -> bool:
+    """
+    This script checks (via git diff) if the creation date of
+    passed VTs has changed, which is not allowed.
+    """
+    creation_date_changed = False
+
+    for nasl_file in nasl_files:
+
+        if not nasl_file.exists():
+            continue
+
+        logger.info("Check file %s", nasl_file)
+        text = git(
+            "-c",
+            "color.status=false",
+            "--no-pager",
+            "diff",
+            commit_range,
+            nasl_file,
+        )
+
+        creation_date_added = re.search(
+            r"^\+" + CREATION_DATE_BASE_PATTERN,
+            text,
+            re.MULTILINE,
+        )
+        if not creation_date_added or not (
+            added := creation_date_added.group("creation_date")
+        ):
+            continue
+
+        creation_date_removed = re.search(
+            r"^\-" + CREATION_DATE_BASE_PATTERN,
+            text,
+            re.MULTILINE,
+        )
+        if not creation_date_removed or not (
+            removed := creation_date_removed.group("creation_date")
+        ):
+            continue
+
+        if added != removed:
+            logger.error(
+                "The creation date of %s was changed, "
+                "which is not allowed.\nNew creation date: "
+                "%s\nOld creation date: %s",
+                nasl_file,
+                added,
+                removed,
+            )
+            creation_date_changed = True
+
+    return creation_date_changed
+
+
+def main() -> int:
+
+    try:
+        git_base = git("rev-parse", "--show-toplevel")
+        os.chdir(git_base.rstrip("\n"))
+    except subprocess.SubprocessError:
+        logger.error(
+            "Your current working directory doesn't belong to a git repository"
+        )
+        return 1
+
+    args = parse_arguments()
+    if check_changed_creation_date(args.commit_range, args.files):
+        return 2
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

troubadix-25.7.0/troubadix/standalone_plugins/util.py

@@ -0,0 +1,27 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+from contextlib import contextmanager
+from os import chdir
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from troubadix.standalone_plugins.changed_creation_date import git
+
+
+@contextmanager
+def temporary_git_directory():
+
+    cwd = Path.cwd()
+
+    with TemporaryDirectory() as tempdir:
+
+        try:
+            chdir(tempdir)
+            git("init", "-b", "main")
+            git("config", "--local", "user.email", "max.mustermann@example.com")
+            git("config", "--local", "user.name", "Max Mustermann")
+            yield Path(tempdir)
+
+        finally:
+            chdir(cwd)