troubadix 25.12.3__py3-none-any.whl → 26.1.0__py3-none-any.whl

troubadix/reporter.py

@@ -77,9 +77,7 @@ class Reporter:
         self._term.ok(message)
         self._log_append(f"\t\t{message}".replace("\n", "\n\t\t"))
 
-    def _process_plugin_results(
-        self, plugin_name: str, plugin_results: Iterable[LinterResult]
-    ):
+    def _process_plugin_results(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"""
         if plugin_results and self._verbose > 0:
@@ -123,9 +121,7 @@ class Reporter:
             with self._term.indent():
                 self._process_plugin_results(plugin_name, plugin_results)
 
-    def report_by_file_plugin(
-        self, file_results: FileResults, pos: int
-    ) -> None:
+    def report_by_file_plugin(self, file_results: FileResults, pos: int) -> None:
         """Print/log the results of all plugins for a specific file
 
         Arguments:
@@ -135,12 +131,8 @@ class Reporter:
         """
         if file_results and self._verbose > 0 or self._verbose > 1:
             # only print the part "common/some_nasl.nasl"
-            from_root_path = get_path_from_root(
-                file_results.file_path, self._root
-            )
-            self._report_bold_info(
-                f"Checking {from_root_path} ({pos}/{self._files_count})"
-            )
+            from_root_path = get_path_from_root(file_results.file_path, self._root)
+            self._report_bold_info(f"Checking {from_root_path} ({pos}/{self._files_count})")
 
         with self._term.indent():
             for (
@@ -164,9 +156,7 @@ class Reporter:
             if included:
                 self.report_info(f"Included Plugins: {', '.join(included)}")
 
-            self.report_info(
-                f"Running plugins: {', '.join([p.name for p in plugins])}"
-            )
+            self.report_info(f"Running plugins: {', '.join([p.name for p in plugins])}")
 
     def report_statistic(self) -> None:
         """Print a Error/Warning summary from the different plugins"""
@@ -195,10 +185,7 @@ class Reporter:
             if self._fix and self._ignore_warnings:
                 line = f"{plugin:48} {count['error']:8} {count['fix']:8}"
             elif self._fix:
-                line = (
-                    f"{plugin:48} {count['error']:8} {count['warning']:8}"
-                    f" {count['fix']:8}"
-                )
+                line = f"{plugin:48} {count['error']:8} {count['warning']:8}" f" {count['fix']:8}"
             elif self._ignore_warnings:
                 line = f"{plugin:48} {count['error']:8}"
             else:

troubadix/results.py

@@ -28,15 +28,9 @@ class Results:
         self.has_plugin_results = False
         self._ignore_warnings = ignore_warnings
 
-    def add_plugin_results(
-        self, plugin_name: str, results: Iterator[LinterResult]
-    ) -> "Results":
+    def add_plugin_results(self, plugin_name: str, results: Iterator[LinterResult]) -> "Results":
         if self._ignore_warnings:
-            results = [
-                result
-                for result in results
-                if not isinstance(result, LinterWarning)
-            ]
+            results = [result for result in results if not isinstance(result, LinterWarning)]
         else:
             results = list(results)
 

troubadix/runner.py

@@ -86,9 +86,7 @@ class Runner:
     def _check_file(self, file_path: Path) -> FileResults:
         """Run all file plugins on a single file and collect the results"""
         results = FileResults(file_path, ignore_warnings=self._ignore_warnings)
-        context = FilePluginContext(
-            root=self._root, nasl_file=file_path.resolve()
-        )
+        context = FilePluginContext(root=self._root, nasl_file=file_path.resolve())
 
         for plugin_class in self.plugins.file_plugins:
             plugin = plugin_class(context)
@@ -105,8 +103,7 @@ class Runner:
                 # run files plugins
                 context = FilesPluginContext(root=self._root, nasl_files=files)
                 files_plugins = [
-                    plugin_class(context)
-                    for plugin_class in self.plugins.files_plugins
+                    plugin_class(context) for plugin_class in self.plugins.files_plugins
                 ]
 
                 for results in pool.imap_unordered(
@@ -116,14 +113,10 @@ class Runner:
 
                 # run file plugins
                 for i, results in enumerate(
-                    iterable=pool.imap_unordered(
-                        self._check_file, files, chunksize=CHUNKSIZE
-                    ),
+                    iterable=pool.imap_unordered(self._check_file, files, chunksize=CHUNKSIZE),
                     start=1,
                 ):
-                    self._reporter.report_by_file_plugin(
-                        file_results=results, pos=i
-                    )
+                    self._reporter.report_by_file_plugin(file_results=results, pos=i)
 
             except KeyboardInterrupt:
                 pool.terminate()
@@ -145,9 +138,7 @@ class Runner:
         start = datetime.datetime.now()
         self._run_pooled(files)
 
-        self._reporter.report_info(
-            f"Time elapsed: {datetime.datetime.now() - start}"
-        )
+        self._reporter.report_info(f"Time elapsed: {datetime.datetime.now() - start}")
         self._reporter.report_statistic()
 
         # Return true if no error exists

troubadix/standalone_plugins/allowed_rev_diff.py

@@ -29,8 +29,7 @@ def parse_arguments() -> Namespace:
         "--directory",
         default=Path.cwd(),
         type=Path,
-        help="The directory the repository to check is located in. "
-        "Defaults to 'pwd'",
+        help="The directory the repository to check is located in. " "Defaults to 'pwd'",
     )
 
     ignored_linestart_group = argument_parser.add_mutually_exclusive_group()
@@ -42,8 +41,7 @@ def parse_arguments() -> Namespace:
         nargs="*",
         type=str,
         default=DEFAULT_IGNORED_LINESTARTS,
-        help="A list of line starts which will make the line be ignored. "
-        "Default: %(default)s",
+        help="A list of line starts which will make the line be ignored. " "Default: %(default)s",
     )
 
     ignored_linestart_group.add_argument(
@@ -73,9 +71,7 @@ def parse_arguments() -> Namespace:
         "to check the diff for",
     )
 
-    argument_parser.add_argument(
-        "-s", "--source", type=str, required=True, help="The upstream rev"
-    )
+    argument_parser.add_argument("-s", "--source", type=str, required=True, help="The upstream rev")
 
     argument_parser.add_argument(
         "-t", "--target", type=str, required=True, help="The downstream rev"
@@ -84,14 +80,8 @@ def parse_arguments() -> Namespace:
     return argument_parser.parse_args()
 
 
-def check_diff_line_starts_with_ignored_linestart(
-    line: str, ignored_linestarts: List[str]
-) -> bool:
-    return any(
-        linestart
-        for linestart in ignored_linestarts
-        if line.startswith(linestart)
-    )
+def check_diff_line_starts_with_ignored_linestart(line: str, ignored_linestarts: List[str]) -> bool:
+    return any(linestart for linestart in ignored_linestarts if line.startswith(linestart))
 
 
 def check_diff_line_matches_pattern(line: str, patterns: List[Pattern]) -> bool:
@@ -104,9 +94,7 @@ def check_diff(
     return [
         line
         for line in lines
-        if not check_diff_line_starts_with_ignored_linestart(
-            line, ignored_linestarts
-        )
+        if not check_diff_line_starts_with_ignored_linestart(line, ignored_linestarts)
         and not check_diff_line_matches_pattern(line, patterns)
     ]
 
@@ -121,10 +109,7 @@ def read_ignored_linestarts(path: Path) -> List[str]:
 
 def read_patterns(path: Path) -> List[Pattern]:
     with open(path, "r", encoding="UTF-8") as file:
-        return [
-            re.compile(pattern.removesuffix("\n"))
-            for pattern in file.readlines()
-        ]
+        return [re.compile(pattern.removesuffix("\n")) for pattern in file.readlines()]
 
 
 def main() -> int:
@@ -140,9 +125,7 @@ def main() -> int:
 
     diff = repo.git.diff(target, merge_base, unified=0)
 
-    result = check_diff(
-        diff.splitlines(), arguments.ignored_linestarts, patterns
-    )
+    result = check_diff(diff.splitlines(), arguments.ignored_linestarts, patterns)
 
     if result:
         print("The following lines don't match the any pattern:")

troubadix/standalone_plugins/changed_creation_date.py

@@ -61,9 +61,7 @@ def parse_arguments() -> Namespace:
     return args
 
 
-def check_changed_creation_date(
-    commit_range: str, nasl_files: list[Path]
-) -> bool:
+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.
@@ -90,9 +88,7 @@ def check_changed_creation_date(
             text,
             re.MULTILINE,
         )
-        if not creation_date_added or not (
-            added := creation_date_added.group("creation_date")
-        ):
+        if not creation_date_added or not (added := creation_date_added.group("creation_date")):
             continue
 
         creation_date_removed = re.search(
@@ -125,9 +121,7 @@ def main() -> int:
         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"
-        )
+        logger.error("Your current working directory doesn't belong to a git repository")
         return 1
 
     args = parse_arguments()

troubadix/standalone_plugins/changed_cves.py

@@ -12,9 +12,7 @@ from troubadix.standalone_plugins.common import get_merge_base, git
 CVE_PATTERN = re.compile(r"CVE-\d{4}-\d{4,}")
 
 
-def compare(
-    old_content: str, current_content: str
-) -> Tuple[List[str], List[str]]:
+def compare(old_content: str, current_content: str) -> Tuple[List[str], List[str]]:
     old_cves = get_cves_from_content(old_content)
     current_cves = get_cves_from_content(current_content)
 
@@ -25,9 +23,7 @@ def compare(
 
 
 def get_cves_from_content(content: str) -> Set[str]:
-    pattern = _get_special_script_tag_pattern(
-        name="cve_id", flags=re.MULTILINE | re.DOTALL
-    )
+    pattern = _get_special_script_tag_pattern(name="cve_id", flags=re.MULTILINE | re.DOTALL)
     match = pattern.search(content)
     if not match:
         return set()
@@ -72,18 +68,14 @@ def main():
     args = parse_args()
     terminal = ConsoleTerminal()
 
-    terminal.info(
-        f"Checking {len(args.files)} file(s) from {args.start_commit} to HEAD"
-    )
+    terminal.info(f"Checking {len(args.files)} file(s) from {args.start_commit} to HEAD")
 
     for file in args.files:
         try:
             old_content = git("show", f"{args.start_commit}:{file}")
             current_content = git("show", f"HEAD:{file}")
         except CalledProcessError:
-            terminal.error(
-                f"Could not find {file} at {args.start_commit} or HEAD"
-            )
+            terminal.error(f"Could not find {file} at {args.start_commit} or HEAD")
             continue
 
         missing_cves, added_cves = compare(old_content, current_content)

troubadix/standalone_plugins/changed_oid.py

@@ -69,9 +69,7 @@ def check_oid(args: Namespace) -> bool:
     if not args.files:
         args.files += [
             Path(f)
-            for f in git(
-                "diff", "--name-only", "--diff-filter=d", args.commit_range
-            ).splitlines()
+            for f in git("diff", "--name-only", "--diff-filter=d", args.commit_range).splitlines()
         ]
 
     rcode = False
@@ -125,9 +123,7 @@ def main() -> int:
         git_base = git("rev-parse", "--show-toplevel")
         os.chdir(git_base.rstrip("\n"))
     except subprocess.SubprocessError:
-        print(
-            "Your current working directory doesn't belong to a git repository"
-        )
+        print("Your current working directory doesn't belong to a git repository")
         return 1
 
     if check_oid(parse_args(args)):

troubadix/standalone_plugins/changed_packages/changed_packages.py

@@ -64,8 +64,7 @@ def filter_reasons(packages: List[Package], reasons: Iterable[Reasons]):
     return [
         package
         for package in packages
-        if not package.reasons
-        or any([reason not in reasons for reason in package.reasons])
+        if not package.reasons or any([reason not in reasons for reason in package.reasons])
     ]
 
 
@@ -154,9 +153,7 @@ def main():
     hide_reasons = set(args.hide_reasons)
     terminal = ConsoleTerminal()
 
-    terminal.info(
-        f"Checking {len(args.files)} file(s) from {args.start_commit} to HEAD"
-    )
+    terminal.info(f"Checking {len(args.files)} file(s) from {args.start_commit} to HEAD")
 
     for file in args.files:
         try:
@@ -164,9 +161,7 @@ def main():
             content = git("show", f"HEAD:{file}")
             missing_packages, new_packages = compare(old_content, content)
         except CalledProcessError:
-            terminal.error(
-                f"Could not find {file} at {args.start_commit} or HEAD"
-            )
+            terminal.error(f"Could not find {file} at {args.start_commit} or HEAD")
             continue
         except ValueError as e:
             terminal.error(f"Error while handling {file}: {e}")

troubadix/standalone_plugins/changed_packages/marker/changed_update.py

@@ -43,9 +43,7 @@ class ChangedUpdate(Marker):
                     old_package
                     for old_package in missing_packages
                     if package.name == old_package.name
-                    and old_package.version.startswith(
-                        package.version.replace(suffix, "")
-                    )
+                    and old_package.version.startswith(package.version.replace(suffix, ""))
                     and package.release == old_package.release
                 ),
                 None,

troubadix/standalone_plugins/changed_packages/marker/dropped_architecture.py

@@ -46,6 +46,4 @@ class DroppedArchitecture(Marker):
                 continue
 
             package.reasons[Reasons.DROPPED_ARCHITECTURE] = Direction.PASSIVE
-            other_package.reasons[Reasons.DROPPED_ARCHITECTURE] = (
-                Direction.ACTIVE
-            )
+            other_package.reasons[Reasons.DROPPED_ARCHITECTURE] = Direction.ACTIVE

troubadix/standalone_plugins/changed_packages/package.py

@@ -42,9 +42,7 @@ class Reasons(str, Enum):
         try:
             return cls[cli_argument.upper().replace("-", "_")]
         except KeyError as error:
-            raise ArgumentError(
-                None, f"Invalid reason '{cli_argument}'"
-            ) from error
+            raise ArgumentError(None, f"Invalid reason '{cli_argument}'") from error
 
 
 @dataclass()
@@ -80,8 +78,7 @@ class Package:
         result = f"{self.name : <50} {self.version : <40} {self.release : <10}"
 
         reasons = ", ".join(
-            f"{change}"
-            f"{' in new package' if direction == Direction.PASSIVE else ''}"
+            f"{change}" f"{' in new package' if direction == Direction.PASSIVE else ''}"
             for change, direction in self.reasons.items()
         )
         result += f"{reasons : <10}"

troubadix/standalone_plugins/dependency_graph/checks.py

@@ -23,28 +23,21 @@ def check_duplicates(scripts: list[Script]) -> Result:
     return Result(name="duplicate dependency", warnings=warnings)
 
 
-def check_missing_dependencies(
-    scripts: list[Script], graph: nx.DiGraph
-) -> Result:
+def check_missing_dependencies(scripts: list[Script], graph: nx.DiGraph) -> Result:
     """
     Checks if any scripts that are depended on are missing from
     the list of scripts created from the local file system,
     logs the scripts dependending on the missing script
     """
     errors = []
-    dependency_names = {
-        dep.name for script in scripts for dep in script.dependencies
-    }
+    dependency_names = {dep.name for script in scripts for dep in script.dependencies}
     script_names = {script.name for script in scripts}
     missing_dependencies = dependency_names - script_names
 
     for missing in missing_dependencies:
         depending_scripts = graph.predecessors(missing)
         errors.append(
-            f"{missing}:"
-            + "".join(
-                f"\n  - used by: {script}" for script in depending_scripts
-            )
+            f"{missing}:" + "".join(f"\n  - used by: {script}" for script in depending_scripts)
         )
 
     return Result(name="missing dependency", errors=errors)
@@ -63,9 +56,7 @@ def check_cycles(graph) -> Result:
     return Result(name="cyclic dependency", errors=errors)
 
 
-def cross_feed_dependencies(
-    graph, is_enterprise_checked: bool
-) -> list[tuple[str, str]]:
+def cross_feed_dependencies(graph, is_enterprise_checked: bool) -> list[tuple[str, str]]:
     """
     creates a list of script and dependency for scripts
     in community feed that depend on scripts in enterprise folders
@@ -105,8 +96,7 @@ def check_category_order(graph) -> Result:
     problematic_edges = [
         (dependent, dependency)
         for dependent, dependency in graph.edges()
-        if graph.nodes[dependent]["category"]
-        < graph.nodes[dependency].get("category", -1)
+        if graph.nodes[dependent]["category"] < graph.nodes[dependency].get("category", -1)
     ]
 
     errors = [

troubadix/standalone_plugins/dependency_graph/dependency_graph.py

@@ -34,9 +34,7 @@ from .checks import (
 from .cli import Feed, parse_args
 from .models import Dependency, Result, Script
 
-DEPENDENCY_PATTERN = _get_special_script_tag_pattern(
-    "dependencies", flags=re.DOTALL | re.MULTILINE
-)
+DEPENDENCY_PATTERN = _get_special_script_tag_pattern("dependencies", flags=re.DOTALL | re.MULTILINE)
 CATEGORY_PATTERN = get_special_script_tag_pattern(SpecialScriptTag.CATEGORY)
 DEPRECATED_PATTERN = get_script_tag_pattern(ScriptTag.DEPRECATED)
 ENTERPRISE_FEED_CHECK_PATTERN = re.compile(
@@ -84,9 +82,7 @@ def get_scripts(directory: Path) -> list[Script]:
             dependencies = extract_dependencies(content)
             category = extract_category(content)
             deprecated = bool(DEPRECATED_PATTERN.search(content))
-            scripts.append(
-                Script(name, feed, dependencies, category, deprecated)
-            )
+            scripts.append(Script(name, feed, dependencies, category, deprecated))
         except Exception as e:
             logger.error(f"Error processing {path}: {e}")
 
@@ -105,20 +101,16 @@ def extract_dependencies(content: str) -> list[Dependency]:
     dependencies = []
 
     if_blocks = [
-        (match.start(), match.end())
-        for match in ENTERPRISE_FEED_CHECK_PATTERN.finditer(content)
+        (match.start(), match.end()) for match in ENTERPRISE_FEED_CHECK_PATTERN.finditer(content)
     ]
 
     for match in DEPENDENCY_PATTERN.finditer(content):
         start, end = match.span()
         is_enterprise_feed = any(
-            start >= block_start and end <= block_end
-            for block_start, block_end in if_blocks
+            start >= block_start and end <= block_end for block_start, block_end in if_blocks
         )
         dep_list = split_dependencies(match.group("value"))
-        dependencies.extend(
-            Dependency(dep, is_enterprise_feed) for dep in dep_list
-        )
+        dependencies.extend(Dependency(dep, is_enterprise_feed) for dep in dep_list)
 
     return dependencies
 

troubadix/standalone_plugins/deprecate_vts.py

@@ -42,9 +42,7 @@ KB_ITEMS_PATTERN = re.compile(r"set_kb_item\(.+\);")
 
 
 def load_transition_oid_mapping(transition_file: Path) -> dict[str, str]:
-    spec = importlib.util.spec_from_file_location(
-        "transition_layer", transition_file
-    )
+    spec = importlib.util.spec_from_file_location("transition_layer", transition_file)
     transition_layer = importlib.util.module_from_spec(spec)
     spec.loader.exec_module(transition_layer)
 
@@ -151,9 +149,7 @@ def find_replacement_oid(
         file.content,
     )
     if not oid_match:
-        raise ValueError(
-            f"No OID found in {file.name}. Cannot map to replacement OID."
-        )
+        raise ValueError(f"No OID found in {file.name}. Cannot map to replacement OID.")
     oid = oid_match.group("value")
     replacement_oid = oid_mapping.get(oid)
     if not replacement_oid:
@@ -181,9 +177,7 @@ def deprecate(
     output_path.mkdir(parents=True, exist_ok=True)
     for file in to_deprecate:
         if re.findall(KB_ITEMS_PATTERN, file.content):
-            logger.warning(
-                f"Unable to deprecate {file.name}. There are still KB keys remaining."
-            )
+            logger.warning(f"Unable to deprecate {file.name}. There are still KB keys remaining.")
             continue
 
         replacement_oid = find_replacement_oid(file, oid_mapping)

troubadix/standalone_plugins/file_extensions.py

@@ -19,9 +19,7 @@ def parse_args() -> Namespace:
         type=directory_type_existing,
         help="directory that should be linted",
     )
-    parser.add_argument(
-        "--ignore-file", type=file_type_existing, help="path to ignore file"
-    )
+    parser.add_argument("--ignore-file", type=file_type_existing, help="path to ignore file")
     parser.add_argument(
         "--gen-ignore-entries",
         action="store_true",
@@ -35,9 +33,7 @@ def create_exclusions(ignore_file: Path) -> set[Path]:
         return set()
 
     with open(ignore_file, "r", encoding="utf-8") as file:
-        return {
-            Path(line.strip()) for line in file if not re.match(r"^\s*#", line)
-        }
+        return {Path(line.strip()) for line in file if not re.match(r"^\s*#", line)}
 
 
 def check_extensions(args: Namespace) -> List[Path]:
@@ -77,10 +73,7 @@ def main() -> int:
             print(file.relative_to(args.dir))
         return 0
 
-    print(
-        f"{len(unwanted_files)} "
-        "Files with unwanted file extension were found:"
-    )
+    print(f"{len(unwanted_files)} " "Files with unwanted file extension were found:")
     for file in unwanted_files:
         print(file)
     return 1

troubadix/standalone_plugins/last_modification.py

@@ -48,9 +48,7 @@ def update(nasl_file: Path, terminal: Terminal):
     )
 
     if not match_last_modification_any_value:
-        terminal.warning(
-            f'Ignoring "{nasl_file}" because it is missing a last_modification tag.'
-        )
+        terminal.warning(f'Ignoring "{nasl_file}" because it is missing a last_modification tag.')
         return
 
     now = datetime.datetime.now(datetime.timezone.utc)
@@ -71,9 +69,7 @@ def update(nasl_file: Path, terminal: Terminal):
         string=file_content,
     )
     if not match_script_version:
-        terminal.warning(
-            f'Ignoring "{nasl_file}" because it is missing a script_version.'
-        )
+        terminal.warning(f'Ignoring "{nasl_file}" because it is missing a script_version.')
         return
 
     # get that date formatted correctly:
@@ -89,9 +85,7 @@ def update(nasl_file: Path, terminal: Terminal):
 
 
 def parse_args(args: Sequence[str] = None) -> Namespace:
-    parser = ArgumentParser(
-        description="Update script_version and last_modification tags"
-    )
+    parser = ArgumentParser(description="Update script_version and last_modification tags")
     what_group = parser.add_mutually_exclusive_group(required=True)
     what_group.add_argument(
         "--files",