853501386

Build Type

github-actions

Committed by GitHub

Commit Message

<a href="https://github.com/dmuhs/mythx-cli/commit/<a class=hub.com/dmuhs/mythx-cli/commit/<a class="double-link" href="https://git"><a class=hub.com/dmuhs/mythx-cli/commit/<a class="double-link" href="https://git"><a class=hub.com/dmuhs/mythx-cli/commit/<a class="double-link" href="https://git"><a class=hub.com/dmuhs/mythx-cli/commit/b0c5e91e936da92adc698c9aad23538a78f1f4dc">b0c5e91e9">&lt;a href=&quot;https://github.com/dmuhs/mythx-cli/commit/</a><a class="double-link" href="https://github.com/dmuhs/mythx-cli/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/dmuhs/mythx-cli/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/dmuhs/mythx-cli/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/dmuhs/mythx-cli/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/dmuhs/mythx-cli/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/dmuhs/mythx-cli/commit/b0c5e91e936da92adc698c9aad23538a78f1f4dc">b0c5e91e9</a><a href="https://github.com/dmuhs/mythx-cli/commit/b0c5e91e936da92adc698c9aad23538a78f1f4dc">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dmuhs/mythx-cli/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dmuhs/mythx-cli/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dmuhs/mythx-cli/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dmuhs/mythx-cli/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dmuhs/mythx-cli/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dmuhs/mythx-cli/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dmuhs/mythx-cli/commit/b0c5e91e936da92adc698c9aad23538a78f1f4dc&quot;&gt;b0c5e91e9&lt;/a&gt;&lt;a href=&quot;https://github.com/dmuhs/mythx-cli/commit/b0c5e91e936da92adc698c9aad23538a78f1f4dc&quot;&gt;&amp;quot;&amp;g... (continued)

Pull Request Pull Request #249: Feat/fuzz

Run Details

654 of 654 new or added lines in 27 files covered. (100.0%)

1439 of 1674 relevant lines covered (85.96%)

3.44 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.3

/mythx_cli/formatter/tabular.py

"""This module contains a tabular data formatter class printing a subset of the
response data."""

from itertools import zip_longest
from os.path import basename
from typing import List, Optional, Tuple

from mythx_models.response import (
    AnalysisInputResponse,
    AnalysisListResponse,
    AnalysisStatusResponse,
    DetectedIssuesResponse,
    GroupListResponse,
    GroupStatusResponse,
    ProjectListResponse,
    VersionResponse,
)
from tabulate import tabulate

from mythx_cli.formatter.base import BaseFormatter
from mythx_cli.formatter.util import generate_dashboard_link
from mythx_cli.util import SourceMap, index_by_filename


class TabularFormatter(BaseFormatter):
    """The tabular formatter.

    This formatter displays an ASCII table. It is enabled by default and
    requires the analysis input data to display each issue's line number
    in the source file. It might break on very large field sizes as
    cell-internal line breaks are not supported by the tabulate library
    yet.
    """

    report_requires_input = True

    @staticmethod
    def format_analysis_list(resp: AnalysisListResponse) -> str:
        """Format an analysis list response to a tabular representation."""

        data = [
            (a.uuid, a.status, a.client_tool_name, a.submitted_at)
            for a in resp.analyses
        ]
        return tabulate(data, tablefmt="fancy_grid")

    @staticmethod
    def format_project_list(resp: ProjectListResponse) -> str:
        """Format an analysis group response to a tabular representation."""

        data = [
            (project.id, project.name, project.group_count, project.modified)
            for project in resp.projects
        ]
        return tabulate(data, tablefmt="fancy_grid")

    @staticmethod
    def format_group_list(resp: GroupListResponse) -> str:
        """Format an analysis group response to a tabular representation."""

        data = [
            (
                group.identifier,
                group.status,
                ",".join([basename(x) for x in group.main_source_files]),
                group.created_at,
            )
            for group in resp.groups
        ]
        return tabulate(data, tablefmt="fancy_grid")

    @staticmethod
    def format_group_status(resp: GroupStatusResponse) -> str:
        """Format a group status response to a tabular representation."""

        data = (
            (
                ("ID", resp.identifier),
                ("Name", resp.name or "<unnamed>"),
                ("Creation Date", resp.created_at),
                ("Created By", resp.created_by),
                ("Progress", "{}/100".format(resp.progress)),
            )
            + tuple(
                zip_longest(("Main Sources",), resp.main_source_files, fillvalue="")
            )
            + (
                ("Status", resp.status.title()),
                ("Queued Analyses", resp.analysis_statistics.queued or 0),
                ("Running Analyses", resp.analysis_statistics.running or 0),
                ("Failed Analyses", resp.analysis_statistics.failed or 0),
                ("Finished Analyses", resp.analysis_statistics.finished or 0),
                ("Total Analyses", resp.analysis_statistics.total or 0),
                (
                    "High Severity Vulnerabilities",
                    resp.vulnerability_statistics.high or 0,
                ),
                (
                    "Medium Severity Vulnerabilities",
                    resp.vulnerability_statistics.medium or 0,
                ),
                (
                    "Low Severity Vulnerabilities",
                    resp.vulnerability_statistics.low or 0,
                ),
                (
                    "Unknown Severity Vulnerabilities",
                    resp.vulnerability_statistics.none or 0,
                ),
            )
        )
        return tabulate(data, tablefmt="fancy_grid")

    @staticmethod
    def format_analysis_status(resp: AnalysisStatusResponse) -> str:
        """Format an analysis status response to a tabular representation."""

        data = (
            ("UUID", resp.uuid),
            ("API Version", resp.api_version),
            ("Mythril Version", resp.mythril_version),
            ("Harvey Version", resp.harvey_version),
            ("Maru Version", resp.maru_version),
            ("Queue Time", resp.queue_time),
            ("Run Time", resp.run_time),
            ("Status", resp.status),
            ("Submitted At", resp.submitted_at),
            ("Submitted By", resp.submitted_by),
            ("Tool Name", resp.client_tool_name),
            ("Group ID", resp.group_id),
            ("Group Name", resp.group_name),
            ("Analysis Mode", resp.analysis_mode),
        )
        return tabulate(data, tablefmt="fancy_grid")

    @staticmethod
    def format_detected_issues(
        issues_list: List[
            Tuple[str, DetectedIssuesResponse, Optional[AnalysisInputResponse]]
        ],
        **kwargs,
    ) -> str:
        """Format an issue report to a tabular representation."""

        result = []
        file_to_issues = index_by_filename(issues_list)
        table_sort_key = kwargs.pop("table_sort_key", "line")

        for filename, data in file_to_issues.items():
            data = [o for o in data if o["issues"]]
            if not data:
                continue
            result.append(f"Report for {filename}")
            links, lines = set(), set()
            for line in data:
                for issue in line["issues"]:
                    links.add(generate_dashboard_link(issue["uuid"]))
                    lines.add(
                        (
                            line["line"],
                            f"({issue['swcID']}) {issue['swcTitle']}",
                            issue["severity"],
                            issue["description"]["head"],
                        )
                    )

            # sort by line number
            sort_idx = {"line": 0, "title": 1, "severity": 2, "description": 3}[
                table_sort_key
            ]
            lines = sorted(lines, key=lambda x: x[sort_idx])

            result.extend(links)
            result.extend(
                (
                    tabulate(
                        lines,
                        tablefmt="fancy_grid",
                        headers=("Line", "SWC Title", "Severity", "Short Description"),
                    ),
                    "",  # new line after table
                )
            )

        return "\n".join(result)

    @staticmethod
    def format_version(resp: VersionResponse) -> str:
        """Format a version response to a tabular representation."""

        data = ((k.title(), v) for k, v in resp.dict(by_alias=True).items())
        return tabulate(data, tablefmt="fancy_grid")

1	"""This module contains a tabular data formatter class printing a subset of the
2	response data."""
3
4	from itertools import zip_longest	4✔
5	from os.path import basename	4✔
6	from typing import List, Optional, Tuple	4✔
7
8	from mythx_models.response import (	4✔
9	AnalysisInputResponse,
10	AnalysisListResponse,
11	AnalysisStatusResponse,
12	DetectedIssuesResponse,
13	GroupListResponse,
14	GroupStatusResponse,
15	ProjectListResponse,
16	VersionResponse,
17	)
18	from tabulate import tabulate	4✔
19
20	from mythx_cli.formatter.base import BaseFormatter	4✔
21	from mythx_cli.formatter.util import generate_dashboard_link	4✔
22	from mythx_cli.util import SourceMap, index_by_filename	4✔
23
24
25	class TabularFormatter(BaseFormatter):	4✔
26	"""The tabular formatter.
27
28	This formatter displays an ASCII table. It is enabled by default and
29	requires the analysis input data to display each issue's line number
30	in the source file. It might break on very large field sizes as
31	cell-internal line breaks are not supported by the tabulate library
32	yet.
33	"""
34
35	report_requires_input = True	4✔
36
37	@staticmethod	4✔
38	def format_analysis_list(resp: AnalysisListResponse) -> str:	4✔
39	"""Format an analysis list response to a tabular representation."""
40
41	data = [	4✔
42	(a.uuid, a.status, a.client_tool_name, a.submitted_at)
43	for a in resp.analyses
44	]
45	return tabulate(data, tablefmt="fancy_grid")	4✔
46
47	@staticmethod	4✔
48	def format_project_list(resp: ProjectListResponse) -> str:	4✔
49	"""Format an analysis group response to a tabular representation."""
50
51	data = [	×
52	(project.id, project.name, project.group_count, project.modified)
53	for project in resp.projects
54	]
55	return tabulate(data, tablefmt="fancy_grid")	×
56
57	@staticmethod	4✔
58	def format_group_list(resp: GroupListResponse) -> str:	4✔
59	"""Format an analysis group response to a tabular representation."""
60
61	data = [	4✔
62	(
63	group.identifier,
64	group.status,
65	",".join([basename(x) for x in group.main_source_files]),
66	group.created_at,
67	)
68	for group in resp.groups
69	]
70	return tabulate(data, tablefmt="fancy_grid")	4✔
71
72	@staticmethod	4✔
73	def format_group_status(resp: GroupStatusResponse) -> str:	4✔
74	"""Format a group status response to a tabular representation."""
75
76	data = (	4✔
77	(
78	("ID", resp.identifier),
79	("Name", resp.name or "<unnamed>"),
80	("Creation Date", resp.created_at),
81	("Created By", resp.created_by),
82	("Progress", "{}/100".format(resp.progress)),
83	)
84	+ tuple(
85	zip_longest(("Main Sources",), resp.main_source_files, fillvalue="")
86	)
87	+ (
88	("Status", resp.status.title()),
89	("Queued Analyses", resp.analysis_statistics.queued or 0),
90	("Running Analyses", resp.analysis_statistics.running or 0),
91	("Failed Analyses", resp.analysis_statistics.failed or 0),
92	("Finished Analyses", resp.analysis_statistics.finished or 0),
93	("Total Analyses", resp.analysis_statistics.total or 0),
94	(
95	"High Severity Vulnerabilities",
96	resp.vulnerability_statistics.high or 0,
97	),
98	(
99	"Medium Severity Vulnerabilities",
100	resp.vulnerability_statistics.medium or 0,
101	),
102	(
103	"Low Severity Vulnerabilities",
104	resp.vulnerability_statistics.low or 0,
105	),
106	(
107	"Unknown Severity Vulnerabilities",
108	resp.vulnerability_statistics.none or 0,
109	),
110	)
111	)
112	return tabulate(data, tablefmt="fancy_grid")	4✔
113
114	@staticmethod	4✔
115	def format_analysis_status(resp: AnalysisStatusResponse) -> str:	4✔
116	"""Format an analysis status response to a tabular representation."""
117
118	data = (	4✔
119	("UUID", resp.uuid),
120	("API Version", resp.api_version),
121	("Mythril Version", resp.mythril_version),
122	("Harvey Version", resp.harvey_version),
123	("Maru Version", resp.maru_version),
124	("Queue Time", resp.queue_time),
125	("Run Time", resp.run_time),
126	("Status", resp.status),
127	("Submitted At", resp.submitted_at),
128	("Submitted By", resp.submitted_by),
129	("Tool Name", resp.client_tool_name),
130	("Group ID", resp.group_id),
131	("Group Name", resp.group_name),
132	("Analysis Mode", resp.analysis_mode),
133	)
134	return tabulate(data, tablefmt="fancy_grid")	4✔
135
136	@staticmethod	4✔
137	def format_detected_issues(	4✔
138	issues_list: List[
139	Tuple[str, DetectedIssuesResponse, Optional[AnalysisInputResponse]]
140	],
141	**kwargs,
142	) -> str:
143	"""Format an issue report to a tabular representation."""
144
145	result = []	4✔
146	file_to_issues = index_by_filename(issues_list)	4✔
147	table_sort_key = kwargs.pop("table_sort_key", "line")	4✔
148
149	for filename, data in file_to_issues.items():	4✔
150	data = [o for o in data if o["issues"]]	4✔
151	if not data:	4✔
152	continue	4✔
153	result.append(f"Report for {filename}")	4✔
154	links, lines = set(), set()	4✔
155	for line in data:	4✔
156	for issue in line["issues"]:	4✔
157	links.add(generate_dashboard_link(issue["uuid"]))	4✔
158	lines.add(	4✔
159	(
160	line["line"],
161	f"({issue['swcID']}) {issue['swcTitle']}",
162	issue["severity"],
163	issue["description"]["head"],
164	)
165	)
166
167	# sort by line number
168	sort_idx = {"line": 0, "title": 1, "severity": 2, "description": 3}[	4✔
169	table_sort_key
170	]
171	lines = sorted(lines, key=lambda x: x[sort_idx])	4✔
172
173	result.extend(links)	4✔
174	result.extend(	4✔
175	(
176	tabulate(
177	lines,
178	tablefmt="fancy_grid",
179	headers=("Line", "SWC Title", "Severity", "Short Description"),
180	),
181	"", # new line after table
182	)
183	)
184
185	return "\n".join(result)	4✔
186
187	@staticmethod	4✔
188	def format_version(resp: VersionResponse) -> str:	4✔
189	"""Format a version response to a tabular representation."""
190
191	data = ((k.title(), v) for k, v in resp.dict(by_alias=True).items())	4✔
192	return tabulate(data, tablefmt="fancy_grid")	4✔

dmuhs / mythx-cli / 853501386

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous