summaryrefslogtreecommitdiff
path: root/robusta_krr/formatters/table.py
blob: 6918512ddcb05a389ecab1cb6712cf12fca85f0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
from __future__ import annotations

import itertools
from typing import Optional

from rich.table import Table

from robusta_krr.core.abstract.formatters import BaseFormatter
from robusta_krr.core.models.allocations import RecommendationValue
from robusta_krr.core.models.result import ResourceScan, ResourceType, Result
from robusta_krr.utils import resource_units

NONE_LITERAL = "none"
NAN_LITERAL = "?"
ALLOWED_DIFFERENCE = 0.05


class TableFormatter(BaseFormatter):
    """Formatter for text output."""

    __display_name__ = "table"

    def _format(self, value: RecommendationValue) -> str:
        if value is None:
            return NONE_LITERAL
        elif isinstance(value, str):
            return NAN_LITERAL
        else:
            return resource_units.format(value)

    def _format_request_str(self, item: ResourceScan, resource: ResourceType, selector: str) -> str:
        allocated = getattr(item.object.allocations, selector)[resource]
        recommended = getattr(item.recommended, selector)[resource]
        severity = recommended.severity

        return (
            f"[{severity.color}]"
            + self._format(allocated)
            + " -> "
            + self._format(recommended.value)
            + f"[/{severity.color}]"
        )

    def format(self, result: Result) -> Table:
        """Format the result as text.

        :param result: The result to format.
        :type result: :class:`core.result.Result`
        :returns: The formatted results.
        :rtype: str
        """

        table = Table(show_header=True, header_style="bold magenta", title=f"Scan result ({result.score} points)", caption=result.description)

        table.add_column("Number", justify="right", no_wrap=True)
        table.add_column("Cluster", style="cyan")
        table.add_column("Namespace", style="cyan")
        table.add_column("Name", style="cyan")
        table.add_column("Pods", style="cyan")
        table.add_column("Old Pods", style="cyan")
        table.add_column("Type", style="cyan")
        table.add_column("Container", style="cyan")
        for resource in ResourceType:
            table.add_column(f"{resource.name} Requests")
            table.add_column(f"{resource.name} Limits")

        for _, group in itertools.groupby(
            enumerate(result.scans), key=lambda x: (x[1].object.cluster, x[1].object.namespace, x[1].object.name)
        ):
            group_items = list(group)

            for j, (i, item) in enumerate(group_items):
                last_row = j == len(group_items) - 1
                full_info_row = j == 0

                table.add_row(
                    f"[{item.severity.color}]{i + 1}.[/{item.severity.color}]",
                    item.object.cluster if full_info_row else "",
                    item.object.namespace if full_info_row else "",
                    item.object.name if full_info_row else "",
                    f"{item.object.current_pods_count}" if full_info_row else "",
                    f"{item.object.deleted_pods_count}" if full_info_row else "",
                    item.object.kind if full_info_row else "",
                    item.object.container,
                    *[
                        self._format_request_str(item, resource, selector)
                        for resource in ResourceType
                        for selector in ["requests", "limits"]
                    ],
                    end_section=last_row,
                )

        return table