874601330

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/<a class="double-link" href="https://git"><a class=hub.com/dmuhs/mythx-cli/commit/fb01cb3233c48e6bae768e10f08168fc7390c730">fb01cb323">&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/fb01cb3233c48e6bae768e10f08168fc7390c730">fb01cb323</a><a href="https://github.com/dmuhs/mythx-cli/commit/fb01cb3233c48e6bae768e10f08168fc7390c730">&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/fb01cb3233c48e6bae768e10f08168fc7390c730&quot;&gt;fb01cb323&lt;/a&gt;&lt;a href=&quot;https://github.com/dmuhs/mythx-cli/commit/fb01cb3233c48e6bae768e10f08168fc7390c730&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dmuhs/mythx-cli/commit/fb01cb3233c48e6bae768e10f08168fc7390c730&amp;quot;&amp;gt;&amp;amp;quot;&amp;amp;gt;&amp;amp;amp;lt;a href=&amp;amp;amp;quot;https://github.com/dmuhs/mythx-cli/commit/&amp;amp;lt;/a&amp;amp;gt;&amp;amp;lt;a class=&amp;amp;quot;doub... (continued)

Pull Request Pull Request #249: Feat/fuzz

Run Details

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

1455 of 1689 relevant lines covered (86.15%)

3.45 hits per line

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

44.12

/mythx_cli/analyze/scribble.py

import json
import os
import subprocess
import sys
from collections import defaultdict
from typing import List

import click

from mythx_cli.util import sol_files_by_directory

SCRIBBLE_ARMING_META_FILE = ".scribble-arming.meta.json"


class ScribbleMixin:
    """A mixing for job objects to instrument code with Scribble."""

    @staticmethod
    def _handle_scribble_error(process: subprocess.CompletedProcess) -> None:
        """Handle scribble subprocess errors.

        This method will throw a CLI error in the case of scribble exiting
        with a non-zero exit code.

        :param process: The finished scribble process object
        """
        if process.returncode == 0:
            return

        click.echo(f"Scribble has encountered an error (code: {process.returncode})")
        click.echo("=====STDERR=====")
        click.echo(process.stderr.decode())
        click.echo("=====STDOUT=====")
        click.echo(process.stdout.decode())

        sys.exit(process.returncode)

    def instrument_truffle_artifacts(
        self, payloads: List[dict], scribble_path: str, remappings: List[str]
    ) -> dict:
        """Instrument a list of truffle artifacts with scribble.

        :param payloads: The list of truffle artifact objects
        :param scribble_path: The path to the scribble executable
        :param remappings: Optional solc import remappings
        :return: The deserialized scribble JSON output object
        """
        stdin = {"sources": {}, "contracts": defaultdict(defaultdict)}

        for payload in payloads:
            # reconstruct solc artifact from payload to pass it into scribble
            for filename, file_data in payload["sources"].items():
                stdin["sources"][filename] = {
                    "ast": file_data["ast"],
                    "source": file_data["source"],
                    "id": payload["source_list"].index(filename),
                }

                stdin["contracts"][filename][payload["contract_name"]] = {
                    "evm": {
                        "bytecode": {
                            "object": payload["bytecode"],
                            "sourceMap": payload["source_map"],
                        },
                        "deployedBytecode": {
                            "object": payload["deployed_bytecode"],
                            "sourceMap": payload["deployed_source_map"],
                        },
                    }
                }

        process = subprocess.run(
            [scribble_path, "--input-mode", "json", "--output-mode", "json"]
            + ([f"--path-remapping" "{';'.join(remappings)}"] if remappings else [])
            + ["--"],
            input=json.dumps(stdin).encode("utf-8"),
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
        )

        self._handle_scribble_error(process)

        return json.loads(process.stdout.decode())

    def instrument_solc_file(
        self, target: str, scribble_path: str, remappings: List[str]
    ) -> dict:
        """Instrument a single Solidity file with scribble.

        :param target: The target filename to pass to scribble
        :param scribble_path: The path to the scribble executable
        :param remappings: Optional solc import remappings
        :return: The deserialized scribble JSON output object
        """
        process = subprocess.run(
            [scribble_path, "--input-mode=source", "--output-mode=json"]
            + ([f"--path-remapping={';'.join(remappings)}"] if remappings else [])
            + [target],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
        )

        self._handle_scribble_error(process)

        return json.loads(process.stdout.decode())

    @staticmethod
    def instrument_solc_in_place(
        file_list: List[str],
        scribble_path: str,
        remappings: List[str] = None,
        solc_version: str = None,
    ) -> None:
        """Instrument a collection of Solidity files in place.

        :param file_list: List of paths to Solidity files to instrument
        :param scribble_path: The path to the scribble executable
        :param remappings: List of import remappings to pass to solc
        :param solc_version: The solc compiler version to use
        """
        command = [
            scribble_path,
            "--arm",
            "--output-mode=files",
            f"--instrumentation-metadata-file={SCRIBBLE_ARMING_META_FILE}",
        ]

        if remappings:
            command.append(f"--path-remapping={';'.join(remappings)}")

        if solc_version:
            command.append(f"--compiler-version={solc_version}")

        # Scribble doesnt currently support directories as inputs
        # so we create a list of all solidity files inside each of the targets
        # and submit that to Scribble.

        sol_files = []
        for file in file_list:
            target_files = sol_files_by_directory(file)
            sol_files = [*sol_files, *target_files]

        command.extend(sol_files)

        process = subprocess.run(
            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
        )

        ScribbleMixin._handle_scribble_error(process)

    @staticmethod
    def disarm_solc_in_place(
        file_list: List[str],
        scribble_path: str,
        remappings: List[str] = None,
        solc_version: str = None,
    ) -> None:
        """Un-instrument a collection of Solidity files in place.

        :param file_list: List of paths to Solidity files to instrument
        :param scribble_path: The path to the scribble executable
        :param remappings: List of import remappings to pass to solc
        :param solc_version: The solc compiler version to use
        """
        command = [scribble_path, "--disarm"]

        if remappings:
            command.append(f"--path-remapping={';'.join(remappings)}")

        if solc_version:
            command.append(f"--compiler-version={solc_version}")

        # Scribble doesnt currently support directories as inputs
        # so we create a list of all solidity files inside each of the targets
        # and submit that to Scribble.

        sol_files = []
        for file in file_list:
            target_files = sol_files_by_directory(file)
            sol_files = [*sol_files, *target_files]

        command.extend(sol_files)

        if os.path.isfile(SCRIBBLE_ARMING_META_FILE):
            os.remove(SCRIBBLE_ARMING_META_FILE)

        process = subprocess.run(
            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
        )

        ScribbleMixin._handle_scribble_error(process)

    @staticmethod
    def get_arming_instr_meta():
        if os.path.exists(SCRIBBLE_ARMING_META_FILE):
            with open(SCRIBBLE_ARMING_META_FILE, "r") as f:
                return json.load(f)

        return None

1	import json	4✔
2	import os	4✔
3	import subprocess	4✔
4	import sys	4✔
5	from collections import defaultdict	4✔
6	from typing import List	4✔
7
8	import click	4✔
9
10	from mythx_cli.util import sol_files_by_directory	4✔
11
12	SCRIBBLE_ARMING_META_FILE = ".scribble-arming.meta.json"	4✔
13
14
15	class ScribbleMixin:	4✔
16	"""A mixing for job objects to instrument code with Scribble."""
17
18	@staticmethod	4✔
19	def _handle_scribble_error(process: subprocess.CompletedProcess) -> None:	4✔
20	"""Handle scribble subprocess errors.
21
22	This method will throw a CLI error in the case of scribble exiting
23	with a non-zero exit code.
24
25	:param process: The finished scribble process object
26	"""
27	if process.returncode == 0:	4✔
28	return	×
29
30	click.echo(f"Scribble has encountered an error (code: {process.returncode})")	4✔
31	click.echo("=====STDERR=====")	4✔
32	click.echo(process.stderr.decode())	4✔
33	click.echo("=====STDOUT=====")	4✔
34	click.echo(process.stdout.decode())	4✔
35
36	sys.exit(process.returncode)	4✔
37
38	def instrument_truffle_artifacts(	4✔
39	self, payloads: List[dict], scribble_path: str, remappings: List[str]
40	) -> dict:
41	"""Instrument a list of truffle artifacts with scribble.
42
43	:param payloads: The list of truffle artifact objects
44	:param scribble_path: The path to the scribble executable
45	:param remappings: Optional solc import remappings
46	:return: The deserialized scribble JSON output object
47	"""
48	stdin = {"sources": {}, "contracts": defaultdict(defaultdict)}	×
49
50	for payload in payloads:	×
51	# reconstruct solc artifact from payload to pass it into scribble
52	for filename, file_data in payload["sources"].items():	×
53	stdin["sources"][filename] = {	×
54	"ast": file_data["ast"],
55	"source": file_data["source"],
56	"id": payload["source_list"].index(filename),
57	}
58
59	stdin["contracts"][filename][payload["contract_name"]] = {	×
60	"evm": {
61	"bytecode": {
62	"object": payload["bytecode"],
63	"sourceMap": payload["source_map"],
64	},
65	"deployedBytecode": {
66	"object": payload["deployed_bytecode"],
67	"sourceMap": payload["deployed_source_map"],
68	},
69	}
70	}
71
72	process = subprocess.run(	×
73	[scribble_path, "--input-mode", "json", "--output-mode", "json"]
74	+ ([f"--path-remapping" "{';'.join(remappings)}"] if remappings else [])
75	+ ["--"],
76	input=json.dumps(stdin).encode("utf-8"),
77	stdout=subprocess.PIPE,
78	stderr=subprocess.PIPE,
79	)
80
81	self._handle_scribble_error(process)	×
82
83	return json.loads(process.stdout.decode())	×
84
85	def instrument_solc_file(	4✔
86	self, target: str, scribble_path: str, remappings: List[str]
87	) -> dict:
88	"""Instrument a single Solidity file with scribble.
89
90	:param target: The target filename to pass to scribble
91	:param scribble_path: The path to the scribble executable
92	:param remappings: Optional solc import remappings
93	:return: The deserialized scribble JSON output object
94	"""
95	process = subprocess.run(	4✔
96	[scribble_path, "--input-mode=source", "--output-mode=json"]
97	+ ([f"--path-remapping={';'.join(remappings)}"] if remappings else [])
98	+ [target],
99	stdout=subprocess.PIPE,
100	stderr=subprocess.PIPE,
101	)
102
103	self._handle_scribble_error(process)	4✔
104
105	return json.loads(process.stdout.decode())	×
106
107	@staticmethod	4✔
108	def instrument_solc_in_place(	4✔
109	file_list: List[str],
110	scribble_path: str,
111	remappings: List[str] = None,
112	solc_version: str = None,
113	) -> None:
114	"""Instrument a collection of Solidity files in place.
115
116	:param file_list: List of paths to Solidity files to instrument
117	:param scribble_path: The path to the scribble executable
118	:param remappings: List of import remappings to pass to solc
119	:param solc_version: The solc compiler version to use
120	"""
121	command = [	×
122	scribble_path,
123	"--arm",
124	"--output-mode=files",
125	f"--instrumentation-metadata-file={SCRIBBLE_ARMING_META_FILE}",
126	]
127
128	if remappings:	×
129	command.append(f"--path-remapping={';'.join(remappings)}")	×
130
131	if solc_version:	×
132	command.append(f"--compiler-version={solc_version}")	×
133
134	# Scribble doesnt currently support directories as inputs
135	# so we create a list of all solidity files inside each of the targets
136	# and submit that to Scribble.
137
138	sol_files = []	×
139	for file in file_list:	×
140	target_files = sol_files_by_directory(file)	×
141	sol_files = [sol_files, target_files]	×
142
143	command.extend(sol_files)	×
144
145	process = subprocess.run(	×
146	command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
147	)
148
149	ScribbleMixin._handle_scribble_error(process)	×
150
151	@staticmethod	4✔
152	def disarm_solc_in_place(	4✔
153	file_list: List[str],
154	scribble_path: str,
155	remappings: List[str] = None,
156	solc_version: str = None,
157	) -> None:
158	"""Un-instrument a collection of Solidity files in place.
159
160	:param file_list: List of paths to Solidity files to instrument
161	:param scribble_path: The path to the scribble executable
162	:param remappings: List of import remappings to pass to solc
163	:param solc_version: The solc compiler version to use
164	"""
165	command = [scribble_path, "--disarm"]	×
166
167	if remappings:	×
168	command.append(f"--path-remapping={';'.join(remappings)}")	×
169
170	if solc_version:	×
171	command.append(f"--compiler-version={solc_version}")	×
172
173	# Scribble doesnt currently support directories as inputs
174	# so we create a list of all solidity files inside each of the targets
175	# and submit that to Scribble.
176
177	sol_files = []	×
178	for file in file_list:	×
179	target_files = sol_files_by_directory(file)	×
180	sol_files = [sol_files, target_files]	×
181
182	command.extend(sol_files)	×
183
184	if os.path.isfile(SCRIBBLE_ARMING_META_FILE):	×
185	os.remove(SCRIBBLE_ARMING_META_FILE)	×
186
187	process = subprocess.run(	×
188	command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
189	)
190
191	ScribbleMixin._handle_scribble_error(process)	×
192
193	@staticmethod	4✔
194	def get_arming_instr_meta():	1✔
195	if os.path.exists(SCRIBBLE_ARMING_META_FILE):	4✔
196	with open(SCRIBBLE_ARMING_META_FILE, "r") as f:	×
197	return json.load(f)	×
198
199	return None	4✔

dmuhs / mythx-cli / 874601330

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