Skip to content

List

taskcat._cli_modules.list

List(profiles='default', regions='ALL', stack_type='ALL')

[ALPHA] lists taskcat jobs with active stacks

:param profiles: comma separated list of aws profiles to search :param regions: comma separated list of regions to search, default is to check all commercial regions :param stack_type: type of stacks to check, options are 'test', 'project', or 'ALL'. default is 'ALL'

Source code in taskcat/_cli_modules/list.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def __init__(  # noqa: C901
    self,
    profiles: Union[str, ListType[str]] = "default",
    regions="ALL",
    stack_type="ALL",
):
    """
    :param profiles: comma separated list of aws profiles to search
    :param regions: comma separated list of regions to search, default is to check \
        all commercial regions
    :param stack_type: type of stacks to check, options are 'test', 'project', or 'ALL'. \
        default is 'ALL'
    """
    if isinstance(profiles, str):
        profiles = profiles.split(",")
    if regions == "ALL":
        region_set: set = set()
        for profile in profiles:
            region_set = region_set.union(
                set(
                    boto3.Session(profile_name=profile).get_available_regions(
                        "cloudformation"
                    )
                )
            )
        regions = list(region_set)
    else:
        regions = regions.split(",")
    stacks = Stacker.list_stacks(profiles, regions)
    jobs: dict = {}
    for stack in stacks:
        stack_key = stack["taskcat-id"].hex + "-" + stack["region"]
        if stack_key not in jobs:
            name = stack.get("taskcat-installer")
            if stack_type == "ALL":
                if not name:
                    name = stack["taskcat-project-name"]
                jobs[stack_key] = {
                    "name": name,
                    "id": stack["taskcat-id"].hex,
                    "project_name": stack["taskcat-project-name"],
                    "active_stacks": 1,
                    "region": stack["region"],
                }
            elif stack_type == "test" and not name:
                name = stack["taskcat-project-name"]
                jobs[stack_key] = {
                    "name": name,
                    "id": stack["taskcat-id"].hex,
                    "project_name": stack["taskcat-project-name"],
                    "active_stacks": 1,
                    "region": stack["region"],
                }
            elif name and stack_type == "project":
                jobs[stack_key] = {
                    "name": name,
                    "id": stack["taskcat-id"].hex,
                    "project_name": stack["taskcat-project-name"],
                    "active_stacks": 1,
                    "region": stack["region"],
                }
        else:
            jobs[stack_key]["active_stacks"] += 1

    longest_name = List._longest([v["name"] for _, v in jobs.items()])
    longest_project_name = List._longest(
        [v["project_name"] for _, v in jobs.items()]
    )
    if not jobs:
        LOG.info("no stacks found")
        return
    if stack_type != "test":
        header = (
            f"NAME{List._spaces(longest_name)}PROJECT{List._spaces(longest_project_name)}"
            f"ID{List._spaces(34)}REGION"
        )
        column = "{}    {}       {}    {}"
    else:
        header = f"NAME{List._spaces(longest_name)}ID{List._spaces(34)}REGION"
        column = "{}    {}    {}"
    LOG.error(header, extra={"nametag": ""})
    for job in jobs.values():
        args = [
            List._pad(job["name"], longest_name),
            List._pad(job["project_name"], longest_project_name),
            job["id"],
            job["region"],
        ]
        if stack_type == "test":
            args = [List._pad(job["name"], longest_name), job["id"], job["region"]]
        LOG.error(column.format(*args), extra={"nametag": ""})