prowler/lib/check/check_test.py

import os

from lib.check.check import (
    exclude_checks_to_run,
    exclude_groups_to_run,
    exclude_services_to_run,
    load_checks_to_execute_from_groups,
    parse_checks_from_file,
    parse_groups_from_file,
)


class Test_Check:
    # def test_import_check(self):
    #     test_cases = [
    #         {
    #             "name": "Test valid check path",
    #             "input": "providers.aws.services.iam.iam_disable_30_days_credentials.iam_disable_30_days_credentials",
    #             "expected": "providers.aws.services.iam.iam_disable_30_days_credentials.iam_disable_30_days_credentials",
    #         }
    #     ]
    #     for test in test_cases:
    #         assert importlib.import_module(test["input"]).__name__ == test["expected"

    def test_parse_groups_from_file(self):
        test_cases = [
            {
                "input": {
                    "path": f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/groupsA.json",
                    "provider": "aws",
                },
                "expected": {
                    "aws": {
                        "gdpr": {
                            "description": "GDPR Readiness",
                            "checks": ["check11", "check12"],
                        },
                        "iam": {
                            "description": "Identity and Access Management",
                            "checks": [
                                "iam_disable_30_days_credentials",
                                "iam_disable_90_days_credentials",
                            ],
                        },
                    }
                },
            }
        ]
        for test in test_cases:
            check_file = test["input"]["path"]
            assert parse_groups_from_file(check_file) == test["expected"]

    def test_parse_checks_from_file(self):
        test_cases = [
            {
                "input": {
                    "path": f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/checklistA.json",
                    "provider": "aws",
                },
                "expected": {"check11", "check12", "check7777"},
            }
        ]
        for test in test_cases:
            check_file = test["input"]["path"]
            provider = test["input"]["provider"]
            assert parse_checks_from_file(check_file, provider) == test["expected"]

    def test_load_checks_to_execute_from_groups(self):
        test_cases = [
            {
                "input": {
                    "groups_json": {
                        "aws": {
                            "gdpr": {
                                "description": "GDPR Readiness",
                                "checks": ["check11", "check12"],
                            },
                            "iam": {
                                "description": "Identity and Access Management",
                                "checks": [
                                    "iam_disable_30_days_credentials",
                                    "iam_disable_90_days_credentials",
                                ],
                            },
                        }
                    },
                    "provider": "aws",
                    "groups": ["gdpr"],
                },
                "expected": {"check11", "check12"},
            }
        ]

        for test in test_cases:
            provider = test["input"]["provider"]
            groups = test["input"]["groups"]
            group_file = test["input"]["groups_json"]

            assert (
                load_checks_to_execute_from_groups(group_file, groups, provider)
                == test["expected"]
            )

    def test_exclude_checks_to_run(self):
        test_cases = [
            {
                "input": {
                    "check_list": {"check12", "check11", "extra72", "check13"},
                    "excluded_checks": {"check12", "check13"},
                },
                "expected": {"check11", "extra72"},
            },
            {
                "input": {
                    "check_list": {"check112", "check11", "extra72", "check13"},
                    "excluded_checks": {"check12", "check13", "check14"},
                },
                "expected": {"check112", "check11", "extra72"},
            },
        ]
        for test in test_cases:
            check_list = test["input"]["check_list"]
            excluded_checks = test["input"]["excluded_checks"]
            assert (
                exclude_checks_to_run(check_list, excluded_checks) == test["expected"]
            )

    def test_exclude_groups_to_run(self):
        test_cases = [
            {
                "input": {
                    "excluded_group_list": {"gdpr"},
                    "provider": "aws",
                    "checks_to_run": {
                        "iam_disable_30_days_credentials",
                        "iam_disable_90_days_credentials",
                    },
                },
                "expected": {
                    "iam_disable_30_days_credentials",
                    "iam_disable_90_days_credentials",
                },
            },
            {
                "input": {
                    "excluded_group_list": {"iam"},
                    "provider": "aws",
                    "checks_to_run": {
                        "iam_disable_30_days_credentials",
                        "iam_disable_90_days_credentials",
                    },
                },
                "expected": set(),
            },
        ]
        for test in test_cases:
            excluded_group_list = test["input"]["excluded_group_list"]
            checks_to_run = test["input"]["checks_to_run"]
            provider = test["input"]["provider"]
            assert (
                exclude_groups_to_run(checks_to_run, excluded_group_list, provider)
                == test["expected"]
            )

    def test_exclude_services_to_run(self):
        test_cases = [
            {
                "input": {
                    "checks_to_run": {
                        "iam_disable_30_days_credentials",
                        "iam_disable_90_days_credentials",
                    },
                    "excluded_services": {"ec2"},
                    "provider": "aws",
                },
                "expected": {
                    "iam_disable_30_days_credentials",
                    "iam_disable_90_days_credentials",
                },
            },
            {
                "input": {
                    "checks_to_run": {
                        "iam_disable_30_days_credentials",
                        "iam_disable_90_days_credentials",
                    },
                    "excluded_services": {"iam"},
                    "provider": "aws",
                },
                "expected": set(),
            },
        ]
        for test in test_cases:
            excluded_services = test["input"]["excluded_services"]
            checks_to_run = test["input"]["checks_to_run"]
            provider = test["input"]["provider"]
            assert (
                exclude_services_to_run(checks_to_run, excluded_services, provider)
                == test["expected"]
            )