arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-19 12:58:13 +00:00
Code Issues Releases Wiki Activity

feat(common/cointool): use support.json as a source of the list of supported models

Browse Source
This commit is contained in:
matejcik 2024-09-02 10:15:13 +02:00 committed by matejcik
parent 491647085f
commit 1f20b2984f
3 changed files with 33 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
common/tools/coin_info.py
View File

@ -26,32 +26,13 @@ ROOT = Path(__file__).resolve().parent.parent
DEFS_DIR = ROOT / "defs"
class SupportItemBool(TypedDict):
supported: dict[str, bool]
unsupported: dict[str, bool]
class SupportItemVersion(TypedDict):
supported: dict[str, str]
unsupported: dict[str, str]
class SupportData(TypedDict):
connect: SupportItemBool
suite: SupportItemBool
t1b1: SupportItemVersion
t2t1: SupportItemVersion
t2b1: SupportItemVersion
class SupportInfoItem(TypedDict):
connect: bool
suite: bool
t1b1: Literal[False] | str
t2t1: Literal[False] | str
t2b1: Literal[False] | str
SupportData = Dict[str, SupportItemVersion]
SupportInfoItem = Dict[str, Literal[False] | str]
SupportInfo = Dict[str, SupportInfoItem]
@ -449,8 +430,6 @@ def _load_fido_apps() -> FidoApps:
# ====== support info ======
RELEASES_URL = "https://data.trezor.io/firmware/{}/releases.json"
MISSING_SUPPORT_MEANS_NO = ("connect", "suite")
VERSIONED_SUPPORT_INFO = ("T1B1", "T2T1", "T2B1", "T3T1", "T3B1")
def get_support_data() -> SupportData:
@ -458,14 +437,18 @@ def get_support_data() -> SupportData:
return load_json("support.json")
def get_models() -> list[str]:
"""Get all models from `support.json`."""
return list(get_support_data().keys())
def latest_releases() -> dict[str, Any]:
"""Get latest released firmware versions for all models"""
if not requests:
raise RuntimeError("requests library is required for getting release info")
latest: dict[str, Any] = {}
for model in VERSIONED_SUPPORT_INFO:
# TODO: support new UPPERCASE model names in RELEASES_URL
for model in get_models():
url_model = model.lower() # need to be e.g. t1b1 for now
releases = requests.get(RELEASES_URL.format(url_model)).json()
latest[model] = max(tuple(r["version"]) for r in releases)
@ -492,8 +475,6 @@ def support_info_single(support_data: SupportData, coin: Coin) -> SupportInfoIte
support_value: Any = False
elif key in values["supported"]:
support_value = values["supported"][key]
elif device in MISSING_SUPPORT_MEANS_NO:
support_value = False
else:
support_value = None
support_info_item[device] = support_value

1
common/tools/cointool.py
View File

@ -160,6 +160,7 @@ def render_file(
ROOT=ROOT,
**coins,
**MAKO_FILTERS,
ALL_MODELS=coin_info.get_models(),
)
dst.write_text(str(result))
src_stat = src.stat()

52
common/tools/support.py
View File

@ -11,6 +11,7 @@ import click
import coin_info
SUPPORT_INFO = coin_info.get_support_data()
MODELS = coin_info.get_models()
VERSION_RE = re.compile(r"\d+.\d+.\d+")
@ -64,7 +65,7 @@ def set_unsupported(device, key, value):
def print_support(coin):
def support_value(where, key, missing_means_no=False):
def support_value(where, key):
if "supported" in where and key in where["supported"]:
val = where["supported"][key]
if val is True:
@ -76,8 +77,6 @@ def print_support(coin):
elif "unsupported" in where and key in where["unsupported"]:
val = where["unsupported"][key]
return f"NO (reason: {val})"
elif missing_means_no:
return "NO"
else:
return "support info missing"
@ -86,8 +85,7 @@ def print_support(coin):
if coin.get("duplicate"):
print(" * DUPLICATE SYMBOL")
for dev, where in SUPPORT_INFO.items():
missing_means_no = dev in coin_info.MISSING_SUPPORT_MEANS_NO
print(" *", dev, ":", support_value(where, key, missing_means_no))
print(" *", dev, ":", support_value(where, key))
# ====== validation functions ====== #
@ -111,12 +109,7 @@ def check_support_values():
else:
for key, value in supported.items():
try:
if device in coin_info.VERSIONED_SUPPORT_INFO:
_check_value_version_soon(value)
else:
if value is not True:
raise ValueError(f"only allowed is True, but found {value}")
_check_value_version_soon(value)
if key in unsupported:
raise ValueError(f"{key} is both supported and unsupported")
@ -135,7 +128,7 @@ def check_support_values():
def find_unsupported_coins(coins_dict):
result = {}
for device in coin_info.VERSIONED_SUPPORT_INFO:
for device in MODELS:
supported, unsupported = support_dicts(device)
support_set = set(supported.keys())
support_set.update(unsupported.keys())
@ -253,10 +246,8 @@ def release(
key: val for key, val in (release.split("=") for release in releases)
}
for key in user_releases_dict:
if key not in coin_info.VERSIONED_SUPPORT_INFO:
raise click.ClickException(
f"Unknown device: {key} - allowed are: {coin_info.VERSIONED_SUPPORT_INFO}"
)
if key not in MODELS:
raise click.ClickException(f"Unknown device: {key} - allowed are: {MODELS}")
def bump_version(version_tuple: tuple[int]) -> str:
version_list = list(version_tuple)
@ -267,7 +258,7 @@ def release(
# Take version either from user or guess it from latest releases info
device_release_version: dict[str, str] = {}
for device in coin_info.VERSIONED_SUPPORT_INFO:
for device in MODELS:
if device in user_releases_dict:
device_release_version[device] = user_releases_dict[device]
else:
@ -355,15 +346,18 @@ def set_support_value(key, entries, reason):
"""Set a support info variable.
Examples:
support.py set coin:BTC T1B1=1.10.5 T2T1=2.4.7 suite=yes connect=no
support.py set coin:LTC T1B1=yes connect=
support.py set coin:BTC T1B1=1.10.5 T2T1=2.4.7 T2B1=no
Setting a variable to "yes", "true" or "1" sets support to true.
Setting a variable to "no", "false" or "0" sets support to false.
(or null, in case of T1B1/T2T1)
Setting variable to empty ("T1B1=") will set to null, or clear the entry.
Setting a variable to a particular version string (e.g., "2.4.7") will set that
particular version.
particular version as the earliest supported.
Setting a variable to "yes", "true" or "1" sets support to the upcoming release,
as fetched via `coin_info.latest_releases()`.
Setting a variable to "no", "false" or "0" sets support to false. You will need to
provide a reason for unsupporting, either via the `-r` option, or interactively.
Setting variable to empty ("T1B1=") will set to null, or clear the entry.
"""
defs, _ = coin_info.coin_info_with_duplicates()
coins = defs.as_dict()
@ -372,6 +366,11 @@ def set_support_value(key, entries, reason):
click.echo("Use 'support.py show' to search for the right one.")
sys.exit(1)
latest_releases = coin_info.latest_releases()
next_releases = {
k: (maj, min, pat + 1) for k, (maj, min, pat) in latest_releases.items()
}
for entry in entries:
try:
device, value = entry.split("=", maxsplit=1)
@ -383,11 +382,8 @@ def set_support_value(key, entries, reason):
raise click.ClickException(f"unknown device: {device}")
if value in ("yes", "true", "1"):
set_supported(device, key, True)
set_supported(device, key, next_releases[device])
elif value in ("no", "false", "0"):
if device in coin_info.MISSING_SUPPORT_MEANS_NO:
click.echo(f"Setting explicitly unsupported for {device}.")
click.echo(f"Perhaps you meant removing support, i.e., '{device}=' ?")
if not reason:
reason = click.prompt(f"Enter reason for not supporting on {device}:")
set_unsupported(device, key, reason)