mirror of
https://github.com/liquidraver/ZephCore.git
synced 2026-10-14 22:07:17 +00:00
198 lines
8.9 KiB
C++
198 lines
8.9 KiB
C++
// prefs.json (helpers/PrefsJson.cpp over upstream's ConfigSerializer).
|
|
#include "test.h"
|
|
#include "PrefsJson.h"
|
|
#include "PrefsCodec.h"
|
|
|
|
#include <cstring>
|
|
#include <string>
|
|
|
|
namespace {
|
|
|
|
class MemStream : public Stream {
|
|
public:
|
|
std::string data;
|
|
size_t pos = 0;
|
|
explicit MemStream(std::string s = "") : data(std::move(s)) {}
|
|
size_t write(uint8_t c) override { data.push_back((char)c); return 1; }
|
|
int available() override { return (int)(data.size() - pos); }
|
|
int read() override { return pos < data.size() ? (uint8_t)data[pos++] : -1; }
|
|
int peek() override { return pos < data.size() ? (uint8_t)data[pos] : -1; }
|
|
};
|
|
|
|
NodePrefs defaults() { NodePrefs p; initNodePrefs(&p); return p; }
|
|
|
|
// Same field values as the codec tests: every serialized field off its default.
|
|
NodePrefs sample() {
|
|
NodePrefs p = defaults();
|
|
p.airtime_factor = 3.5f; strcpy(p.node_name, "Node-Test");
|
|
p.node_lat = 47.5; p.node_lon = 19.04;
|
|
strcpy(p.password, "adminpw"); strcpy(p.guest_password, "guestpw");
|
|
p.freq = 869.525f; p.sf = 9; p.cr = 6; p.bw = 125.0f; p.tx_power_dbm = 14;
|
|
p.disable_fwd = 1; p.advert_interval = 30; p.flood_advert_interval = 12;
|
|
p.rx_delay_base = 1.5f; p.tx_delay_factor = 0.7f; p.direct_tx_delay_factor = 0.4f;
|
|
p.backoff_multiplier = 0.6f; p.allow_read_only = 1; p.multi_acks = 1;
|
|
p.flood_max = 20; p.flood_max_unscoped = 10; p.flood_max_advert = 4;
|
|
p.interference_threshold = 7; p.leds_disabled = 1; p.leds_radio_mode = LEDS_RADIO_RX;
|
|
p.leds_hb_mode = LEDS_HB_UNREAD; p.led_brightness = 42; p.powersaving_enabled = 1; p.gps_enabled = 1;
|
|
p.gps_interval = 600; p.advert_loc_policy = ADVERT_LOC_SHARE; p.discovery_mod_timestamp = 123456;
|
|
p.adc_multiplier = 1.25f; strcpy(p.owner_info, "owner info");
|
|
p.rx_boost = 0; p.fem_rxgain = 0; p.rx_duty_cycle = 1;
|
|
p.meshtimesync = 1; p.cad_auto = 0; p.cad_offset = -3; p.probe_interval = 30; p.cad_busycap = 40;
|
|
p.extra_sf[0] = 10; p.extra_sf[1] = 11; p.extra_sf[2] = 0;
|
|
p.display_rotate = 1; p.input_rotate = 1; p.tz_offset = -5; p.cad_base = 21;
|
|
p.manual_add_contacts = 1; p.telemetry_mode_base = 1; p.telemetry_mode_loc = 2;
|
|
p.telemetry_mode_env = 1; p.ble_pin = 123456; p.buzzer_quiet = 1; p.autoadd_config = 0x1E;
|
|
p.client_repeat = 1; p.path_hash_mode = 2; p.autoadd_max_hops = 5; p.loop_detect = 3;
|
|
strcpy(p.default_scope_name, "#hu");
|
|
for (int i = 0; i < 16; i++) p.default_scope_key[i] = (uint8_t)(i + 1);
|
|
p.ble_disabled = 1; p.display_brightness = 50; p.wake_on_msg = 0; p.screen_off_secs = 60;
|
|
p.auto_shutdown_mv = 3300; p.v_contact_enabled = 0; p.v_battery_alert_mv = 3500;
|
|
p.v_contact_flags = 0x81; p.wifi_enabled = 0; p.offgrid_home_freq = 869.618f;
|
|
strcpy(p.wifi_ssid, "MyNet"); strcpy(p.wifi_pwd, "secret");
|
|
return p;
|
|
}
|
|
|
|
std::string companionBytes(const NodePrefs &p) {
|
|
uint8_t b[COMPANION_PREFS_SIZE];
|
|
companionPrefsEncode(p, b, sizeof(b));
|
|
return std::string((const char *)b, sizeof(b));
|
|
}
|
|
std::string serverBytes(const NodePrefs &p) {
|
|
uint8_t b[SERVER_PREFS_SIZE];
|
|
serverPrefsEncode(p, b, sizeof(b));
|
|
return std::string((const char *)b, sizeof(b));
|
|
}
|
|
|
|
} // namespace
|
|
|
|
TEST(pjson_companion_roundtrip, "UNIT-PJSON-001", "Companion prefs survive prefs.json field for field") {
|
|
NodePrefs p = sample();
|
|
MemStream s;
|
|
CHECK(companionPrefsToJson(p, s));
|
|
NodePrefs q = defaults();
|
|
CHECK(companionPrefsFromJson(q, s));
|
|
// Every field of the binary layout, as a legacy file migrated to JSON.
|
|
CHECK(companionBytes(q) == companionBytes(p));
|
|
// prefs.json only: not in the binary layout.
|
|
CHECK(q.led_brightness == 42);
|
|
CHECK(q.offgrid_home_freq == 869.618f);
|
|
}
|
|
|
|
TEST(pjson_server_roundtrip, "UNIT-PJSON-002", "Server prefs survive prefs.json field for field") {
|
|
NodePrefs p = sample();
|
|
MemStream s;
|
|
CHECK(serverPrefsToJson(p, s));
|
|
NodePrefs q = defaults();
|
|
CHECK(serverPrefsFromJson(q, s));
|
|
CHECK(serverBytes(q) == serverBytes(p));
|
|
CHECK(q.led_brightness == 42);
|
|
}
|
|
|
|
TEST(pjson_upstream_file, "UNIT-PJSON-003", "A companion prefs.json as upstream v1.17 writes it loads") {
|
|
MemStream s("{name:\"Up\",lat:1.5,lon:2.5,radio:{freq:869.6180,bw:62.5000,sf:8,cr:5,cad:1,"
|
|
"int_thr:0,rxgain:1,fem_rxgain:0,fem_txgain:0,tx:20,af:9.0000,rxdelay:0,"
|
|
"f_txdelay:0.5000,d_txdelay:0.3000,agc_int:0,hash_mode:1,multi_ack:0},"
|
|
"gps:{en:0,int:300,adv_loc:0},repeat:{disable:0},comp:{auto_max:3,defs_nm:\"\","
|
|
"defs_key:\"000102030405060708090A0B0C0D0E0F\",pin:0,buzz_q:1,vibe_q:0,auto_add:0,"
|
|
"man_add:0,tel_base:0,tel_loc:0,tel_env:0,tz_offset:2},custom:{},"
|
|
"wifi:{ssid:\"x\",pwd:\"y\",enabled:1}}");
|
|
NodePrefs q = defaults();
|
|
CHECK(companionPrefsFromJson(q, s));
|
|
CHECK(std::strcmp(q.node_name, "Up") == 0);
|
|
CHECK(q.sf == 8 && q.tx_power_dbm == 20 && q.freq == 869.618f && q.bw == 62.5f);
|
|
CHECK(q.client_repeat == 1);
|
|
CHECK(q.autoadd_max_hops == 3 && q.buzzer_quiet == 1 && q.tz_offset == 2);
|
|
CHECK(q.default_scope_key[15] == 0x0F);
|
|
CHECK(std::strcmp(q.wifi_ssid, "x") == 0 && std::strcmp(q.wifi_pwd, "y") == 0);
|
|
// No "zc" object: ZephCore's own fields keep their defaults.
|
|
NodePrefs d = defaults();
|
|
CHECK(q.cad_auto == d.cad_auto && q.probe_interval == d.probe_interval && q.wake_on_msg == d.wake_on_msg);
|
|
}
|
|
|
|
TEST(pjson_parse_errors, "UNIT-PJSON-004", "A broken prefs.json leaves prefs untouched, an empty object changes nothing") {
|
|
const char *broken[] = { "{name:\"x\"", "{radio:{sf:9}", "name:\"x\"}", "{na-me:1}" };
|
|
for (const char *text : broken) {
|
|
NodePrefs q = sample();
|
|
std::string before = companionBytes(q);
|
|
MemStream s(text);
|
|
if (companionPrefsFromJson(q, s)) throw std::runtime_error(std::string("accepted: ") + text);
|
|
CHECK(companionBytes(q) == before);
|
|
}
|
|
NodePrefs q = sample();
|
|
std::string before = serverBytes(q);
|
|
MemStream s("{}");
|
|
CHECK(serverPrefsFromJson(q, s));
|
|
CHECK(serverBytes(q) == before);
|
|
}
|
|
|
|
TEST(pjson_strings, "UNIT-PJSON-005", "Quotes, backslashes, newlines and UTF-8 in strings round trip") {
|
|
NodePrefs p = sample();
|
|
strcpy(p.node_name, "A \"q\" \\b \xF0\x9F\x93\xA1");
|
|
strcpy(p.owner_info, "line1\nline2\r\"x\"");
|
|
strcpy(p.wifi_pwd, "p\"w\\d");
|
|
MemStream s;
|
|
CHECK(serverPrefsToJson(p, s));
|
|
NodePrefs q = defaults();
|
|
CHECK(serverPrefsFromJson(q, s));
|
|
CHECK(std::strcmp(q.node_name, p.node_name) == 0);
|
|
CHECK(std::strcmp(q.owner_info, p.owner_info) == 0);
|
|
MemStream c;
|
|
CHECK(companionPrefsToJson(p, c));
|
|
NodePrefs r = defaults();
|
|
CHECK(companionPrefsFromJson(r, c));
|
|
CHECK(std::strcmp(r.wifi_pwd, p.wifi_pwd) == 0);
|
|
}
|
|
|
|
TEST(pjson_radio_floats, "UNIT-PJSON-006", "Frequencies and bandwidths survive the 4-decimal float encoding exactly") {
|
|
const float freqs[] = { 433.175f, 433.875f, 868.1f, 869.4125f, 869.525f, 869.618f, 902.125f,
|
|
915.0f, 916.575f, 918.25f, 923.2f, 2400.0f, 2450.12f };
|
|
const float bws[] = { 7.8f, 10.4f, 15.6f, 20.8f, 31.25f, 41.7f, 62.5f, 125.0f, 250.0f, 500.0f };
|
|
for (float f : freqs) {
|
|
for (float bw : bws) {
|
|
NodePrefs p = sample();
|
|
p.freq = f; p.bw = bw;
|
|
MemStream s;
|
|
CHECK(companionPrefsToJson(p, s));
|
|
NodePrefs q = defaults();
|
|
CHECK(companionPrefsFromJson(q, s));
|
|
if (q.freq != f || q.bw != bw)
|
|
throw std::runtime_error("freq " + std::to_string(f) + " bw " + std::to_string(bw));
|
|
}
|
|
}
|
|
}
|
|
|
|
TEST(pjson_bad_radio, "UNIT-PJSON-007", "An implausible radio preset in prefs.json falls back to the defaults") {
|
|
MemStream s("{name:\"Z\",radio:{freq:5000,sf:9,tx:14},gps:{int:900}}");
|
|
NodePrefs q = defaults();
|
|
CHECK(serverPrefsFromJson(q, s));
|
|
CHECK(q.freq == mesh::LoRaConfig::FREQ_MHZ);
|
|
CHECK(q.sf == mesh::LoRaConfig::SPREADING_FACTOR);
|
|
CHECK(q.tx_power_dbm == mesh::LoRaConfig::TX_POWER_DBM);
|
|
CHECK(std::strcmp(q.node_name, "Z") == 0);
|
|
CHECK(q.gps_interval == 900);
|
|
}
|
|
|
|
TEST(pjson_server_gps_upgrade, "UNIT-PJSON-008", "Server gps.en: a file without zc.gps_set is upgraded to on once, then honoured") {
|
|
// Written before slice 10, when servers ran the GPS whatever gps.en said.
|
|
MemStream old_file("{name:\"R\",gps:{en:0,int:172800}}");
|
|
NodePrefs q = defaults();
|
|
CHECK(serverPrefsFromJson(q, old_file));
|
|
CHECK(q.gps_enabled == 1 && q.gps_enabled_set == 1);
|
|
|
|
// `gps off` after the upgrade: saved with the marker, so it holds.
|
|
q.gps_enabled = 0;
|
|
MemStream s;
|
|
CHECK(serverPrefsToJson(q, s));
|
|
NodePrefs r = defaults();
|
|
r.gps_enabled = 1;
|
|
CHECK(serverPrefsFromJson(r, s));
|
|
CHECK(r.gps_enabled == 0 && r.gps_enabled_set == 1);
|
|
|
|
// The companion has no such history: its gps.en is taken as written.
|
|
MemStream comp("{name:\"C\",gps:{en:0}}");
|
|
NodePrefs c = defaults();
|
|
c.gps_enabled = 1;
|
|
CHECK(companionPrefsFromJson(c, comp));
|
|
CHECK(c.gps_enabled == 0);
|
|
}
|