test_plugin.py

def test_help_message(pytester):
    """Make sure that the plugin is loaded by capturing an option it adds in the help message."""
    result = pytester.runpytest("--help")
    result.stdout.fnmatch_lines(["*Infrahub configuration file for the repository*"])


def test_without_config(pytester):
    """Make sure 0 tests run when test file is not found."""
    result = pytester.runpytest()
    result.assert_outcomes()


def test_emptyconfig(pytester):
    """Make sure that the plugin load the test file properly."""
    pytester.makefile(
        ".yml",
        test_empty="""
        ---
        version: "1.0"
        infrahub_tests: []
    """,
    )

    result = pytester.runpytest()
    result.assert_outcomes()


def test_jinja2_transform_config_missing_directory(pytester):
    """Make sure tests raise errors if directories are not found."""
    pytester.makefile(
        ".yml",
        test_jinja2_transform="""
        ---
        version: "1.0"
        infrahub_tests:
          - resource: "Jinja2Transform"
            resource_name: "bgp_config"
            tests:
              - name: "base"
                expect: PASS
                spec:
                  kind: "jinja2-transform-unit-render"
                  directory: bgp_config/base
    """,
    )
    pytester.makefile(
        ".yml",
        infrahub_config="""
        ---
        schemas:
          - schemas/demo_edge_fabric.yml

        jinja2_transforms:
          - name: bgp_config
            description: "Template for BGP config base"
            query: "bgp_sessions"
            template_path: "templates/bgp_config.j2"

    """,
    )

    result = pytester.runpytest("--infrahub-repo-config=infrahub_config.yml")
    result.assert_outcomes(errors=1)


def test_jinja2_transform_config_missing_input(pytester):
    """Make sure tests raise errors if no inputs are provided."""
    pytester.makefile(
        ".yml",
        test_jinja2_transform="""
        ---
        version: "1.0"
        infrahub_tests:
          - resource: "Jinja2Transform"
            resource_name: "bgp_config"
            tests:
              - name: "base"
                expect: PASS
                spec:
                  kind: "jinja2-transform-unit-render"
                  directory: bgp_config/base
    """,
    )
    pytester.makefile(
        ".yml",
        infrahub_config="""
        ---
        schemas:
          - schemas/demo_edge_fabric.yml

        jinja2_transforms:
          - name: bgp_config
            description: "Template for BGP config base"
            query: "bgp_sessions"
            template_path: "templates/bgp_config.j2"

    """,
    )

    pytester.mkdir("bgp_config")
    pytester.mkdir("bgp_config/base")

    result = pytester.runpytest("--infrahub-repo-config=infrahub_config.yml")
    result.assert_outcomes(errors=1)


def test_jinja2_transform_no_expected_output(pytester):
    """Make sure tests succeed if no expect outputs are provided."""
    pytester.makefile(
        ".yml",
        test_jinja2_transform="""
        ---
        version: "1.0"
        infrahub_tests:
          - resource: "Jinja2Transform"
            resource_name: "bgp_config"
            tests:
              - name: "base"
                expect: PASS
                spec:
                  kind: "jinja2-transform-unit-render"
                  directory: bgp_config/base
    """,
    )
    pytester.makefile(
        ".yml",
        infrahub_config="""
        ---
        schemas:
          - schemas/demo_edge_fabric.yml

        jinja2_transforms:
          - name: bgp_config
            description: "Template for BGP config base"
            query: "bgp_sessions"
            template_path: "templates/bgp_config.j2"

    """,
    )

    pytester.mkdir("bgp_config")
    test_dir = pytester.mkdir("bgp_config/base")
    test_input = pytester.makefile(".json", input='{"data": {}}')
    pytester.run("mv", test_input, test_dir)

    template_dir = pytester.mkdir("templates")
    template = pytester.makefile(
        ".j2",
        bgp_config="""
    protocols {
        bgp {
            log-up-down;
            bgp-error-tolerance;
        }
    }
    """,
    )
    pytester.run("mv", template, template_dir)

    result = pytester.runpytest("--infrahub-repo-config=infrahub_config.yml")
    result.assert_outcomes(passed=1)


def test_jinja2_transform_unexpected_output(pytester):
    """Make sure tests fail if the expected and computed outputs don't match."""
    pytester.makefile(
        ".yml",
        test_jinja2_transform="""
        ---
        version: "1.0"
        infrahub_tests:
          - resource: "Jinja2Transform"
            resource_name: "bgp_config"
            tests:
              - name: "base"
                expect: PASS
                spec:
                  kind: "jinja2-transform-unit-render"
                  directory: bgp_config/base
    """,
    )
    pytester.makefile(
        ".yml",
        infrahub_config="""
        ---
        schemas:
          - schemas/demo_edge_fabric.yml

        jinja2_transforms:
          - name: bgp_config
            description: "Template for BGP config base"
            query: "bgp_sessions"
            template_path: "templates/bgp_config.j2"

    """,
    )

    pytester.mkdir("bgp_config")
    test_dir = pytester.mkdir("bgp_config/base")
    test_input = pytester.makefile(".json", input='{"data": {}}')
    test_output = pytester.makefile(
        ".txt",
        output="""
    protocols {
        bgp {
            group ipv4-ibgp {
                peer-as 64545;
            }
            log-up-down;
            bgp-error-tolerance;
        }
    }
    """,
    )
    pytester.run("mv", test_input, test_dir)
    pytester.run("mv", test_output, test_dir)

    template_dir = pytester.mkdir("templates")
    template = pytester.makefile(
        ".j2",
        bgp_config="""
    protocols {
        bgp {
            log-up-down;
            bgp-error-tolerance;
        }
    }
    """,
    )
    pytester.run("mv", template, template_dir)

    result = pytester.runpytest("--infrahub-repo-config=infrahub_config.yml")
    result.assert_outcomes(failed=1)


def test_python_transform(pytester):
    pytester.makefile(
        ".yml",
        test_python_transform="""
        ---
        version: "1.0"
        infrahub_tests:
          - resource: "PythonTransform"
            resource_name: "device_config"
            tests:
              - name: "base_config"
                expect: PASS
                spec:
                  kind: "python-transform-unit-process"
                  directory: device_config/base_config
    """,
    )
    pytester.makefile(
        ".yml",
        infrahub_config="""
        ---
        schemas:
          - schemas/dcim.yml

        python_transforms:
          - name: device_config
            class_name: "DeviceConfig"
            file_path: "transforms/device_config.py"
    """,
    )
    test_input = pytester.makefile(
        ".json", input='{"data": { "InfraDevice": { "edges": [ { "node": { "name": {"value": "atl1-edge1"} } } ] } } }'
    )
    test_output = pytester.makefile(".json", output='{"hostname": "atl1-edge1"}')
    test_template = pytester.makefile(
        ".py",
        device_config="""
        from infrahub_sdk.transforms import InfrahubTransform

        class DeviceConfig(InfrahubTransform):
            query = "device_config"
            async def transform(self, data):
                return {"hostname": data["InfraDevice"]["edges"][0]["node"]["name"]["value"]}
    """,
    )

    pytester.mkdir("device_config")
    test_dir = pytester.mkdir("device_config/base_config")
    pytester.run("mv", test_input, test_dir)
    pytester.run("mv", test_output, test_dir)

    transform_dir = pytester.mkdir("transforms")
    pytester.run("mv", test_template, transform_dir)

    result = pytester.runpytest("--infrahub-repo-config=infrahub_config.yml")
    result.assert_outcomes(passed=1)