troubadix 25.12.4__py3-none-any.whl → 26.2.0__py3-none-any.whl

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

@@ -49,8 +49,7 @@ def parse_args(args: Iterable[str]) -> Namespace:
         type=file_type_existing,
         default=[],
         help=(
-            "List of files to diff. "
-            "If empty use all files added or modified in the commit range."
+            "List of files to diff. If empty use all files added or modified in the commit range."
         ),
     )
     return parser.parse_args(args=args)
@@ -69,9 +68,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 +122,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()
@@ -76,14 +74,22 @@ class Package:
 
         return False
 
+    def __le__(self, other: "Package") -> bool:
+        # Sort by release first, then the other fields
+        if self.release != other.release:
+            return self.release < other.release
+        if self.name != other.name:
+            return self.name < other.name
+
+        return self.version <= other.version
+
     def __str__(self) -> str:
-        result = f"{self.name : <50} {self.version : <40} {self.release : <10}"
+        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}{' in new package' if direction == Direction.PASSIVE else ''}"
             for change, direction in self.reasons.items()
         )
-        result += f"{reasons : <10}"
+        result += f"{reasons: <10}"
 
         return result

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",

troubadix/standalone_plugins/no_solution.py

@@ -53,9 +53,7 @@ MONTH_AS_DAYS = 365 / 12
 def parse_solution_date(date_string: str) -> datetime:
     """Convert date string to date trying different formats"""
 
-    date_string = re.sub(
-        r"(?P<date>.\d{1,2})(st|nd|rd|th)", r"\g<date>", date_string
-    )
+    date_string = re.sub(r"(?P<date>.\d{1,2})(st|nd|rd|th)", r"\g<date>", date_string)
 
     for strptime in SOLUTION_DATE_FORMATS:
         try:
@@ -99,8 +97,7 @@ def parse_args() -> Namespace:
         dest="threshold",
         type=int,
         default=12,
-        help="The threshold after which to assume no solution "
-        "will be provided anymore",
+        help="The threshold after which to assume no solution will be provided anymore",
     )
 
     parser.add_argument(
@@ -118,10 +115,7 @@ def parse_args() -> Namespace:
 
 def check_skip_script(file_content: str) -> bool:
     solution_type = SOLUTION_TYPE_PATTERN.search(file_content)
-    if (
-        solution_type
-        and solution_type.group("value") != SOLUTION_TYPE_NONE_AVAILABLE
-    ):
+    if solution_type and solution_type.group("value") != SOLUTION_TYPE_NONE_AVAILABLE:
         return True
 
     cvss = CVSS_PATTERN.search(file_content)
@@ -148,9 +142,7 @@ def extract_tags(content: str) -> Optional[Tuple[str, datetime, datetime]]:
     if not creation_match:
         return None
 
-    creation_date = datetime.strptime(
-        creation_match.group("value")[:10], CREATION_DATE_FORMAT
-    )
+    creation_date = datetime.strptime(creation_match.group("value")[:10], CREATION_DATE_FORMAT)
 
     oid_match = OID_PATTERN.search(content)
     if not oid_match:
@@ -164,9 +156,7 @@ def extract_tags(content: str) -> Optional[Tuple[str, datetime, datetime]]:
 def get_no_solution_vts(
     files: Iterable[Path],
 ) -> Iterable[Tuple[Path, str, datetime, datetime]]:
-    file_contents = (
-        (file, file.read_text(encoding=CURRENT_ENCODING)) for file in files
-    )
+    file_contents = ((file, file.read_text(encoding=CURRENT_ENCODING)) for file in files)
     return (
         (file, *extract_tags(content))
         for file, content in file_contents
@@ -191,22 +181,17 @@ def check_no_solutions(
             (
                 milestone
                 for milestone in milestones
-                if solution_date
-                < creation_date + timedelta(days=milestone * MONTH_AS_DAYS)
-                and milestone * MONTH_AS_DAYS
-                <= (datetime.now() - creation_date).days
+                if solution_date < creation_date + timedelta(days=milestone * MONTH_AS_DAYS)
+                and milestone * MONTH_AS_DAYS <= (datetime.now() - creation_date).days
             ),
             None,
         )
 
-        if solution_date > creation_date + timedelta(
-            days=last_milestone * MONTH_AS_DAYS
-        ):
+        if solution_date > creation_date + timedelta(days=last_milestone * MONTH_AS_DAYS):
             milestone = last_milestone
 
         if not milestone or (
-            milestone == last_milestone
-            and (datetime.now() - solution_date) < snooze_duration
+            milestone == last_milestone and (datetime.now() - solution_date) < snooze_duration
         ):
             continue
 
@@ -254,10 +239,7 @@ def print_report(
                 "No solution should be expected at this point. "
             )
         else:
-            term.bold_info(
-                f"{len(vts)} VTs with no solution for "
-                f"more than {milestone} month(s)"
-            )
+            term.bold_info(f"{len(vts)} VTs with no solution for more than {milestone} month(s)")
 
         for vt, oid, creation, solution in vts:
             term.info(str(vt.relative_to(root)))
@@ -265,9 +247,7 @@ def print_report(
             with term.indent():
                 term.print(f"OID: {oid}")
                 term.print(f"Created: {creation.strftime('%Y-%m-%d')}")
-                term.print(
-                    f"Last solution update: {solution.strftime('%Y-%m-%d')}"
-                )
+                term.print(f"Last solution update: {solution.strftime('%Y-%m-%d')}")
 
         term.print()
 
@@ -284,9 +264,7 @@ def main():
 
         term = ConsoleTerminal()
 
-        print_info(
-            term, milestones, arguments.threshold, arguments.snooze, root
-        )
+        print_info(term, milestones, arguments.threshold, arguments.snooze, root)
 
         summary = check_no_solutions(files, milestones, arguments.snooze)
 

troubadix/standalone_plugins/util.py

@@ -11,11 +11,9 @@ 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")

troubadix/standalone_plugins/version_updated.py

@@ -31,9 +31,7 @@ from troubadix.helper.patterns import (
 )
 from troubadix.standalone_plugins.common import git
 
-SCRIPT_VERSION_PATTERN = re.compile(
-    r"^\+\s*" + SCRIPT_VERSION_ANY_VALUE_PATTERN, re.MULTILINE
-)
+SCRIPT_VERSION_PATTERN = re.compile(r"^\+\s*" + SCRIPT_VERSION_ANY_VALUE_PATTERN, re.MULTILINE)
 SCRIPT_LAST_MODIFICATION_PATTERN = re.compile(
     r"^\+\s*" + LAST_MODIFICATION_ANY_VALUE_PATTERN, re.MULTILINE
 )
@@ -70,8 +68,7 @@ def parse_args(args: Iterable[str]) -> Namespace:
         type=file_type_existing,
         default=[],
         help=(
-            "List of files to diff. "
-            "If empty use all files added or modified in the commit range."
+            "List of files to diff. If empty use all files added or modified in the commit range."
         ),
     )
     return parser.parse_args(args=args)
@@ -88,9 +85,7 @@ def check_version_updated(files: List[Path], commit_range: str) -> bool:
     if not files:
         files = [
             Path(f)
-            for f in git(
-                "diff", "--name-only", "--diff-filter=d", commit_range
-            ).splitlines()
+            for f in git("diff", "--name-only", "--diff-filter=d", commit_range).splitlines()
         ]
 
     rcode = True
@@ -113,9 +108,7 @@ def check_version_updated(files: List[Path], commit_range: str) -> bool:
         )
 
         if not SCRIPT_VERSION_PATTERN.search(text):
-            print(
-                f"{nasl_file}: Missing updated script_version", file=sys.stderr
-            )
+            print(f"{nasl_file}: Missing updated script_version", file=sys.stderr)
             rcode = False
 
         if not SCRIPT_LAST_MODIFICATION_PATTERN.search(text):
@@ -135,9 +128,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
 
     parsed_args = parse_args(args)

troubadix/troubadix.py

@@ -98,10 +98,7 @@ def generate_patterns(
 def from_file(include_file: Path, term: Terminal) -> Iterable[Path]:
     """Parse the given file containing a list of files into"""
     try:
-        return [
-            Path(f)
-            for f in include_file.read_text(encoding="utf-8").splitlines()
-        ]
+        return [Path(f) for f in include_file.read_text(encoding="utf-8").splitlines()]
     except FileNotFoundError:
         term.error(f"File {include_file} containing the file list not found.")
         sys.exit(1)

{troubadix-25.12.4.dist-info → troubadix-26.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: troubadix
-Version: 25.12.4
+Version: 26.2.0
 Summary: A linting and QA check tool for NASL files
 License: GPL-3.0-or-later
 License-File: LICENSE