cyberark-tpc-plugin-validator 0.2.0__py3-none-any.whl

cyberark_tpc_plugin_validator-0.2.0.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: cyberark-tpc-plugin-validator
+Version: 0.2.0
+Summary: A tool to help validate a custom TPC plugin.
+Author-email: Peter McDonald <git@petermcdonald.co.uk>
+License: MIT License
+        
+        Copyright (c) 2025 (Peter McDonald)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# CyberArk TPC Plugin Validator
+
+This repository is a placeholder for a new package that is intended to validate CyberArk TPC plugins. The package will
+include a set of tools and scripts to ensure that the plugins meet the required standards and function correctly within
+the CyberArk environment.

cyberark_tpc_plugin_validator-0.2.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+cyberark_tpc_plugin_validator-0.2.0.dist-info/licenses/LICENSE,sha256=3uaL9bRy1TQRSsUyzskLL1GTXFYzmd7Aew6JlPpZJq0,1073
+tpc_plugin_validator/__init__.py,sha256=d1YTr2Y253X8hS3_f9AfooOp8aG7y2nkLrvJ5qgNUrQ,73
+tpc_plugin_validator/main.py,sha256=jGKlE7T5pJGuSINqRd8nivfV7uiGG1sxNrou45u5a5A,1493
+tpc_plugin_validator/validator.py,sha256=Cgc5WdkxWuiliO9gbWVO5GJE5Ru6xCDtR3waMcmQmJs,2544
+tpc_plugin_validator/lexer/__init__.py,sha256=eIdZea9EkshGJmN09wsnUVm661sTy2UH83h4kSfufgQ,69
+tpc_plugin_validator/lexer/lexer.py,sha256=9eTN6zDI3ADC_7Ev7zv72m-Q8rP2GUpmiNBAP-lgTQo,7341
+tpc_plugin_validator/lexer/tokens/__init__.py,sha256=d1YTr2Y253X8hS3_f9AfooOp8aG7y2nkLrvJ5qgNUrQ,73
+tpc_plugin_validator/lexer/tokens/assignment.py,sha256=mYyXioEp6pZ-hJ5EgjXHF_xQtilgRgClOAzCi5BlsJs,404
+tpc_plugin_validator/lexer/tokens/comment.py,sha256=J77JpxAGeTWl0WPuXzB2V5NRGH8odjmML_KLSsK8S-g,318
+tpc_plugin_validator/lexer/tokens/cpm_parameter_validation.py,sha256=cYukUa1p38qukrSsp_9jb1jA9C19c0NNOewrP80yfgs,467
+tpc_plugin_validator/lexer/tokens/fail_state.py,sha256=MH-WRBXzZUtvBOORtbXNV7a-W05gxuEbi0bpM-fKDdc,357
+tpc_plugin_validator/lexer/tokens/section_header.py,sha256=SCCtsTerV5fltafjsrXSCWbBqDtN0WkaRn_GR1Mr8K0,347
+tpc_plugin_validator/lexer/tokens/transition.py,sha256=tFSIo3mYYrZ7T-dvAJCbkCQ7fihwIgiXUQpPhz2RV7E,386
+tpc_plugin_validator/lexer/utilities/__init__.py,sha256=d1YTr2Y253X8hS3_f9AfooOp8aG7y2nkLrvJ5qgNUrQ,73
+tpc_plugin_validator/lexer/utilities/regex.py,sha256=XwlXZsMZg8oCT-6C_hF_ENxA4ahQbU72y4JUR_NRx-Q,865
+tpc_plugin_validator/lexer/utilities/token_name.py,sha256=HS1gthkYXEdV2bAePT2zdaWyf-Y3IwNnZ_r2uFOsEnA,343
+tpc_plugin_validator/lexer/utilities/types.py,sha256=v5gz8ogUhy6ZrK0eBCxCupzcp0B6uT_oTZ2tFYkfHZY,831
+tpc_plugin_validator/parser/__init__.py,sha256=eIdZea9EkshGJmN09wsnUVm661sTy2UH83h4kSfufgQ,69
+tpc_plugin_validator/parser/parser.py,sha256=GnsK-AsaqVjDB4_GAYPZi0picZx-S2DRUCKygHgmt7Y,3077
+tpc_plugin_validator/rule_sets/__init__.py,sha256=d1YTr2Y253X8hS3_f9AfooOp8aG7y2nkLrvJ5qgNUrQ,73
+tpc_plugin_validator/rule_sets/conditions_section_rule_set.py,sha256=nxQW8BDFfrTeJdlP5juryIypDYp1E4KpIg3ApZqpT_U,3725
+tpc_plugin_validator/rule_sets/cpm_parameters_validation_section_rule_set.py,sha256=yeOZQ9th4LJkiWJZtNp_7QDw7Y18i_bKWNZ5SqqSkeI,3719
+tpc_plugin_validator/rule_sets/debug_information_section_rule_set.py,sha256=TrvDCIcuzMBhHfBczFQ7fw7fvdPyntYTxICnszviAWg,6202
+tpc_plugin_validator/rule_sets/file_rule_set.py,sha256=QwNu7QyqOS7eX5HcJQmajl3xQFqkib8uiaqv0oM0XQ0,3494
+tpc_plugin_validator/rule_sets/parameters_section_rule_set.py,sha256=XnlFF9hPm0IWLNqlMM_rrDxUA88qO7QMx6Y6pbxj2EA,5626
+tpc_plugin_validator/rule_sets/process_file_rule_set.py,sha256=OHuOgYhhLvyWniPCa6liM2r8ozxXfWk86pfCKyc4vgM,2068
+tpc_plugin_validator/rule_sets/prompts_file_rule_set.py,sha256=xkp-F3vIxHGbwKEDcTo7-ZajAny8D0X2ioUGlOWkGrw,1641
+tpc_plugin_validator/rule_sets/rule_set.py,sha256=tdSj0OkuLTjFJZT5CxkoyApH6ZDWoc5M42SNRiXr2uw,5728
+tpc_plugin_validator/rule_sets/section_rule_set.py,sha256=3h8F9nI1s88hKfORN1XXUaG11ML9l9ytPx6P-6KpRgw,1943
+tpc_plugin_validator/rule_sets/states_section_rule_set.py,sha256=VMznvxqvgbYnngyXAr7nIpyeFTVvw5Fu774UhS4T8QI,5550
+tpc_plugin_validator/rule_sets/transitions_section_rule_set.py,sha256=cnVz2yfoj9FgebfQMK68L4atO27_D3LS9zON_6PM4zQ,6855
+tpc_plugin_validator/utilities/__init__.py,sha256=eIdZea9EkshGJmN09wsnUVm661sTy2UH83h4kSfufgQ,69
+tpc_plugin_validator/utilities/exceptions.py,sha256=tc1hXH1XXm1ZdLpaeeFrR2QYLslg7hoQjctPS7cZETY,227
+tpc_plugin_validator/utilities/severity.py,sha256=5Yh3gnbDc5kXX5o0bbfMTKrFpKxpfjhwJFKeyk5vTas,233
+tpc_plugin_validator/utilities/types.py,sha256=mfYtcTtj5K4MJP6vBw7bdlOhFDBJ26TmbZfQF419mjI,1713
+tpc_plugin_validator/utilities/validation_result.py,sha256=9qGpKdb9J5KNkCNRmLnaxIiebPOqtlZohBWtKbLqM_k,309
+cyberark_tpc_plugin_validator-0.2.0.dist-info/METADATA,sha256=xGMBcs_RLokC749DzqRNjYRku1lfkMcUjlE1nV9mem4,2209
+cyberark_tpc_plugin_validator-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cyberark_tpc_plugin_validator-0.2.0.dist-info/entry_points.txt,sha256=77dSsMZKHYjvbczAI8SCO-zNtS3F4hQWO7fFWEQ7XRE,65
+cyberark_tpc_plugin_validator-0.2.0.dist-info/top_level.txt,sha256=vxogCWT2oDGffT5_IEB3TcbkXU8h30V9KO_rWxHBG0U,21
+cyberark_tpc_plugin_validator-0.2.0.dist-info/RECORD,,

cyberark_tpc_plugin_validator-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cyberark_tpc_plugin_validator-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tpc-validator = tpc_plugin_validator.main:main

cyberark_tpc_plugin_validator-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 (Peter McDonald)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cyberark_tpc_plugin_validator-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tpc_plugin_validator

tpc_plugin_validator/__init__.py

@@ -0,0 +1 @@
+"""Standard blank __init__ file for the tpc_plugin_validator package."""

tpc_plugin_validator/lexer/__init__.py

@@ -0,0 +1 @@
+# Standard blank __init__ file for the tpc_plugin_validator package.

tpc_plugin_validator/lexer/lexer.py

@@ -0,0 +1,221 @@
+import re
+
+from tpc_plugin_validator.lexer.tokens.assignment import Assignment
+from tpc_plugin_validator.lexer.tokens.comment import Comment
+from tpc_plugin_validator.lexer.tokens.cpm_parameter_validation import (
+    CPMParameterValidation,
+)
+from tpc_plugin_validator.lexer.tokens.fail_state import FailState
+from tpc_plugin_validator.lexer.tokens.section_header import SectionHeader
+from tpc_plugin_validator.lexer.tokens.transition import Transition
+from tpc_plugin_validator.lexer.utilities.regex import (
+    ASSIGNMENT,
+    COMMENT,
+    CPM_PARAMETER_VALIDATION,
+    FAIL_STATE,
+    SECTION_HEADER,
+    TRANSITION,
+)
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+from tpc_plugin_validator.lexer.utilities.types import ALL_TOKEN_TYPES, TokenSpecs
+from tpc_plugin_validator.utilities.exceptions import LexerException
+
+
+class Lexer(object):
+    """Object to handle processing the ini files."""
+
+    __slots__ = (
+        "_parsed_data",
+        "_source",
+        "_token_specs",
+    )
+
+    def __init__(self, source: str) -> None:
+        """Standard init for the Lexer object."""
+
+        self._parsed_data: list[
+            tuple[
+                TokenName,
+                ALL_TOKEN_TYPES,
+            ]
+        ] = []
+        self._source: str = source
+        self._token_specs: list[TokenSpecs] = [
+            {
+                "pattern": re.compile(ASSIGNMENT, re.IGNORECASE),
+                "token_name": TokenName.ASSIGNMENT,
+                "processor_method": "_process_assignment",
+            },
+            {
+                "pattern": re.compile(COMMENT, re.IGNORECASE),
+                "token_name": TokenName.COMMENT,
+                "processor_method": "_process_comment",
+            },
+            {
+                "pattern": re.compile(CPM_PARAMETER_VALIDATION, re.IGNORECASE),
+                "token_name": TokenName.CPM_PARAMETER_VALIDATION,
+                "processor_method": "_process_cpm_parameter_validation",
+            },
+            {
+                "pattern": re.compile(FAIL_STATE, re.IGNORECASE),
+                "token_name": TokenName.FAIL_STATE,
+                "processor_method": "_process_fail_state",
+            },
+            {
+                "pattern": re.compile(SECTION_HEADER, re.IGNORECASE),
+                "token_name": TokenName.SECTION_HEADER,
+                "processor_method": "_process_section_header",
+            },
+            {
+                "pattern": re.compile(TRANSITION, re.IGNORECASE),
+                "token_name": TokenName.TRANSITION,
+                "processor_method": "_process_transitions",
+            },
+        ]
+
+    def process(self) -> None:
+        """
+        Process the content of the file line by line.
+
+        :raises LexerException: If the line is not valid.
+        """
+
+        if self._parsed_data:
+            # Returning as we have parsed the data already.
+            return
+
+        for line_number, line in enumerate(self._source.splitlines(), start=1):
+            for token_spec in self._token_specs:
+                if match := token_spec["pattern"].match(line):
+                    getattr(self, token_spec["processor_method"])(match=match, line_number=line_number)
+                    break
+            else:
+                if line.strip():
+                    raise LexerException(f'Unable to parse "{line}" on line {line_number}')
+
+    def _process_assignment(self, match: re.Match, line_number: int) -> None:
+        """
+        Process a variable assignment line
+
+        :param match: Regex match of the assignment.
+        """
+        name: str = str(match["name"]).strip()
+        equals = str(match["equals"]).strip() if match.groupdict().get("equals", None) else None
+        assigned_stripped = str(match["value"]).strip() if match.groupdict().get("value", None) else None
+        assigned = assigned_stripped or None
+        self._parsed_data.append(
+            (
+                TokenName.ASSIGNMENT,
+                Assignment(
+                    name=name,
+                    equals=equals,
+                    assigned=assigned,
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    def _process_comment(self, match: re.Match, line_number: int) -> None:
+        """
+        Process the provided comment.
+
+        :param match: Regex match of the comment.
+        """
+        self._parsed_data.append(
+            (
+                TokenName.COMMENT,
+                Comment(
+                    content=str(match["comment"]).strip(),
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    def _process_cpm_parameter_validation(self, match: re.Match, line_number: int) -> None:
+        """
+        Process the provided parameter validation.
+
+        :param match: Regex match of the parameter validation.
+        """
+        allow_characters: str | None = None
+        if match["allowcharacters"]:
+            allow_characters = str(match["allowcharacters"]).strip()
+
+        self._parsed_data.append(
+            (
+                TokenName.CPM_PARAMETER_VALIDATION,
+                CPMParameterValidation(
+                    name=str(match["name"]),
+                    source=str(match["source"]),
+                    mandatory=str(match["mandatory"]),
+                    allow_characters=allow_characters,
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    def _process_fail_state(self, match: re.Match, line_number: int) -> None:
+        """
+        Process the provided fail state .
+
+        :param match: Regex match of the fail state.
+        """
+        self._parsed_data.append(
+            (
+                TokenName.FAIL_STATE,
+                FailState(
+                    name=str(match["name"]).strip(),
+                    message=str(match["message"]).strip(),
+                    code=int(match["code"]),
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    def _process_section_header(self, match: re.Match, line_number: int) -> None:
+        """
+        Process the provided section header.
+
+        :param match: Regex match of the section header.
+        """
+        self._parsed_data.append(
+            (
+                TokenName.SECTION_HEADER,
+                SectionHeader(
+                    name=str(match["name"].strip()),
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    def _process_transitions(self, match: re.Match, line_number: int) -> None:
+        """
+        Process the provided transitions.
+
+        :param match: Regex match of the transitions.
+        """
+        self._parsed_data.append(
+            (
+                TokenName.TRANSITION,
+                Transition(
+                    current_state=str(match["current"]).strip(),
+                    condition=str(match["condition"]).strip(),
+                    next_state=str(match["next"]).strip(),
+                    line_number=line_number,
+                ),
+            )
+        )
+
+    @property
+    def tokens(
+        self,
+    ) -> list[
+        tuple[
+            TokenName,
+            ALL_TOKEN_TYPES,
+        ]
+    ]:
+        """A list of tokens found by the lexer."""
+        if not self._parsed_data:
+            self.process()
+        return self._parsed_data

tpc_plugin_validator/lexer/tokens/__init__.py

@@ -0,0 +1 @@
+"""Standard blank __init__ file for the tpc_plugin_validator package."""

tpc_plugin_validator/lexer/tokens/assignment.py

@@ -0,0 +1,16 @@
+"""Class to hold the assignment token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class Assignment(object):
+    """Dataclass to hold variable assignment details."""
+
+    line_number: int
+    name: str
+    equals: str | None = None
+    assigned: str | None = None
+    token_name: str = TokenName.ASSIGNMENT.value

tpc_plugin_validator/lexer/tokens/comment.py

@@ -0,0 +1,14 @@
+"""Class to hold the comment token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class Comment(object):
+    """Dataclass to hold a comment."""
+
+    line_number: int
+    content: str
+    token_name: str = TokenName.COMMENT.value

tpc_plugin_validator/lexer/tokens/cpm_parameter_validation.py

@@ -0,0 +1,17 @@
+"""Class to hold the parameter validation token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class CPMParameterValidation(object):
+    """Dataclass to hold variable cpm parameter validation details."""
+
+    line_number: int
+    name: str
+    source: str
+    mandatory: str
+    allow_characters: str | None = None
+    token_name: str = TokenName.CPM_PARAMETER_VALIDATION.value

tpc_plugin_validator/lexer/tokens/fail_state.py

@@ -0,0 +1,16 @@
+"""Class to hold the fail state token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class FailState(object):
+    """Dataclass to hold a fail state."""
+
+    line_number: int
+    name: str
+    message: str
+    code: int
+    token_name: str = TokenName.FAIL_STATE.value

tpc_plugin_validator/lexer/tokens/section_header.py

@@ -0,0 +1,14 @@
+"""Class to hold the section header token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class SectionHeader(object):
+    """Dataclass to hold a section header name."""
+
+    line_number: int
+    name: str
+    token_name: str = TokenName.SECTION_HEADER.value

tpc_plugin_validator/lexer/tokens/transition.py

@@ -0,0 +1,16 @@
+"""Class to hold the state transition token."""
+
+from dataclasses import dataclass
+
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+
+@dataclass(frozen=True)
+class Transition(object):
+    """Dataclass to hold state transitions."""
+
+    line_number: int
+    current_state: str
+    condition: str
+    next_state: str
+    token_name: str = TokenName.TRANSITION.value

tpc_plugin_validator/lexer/utilities/__init__.py

@@ -0,0 +1 @@
+"""Standard blank __init__ file for the tpc_plugin_validator package."""

tpc_plugin_validator/lexer/utilities/regex.py

@@ -0,0 +1,10 @@
+"""List of regex the lexer uses."""
+
+ASSIGNMENT = (
+    r"^(?:[\s]*)(?P<name>[\w]+)(?:(?:[\s]*)(?P<equals>=)(?:(?:[\s]*)(?P<value>(?:(?!\s*fail\s*\().)+))?)?(?:[\s]*)$"
+)
+COMMENT = r"^(?:[\s]*)(?P<comment>(?:[#;]+)(?:.*))(?:[\s]*)$"
+CPM_PARAMETER_VALIDATION = r"^(?:[\s]*)(?P<name>[\w\\]+)(?:(?:[\s]*,[\s]*)(?:source)(?:[\s]*)=(?:[\s]*)(?P<source>[^, ]*))(?:(?:[\s]*,[\s]*)(?:mandatory)(?:[\s]*)=(?:[\s]*)(?P<mandatory>[^,]*))?(?:(?:[\s]*,[\s]*)(?:allowcharacters)(?:[\s]*)=(?:[\s]*)(?P<allowcharacters>.*))?$"
+FAIL_STATE = r"^(?:[\s]*)(?P<name>[\w]+)(?:[\s]*)=(?:[\s]*)(?:[\s]*)(?:fail)(?:[\s]*)\((?:[\s]*)(?P<message>.*)(?:[\s])?,(?:[\s]*)(?P<code>[0-9]+)\)(?:[\s]*)$"
+SECTION_HEADER = r"^(?:[\s]*)\[(?P<name>[\w]+(?:[\s]+[\w]+)*)](?:[\s]*)$"
+TRANSITION = r"^(?:[\s]*)(?P<current>[\w]+)(?:[\s]*,[\s]*)(?P<condition>[\w]+)(?:[\s]*,[\s]*)(?P<next>[\w]+)(?:[\s]*)$"

tpc_plugin_validator/lexer/utilities/token_name.py

@@ -0,0 +1,14 @@
+"""Enum to hold the allowed token names."""
+
+from enum import Enum
+
+
+class TokenName(Enum):
+    """CLass to hold the token name."""
+
+    ASSIGNMENT = "Assignment"
+    COMMENT = "Comment"
+    FAIL_STATE = "Fail State"
+    CPM_PARAMETER_VALIDATION = "CPM Parameter Validation"
+    SECTION_HEADER = "Section Header"
+    TRANSITION = "Transition"

tpc_plugin_validator/lexer/utilities/types.py

@@ -0,0 +1,22 @@
+"""Module for aggregating all token types used in the lexer."""
+
+from typing import TypedDict
+import re
+
+from tpc_plugin_validator.lexer.tokens.assignment import Assignment
+from tpc_plugin_validator.lexer.tokens.comment import Comment
+from tpc_plugin_validator.lexer.tokens.cpm_parameter_validation import (
+    CPMParameterValidation,
+)
+from tpc_plugin_validator.lexer.tokens.fail_state import FailState
+from tpc_plugin_validator.lexer.tokens.section_header import SectionHeader
+from tpc_plugin_validator.lexer.tokens.transition import Transition
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+
+ALL_TOKEN_TYPES = Assignment | Comment | FailState | CPMParameterValidation | SectionHeader | Transition
+
+
+class TokenSpecs(TypedDict):
+    pattern: re.Pattern
+    token_name: TokenName
+    processor_method: str

tpc_plugin_validator/main.py

@@ -0,0 +1,41 @@
+"""Entry point for the TPC Plugin Validator module."""
+
+import argparse
+import os
+import sys
+
+from tpc_plugin_validator.parser.parser import Parser
+from tpc_plugin_validator.validator import Validator
+
+
+def main() -> None:
+    """Main entry point for the TPC Plugin Validator module."""
+    arg_parse = argparse.ArgumentParser(
+        prog="CyberArk TPC Plugin Validator",
+        description="Validate the provided TPC process and prompts file.",
+    )
+    arg_parse.add_argument("process_file", type=str, help="Path to the process file to validate")
+    arg_parse.add_argument("prompts_file", type=str, help="Path to the prompts file to validate")
+    args = arg_parse.parse_args()
+
+    if not os.path.isfile(args.process_file):
+        arg_parse.error(f'The process file "{args.process_file}" does not exist or is not accessible.')
+
+    if not os.path.isfile(args.prompts_file):
+        arg_parse.error(f'The prompts file "{args.prompts_file}" does not exist or is not accessible.')
+
+    with open(args.process_file, "r", encoding="utf-8") as process_handler:
+        process_file = process_handler.read()
+
+    with open(args.prompts_file, "r", encoding="utf-8") as prompts_handler:
+        prompts_file = prompts_handler.read()
+
+    parser = Parser(process_file=process_file, prompts_file=prompts_file)
+    validator = Validator(parser=parser, config={})
+    validator.validate()
+    result = validator.get_violations()
+    print(result)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

tpc_plugin_validator/parser/__init__.py

@@ -0,0 +1 @@
+# Standard blank __init__ file for the tpc_plugin_validator package.

tpc_plugin_validator/parser/parser.py

@@ -0,0 +1,91 @@
+"""Parser module for reading and processing configuration files."""
+
+from tpc_plugin_validator.lexer.lexer import Lexer
+from tpc_plugin_validator.lexer.tokens.section_header import SectionHeader
+from tpc_plugin_validator.lexer.utilities.token_name import TokenName
+from tpc_plugin_validator.lexer.utilities.types import ALL_TOKEN_TYPES
+
+
+class Parser(object):
+    """Object to handle parsing ini files."""
+
+    __slots__ = (
+        "_process_file",
+        "_process_file_path",
+        "_prompts_file",
+        "_prompts_file_path",
+    )
+
+    def __init__(self, process_file: str, prompts_file: str) -> None:
+        """
+        Initializes the Parser with the given process and prompts files.
+
+        :param process_file (str): Path to the process configuration file.
+        :param prompts_file (str): Path to the prompt configuration file.
+        """
+
+        process_lexer = Lexer(source=process_file)
+        self._prepare_process(lexed_process=process_lexer)
+
+        prompts_lexer = Lexer(source=prompts_file)
+        self._prepare_prompts(lexed_prompts=prompts_lexer)
+
+    def _prepare_process(self, lexed_process: Lexer) -> None:
+        """
+        Prepare the process file from the lexed result.
+
+        :param lexed_process: Result of lexing the process file.
+        """
+        self._process_file = self._process_lex(lexed_file=lexed_process)
+
+    def _prepare_prompts(self, lexed_prompts: Lexer) -> None:
+        """
+        Prepare the prompts file from the lexed result.
+
+        :param lexed_prompts: Result of lexing the prompts file.
+        """
+        self._prompts_file = self._process_lex(lexed_file=lexed_prompts)
+
+    @staticmethod
+    def _process_lex(lexed_file: Lexer):
+        """
+        Process a lex and return the results.
+
+        :param lexed_file: Result of lexing a file.
+
+        :return: Result of processing the lexed file.
+        """
+        current_section_name: str = "default"
+        section_entries: list[ALL_TOKEN_TYPES,] = []
+        sorted_lex = {}
+        for lexed_line in lexed_file.tokens:
+            if lexed_line[0] == TokenName.SECTION_HEADER:
+                sorted_lex[current_section_name] = section_entries
+                if type(lexed_line[1]) is SectionHeader:
+                    current_section_name = lexed_line[1].name
+                else:
+                    # This should never be reached, this is here to satisfy typing.
+                    current_section_name = "UNKNOWN"
+                section_entries = []
+                continue
+            section_entries.append(lexed_line[1])
+        sorted_lex[current_section_name] = section_entries
+        return sorted_lex
+
+    @property
+    def process_file(self):
+        """
+        Returns the parsed process configuration.
+
+        :return: ConfigParser object containing the process file.
+        """
+        return self._process_file
+
+    @property
+    def prompts_file(self):
+        """
+        Returns the parsed prompts file.
+
+        :return: ConfigParser object containing the prompt file.
+        """
+        return self._prompts_file

tpc_plugin_validator/rule_sets/__init__.py

@@ -0,0 +1 @@
+"""Standard blank __init__ file for the tpc_plugin_validator package."""