From 17b3092e76758fcfc2fd4748e25746bb5b5e07ab Mon Sep 17 00:00:00 2001
From: Jason Wen <haibin.wen3@gmail.com>
Date: Sat, 1 Feb 2025 02:55:52 -0500
Subject: [PATCH] modeld: script to generate new default model hash and name
 (#629)

* modeld: script to generate new default model hash and name

* break CI intentionally to trigger new changes

* more verbose and fix

* more verbose hehe
---
 sunnypilot/modeld/default_model.py            | 64 +++++++++++++++++++
 sunnypilot/modeld/tests/test_default_model.py | 31 ++-------
 2 files changed, 68 insertions(+), 27 deletions(-)
 create mode 100644 sunnypilot/modeld/default_model.py

diff --git a/sunnypilot/modeld/default_model.py b/sunnypilot/modeld/default_model.py
new file mode 100644
index 000000000..21f73ee8b
--- /dev/null
+++ b/sunnypilot/modeld/default_model.py
@@ -0,0 +1,64 @@
+import argparse
+import os
+import hashlib
+
+from openpilot.common.basedir import BASEDIR
+
+DEFAULT_MODEL_NAME_PATH = os.path.join(BASEDIR, "common", "model.h")
+MODEL_HASH_PATH = os.path.join(BASEDIR, "sunnypilot", "modeld", "tests", "model_hash")
+ONNX_PATH = os.path.join(BASEDIR, "selfdrive", "modeld", "models", "supercombo.onnx")
+
+
+def get_hash(path: str) -> str:
+  sha256_hash = hashlib.sha256()
+  with open(path, "rb") as f:
+    for byte_block in iter(lambda: f.read(4096), b""):
+      sha256_hash.update(byte_block)
+  return sha256_hash.hexdigest()
+
+
+def update_model_hash():
+  new_hash = get_hash(ONNX_PATH)
+  with open(MODEL_HASH_PATH, "w") as f:
+    f.write(new_hash)
+  print(f"Generated and updated new hash to {MODEL_HASH_PATH}")
+
+
+def get_current_default_model_name():
+  print("[GET DEFAULT MODEL NAME]")
+  with open(DEFAULT_MODEL_NAME_PATH) as f:
+    name = f.read().split('"')[1]
+  print(f'Current default model name: "{name}"')
+
+  return name
+
+
+def update_default_model_name(name: str):
+  print("[CHANGE DEFAULT MODEL NAME]")
+  with open(DEFAULT_MODEL_NAME_PATH, "w") as f:
+    f.write(f'#define DEFAULT_MODEL "{name}"\n')
+  print(f'New default model name: "{name}"')
+  print("[DONE]")
+
+
+if __name__ == "__main__":
+  parser = argparse.ArgumentParser(description="Update default model name and hash")
+  parser.add_argument("--new_name", type=str, help="New default model name")
+  args = parser.parse_args()
+
+  if not args.new_name:
+    print("Warning: No new default model name provided. Use --new_name to specify")
+    print("Default model name and hash will not be updated! (aborted)")
+    exit(0)
+
+  current_name = get_current_default_model_name()
+  new_name = f"{args.new_name} (Default)"
+  if current_name == new_name:
+    print(f'Proposed default model name: "{new_name}"')
+    confirm = input("Proposed default model name is the same as the current default model name. Confirm? (y/n):").upper().strip()
+    if confirm != "Y":
+      print("Default model name and hash will not be updated! (aborted)")
+      exit(0)
+
+  update_default_model_name(new_name)
+  update_model_hash()
diff --git a/sunnypilot/modeld/tests/test_default_model.py b/sunnypilot/modeld/tests/test_default_model.py
index 6f3c835f2..3e3c14523 100644
--- a/sunnypilot/modeld/tests/test_default_model.py
+++ b/sunnypilot/modeld/tests/test_default_model.py
@@ -1,34 +1,11 @@
-import os
-import hashlib
-
-from openpilot.common.basedir import BASEDIR
-
-MODEL_HASH_DIR = os.path.dirname(os.path.abspath(__file__))
+from openpilot.sunnypilot.modeld.default_model import get_hash, MODEL_HASH_PATH, ONNX_PATH
 
 
 class TestDefaultModel:
-  @classmethod
-  def setup_class(cls):
-    cls.onnx_path = os.path.join(BASEDIR, "selfdrive", "modeld", "models", "supercombo.onnx")
-    cls.current_hash_path = os.path.join(MODEL_HASH_DIR, "model_hash")
-
-  @staticmethod
-  def get_hash(path: str) -> str:
-    sha256_hash = hashlib.sha256()
-    with open(path, "rb") as f:
-      for byte_block in iter(lambda: f.read(4096), b""):
-        sha256_hash.update(byte_block)
-    return sha256_hash.hexdigest()
-
   def test_compare_onnx_hashes(self):
-    new_hash = self.get_hash(str(self.onnx_path))
+    new_hash = get_hash(ONNX_PATH)
 
-    with open(self.current_hash_path) as f:
+    with open(MODEL_HASH_PATH) as f:
       current_hash = f.read().strip()
 
-    assert new_hash == current_hash, (
-      "Driving model updated!\n" +
-      f"Current hash: {current_hash}\n" +
-      f"New hash: {new_hash}\n" +
-      "Please update common/model.h if the default driving model name has changed."
-    )
+    assert new_hash == current_hash, "Run sunnypilot/modeld/default_model.py to update the default model name and hash"