troubadix 25.7.2__py3-none-any.whl → 25.7.3__py3-none-any.whl

troubadix/__version__.py

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

troubadix/helper/if_block_parser.py

@@ -4,6 +4,7 @@
 """Helper for parsing if blocks and single-expression if statements in NASL files."""
 
 from dataclasses import dataclass
+from enum import Enum
 
 from troubadix.helper.text_utils import (
     StringState,
@@ -12,7 +13,7 @@ from troubadix.helper.text_utils import (
 
 # Brace pairings
 CONDITION_BRACES = ("(", ")")
-BLOCK_BRACES = ("{", "}")
+BODY_BRACES = ("{", "}")
 
 
 @dataclass
@@ -21,10 +22,35 @@ class IfStatement:
     if_end: int
     condition_start: int
     condition_end: int
-    statement_start: int
-    statement_end: int
+    outcome_start: int
+    outcome_end: int
     condition: str
-    statement: str
+    outcome: str
+
+
+class IfErrorType(Enum):
+    UNCLOSED_CONDITION = "Unclosed parenthesis in if condition at line {line}"
+    UNCLOSED_BODY = "Unclosed brace in if body at line {line}"
+    MISSING_OUTCOME = (
+        "Missing statement or body after if condition at line {line}"
+    )
+    TERMINATED_AFTER_CONDITION = (
+        "Semicolon after if condition at line {line} causes if to terminate early. "
+        "Following block will always execute."
+    )
+    MISSING_STATEMENT = "Missing expression after if condition at line {line}"
+
+
+@dataclass
+class IfParseError:
+    line: int
+    error_type: IfErrorType
+
+
+@dataclass
+class IfParseResult:
+    statements: list[IfStatement]
+    errors: list[IfParseError]
 
 
 class IfParser:
@@ -33,44 +59,76 @@ class IfParser:
     def __init__(self, file_content: str):
         self.file_content = file_content
 
-    def find_if_statements(self) -> list[IfStatement]:
-        """Parse the file to find all if statements (blocks and single expressions)."""
+    def find_if_statements(self) -> IfParseResult:
+        """
+        Parse the file to find all if statements (blocks and single expressions), collecting errors.
+
+        Example NASL if statements:
+            if (x > 0) {
+                foo();
+            }
+            if (y < 5)
+              bar();
+        """
         results: list[IfStatement] = []
+        errors: list[IfParseError] = []
+        # Step 1: Find all 'if' condition starts
         starts = self._find_condition_starts()
         if not starts:
-            return results
+            return IfParseResult(results, errors)
 
         for if_start, opening_brace in starts:
             line, _ = index_to_linecol(self.file_content, if_start)
 
-            condition_end = self._find_closing_brace(
-                opening_brace, CONDITION_BRACES, line
+            # Step 2: Find the end of the condition (the closing parenthesis)
+            condition_end, condition_error = self._find_closing_brace(
+                opening_brace, CONDITION_BRACES
             )
+            if condition_error:
+                errors.append(
+                    IfParseError(line=line, error_type=condition_error)
+                )
+                continue
             condition = self.file_content[
                 opening_brace + 1 : condition_end
             ].strip()
-            statement_pos = self._find_statement_start(condition_end, line)
 
-            if self.file_content[statement_pos] == "{":
-                # Block statement
-                block_end = self._find_closing_brace(
-                    statement_pos, BLOCK_BRACES, line
+            # Step 3: Find the start of the outcome (first non-whitespace after condition)
+            outcome_start, outcome_error = self._find_outcome_start(
+                condition_end
+            )
+            if outcome_error:
+                errors.append(IfParseError(line=line, error_type=outcome_error))
+                continue
+
+            # Step 4: Determine if this is a body or single-expression statement
+            if self.file_content[outcome_start] == "{":
+                # Body: find closing brace for body '}'
+                body_end, body_error = self._find_closing_brace(
+                    outcome_start, BODY_BRACES
                 )
-                if_end = block_end + 1
-                statement_start = statement_pos + 1
-                statement_end = block_end
-                statement = self.file_content[
-                    statement_pos + 1 : block_end
-                ].strip()
+                if body_error:
+                    errors.append(
+                        IfParseError(line=line, error_type=body_error)
+                    )
+                    continue
+                if_end = body_end + 1
+                outcome_start = outcome_start + 1  # exclude opening brace
+                outcome_end = body_end
             else:
-                # Single expression
-                expression_end = self._find_expression_end(statement_pos, line)
-                if_end = expression_end + 1
-                statement_start = statement_pos
-                statement_end = expression_end
-                statement = self.file_content[
-                    statement_pos:expression_end
-                ].strip()
+                # Single statement: find end of statement ';'
+                statement_end, statement_error = self._find_statement_end(
+                    outcome_start
+                )
+                if statement_error:
+                    errors.append(
+                        IfParseError(line=line, error_type=statement_error)
+                    )
+                    continue
+                if_end = statement_end + 1
+                outcome_end = statement_end
+
+            outcome = self.file_content[outcome_start:outcome_end].strip()
 
             results.append(
                 IfStatement(
@@ -78,21 +136,20 @@ class IfParser:
                     if_end=if_end,
                     condition_start=opening_brace + 1,
                     condition_end=condition_end,
-                    statement_start=statement_start,
-                    statement_end=statement_end,
+                    outcome_start=outcome_start,
+                    outcome_end=outcome_end,
                     condition=condition,
-                    statement=statement,
+                    outcome=outcome,
                 )
             )
 
-        return results
+        return IfParseResult(results, errors)
 
     def _find_closing_brace(
         self,
         start_pos: int,
         brace_pair: tuple[str, str],
-        line: int,
-    ) -> int:
+    ) -> tuple[int | None, IfErrorType | None]:
         """Find the matching closing brace, with proper error reporting."""
         opening_brace, closing_brace = brace_pair
         open_count = 1
@@ -111,19 +168,13 @@ class IfParser:
             elif char == closing_brace:
                 open_count -= 1
                 if open_count == 0:
-                    return i
+                    return i, None
 
-        # Generate appropriate error message based on brace type
+        # Error: unclosed brace
         if opening_brace == "(":
-            raise ValueError(
-                f"Unclosed parenthesis in if statement at line {line}"
-            )
-        elif opening_brace == "{":
-            raise ValueError(f"Unclosed brace in if statement at line {line}")
+            return None, IfErrorType.UNCLOSED_CONDITION
         else:
-            raise ValueError(
-                f"Unclosed {opening_brace} in if statement at line {line}"
-            )
+            return None, IfErrorType.UNCLOSED_BODY
 
     def _find_condition_starts(self) -> list[tuple[int, int]]:
         """
@@ -159,42 +210,41 @@ class IfParser:
 
         return starts
 
-    def _find_statement_start(self, condition_end: int, line: int) -> int:
-        """Find the start of the statement after the condition (next non-whitespace character)."""
+    def _find_outcome_start(
+        self, condition_end: int
+    ) -> tuple[int | None, IfErrorType | None]:
+        """
+        Find the start of the outcome/then part after the condition (next non-whitespace character).
+        """
         pos = condition_end + 1
         while pos < len(self.file_content) and self.file_content[pos].isspace():
             pos += 1
 
         if pos >= len(self.file_content):
-            raise ValueError(
-                f"Missing statement after if condition at line {line}"
-            )
+            return None, IfErrorType.MISSING_OUTCOME
 
         if self.file_content[pos] == ";":
-            raise ValueError(
-                f"Semicolon after if condition at line {line} makes following block "
-                f"always execute. Remove semicolon to fix."
-            )
+            return None, IfErrorType.TERMINATED_AFTER_CONDITION
 
-        return pos
+        return pos, None
 
-    def _find_expression_end(self, expression_start: int, line: int) -> int:
-        """Find the end of a single expression (semicolon outside of strings)."""
+    def _find_statement_end(
+        self, statement_start: int
+    ) -> tuple[int | None, IfErrorType | None]:
+        """Find the end of a single statement (semicolon outside of strings)."""
         string_state = StringState()
 
-        for i in range(expression_start, len(self.file_content)):
+        for i in range(statement_start, len(self.file_content)):
             char = self.file_content[i]
             string_state.process_next_char(char)
             if not string_state.in_string and char == ";":
-                return i
+                return i, None
 
-        raise ValueError(
-            f"Missing expression after if condition at line {line}"
-        )
+        return None, IfErrorType.MISSING_STATEMENT
 
 
 # Wrapper function to maintain backward compatibility
-def find_if_statements(file_content: str) -> list[IfStatement]:
-    """Parse a file to find all if statements (blocks and single expressions)."""
+def find_if_statements(file_content: str) -> IfParseResult:
+    """Parse a file to find all if statements."""
     parser = IfParser(file_content)
     return parser.find_if_statements()

troubadix/plugins/__init__.py

@@ -39,6 +39,7 @@ from .forking_nasl_functions import CheckForkingNaslFunctions
 from .get_kb_on_services import CheckGetKBOnServices
 from .grammar import CheckGrammar
 from .http_links_in_tags import CheckHttpLinksInTags
+from .if_statement_syntax import CheckIfStatementSyntax
 from .illegal_characters import CheckIllegalCharacters
 from .log_messages import CheckLogMessages
 from .malformed_dependencies import CheckMalformedDependencies
@@ -149,6 +150,7 @@ _FILE_PLUGINS = [
     CheckVTPlacement,
     CheckWrongSetGetKBCalls,
     CheckSpacesBeforeDots,
+    CheckIfStatementSyntax,
 ]
 
 # plugins checking all files

troubadix/plugins/if_statement_syntax.py

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+
+
+from pathlib import Path
+from typing import Iterator
+
+from troubadix.helper.if_block_parser import find_if_statements
+from troubadix.helper.remove_comments import remove_comments
+from troubadix.plugin import FileContentPlugin, LinterError, LinterResult
+
+
+class CheckIfStatementSyntax(FileContentPlugin):
+    """Check for syntax errors in if statements.
+
+    This plugin uses the if statement parser to detect common syntax errors such as:
+    - Unclosed parentheses in if conditions
+    - Unclosed braces in if blocks
+    - Missing statements after if conditions
+    - Semicolons after if conditions (which make following blocks always execute)
+    - Missing semicolons in single-line expressions
+    """
+
+    name = "check_if_statement_syntax"
+
+    def check_content(
+        self,
+        nasl_file: Path,
+        file_content: str,
+    ) -> Iterator[LinterResult]:
+        """Check the file content for if statement syntax errors."""
+        # Remove comments to avoid false positives from commented code
+        comment_free_content = remove_comments(file_content)
+
+        result = find_if_statements(comment_free_content)
+        for error in result.errors:
+            yield LinterError(
+                error.error_type.value.format(line=error.line),
+                file=nasl_file,
+                plugin=self.name,
+            )

troubadix/plugins/using_display.py

@@ -38,22 +38,15 @@ class CheckUsingDisplay(FileContentPlugin):
             return
 
         comment_free_content = remove_comments(file_content)
-        try:
-            if_statements = find_if_statements(comment_free_content)
-        except ValueError as e:
-            yield LinterError(
-                str(e),
-                file=nasl_file,
-                plugin=self.name,
-            )
+
+        display_matches = list(DISPLAY_PATTERN.finditer(comment_free_content))
+
+        if not display_matches:
             return
 
-        # Find all display() calls in the entire file
-        all_display_matches = list(
-            DISPLAY_PATTERN.finditer(comment_free_content)
-        )
+        if_statements = find_if_statements(comment_free_content).statements
 
-        for display_match in all_display_matches:
+        for display_match in display_matches:
             display_pos = display_match.start()
 
             # Skip if this match is inside a string literal

{troubadix-25.7.2.dist-info → troubadix-25.7.3.dist-info}/METADATA

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

{troubadix-25.7.2.dist-info → troubadix-25.7.3.dist-info}/RECORD

@@ -1,5 +1,5 @@
 troubadix/__init__.py,sha256=K7sIXXDrC7YRb7BvIpdQ6ZfG_QkT0qUH_wAlHROVRfM,716
-troubadix/__version__.py,sha256=EA2GLQK348RjHkRyKol1zd5TvtYoIPcrWZ21w68GjG0,103
+troubadix/__version__.py,sha256=u9FnDhh-YcJ5SxwN459lv4y5J4xuIuXl2bH00srEsSE,103
 troubadix/argparser.py,sha256=-H07Jhqh68_M4Mbjq9qJjTr3MShy_N2pxl2qHA6cfRU,7481
 troubadix/codespell/codespell.additions,sha256=E62zoHJavUhcbMoyBqO2rOUe3OqIXikh7uAiGmNs5uw,524
 troubadix/codespell/codespell.exclude,sha256=8blBv8KRrKU4KQhneHOPth1tSCYdrEoOCI5kYRfhOEA,147451
@@ -7,13 +7,13 @@ troubadix/codespell/codespell.ignore,sha256=2CP8u6O2VENcDpt2FfEDNmfa1Eh3D80yeYHT
 troubadix/helper/__init__.py,sha256=tp2fPLzwGEA_2eiJbvuePiY6rjYSFxx7VUsCV4fSwvw,1110
 troubadix/helper/date_format.py,sha256=2m8EWZPmTQ1kxgv4i5hrPoPlAA8usjz28aRff352zNU,2488
 troubadix/helper/helper.py,sha256=GXapYLii2rLKwkX2ok31YoAdUSizBnyPjWz-aPP6HM8,3105
-troubadix/helper/if_block_parser.py,sha256=mPcx5XYca4Rr3F1jTo53DRMQ2DZlgY2I7ydymMjeLB0,6813
+troubadix/helper/if_block_parser.py,sha256=_51UlsYrELt4GwWzJIU7qc7HIZPdpmExLG8WM8xtjTg,8294
 troubadix/helper/linguistic_exception_handler.py,sha256=Bq7ULjDdWTKUpFNTUX6XMPdD4s4v8eIjZPyqBe8VLws,6811
 troubadix/helper/patterns.py,sha256=qhiAtNQs89Hk6-yRGrjjRO4DdVIMhYLd8IEQ48REpu4,9752
 troubadix/helper/remove_comments.py,sha256=zjhXPQXgKaEOparAdu4aBXcJlEul8LbNaP3uLCYGwHw,1244
 troubadix/helper/text_utils.py,sha256=gBX0box9VtgA0CMfE0u2Vvi1IuOopxUfCQFYn_1wVjE,2543
 troubadix/plugin.py,sha256=3fQPj3Qe_hgwHerlYE4hbdzYMzRU557NxJ-UwtE9mOI,3525
-troubadix/plugins/__init__.py,sha256=w5ItmwNALfW4tIHuPuxqi2PMExA6eKbLiXCmviY9CSE,8661
+troubadix/plugins/__init__.py,sha256=7NqTzddmptQZJ_s1yxpamVo0Y8zohAWlEQU2lf103_Y,8745
 troubadix/plugins/badwords.py,sha256=k1A1d2pdXzie87FGGXrykP2BgdZbY5QtmQItupHtNyw,4701
 troubadix/plugins/copyright_text.py,sha256=jYsLWmTbT_A78XQQxQFK-5kMMHkh3xdvlh7mEF2dZGU,3583
 troubadix/plugins/copyright_year.py,sha256=XzM9MHVzOXwNLwHpfuaWj8PUOmswr56SBVOLBdvxjd4,5478
@@ -32,6 +32,7 @@ troubadix/plugins/forking_nasl_functions.py,sha256=IUtCrTK_sGDx79jAPS8lF_aN8zSG2
 troubadix/plugins/get_kb_on_services.py,sha256=oFmcjiF7ZD3x5tEbJEoZNn80y1qUzNgeSZNsogSqaZ0,3401
 troubadix/plugins/grammar.py,sha256=9VPdf4nO-UOE2P8fiAKgh_8GwjGbLztPEixb2AQyeFU,9642
 troubadix/plugins/http_links_in_tags.py,sha256=yKT5SgLo__TJKAfudfIHkoMF0g9VtOP4VI77dANj014,7221
+troubadix/plugins/if_statement_syntax.py,sha256=5BRJwCCghvZn1AfvYzmk8l9S7aRqbVaLHhSKod_Q9zw,1429
 troubadix/plugins/illegal_characters.py,sha256=B6q_RU85AxCjLry56Oc-RhMSpnJU8mTrxclRzi1FVFU,4406
 troubadix/plugins/log_messages.py,sha256=COrnp3bXMG8PRIAD2x5Ka9hk-jI16We9ifXj6JBZI0c,2960
 troubadix/plugins/malformed_dependencies.py,sha256=96W5RJX8CbMkprA2M601qVLgBV-ibJ96bAmtyoSrgFw,3000
@@ -70,7 +71,7 @@ troubadix/plugins/spelling.py,sha256=3AW5sNtLL67OthKLaCH_y2HCVJ5YH_eyF9xjTJMIDG4
 troubadix/plugins/tabs.py,sha256=7zXaTZe4cZoZvrLyqntVfTeNN_W3D8dfQl67QevXxtc,1319
 troubadix/plugins/todo_tbd.py,sha256=MN5fFwBhPmt3JDQ2Hx20B8yUy1vz7LIZC3rDIOzfW9M,1758
 troubadix/plugins/trailing_spaces_tabs.py,sha256=nMly8ZsmGprxHvwCDclKBDRB0eq6JEkjERYKvtStkY4,1873
-troubadix/plugins/using_display.py,sha256=BBqjMzRhlVZbbeOAAktdhqysuYoHNaMmqO6-6l_-Hy4,3983
+troubadix/plugins/using_display.py,sha256=jCl55MXujaO4VlwN_yex269CKnH-oHiMeq8WqvDmGRI,3760
 troubadix/plugins/valid_oid.py,sha256=zoSDyHdePitXJwCtBk4WExtCN36Ql5NATgoQh90oKpI,17824
 troubadix/plugins/valid_script_tag_names.py,sha256=6uMJsBdV-Zx-k1F2_MWmQPHXNo1u0ifuosbftbg-27E,3447
 troubadix/plugins/variable_assigned_in_if.py,sha256=NNz8iuzyQ4rSM6My4WYC1s5TABQqgs7us15PkDA-VV0,3285
@@ -107,8 +108,8 @@ troubadix/standalone_plugins/no_solution.py,sha256=p_-az9Igl4GH6HnhLLYbYlWIiEP64
 troubadix/standalone_plugins/util.py,sha256=JTXGmi-_BJouTNe6QzEosLlXUt9jKW-3fz4db05RJJw,696
 troubadix/standalone_plugins/version_updated.py,sha256=6YHF0OjL5NWszQdsSh7XzlSji1e6Uaqwu_Y6m3R0mvI,4203
 troubadix/troubadix.py,sha256=5__Jz3bYSrya4aG6RCBWxqnsDepXfwXZ3v0bjCzEFi0,6039
-troubadix-25.7.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-troubadix-25.7.2.dist-info/METADATA,sha256=WXNcQxUkAQmWXwdlCo56byIh1KNPwDP0oFHLrFeD4MQ,4462
-troubadix-25.7.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-troubadix-25.7.2.dist-info/entry_points.txt,sha256=ETEPBi4fKv3o7hzkzceX4838G6g5_5wRdEddYot8N6A,920
-troubadix-25.7.2.dist-info/RECORD,,
+troubadix-25.7.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+troubadix-25.7.3.dist-info/METADATA,sha256=Gom5h4veT9nQrAy-44KjDlz5TunMgOFJpu13dLmzkAo,4462
+troubadix-25.7.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+troubadix-25.7.3.dist-info/entry_points.txt,sha256=ETEPBi4fKv3o7hzkzceX4838G6g5_5wRdEddYot8N6A,920
+troubadix-25.7.3.dist-info/RECORD,,