bss/gp2040ce-binary-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 9 Wiki Activity

visualize-storage flag to print as JSON

Browse Source 
closes #3
This commit is contained in:
Brian S. Stephan 2023-06-21 18:21:22 -05:00
parent 88ca5c5152
commit 1b02e458e2
Signed by: bss
GPG Key ID: 3DE06D3180895FCB
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gp2040ce_bintools/storage.py
View File

@ -2,6 +2,9 @@
import argparse import argparse
import logging import logging
from google.protobuf.json_format import MessageToJson
from google.protobuf.message import Message
from gp2040ce_bintools import core_parser, get_config_pb2 from gp2040ce_bintools import core_parser, get_config_pb2
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -18,7 +21,7 @@ FOOTER_MAGIC = b'\x65\xe3\xf1\xd2'
############### ###############
def get_config(content: bytes) -> dict: def get_config(content: bytes) -> Message:
"""Read the config from a GP2040-CE storage section. """Read the config from a GP2040-CE storage section.
Args: Args:
@ -67,7 +70,7 @@ def get_config_footer(content: bytes) -> tuple[int, int, str]:
return config_size, config_crc, config_magic return config_size, config_crc, config_magic
def get_config_from_file(filename: str, whole_board: bool = False) -> dict: def get_config_from_file(filename: str, whole_board: bool = False) -> Message:
"""Read the specified file (memory dump or whole board dump) and get back its config section. """Read the specified file (memory dump or whole board dump) and get back its config section.
Args: Args:
@ -114,7 +117,12 @@ def visualize():
parents=[core_parser], parents=[core_parser],
) )
parser.add_argument('--whole-board', action='store_true', help="indicate the binary file is a whole board dump") parser.add_argument('--whole-board', action='store_true', help="indicate the binary file is a whole board dump")
parser.add_argument('--json', action='store_true', help="print the config out as a JSON document")
parser.add_argument('filename', help=".bin file of a GP2040-CE board's storage section, bytes 101FE000-10200000, " parser.add_argument('filename', help=".bin file of a GP2040-CE board's storage section, bytes 101FE000-10200000, "
"or of a GP2040-CE's whole board dump if --whole-board is specified") "or of a GP2040-CE's whole board dump if --whole-board is specified")
args, _ = parser.parse_known_args() args, _ = parser.parse_known_args()
print(get_config_from_file(args.filename, whole_board=args.whole_board)) config = get_config_from_file(args.filename, whole_board=args.whole_board)
if args.json:
print(MessageToJson(config))
else:
print(config)

10
tests/test_commands.py
View File

@ -1,4 +1,5 @@
"""Test our tools themselves to make sure they adhere to certain flags.""" """Test our tools themselves to make sure they adhere to certain flags."""
import json
from subprocess import run from subprocess import run
from gp2040ce_bintools import __version__ from gp2040ce_bintools import __version__
@ -31,3 +32,12 @@ def test_debug_storage_dump_invocation():
capture_output=True, encoding='utf8') capture_output=True, encoding='utf8')
assert 'boardVersion: "v0.7.2"' in result.stdout assert 'boardVersion: "v0.7.2"' in result.stdout
assert 'length of content to look for footer in: 8192' in result.stderr assert 'length of content to look for footer in: 8192' in result.stderr
def test_storage_dump_json_invocation():
"""Test that a normal invocation against a dump works."""
result = run(['visualize-storage', '-P', 'tests/test-files/proto-files', '--json',
'tests/test-files/test-storage-area.bin'],
capture_output=True, encoding='utf8')
to_dict = json.loads(result.stdout)
assert to_dict['boardVersion'] == 'v0.7.2'