cyberark-tpc-plugin-validator 0.2.0__tar.gz

cyberark_tpc_plugin_validator-0.2.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,5 @@
+# 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/cyberark_tpc_plugin_validator.egg-info/PKG-INFO

@@ -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/cyberark_tpc_plugin_validator.egg-info/SOURCES.txt

@@ -0,0 +1,52 @@
+LICENSE
+README.md
+pyproject.toml
+cyberark_tpc_plugin_validator.egg-info/PKG-INFO
+cyberark_tpc_plugin_validator.egg-info/SOURCES.txt
+cyberark_tpc_plugin_validator.egg-info/dependency_links.txt
+cyberark_tpc_plugin_validator.egg-info/entry_points.txt
+cyberark_tpc_plugin_validator.egg-info/top_level.txt
+tests/test_conditions_section_rule_set.py
+tests/test_cpm_parameters_validation_section_rule_set.py
+tests/test_debug_information_section_rule_set.py
+tests/test_lexer.py
+tests/test_parameters_section_rule_set.py
+tests/test_process_file_rule_set.py
+tests/test_prompts_file_rule_set.py
+tests/test_states_section_rule_set.py
+tests/test_transitions_section_rule_set.py
+tpc_plugin_validator/__init__.py
+tpc_plugin_validator/main.py
+tpc_plugin_validator/validator.py
+tpc_plugin_validator/lexer/__init__.py
+tpc_plugin_validator/lexer/lexer.py
+tpc_plugin_validator/lexer/tokens/__init__.py
+tpc_plugin_validator/lexer/tokens/assignment.py
+tpc_plugin_validator/lexer/tokens/comment.py
+tpc_plugin_validator/lexer/tokens/cpm_parameter_validation.py
+tpc_plugin_validator/lexer/tokens/fail_state.py
+tpc_plugin_validator/lexer/tokens/section_header.py
+tpc_plugin_validator/lexer/tokens/transition.py
+tpc_plugin_validator/lexer/utilities/__init__.py
+tpc_plugin_validator/lexer/utilities/regex.py
+tpc_plugin_validator/lexer/utilities/token_name.py
+tpc_plugin_validator/lexer/utilities/types.py
+tpc_plugin_validator/parser/__init__.py
+tpc_plugin_validator/parser/parser.py
+tpc_plugin_validator/rule_sets/__init__.py
+tpc_plugin_validator/rule_sets/conditions_section_rule_set.py
+tpc_plugin_validator/rule_sets/cpm_parameters_validation_section_rule_set.py
+tpc_plugin_validator/rule_sets/debug_information_section_rule_set.py
+tpc_plugin_validator/rule_sets/file_rule_set.py
+tpc_plugin_validator/rule_sets/parameters_section_rule_set.py
+tpc_plugin_validator/rule_sets/process_file_rule_set.py
+tpc_plugin_validator/rule_sets/prompts_file_rule_set.py
+tpc_plugin_validator/rule_sets/rule_set.py
+tpc_plugin_validator/rule_sets/section_rule_set.py
+tpc_plugin_validator/rule_sets/states_section_rule_set.py
+tpc_plugin_validator/rule_sets/transitions_section_rule_set.py
+tpc_plugin_validator/utilities/__init__.py
+tpc_plugin_validator/utilities/exceptions.py
+tpc_plugin_validator/utilities/severity.py
+tpc_plugin_validator/utilities/types.py
+tpc_plugin_validator/utilities/validation_result.py

cyberark_tpc_plugin_validator-0.2.0/cyberark_tpc_plugin_validator.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cyberark_tpc_plugin_validator-0.2.0/cyberark_tpc_plugin_validator.egg-info/entry_points.txt

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

cyberark_tpc_plugin_validator-0.2.0/cyberark_tpc_plugin_validator.egg-info/top_level.txt

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

cyberark_tpc_plugin_validator-0.2.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "cyberark-tpc-plugin-validator"
+version = "0.2.0"
+description = "A tool to help validate a custom TPC plugin."
+authors = [{ name = "Peter McDonald", email = "git@petermcdonald.co.uk"}]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+dependencies = []
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-cov>=6.3.0",
+    "pytest-mypy-plugins>=3.2.0",
+    "ruff>=0.12.12",
+    "troml>=0.4.1",
+    "ty>=0.0.1a20",
+]
+
+[project.scripts]
+tpc-validator = "tpc_plugin_validator.main:main"
+
+[tool.pytest.ini_options]
+addopts = "--cov=tpc_plugin_validator --cov-report term-missing --cov-report xml:coverage.xml"
+
+[tool.ruff]
+line-length = 120

cyberark_tpc_plugin_validator-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cyberark_tpc_plugin_validator-0.2.0/tests/test_conditions_section_rule_set.py

@@ -0,0 +1,80 @@
+"""Tests for the conditions section rule set."""
+
+import pytest
+
+from tpc_plugin_validator.parser.parser import Parser
+from tpc_plugin_validator.rule_sets.conditions_section_rule_set import (
+    ConditionsSectionRuleSet,
+)
+from tpc_plugin_validator.utilities.severity import Severity
+from tpc_plugin_validator.utilities.validation_result import ValidationResult
+
+
+class TestConditionsSectionRuleSet(object):
+    """Tests for the debug information rule set."""
+
+    @pytest.mark.parametrize(
+        "process_file,prompts_file,expected_results",
+        [
+            (
+                "tests/data/valid-process.ini",
+                "tests/data/valid-prompts.ini",
+                [],
+            ),
+            (
+                "tests/data/invalid-process.ini",
+                "tests/data/invalid-prompts.ini",
+                [
+                    ValidationResult(
+                        rule="InvalidTokenTypeViolation",
+                        severity=Severity.WARNING,
+                        message='The token type "Transition" is not valid in this section, file: prompts.ini, section: conditions, line: 18.',
+                    ),
+                    ValidationResult(
+                        rule="DuplicateAssignmentViolation",
+                        severity=Severity.CRITICAL,
+                        message='The assignment "failure" has been declared 2 times, file: prompts.ini, section: conditions.',
+                    ),
+                    ValidationResult(
+                        rule="NameCaseMismatchViolation",
+                        severity=Severity.WARNING,
+                        message='The condition "Hello" is declared but is used as "hello", file: prompts.ini, section: conditions, line: 13.',
+                    ),
+                    ValidationResult(
+                        rule="UnusedConditionViolation",
+                        severity=Severity.WARNING,
+                        message='The condition "Unused" is declared but is not used, file: prompts.ini, section: conditions, line: 19.',
+                    ),
+                ],
+            ),
+        ],
+    )
+    def test_conditions_section_rule_set(
+        self,
+        process_file: str,
+        prompts_file: str,
+        expected_results: list[ValidationResult],
+    ) -> None:
+        """
+        Tests for the conditions section rule set.
+
+        :param process_file: Path to the process file to use for the test case.
+        :param prompts_file: Path to the prompts file to use for the test case.
+        :param expected_results: List of expected ValidationResult
+        """
+        with open(process_file, "r") as process_fh, open(prompts_file, "r") as prompts_fh:
+            process_file_content = process_fh.read()
+            prompts_file_content = prompts_fh.read()
+
+        parser = Parser(process_file=process_file_content, prompts_file=prompts_file_content)
+        parsed_process_file = parser.process_file
+        parsed_prompts_file = parser.prompts_file
+
+        rule = ConditionsSectionRuleSet(prompts_file=parsed_prompts_file, process_file=parsed_process_file, config={})
+        rule.validate()
+        results = rule.get_violations()
+
+        assert len(results) == len(expected_results)
+
+        for result in results:
+            assert result in expected_results

cyberark_tpc_plugin_validator-0.2.0/tests/test_cpm_parameters_validation_section_rule_set.py

@@ -0,0 +1,82 @@
+"""Tests for the CPM Parameters Validation section rule set."""
+
+import pytest
+
+from tpc_plugin_validator.parser.parser import Parser
+from tpc_plugin_validator.rule_sets.cpm_parameters_validation_section_rule_set import (
+    CPMParametersValidationSectionRuleSet,
+)
+from tpc_plugin_validator.utilities.severity import Severity
+from tpc_plugin_validator.utilities.validation_result import ValidationResult
+
+
+class TestCPMParametersValidationSectionRuleSet(object):
+    """Tests for the CPM Parameters Validation section rule set."""
+
+    @pytest.mark.parametrize(
+        "process_file,prompts_file,expected_results",
+        [
+            (
+                "tests/data/valid-process.ini",
+                "tests/data/valid-prompts.ini",
+                [],
+            ),
+            (
+                "tests/data/invalid-process.ini",
+                "tests/data/invalid-prompts.ini",
+                [
+                    ValidationResult(
+                        rule="InvalidTokenTypeViolation",
+                        severity=Severity.WARNING,
+                        message='The token type "Transition" is not valid in this section, file: process.ini, section: CPM Parameters Validation, line: 53.',
+                    ),
+                    ValidationResult(
+                        rule="UnusedParameterViolation",
+                        severity=Severity.WARNING,
+                        message='The parameter "extrapass2\\Username" has been validated but is not used, file: process.ini, section: CPM Parameters Validation, line: 54.',
+                    ),
+                    ValidationResult(
+                        rule="UnusedParameterViolation",
+                        severity=Severity.WARNING,
+                        message='The parameter "extrapass2\\Username" has been validated but is not used, file: process.ini, section: CPM Parameters Validation, line: 56.',
+                    ),
+                    ValidationResult(
+                        rule="DuplicateAssignmentViolation",
+                        severity=Severity.CRITICAL,
+                        message='The assignment "extrapass2\\Username" has been declared 2 times, file: process.ini, section: CPM Parameters Validation.',
+                    ),
+                ],
+            ),
+        ],
+    )
+    def test_cpm_parameters_validation_section_rule_set(
+        self,
+        process_file: str,
+        prompts_file: str,
+        expected_results: list[ValidationResult],
+    ) -> None:
+        """
+        Tests for the CPM Parameters Validation section rule set.
+
+        :param process_file: Path to the process file to use for the test case.
+        :param prompts_file: Path to the prompts file to use for the test case.
+        :param expected_results: List of expected ValidationResult
+        """
+        with open(process_file, "r") as process_fh, open(prompts_file, "r") as prompts_fh:
+            process_file_content = process_fh.read()
+            prompts_file_content = prompts_fh.read()
+
+        parser = Parser(process_file=process_file_content, prompts_file=prompts_file_content)
+        parsed_process_file = parser.process_file
+        parsed_prompts_file = parser.prompts_file
+
+        rule = CPMParametersValidationSectionRuleSet(
+            prompts_file=parsed_prompts_file, process_file=parsed_process_file, config={}
+        )
+        rule.validate()
+        results = rule.get_violations()
+
+        assert len(results) == len(expected_results)
+
+        for result in results:
+            assert result in expected_results

cyberark_tpc_plugin_validator-0.2.0/tests/test_debug_information_section_rule_set.py

@@ -0,0 +1,117 @@
+"""Tests for the debug information section rule set."""
+
+import pytest
+
+from tpc_plugin_validator.parser.parser import Parser
+from tpc_plugin_validator.rule_sets.debug_information_section_rule_set import (
+    DebugInformationSectionRuleSet,
+)
+from tpc_plugin_validator.utilities.severity import Severity
+from tpc_plugin_validator.utilities.validation_result import ValidationResult
+
+
+class TestDebugInformationSectionRuleSet(object):
+    """Tests for the debug information section rule set."""
+
+    @pytest.mark.parametrize(
+        "process_file,prompts_file,expected_results",
+        [
+            (
+                "tests/data/valid-process.ini",
+                "tests/data/valid-prompts.ini",
+                [],
+            ),
+            (
+                "tests/data/invalid-process.ini",
+                "tests/data/invalid-prompts.ini",
+                [
+                    ValidationResult(
+                        rule="InvalidTokenTypeViolation",
+                        severity=Severity.WARNING,
+                        message='The token type "Transition" is not valid in this section, file: process.ini, section: Debug Information, line: 73.',
+                    ),
+                    ValidationResult(
+                        rule="ValueCaseViolation",
+                        severity=Severity.WARNING,
+                        message='The value for "DebugLogFullExecutionInfo" is set to "No" this should be in lower case, file: process.ini, section: Debug Information, line: 75.',
+                    ),
+                    ValidationResult(
+                        rule="NameViolation",
+                        severity=Severity.WARNING,
+                        message='The setting "InvalidName" is not a valid setting. Valid settings are: DebugLogFullParsingInfo, DebugLogFullExecutionInfo, DebugLogDetailBuiltInActions, ExpectLog, ConsoleOutput, file: process.ini, section: Debug Information, line: 79.',
+                    ),
+                    ValidationResult(
+                        rule="NameCaseViolation",
+                        severity=Severity.WARNING,
+                        message='The setting "COnsoleOutput" should be set as "ConsoleOutput", file: process.ini, section: Debug Information, line: 78.',
+                    ),
+                    ValidationResult(
+                        rule="NameCaseViolation",
+                        severity=Severity.WARNING,
+                        message='The setting "COnsoleOutput" should be set as "ConsoleOutput", file: process.ini, section: Debug Information, line: 80.',
+                    ),
+                    ValidationResult(
+                        rule="ValueCaseViolation",
+                        severity=Severity.WARNING,
+                        message='The value for "COnsoleOutput" is set to "No" this should be in lower case, file: process.ini, section: Debug Information, line: 78.',
+                    ),
+                    ValidationResult(
+                        rule="ValueCaseViolation",
+                        severity=Severity.WARNING,
+                        message='The value for "COnsoleOutput" is set to "No" this should be in lower case, file: process.ini, section: Debug Information, line: 80.',
+                    ),
+                    ValidationResult(
+                        rule="ValueViolation",
+                        severity=Severity.CRITICAL,
+                        message='The value for "DebugLogDetailBuiltInActions" is set to "maybe" and is invalid. Valid values are "no" and "yes", file: process.ini, section: Debug Information, line: 76.',
+                    ),
+                    ValidationResult(
+                        rule="ValueViolation",
+                        severity=Severity.WARNING,
+                        message='The value for "DebugLogFullParsingInfo" is blank. Setting should be explicitly set to "no", file: process.ini, section: Debug Information, line: 74.',
+                    ),
+                    ValidationResult(
+                        rule="LoggingEnabledViolation",
+                        severity=Severity.CRITICAL,
+                        message='The value for "ExpectLog" is set to "yes". It is recommended to set all settings in this section to "no" for production environments, file: process.ini, section: Debug Information, line: 77.',
+                    ),
+                    ValidationResult(
+                        rule="DuplicateAssignmentViolation",
+                        severity=Severity.CRITICAL,
+                        message='The assignment "COnsoleOutput" has been declared 2 times, file: process.ini, section: Debug Information.',
+                    ),
+                ],
+            ),
+        ],
+    )
+    def test_debug_information_logging_section_rule_set(
+        self,
+        process_file: str,
+        prompts_file: str,
+        expected_results: list[ValidationResult],
+    ) -> None:
+        """
+        Tests for the debug information section rule set.
+
+        :param process_file: Path to the process file to use for the test case.
+        :param prompts_file: Path to the prompts file to use for the test case.
+        :param expected_results: List of expected ValidationResult
+        """
+        with open(process_file, "r") as process_fh, open(prompts_file, "r") as prompts_fh:
+            process_file_content = process_fh.read()
+            prompts_file_content = prompts_fh.read()
+
+        parser = Parser(process_file=process_file_content, prompts_file=prompts_file_content)
+        parsed_process_file = parser.process_file
+        parsed_prompts_file = parser.prompts_file
+
+        rule = DebugInformationSectionRuleSet(
+            prompts_file=parsed_prompts_file, process_file=parsed_process_file, config={}
+        )
+        rule.validate()
+        results = rule.get_violations()
+
+        assert len(results) == len(expected_results)
+
+        for result in results:
+            assert result in expected_results