nac-test 0.3.0a0__py3-none-any.whl

nac_test/__init__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Daniel Schmidt <danischm@cisco.com>
+
+from importlib.metadata import version  # type: ignore
+
+__version__ = version(__name__)

nac_test/__main__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Daniel Schmidt <danischm@cisco.com>
+
+import nac_test.cli.main
+
+if __name__ == "__main__":
+    nac_test.cli.main.app()

nac_test/cli/main.py

@@ -0,0 +1,224 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Daniel Schmidt <danischm@cisco.com>
+
+import logging
+import sys
+
+import errorhandler
+
+import typer
+from typing_extensions import Annotated
+from enum import Enum
+
+from pathlib import Path
+
+import nac_test.pabot
+import nac_test.robot_writer
+
+
+app = typer.Typer(add_completion=False)
+
+logger = logging.getLogger(__name__)
+
+error_handler = errorhandler.ErrorHandler()
+
+
+def configure_logging(level: str) -> None:
+    if level == "DEBUG":
+        lev = logging.DEBUG
+    elif level == "INFO":
+        lev = logging.INFO
+    elif level == "WARNING":
+        lev = logging.WARNING
+    elif level == "ERROR":
+        lev = logging.ERROR
+    else:
+        lev = logging.CRITICAL
+    logger = logging.getLogger()
+    handler = logging.StreamHandler(sys.stdout)
+    handler.setFormatter(logging.Formatter("%(levelname)s - %(message)s"))
+    logger.addHandler(handler)
+    logger.setLevel(lev)
+    error_handler.reset()
+
+
+class VerbosityLevel(str, Enum):
+    debug = "DEBUG"
+    info = "INFO"
+    warning = "WARNING"
+    error = "ERROR"
+    critical = "CRITICAL"
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        print(f"nac-test, version {nac_test.__version__}")
+        raise typer.Exit()
+
+
+Verbosity = Annotated[
+    VerbosityLevel,
+    typer.Option(
+        "-v",
+        "--verbosity",
+        help="Verbosity level.",
+        envvar="NAC_VALIDATE_VERBOSITY",
+        is_eager=True,
+    ),
+]
+
+
+Data = Annotated[
+    list[Path],
+    typer.Option(
+        "-d",
+        "--data",
+        exists=True,
+        dir_okay=True,
+        file_okay=True,
+        help="Path to data YAML files.",
+        envvar="NAC_TEST_DATA",
+    ),
+]
+
+
+Templates = Annotated[
+    Path,
+    typer.Option(
+        "-t",
+        "--templates",
+        exists=True,
+        dir_okay=True,
+        file_okay=False,
+        help="Path to test templates.",
+        envvar="NAC_TEST_TEMPLATES",
+    ),
+]
+
+
+Filters = Annotated[
+    Path | None,
+    typer.Option(
+        "-f",
+        "--filters",
+        exists=True,
+        dir_okay=True,
+        file_okay=False,
+        help="Path to Jinja filters.",
+        envvar="NAC_TEST_FILTERS",
+    ),
+]
+
+
+Tests = Annotated[
+    Path | None,
+    typer.Option(
+        "--tests",
+        exists=True,
+        dir_okay=True,
+        file_okay=False,
+        help="Path to Jinja tests.",
+        envvar="NAC_TEST_TESTS",
+    ),
+]
+
+
+Output = Annotated[
+    Path,
+    typer.Option(
+        "-o",
+        "--output",
+        exists=False,
+        dir_okay=True,
+        file_okay=False,
+        help="Path to output directory.",
+        envvar="NAC_TEST_OUTPUT",
+    ),
+]
+
+
+Include = Annotated[
+    list[str],
+    typer.Option(
+        "-i",
+        "--include",
+        help="Selects the test cases by tag (include).",
+        envvar="NAC_TEST_INCLUDE",
+    ),
+]
+
+
+Exclude = Annotated[
+    list[str],
+    typer.Option(
+        "-e",
+        "--exclude",
+        help="Selects the test cases by tag (exclude).",
+        envvar="NAC_TEST_EXCLUDE",
+    ),
+]
+
+
+RenderOnly = Annotated[
+    bool,
+    typer.Option(
+        "--render-only",
+        help="Only render tests without executing them.",
+        envvar="NAC_TEST_RENDER_ONLY",
+    ),
+]
+
+
+DryRun = Annotated[
+    bool,
+    typer.Option(
+        "--dry-run",
+        help="Dry run flag. See robot dry run mode.",
+        envvar="NAC_TEST_DRY_RUN",
+    ),
+]
+
+
+Version = Annotated[
+    bool,
+    typer.Option(
+        "--version",
+        callback=version_callback,
+        help="Display version number.",
+        is_eager=True,
+    ),
+]
+
+
+@app.command()
+def main(
+    data: Data,
+    templates: Templates,
+    output: Output,
+    filters: Filters = None,
+    tests: Tests = None,
+    include: Include = [],
+    exclude: Exclude = [],
+    render_only: RenderOnly = False,
+    dry_run: DryRun = False,
+    verbosity: Verbosity = VerbosityLevel.warning,
+    version: Version = False,
+) -> None:
+    """A CLI tool to render and execute Robot Framework tests using Jinja templating."""
+    configure_logging(verbosity)
+
+    writer = nac_test.robot_writer.RobotWriter(data, filters, tests, include, exclude)
+    writer.write(templates, output)
+    if not render_only:
+        nac_test.pabot.run_pabot(
+            output, include, exclude, dry_run, verbosity == VerbosityLevel.debug
+        )
+    exit()
+
+
+def exit() -> None:
+    if error_handler.fired:
+        raise typer.Exit(1)
+    else:
+        raise typer.Exit(0)

nac_test/pabot.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Daniel Schmidt <danischm@cisco.com>
+
+from pathlib import Path
+
+import pabot.pabot
+
+
+def run_pabot(
+    path: Path,
+    include: list[str] = [],
+    exclude: list[str] = [],
+    dry_run: bool = False,
+    verbose: bool = False,
+) -> None:
+    """Run pabot"""
+    args = ["--pabotlib", "--pabotlibport", "0"]
+    if verbose:
+        args.append("--verbose")
+    if dry_run:
+        args.append("--dryrun")
+    for i in include:
+        args.extend(["--include", i])
+    for e in exclude:
+        args.extend(["--exclude", e])
+    args.extend(
+        [
+            "-d",
+            str(path),
+            "--skiponfailure",
+            "non-critical",
+            "-x",
+            "xunit.xml",
+            str(path),
+        ]
+    )
+    pabot.pabot.main(args)

nac_test/robot_writer.py

@@ -0,0 +1,191 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Daniel Schmidt <danischm@cisco.com>
+
+import importlib.util
+import json
+import logging
+import os
+import pathlib
+import re
+import shutil
+import sys
+from typing import Any
+
+from jinja2 import ChainableUndefined, Environment, FileSystemLoader  # type: ignore
+from pathlib import Path
+
+from nac_yaml import yaml
+
+logger = logging.getLogger(__name__)
+
+
+class RobotWriter:
+    def __init__(
+        self,
+        data_paths: list[Path],
+        filters_path: Path | None,
+        tests_path: Path | None,
+        include_tags: list[str] = [],
+        exclude_tags: list[str] = [],
+    ) -> None:
+        logger.info("Loading yaml files from %s", data_paths)
+        self.data = yaml.load_yaml_files(data_paths)
+        self.filters: dict[str, Any] = {}
+        self.include_tags = include_tags
+        self.exclude_tags = exclude_tags
+        if filters_path:
+            logger.info("Loading filters")
+            for filename in os.listdir(filters_path):
+                if Path(filename).suffix == ".py":
+                    file_path = Path(filters_path, filename)
+                    spec = importlib.util.spec_from_file_location(
+                        "nac_test.filters", file_path
+                    )
+                    if spec is not None:
+                        mod = importlib.util.module_from_spec(spec)
+                        sys.modules["nac_test.filters"] = mod
+                        if spec.loader is not None:
+                            spec.loader.exec_module(mod)
+                            self.filters[mod.Filter.name] = mod.Filter
+        self.tests: dict[str, Any] = {}
+        if tests_path:
+            logger.info("Loading tests")
+            for filename in os.listdir(tests_path):
+                if Path(filename).suffix == ".py":
+                    file_path = Path(tests_path, filename)
+                    spec = importlib.util.spec_from_file_location(
+                        "nac_test.tests", file_path
+                    )
+                    if spec is not None:
+                        mod = importlib.util.module_from_spec(spec)
+                        sys.modules["nac_test.tests"] = mod
+                        if spec.loader is not None:
+                            spec.loader.exec_module(mod)
+                            self.tests[mod.Test.name] = mod.Test
+
+    def render_template(
+        self, template_path: Path, output_path: Path, env: Environment, **kwargs: Any
+    ) -> None:
+        """Render single robot jinja template"""
+        logger.info("Render robot template: %s", template_path)
+        # add robot tags to kwargs
+        kwargs["robot_include_tags"] = self.include_tags
+        kwargs["robot_exclude_tags"] = self.exclude_tags
+        # create output directory if it does not exist yet
+        pathlib.Path(os.path.dirname(output_path)).mkdir(parents=True, exist_ok=True)
+
+        template = env.get_template(str(template_path))
+        # hack to convert nested ordereddict to dict, to avoid duplicate dict keys, e.g. 'tag'
+        # json roundtrip should be safe as everything should be serializable
+        data = json.loads(json.dumps(self.data))
+        result = template.render(data, **kwargs)
+
+        # remove extra empty lines
+        lines = result.splitlines()
+        cleaned_lines = []
+        for index, line in enumerate(lines):
+            if len(line.strip()):
+                cleaned_lines.append(line)
+            else:
+                if index + 1 < len(lines):
+                    next_line = lines[index + 1]
+                    if len(next_line) and not next_line[0].isspace():
+                        cleaned_lines.append(line)
+        result = os.linesep.join(cleaned_lines)
+
+        with open(output_path, "w") as file:
+            file.write(result)
+
+    def _fix_duplicate_path(self, *paths: str) -> Path:
+        """Helper function to detect existing paths with non-matching case. Returns a unique path to work with case-insensitve filesystems."""
+        directory = os.path.join(*paths[:-1])
+        if os.path.exists(directory):
+            entries = os.listdir(directory)
+            lower_case_entries = [path.lower() for path in entries]
+            if paths[-1].lower() in lower_case_entries and paths[-1] not in entries:
+                return Path(*paths[:-1], "_" + paths[-1])
+        return Path(os.path.join(*paths))
+
+    def write(self, templates_path: Path, output_path: Path) -> None:
+        """Render Robot test suites."""
+        env = Environment(
+            loader=FileSystemLoader(templates_path),
+            undefined=ChainableUndefined,
+            lstrip_blocks=True,
+            trim_blocks=True,
+        )
+        for name, filter in self.filters.items():
+            env.filters[name] = filter.filter
+        for name, test in self.tests.items():
+            env.tests[name] = test.test
+
+        for dir, _, files in os.walk(templates_path):
+            for filename in files:
+                if Path(filename).suffix not in [".robot", ".resource", ".j2"]:
+                    logger.info(
+                        "Skip file with unknown file extension (not one of .robot, .resource or .j2): %s",
+                        Path(dir, filename),
+                    )
+                    out = Path(output_path, os.path.relpath(dir, templates_path))
+                    pathlib.Path(out).mkdir(parents=True, exist_ok=True)
+                    shutil.copy(Path(dir, filename), out)
+                    continue
+                rel = os.path.relpath(dir, templates_path)
+                t_path = Path(rel, filename)
+
+                # search for directives
+                pattern = re.compile("{#(.+?)#}")
+                content = ""
+                next_template = False
+                try:
+                    with open(Path(dir, filename), "r") as file:
+                        content = file.read()
+                except:  # noqa: E722
+                    logger.warning("Could not open/read file: %s", Path(dir, filename))
+                    continue
+                for match in re.finditer(pattern, content):
+                    params = match.group().split(" ")
+                    if len(params) == 6 and params[1] in [
+                        "iterate_list",
+                        "iterate_list_folder",
+                    ]:
+                        next_template = True
+                        path = params[2].split(".")
+                        attr = params[3]
+                        elem = self.data
+                        for p in path:
+                            elem = elem.get(p, {})
+                        if not isinstance(elem, list):
+                            continue
+                        for item in elem:
+                            value = str(item.get(attr))
+                            if value is None:
+                                continue
+                            extra: dict[str, Any] = {}
+                            if "[" in params[4]:
+                                index = params[4].split("[")[1].split("]")[0]
+                                extra_list: list[Any] = [None] * (int(index) + 1)
+                                extra_list[int(index)] = value
+                                extra = {params[4].split("[")[0]: extra_list}
+                            else:
+                                extra = {params[4]: value}
+                            if params[1] == "iterate_list":
+                                o_dir = self._fix_duplicate_path(
+                                    str(output_path), rel, value
+                                )
+                                o_path = Path(o_dir, filename)
+                            else:
+                                foldername = os.path.splitext(filename)[0]
+                                new_filename = (
+                                    value + "." + os.path.splitext(filename)[1][1:]
+                                )
+                                o_path = self._fix_duplicate_path(
+                                    str(output_path), rel, foldername, new_filename
+                                )
+                            self.render_template(t_path, Path(o_path), env, **extra)
+                if next_template:
+                    continue
+
+                o_path = Path(output_path, rel, filename)
+                self.render_template(t_path, o_path, env)

nac_test-0.3.0a0.dist-info/LICENSE

@@ -0,0 +1,385 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+
+* *
+* 6. Disclaimer of Warranty                                           *
+* -------------------------                                           *
+* *
+* Covered Software is provided under this License on an "as is"       *
+* basis, without warranty of any kind, either expressed, implied, or  *
+* statutory, including, without limitation, warranties that the       *
+* Covered Software is free of defects, merchantable, fit for a        *
+* particular purpose or non-infringing. The entire risk as to the     *
+* quality and performance of the Covered Software is with You.        *
+* Should any Covered Software prove defective in any respect, You     *
+* (not any Contributor) assume the cost of any necessary servicing,   *
+* repair, or correction. This disclaimer of warranty constitutes an   *
+* essential part of this License. No use of any Covered Software is   *
+* authorized under this License except under this disclaimer.         *
+* *
+
+************************************************************************
+
+************************************************************************
+
+* *
+* 7. Limitation of Liability                                          *
+* --------------------------                                          *
+* *
+* Under no circumstances and under no legal theory, whether tort      *
+* (including negligence), contract, or otherwise, shall any           *
+* Contributor, or anyone who distributes Covered Software as          *
+* permitted above, be liable to You for any direct, indirect,         *
+* special, incidental, or consequential damages of any character      *
+* including, without limitation, damages for lost profits, loss of    *
+* goodwill, work stoppage, computer failure or malfunction, or any    *
+* and all other commercial damages or losses, even if such party      *
+* shall have been informed of the possibility of such damages. This   *
+* limitation of liability shall not apply to liability for death or   *
+* personal injury resulting from such party's negligence to the       *
+* extent applicable law prohibits such limitation. Some               *
+* jurisdictions do not allow the exclusion or limitation of           *
+* incidental or consequential damages, so this exclusion and          *
+* limitation may not apply to You.                                    *
+* *
+
+************************************************************************
+
+8. Litigation
+
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at <http://mozilla.org/MPL/2.0/>.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

nac_test-0.3.0a0.dist-info/METADATA

@@ -0,0 +1,250 @@
+Metadata-Version: 2.3
+Name: nac-test
+Version: 0.3.0a0
+Summary: A CLI tool to render and execute Robot Framework tests using Jinja templating.
+License: LICENSE
+Author: Daniel Schmidt
+Author-email: danischm@cisco.com
+Maintainer: Daniel Schmidt
+Maintainer-email: danischm@cisco.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: Jinja2 (>=3.1,<4.0)
+Requires-Dist: RESTinstance (>=1.5,<2.0)
+Requires-Dist: errorhandler (>=2.0,<3.0)
+Requires-Dist: jmespath (>=1.0,<2.0)
+Requires-Dist: nac-yaml (>=0.1.2)
+Requires-Dist: robotframework (>=7.2,<8.0)
+Requires-Dist: robotframework-jsonlibrary (>=0.5,<1.0)
+Requires-Dist: robotframework-pabot (>=4.1,<5.0)
+Requires-Dist: robotframework-requests (>=0.9,<1.0)
+Requires-Dist: ruamel-yaml (>=0.16,<1.0)
+Requires-Dist: typer (>=0.15,<1.0)
+Project-URL: Documentation, https://github.com/netascode/nac-test
+Project-URL: Homepage, https://github.com/netascode/nac-test
+Project-URL: Repository, https://github.com/netascode/nac-test
+Description-Content-Type: text/markdown
+
+[![Tests](https://github.com/netascode/nac-test/actions/workflows/test.yml/badge.svg)](https://github.com/netascode/nac-test/actions/workflows/test.yml)
+![Python Support](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-informational "Python Support: 3.10, 3.11, 3.12, 3.13")
+
+# nac-test
+
+A CLI tool to render and execute [Robot Framework](https://robotframework.org/) tests using [Jinja](https://jinja.palletsprojects.com/) templating. Combining Robot's language agnostic syntax with the flexibility of Jinja templating allows dynamically rendering a set of test suites from the desired infrastructure state expressed in YAML syntax.
+
+```shell
+$ nac-test -h
+
+ Usage: nac-test [OPTIONS]                                                                                                                                    
+                                                                                                                                                              
+ A CLI tool to render and execute Robot Framework tests using Jinja templating.                                                                               
+                                                                                                                                                              
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ *  --data         -d      PATH                                 Path to data YAML files. [env var: NAC_TEST_DATA] [default: None] [required]                │
+│ *  --templates    -t      DIRECTORY                            Path to test templates. [env var: NAC_TEST_TEMPLATES] [default: None] [required]            │
+│ *  --output       -o      DIRECTORY                            Path to output directory. [env var: NAC_TEST_OUTPUT] [default: None] [required]             │
+│    --filters      -f      DIRECTORY                            Path to Jinja filters. [env var: NAC_TEST_FILTERS] [default: None]                          │
+│    --tests                DIRECTORY                            Path to Jinja tests. [env var: NAC_TEST_TESTS] [default: None]                              │
+│    --include      -i      TEXT                                 Selects the test cases by tag (include). [env var: NAC_TEST_INCLUDE]                        │
+│    --exclude      -e      TEXT                                 Selects the test cases by tag (exclude). [env var: NAC_TEST_EXCLUDE]                        │
+│    --render-only                                               Only render tests without executing them. [env var: NAC_TEST_RENDER_ONLY]                   │
+│    --dry-run                                                   Dry run flag. See robot dry run mode. [env var: NAC_TEST_DRY_RUN]                           │
+│    --verbosity    -v      [DEBUG|INFO|WARNING|ERROR|CRITICAL]  Verbosity level. [env var: NAC_VALIDATE_VERBOSITY] [default: WARNING]                       │
+│    --version                                                   Display version number.                                                                     │
+│    --help                                                      Show this message and exit.                                                                 │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+All data from the YAML files (`--data` option) will first be combined into a single data structure which is then provided as input to the templating process. Each template in the `--templates` path will then be rendered and written to the `--output` path. If the `--templates` path has subfolders, the folder structure will be retained when rendering the templates.
+
+After all templates have been rendered [Pabot](https://pabot.org/) will execute all test suites in parallel and create a test report in the `--output` path. The `--skiponfailure non-critical` argument will be used by default, meaning all failed tests with a `non-critical` tag will show up as "skipped" instead of "failed" in the final test report.
+
+## Installation
+
+Python 3.10+ is required to install `nac-test`. Don't have Python 3.10 or later? See [Python 3 Installation & Setup Guide](https://realpython.com/installing-python/).
+
+`nac-test` can be installed in a virtual environment using `pip`:
+
+```shell
+pip install nac-test
+```
+
+The following Robot libraries are installed with `nac-test`:
+
+- [RESTinstance](https://github.com/asyrjasalo/RESTinstance)
+- [Requests](https://github.com/MarketSquare/robotframework-requests)
+- [JSONLibrary](https://github.com/robotframework-thailand/robotframework-jsonlibrary)
+
+Any other libraries can of course be added via `pip`.
+
+## Ansible Vault Support
+
+Values in YAML files can be encrypted using [Ansible Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html). This requires Ansible (`ansible-vault` command) to be installed and the following two environment variables to be defined:
+
+```
+export ANSIBLE_VAULT_ID=dev
+export ANSIBLE_VAULT_PASSWORD=Password123
+```
+
+`ANSIBLE_VAULT_ID` is optional, and if not defined will be omitted.
+
+## Additional Tags
+
+### Reading Environment Variables
+
+The `!env` YAML tag can be used to read values from environment variables.
+
+```yaml
+root:
+  name: !env VAR_NAME
+```
+
+## Example
+
+`data.yaml` located in `./data` folder:
+
+```yaml
+---
+root:
+  children:
+    - name: ABC
+      param: value
+    - name: DEF
+      param: value
+```
+
+`test1.robot` located in `./templates` folder:
+
+```
+*** Settings ***
+Documentation   Test1
+
+*** Test Cases ***
+{% for child in root.children | default([]) %}
+
+Test {{ child.name }}
+    Should Be Equal   {{ child.param }}   value
+{% endfor %}
+```
+
+After running `nac-test` with the following parameters:
+
+```shell
+nac-test --data ./data --templates ./templates --output ./tests
+```
+
+The following rendered Robot test suite can be found in the `./tests` folder:
+
+```
+*** Settings ***
+Documentation   Test1
+
+*** Test Cases ***
+
+Test ABC
+    Should Be Equal   value   value
+
+Test DEF
+    Should Be Equal   value   value
+```
+
+As well as the test results and reports:
+
+```shell
+$ tree -L 1 tests
+tests
+├── log.html
+├── output.xml
+├── pabot_results
+├── report.html
+├── test1.robot
+└── xunit.xml
+```
+
+## Custom Jinja Filters
+
+Custom Jinja filters can be used by providing a set of Python classes where each filter is implemented as a separate `Filter` class in a `.py` file located in the `--filters` path. The class must have a single attribute named `name`, the filter name, and a `classmethod()` named `filter` which has one or more arguments. A sample filter can be found below.
+
+```python
+class Filter:
+    name = "filter1"
+
+    @classmethod
+    def filter(cls, data):
+        return str(data) + "_filtered"
+```
+
+## Custom Jinja Tests
+
+Custom Jinja tests can be used by providing a set of Python classes where each test is implemented as a separate `Test` class in a `.py` file located in the `--tests` path. The class must have a single attribute named `name`, the test name, and a `classmethod()` named `test` which has one or more arguments. A sample test can be found below.
+
+```python
+class Test:
+    name = "test1"
+
+    @classmethod
+    def test(cls, data1, data2):
+        return data1 == data2
+```
+
+## Rendering Directives
+
+Special rendering directives exist to render a single test suite per (YAML) list item. The directive can be added to the Robot template as a Jinja comment following this syntax:
+
+```
+{# iterate_list <YAML_PATH_TO_LIST> <LIST_ITEM_ID> <JINJA_VARIABLE_NAME> #}
+```
+
+After running `nac-test` with the data from the previous [example](#example) and the following template:
+
+```
+{# iterate_list root.children name child_name #}
+*** Settings ***
+Documentation   Test1
+
+*** Test Cases ***
+{% for child in root.children | default([]) %}
+{% if child.name == child_name %}
+
+Test {{ child.name }}
+    Should Be Equal   {{ child.param }}   value
+{% endif %}
+{% endfor %}
+```
+
+The following test suites will be rendered:
+
+```shell
+$ tree -L 2 tests
+tests
+├── ABC
+│   └── test1.robot
+└── DEF
+    └── test1.robot
+```
+
+A similar directive exists to put the test suites in a common folder though with a unique filename.
+
+```
+{# iterate_list_folder <YAML_PATH_TO_LIST> <LIST_ITEM_ID> <JINJA_VARIABLE_NAME> #}
+```
+
+The following test suites will be rendered:
+
+```shell
+$ tree -L 2 tests
+tests
+└── test1
+    ├── ABC.robot
+    └── DEF.robot
+```
+
+## Select Test Cases By Tag
+
+It is possible to include and exclude test cases by tag names with the `--include` and `--exclude` CLI options. These options are directly passed to the Pabot/Robot executor and are documented [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#by-tag-names).
+

nac_test-0.3.0a0.dist-info/RECORD

@@ -0,0 +1,11 @@
+nac_test/__init__.py,sha256=cSkdnIbb8C7D00CmEW21Mb1bQaM_0KoMBXw86eAlN74,173
+nac_test/__main__.py,sha256=eMQdtzk6p-z59sXDzlcQq7VEWGXwh4AsDgWR_oarIrM,166
+nac_test/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nac_test/cli/main.py,sha256=YioTFolBesJgfoOUbKcGoXEcGVxY-JdJIRP30icBWbk,4431
+nac_test/pabot.py,sha256=p-V5ETUG6kOt_xWOXMyfG9hyXH6taqnGKyWvSsexZm0,808
+nac_test/robot_writer.py,sha256=gpu4w8QzUxkYSugRfwW6yhEX3YJ6RNwlQRpZBUYLpm8,8369
+nac_test-0.3.0a0.dist-info/LICENSE,sha256=zt2sx-c0iEk6-OO0iqRQ4l6fIGazRKW_qLMqfDpLm6M,16295
+nac_test-0.3.0a0.dist-info/METADATA,sha256=ko74znxx0HIimxOpky_UxZciQiwUY-nWsgcGmU_Cmp4,10972
+nac_test-0.3.0a0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+nac_test-0.3.0a0.dist-info/entry_points.txt,sha256=WFwenG8Bd4xTHOwQOyNCBtHuoxTMq0ZSbtvNFoXNRhM,81
+nac_test-0.3.0a0.dist-info/RECORD,,

nac_test-0.3.0a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.2
+Root-Is-Purelib: true
+Tag: py3-none-any

nac_test-0.3.0a0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+iac-test=nac_test.cli.main:app
+nac-test=nac_test.cli.main:app
+