StarPilot/common/tests/test_params.py

import pytest
import datetime
import os
import threading
import time
import uuid

from openpilot.common.params import Params, ParamKeyFlag, ParamKeyType, UnknownKeyName

class TestParams:
  def setup_method(self):
    self.params = Params()

  def test_params_put_and_get(self):
    self.params.put("DongleId", "cb38263377b873ee")
    assert self.params.get("DongleId") == "cb38263377b873ee"

  def test_params_non_ascii(self):
    st = b"\xe1\x90\xff"
    self.params.put("CarParams", st)
    assert self.params.get("CarParams") == st

  def test_params_get_cleared_manager_start(self):
    self.params.put("CarParams", b"test")
    self.params.put("DongleId", "cb38263377b873ee")
    assert self.params.get("CarParams") == b"test"

    undefined_param = self.params.get_param_path(uuid.uuid4().hex)
    with open(undefined_param, "w") as f:
      f.write("test")
    assert os.path.isfile(undefined_param)

    self.params.clear_all(ParamKeyFlag.CLEAR_ON_MANAGER_START)
    assert self.params.get("CarParams") is None
    assert self.params.get("DongleId") is not None
    assert not os.path.isfile(undefined_param)

  def test_params_two_things(self):
    self.params.put("DongleId", "bob")
    self.params.put("AthenadPid", 123)
    assert self.params.get("DongleId") == "bob"
    assert self.params.get("AthenadPid") == 123

  def test_params_get_block(self):
    def _delayed_writer():
      time.sleep(0.1)
      self.params.put("CarParams", b"test")
    threading.Thread(target=_delayed_writer).start()
    assert self.params.get("CarParams") is None
    assert self.params.get("CarParams", block=True) == b"test"

  def test_params_unknown_key_fails(self):
    assert self.params.get("swag") is None
    assert not self.params.get_bool("swag")

    with pytest.raises(UnknownKeyName):
      self.params.put("swag", "abc")

    with pytest.raises(UnknownKeyName):
      self.params.put_bool("swag", True)

  def test_remove_not_there(self):
    assert self.params.get("CarParams") is None
    self.params.remove("CarParams")
    assert self.params.get("CarParams") is None

  def test_get_bool(self):
    self.params.remove("IsMetric")
    assert not self.params.get_bool("IsMetric")

    self.params.put_bool("IsMetric", True)
    assert self.params.get_bool("IsMetric")

    self.params.put_bool("IsMetric", False)
    assert not self.params.get_bool("IsMetric")

    self.params.put("IsMetric", True)
    assert self.params.get_bool("IsMetric")

    self.params.put("IsMetric", False)
    assert not self.params.get_bool("IsMetric")

  def test_put_non_blocking_with_get_block(self):
    q = Params()
    def _delayed_writer():
      time.sleep(0.1)
      Params().put_nonblocking("CarParams", b"test")
    threading.Thread(target=_delayed_writer).start()
    assert q.get("CarParams") is None
    assert q.get("CarParams", True) == b"test"

  def test_put_bool_non_blocking_with_get_block(self):
    q = Params()
    def _delayed_writer():
      time.sleep(0.1)
      Params().put_bool_nonblocking("CarParams", True)
    threading.Thread(target=_delayed_writer).start()
    assert q.get("CarParams") is None
    assert q.get("CarParams", True) == b"1"

  def test_put_nonblocking_latest_value_wins(self, tmp_path):
    q = Params(str(tmp_path))
    for i in range(100):
      q.put_nonblocking("CarParams", f"value-{i}".encode())

    del q

    r = Params(str(tmp_path))
    assert r.get("CarParams") == b"value-99"

  def test_params_all_keys(self):
    keys = Params().all_keys()

    # sanity checks
    assert len(keys) > 20
    assert len(keys) == len(set(keys))
    assert b"CarParams" in keys

  def test_params_default_value(self):
    self.params.remove("LanguageSetting")
    self.params.remove("LongitudinalPersonality")
    self.params.remove("LiveParameters")

    assert self.params.get("LanguageSetting") is None
    assert self.params.get("LanguageSetting", return_default=False) is None
    assert isinstance(self.params.get("LanguageSetting", return_default=True), str)
    assert isinstance(self.params.get("LongitudinalPersonality", return_default=True), int)
    assert self.params.get("LiveParameters") is None
    assert self.params.get("LiveParameters", return_default=True) is None

  def test_longitudinal_personality_profiles_json_round_trip(self):
    key = "LongitudinalPersonalityProfiles"
    value = {
      "schemaVersion": 1,
      "enabled": False,
      "axes": {
        "acceleration": {
          "speed": {"unit": "mph", "values": [0.0, 11.184681, 22.369363, 33.554044, 44.738726, 55.923407, 89.477452]},
          "value": {"unit": "m/s^2", "meaning": "maximum_requested_acceleration"},
        },
        "braking": {
          "speed": {"unit": "mph", "values": [0.0, 11.184681, 22.369363, 33.554044, 44.738726, 55.923407, 89.477452]},
          "value": {"unit": "m/s^2", "meaning": "cruise_slc_deceleration_magnitude"},
        },
        "following": {"speed": {"unit": "mph", "values": [0, 10, 20, 30, 40, 50, 60, 70, 80, 90]}, "value": {"unit": "s", "meaning": "base_time_headway"}},
      },
      "profiles": {},
    }
    self.params.remove(key)

    assert self.params.get_type(key) == ParamKeyType.JSON
    assert self.params.get(key) is None
    self.params.put(key, value)
    assert self.params.get(key) == value

  def test_params_get_type(self):
    # json
    self.params.put("ApiCache_DriveStats", {"a": 0})
    assert self.params.get("ApiCache_DriveStats") == {"a": 0}

    # int
    self.params.put("BootCount", 1441)
    assert self.params.get("BootCount") == 1441

    # bool
    self.params.put("AdbEnabled", True)
    assert self.params.get("AdbEnabled")
    assert isinstance(self.params.get("AdbEnabled"), bool)

    # time
    now = datetime.datetime.now(datetime.UTC)
    self.params.put("InstallDate", now)
    assert self.params.get("InstallDate") == now