ESPSomfy-RTS/test/test_utils/test_utils.cpp

#include <unity.h>
#include "Utils.h"

// The C runtime only picks up TZ after it is re-read.
static void setTZ(const char *tz) {
#ifdef _WIN32
  _putenv_s("TZ", tz);
  _tzset();
#else
  setenv("TZ", tz, 1);
  tzset();
#endif
}

// 2024-03-05T07:08:09Z
static const time_t SAMPLE_UTC = 1709622489;

void setUp() { setTZ("UTC0"); }
void tearDown() {}

/*********************************************************************
 * _trim
 ********************************************************************/
static void test_trim_strips_whitespace_and_quotes() {
  char str[] = " \t\"Living Room\"\r\n";
  _trim(str);
  TEST_ASSERT_EQUAL_STRING("Living Room", str);
}
static void test_trim_keeps_clean_string() {
  char str[] = "Kitchen";
  _trim(str);
  TEST_ASSERT_EQUAL_STRING("Kitchen", str);
}
static void test_trim_all_whitespace_becomes_empty() {
  char str[] = " \t\r\n\" ";
  _trim(str);
  TEST_ASSERT_EQUAL_STRING("", str);
}
static void test_trim_empty_string() {
  char str[] = "";
  _trim(str);
  TEST_ASSERT_EQUAL_STRING("", str);
}

/*********************************************************************
 * toBoolean
 ********************************************************************/
static void test_toBoolean_missing_uses_default() {
  TEST_ASSERT_TRUE(toBoolean(nullptr, true));
  TEST_ASSERT_FALSE(toBoolean(nullptr, false));
  TEST_ASSERT_TRUE(toBoolean("", true));
  TEST_ASSERT_FALSE(toBoolean("", false));
}
static void test_toBoolean_true_values() {
  TEST_ASSERT_TRUE(toBoolean("true", false));
  TEST_ASSERT_TRUE(toBoolean("True", false));
  TEST_ASSERT_TRUE(toBoolean("1", false));
}
static void test_toBoolean_false_values() {
  TEST_ASSERT_FALSE(toBoolean("false", true));
  TEST_ASSERT_FALSE(toBoolean("False", true));
  TEST_ASSERT_FALSE(toBoolean("0", true));
}
static void test_toBoolean_unknown_uses_default() {
  TEST_ASSERT_TRUE(toBoolean("yes", true));
  TEST_ASSERT_FALSE(toBoolean("yes", false));
}

/*********************************************************************
 * SETCHARPROP
 ********************************************************************/
static void test_setcharprop_copies_short_value() {
  char prop[8];
  SETCHARPROP(prop, "abc", sizeof(prop));
  TEST_ASSERT_EQUAL_STRING("abc", prop);
}
static void test_setcharprop_truncates_long_value() {
  char prop[5];
  SETCHARPROP(prop, "abcdefgh", sizeof(prop));
  TEST_ASSERT_EQUAL_STRING("abcd", prop);
}
static void test_setcharprop_unterminated_source() {
  // A coredump's app_elf_sha256 can be full of hex digits with no terminator.
  // The copy must stop inside the array and come out as a comparable string.
  const char crashed[17] = {'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f','9'};
  char sha[sizeof(crashed)];
  SETCHARPROP(sha, crashed, sizeof(sha));
  TEST_ASSERT_EQUAL_STRING("0123456789abcdef", sha);
  TEST_ASSERT_EQUAL_INT(0, strcmp(sha, "0123456789abcdef"));
}

/*********************************************************************
 * sortArray / sortArrayReverse
 ********************************************************************/
static bool absLarger(int a, int b) { return abs(a) > abs(b); }

static void test_sortArray_ascending() {
  int arr[] = {5, -1, 3, 0, 3};
  const int expected[] = {-1, 0, 3, 3, 5};
  sortArray(arr, 5);
  TEST_ASSERT_EQUAL_INT_ARRAY(expected, arr, 5);
}
static void test_sortArrayReverse_descending() {
  int arr[] = {5, -1, 3, 0, 3};
  const int expected[] = {5, 3, 3, 0, -1};
  sortArrayReverse(arr, 5);
  TEST_ASSERT_EQUAL_INT_ARRAY(expected, arr, 5);
}
static void test_sortArray_custom_comparator() {
  int arr[] = {-4, 1, 3, -2};
  const int expected[] = {1, -2, 3, -4};
  sortArray(arr, 4, absLarger);
  TEST_ASSERT_EQUAL_INT_ARRAY(expected, arr, 4);
  const int reversed[] = {-4, 3, -2, 1};
  sortArrayReverse(arr, 4, absLarger);
  TEST_ASSERT_EQUAL_INT_ARRAY(reversed, arr, 4);
}
static void test_sortArray_empty_and_single() {
  int one[] = {42};
  sortArray(one, 1);
  TEST_ASSERT_EQUAL_INT(42, one[0]);
  int none[] = {7};
  sortArray(none, 0);
  TEST_ASSERT_EQUAL_INT(7, none[0]);
}
static void test_sortArray_moves_free_ids_last() {
  // Free shade id slots are 255 and must end up after the used ones.
  uint8_t ids[] = {3, 255, 1, 255, 2};
  const uint8_t expected[] = {1, 2, 3, 255, 255};
  sortArray<uint8_t>(ids, sizeof(ids));
  TEST_ASSERT_EQUAL_UINT8_ARRAY(expected, ids, sizeof(ids));
}

/*********************************************************************
 * Timestamp
 ********************************************************************/
static struct tm sampleTm() {
  struct tm dt = {};
  dt.tm_year = 2024 - 1900;
  dt.tm_mon = 2;
  dt.tm_mday = 5;
  dt.tm_hour = 7;
  dt.tm_min = 8;
  dt.tm_sec = 9;
  return dt;
}
static void test_formatISO_offsets() {
  Timestamp ts;
  struct tm dt = sampleTm();
  TEST_ASSERT_EQUAL_STRING("2024-03-05T07:08:09.000+0000", ts.formatISO(&dt, 0));
  TEST_ASSERT_EQUAL_STRING("2024-03-05T07:08:09.000-0500", ts.formatISO(&dt, -500));
  TEST_ASSERT_EQUAL_STRING("2024-03-05T07:08:09.000+0530", ts.formatISO(&dt, 530));
}
static void test_calcTZOffset_whole_hours() {
  time_t t = SAMPLE_UTC;
  setTZ("UTC0");
  TEST_ASSERT_EQUAL_INT(0, Timestamp::calcTZOffset(&t));
  setTZ("EST5");
  TEST_ASSERT_EQUAL_INT(-500, Timestamp::calcTZOffset(&t));
}
static void test_calcTZOffset_half_hour_east() {
  time_t t = SAMPLE_UTC;
  setTZ("IST-5:30");
  TEST_ASSERT_EQUAL_INT(530, Timestamp::calcTZOffset(&t));
}
static void test_calcTZOffset_half_hour_west() {
  time_t t = SAMPLE_UTC;
  setTZ("NST3:30");
  TEST_ASSERT_EQUAL_INT(-330, Timestamp::calcTZOffset(&t));
}
static void test_parseUTCTime_in_utc() {
  setTZ("UTC0");
  TEST_ASSERT_EQUAL_INT64((int64_t)SAMPLE_UTC, (int64_t)Timestamp::parseUTCTime("2024-03-05T07:08:09Z"));
}
static void test_parseUTCTime_ignores_local_zone() {
  setTZ("IST-5:30");
  TEST_ASSERT_EQUAL_INT64((int64_t)SAMPLE_UTC, (int64_t)Timestamp::parseUTCTime("2024-03-05T07:08:09Z"));
}

/*********************************************************************
 * rssiNeedsEmit
 ********************************************************************/
static void test_rssiNeedsEmit_channel_change_always_emits() {
  TEST_ASSERT_TRUE(rssiNeedsEmit(-70, -70, 6, 11, 3));
}
static void test_rssiNeedsEmit_small_change_is_ignored() {
  TEST_ASSERT_FALSE(rssiNeedsEmit(-72, -70, 6, 6, 3));
}
static void test_rssiNeedsEmit_real_change_emits() {
  TEST_ASSERT_TRUE(rssiNeedsEmit(-73, -70, 6, 6, 3));
}
static void test_rssiNeedsEmit_either_direction() {
  TEST_ASSERT_TRUE(rssiNeedsEmit(-67, -70, 6, 6, 3));
  TEST_ASSERT_TRUE(rssiNeedsEmit(-73, -70, 6, 6, 3));
}

/*********************************************************************
 * RssiBroadcast
 ********************************************************************/
static RssiBroadcast broadcastOf(int rssi, int channel) {
  RssiBroadcast b;
  b.sent(rssi, channel);
  return b;
}
static void test_rssiBroadcast_first_status_is_due() {
  // Nothing broadcast since boot, so the first status tick after connecting
  // sends the signal.
  RssiBroadcast b;
  TEST_ASSERT_TRUE(b.due(-60, 6, 3));
}
static void test_rssiBroadcast_broadcast_moves_baseline() {
  RssiBroadcast b = broadcastOf(-60, 6);
  b.sent(-65, 6);
  TEST_ASSERT_EQUAL_INT(-65, b.rssi);
  // Measured from the new baseline.
  TEST_ASSERT_FALSE(b.due(-66, 6, 3));
  TEST_ASSERT_TRUE(b.due(-70, 6, 3));
}
static void test_rssiBroadcast_channel_change_is_due() {
  RssiBroadcast b = broadcastOf(-60, 6);
  TEST_ASSERT_TRUE(b.due(-60, 11, 3));
}

/*********************************************************************
 * emitAllowed
 ********************************************************************/
static int loopTask, wifiEventTask;
static void test_emitAllowed_on_the_loop_task() {
  TEST_ASSERT_TRUE(emitAllowed(&loopTask, &loopTask));
}
static void test_emitAllowed_refuses_another_task() {
  TEST_ASSERT_FALSE(emitAllowed(&wifiEventTask, &loopTask));
}
static void test_emitAllowed_before_the_owner_is_known() {
  // setup() before ProtoSocket::begin(), which is loop()'s task anyway.
  TEST_ASSERT_TRUE(emitAllowed(&loopTask, nullptr));
}

/*********************************************************************
 * worthRoaming
 ********************************************************************/
static void test_worthRoaming_needs_the_full_gain() {
  TEST_ASSERT_FALSE(worthRoaming(true, -70, -65, 6));
  TEST_ASSERT_TRUE(worthRoaming(true, -70, -64, 6));
  TEST_ASSERT_TRUE(worthRoaming(true, -70, -50, 6));
}
static void test_worthRoaming_never_to_a_weaker_ap() {
  // The scan also lists the AP we are on.
  TEST_ASSERT_FALSE(worthRoaming(true, -70, -70, 6));
  TEST_ASSERT_FALSE(worthRoaming(true, -70, -80, 6));
}
static void test_worthRoaming_any_ap_while_disconnected() {
  TEST_ASSERT_TRUE(worthRoaming(false, 0, -90, 6));
}

/*********************************************************************
 * otaProven
 ********************************************************************/
static void test_otaProven_after_the_minimum_uptime_with_network() {
  TEST_ASSERT_TRUE(otaProven(true, 60000, 60000));
  TEST_ASSERT_TRUE(otaProven(true, 3600000, 60000));
}
static void test_otaProven_not_before_the_minimum_uptime() {
  TEST_ASSERT_FALSE(otaProven(true, 59999, 60000));
}
static void test_otaProven_not_without_network() {
  // A firmware that can't connect would leave the device unreachable.
  TEST_ASSERT_FALSE(otaProven(false, 3600000, 60000));
}

/*********************************************************************
 * releaseAssetName
 ********************************************************************/
static void test_releaseAssetName_matches_the_release_workflow() {
  // .github/workflows/build.yaml fwname and fsname, from ConfigSettings::chipModel.
  char buf[64];
  releaseAssetName(buf, sizeof(buf), "ino", "");
  TEST_ASSERT_EQUAL_STRING("SomfyController.ino.esp32.bin", buf);
  releaseAssetName(buf, sizeof(buf), "littlefs", "s3");
  TEST_ASSERT_EQUAL_STRING("SomfyController.littlefs.esp32s3.bin", buf);
  releaseAssetName(buf, sizeof(buf), "ino", "c3");
  TEST_ASSERT_EQUAL_STRING("SomfyController.ino.esp32c3.bin", buf);
  releaseAssetName(buf, sizeof(buf), "ino", "c5");
  TEST_ASSERT_EQUAL_STRING("SomfyController.ino.esp32c5.bin", buf);
  releaseAssetName(buf, sizeof(buf), "littlefs", "c6");
  TEST_ASSERT_EQUAL_STRING("SomfyController.littlefs.esp32c6.bin", buf);
}

/*********************************************************************
 * formatBacktrace
 ********************************************************************/
static void test_formatBacktrace_frames_the_dump_holds() {
  const uint32_t bt[16] = {0x40083c19, 0x4008e42d, 0x00000011};
  char buf[256];
  formatBacktrace(buf, sizeof(buf), bt, 16, 3);
  TEST_ASSERT_EQUAL_STRING(" 0x40083c19 0x4008e42d 0x00000011", buf);
}
static void test_formatBacktrace_garbage_depth_stays_in_bounds() {
  // A half-written dump reads back as the 0xa5 stack fill: depth 0xa5a5a5a5.
  // setup() looped that many times and overran bt[] and its buffer.
  struct { uint32_t bt[16]; uint32_t depth; } summary;
  memset(&summary, 0xa5, sizeof(summary));
  struct { char buf[256]; char guard[16]; } out;
  memset(out.guard, 'G', sizeof(out.guard));
  formatBacktrace(out.buf, sizeof(out.buf), summary.bt, 16, summary.depth);
  TEST_ASSERT_EQUAL(16 * 11, strlen(out.buf));
  for (size_t i = 0; i < sizeof(out.guard); i++) TEST_ASSERT_EQUAL_CHAR('G', out.guard[i]);
}
static void test_formatBacktrace_stops_when_the_buffer_is_full() {
  const uint32_t bt[16] = {0};
  struct { char buf[30]; char guard[16]; } out;
  memset(out.guard, 'G', sizeof(out.guard));
  formatBacktrace(out.buf, sizeof(out.buf), bt, 16, 16);
  TEST_ASSERT_EQUAL(sizeof(out.buf) - 1, strlen(out.buf));
  for (size_t i = 0; i < sizeof(out.guard); i++) TEST_ASSERT_EQUAL_CHAR('G', out.guard[i]);
}

/*********************************************************************
 * wifiAuthModeName
 ********************************************************************/
static void test_wifiAuthModeName_matches_the_idf_enum() {
  TEST_ASSERT_EQUAL_STRING("OPEN", wifiAuthModeName(0));
  TEST_ASSERT_EQUAL_STRING("WPA2", wifiAuthModeName(3));
  TEST_ASSERT_EQUAL_STRING("WPA3", wifiAuthModeName(6));
  TEST_ASSERT_EQUAL_STRING("WPA2/WPA3", wifiAuthModeName(7));
  TEST_ASSERT_EQUAL_STRING("WAPI", wifiAuthModeName(8));
}
static void test_wifiAuthModeName_unknown_past_the_shared_values() {
  TEST_ASSERT_EQUAL_STRING("UNKNOWN", wifiAuthModeName(9));
  TEST_ASSERT_EQUAL_STRING("UNKNOWN", wifiAuthModeName(255));
}

/*********************************************************************
 * LoopStats
 ********************************************************************/
static void test_loopStats_rate_is_passes_per_second() {
  LoopStats stats;
  for(int i = 0; i < 4500; i++) stats.record(100);
  TEST_ASSERT_EQUAL_UINT32(1500, stats.rate(3000));
}
static void test_loopStats_empty_window_has_no_rate() {
  LoopStats stats;
  stats.record(100);
  TEST_ASSERT_EQUAL_UINT32(0, stats.rate(0));
}
static void test_loopStats_keeps_the_longest_pass() {
  LoopStats stats;
  stats.record(120);
  stats.record(4800);
  stats.record(90);
  TEST_ASSERT_EQUAL_UINT32(4800, stats.maxUs());
}
static void test_loopStats_nothing_published_before_the_first_window() {
  LoopStats stats;
  stats.record(4800);
  TEST_ASSERT_EQUAL_UINT32(0, stats.publishedRate());
  TEST_ASSERT_EQUAL_UINT32(0, stats.publishedMaxUs());
}
static void test_loopStats_publish_keeps_the_window_and_starts_a_new_one() {
  LoopStats stats;
  for(int i = 0; i < 300; i++) stats.record(100);
  stats.record(4800);
  stats.publish(1000);
  TEST_ASSERT_EQUAL_UINT32(301, stats.publishedRate());
  TEST_ASSERT_EQUAL_UINT32(4800, stats.publishedMaxUs());
  TEST_ASSERT_EQUAL_UINT32(0, stats.rate(1000));
  TEST_ASSERT_EQUAL_UINT32(0, stats.maxUs());
  for(int i = 0; i < 50; i++) stats.record(200);
  // The new window started at the publish, not at boot.
  TEST_ASSERT_EQUAL_UINT32(100, stats.rate(1500));
  TEST_ASSERT_EQUAL_UINT32(200, stats.maxUs());
  TEST_ASSERT_EQUAL_UINT32(301, stats.publishedRate());
}
static void test_loopStats_reading_does_not_reset_the_window() {
  LoopStats stats;
  stats.record(4800);
  (void)stats.rate(500);
  (void)stats.maxUs();
  stats.record(100);
  TEST_ASSERT_EQUAL_UINT32(4800, stats.maxUs());
  TEST_ASSERT_EQUAL_UINT32(2, stats.rate(1000));
}
static void test_loopStats_window_across_millis_wrap() {
  LoopStats stats;
  stats.publish(0xFFFFFE00);
  for(int i = 0; i < 1024; i++) stats.record(100);
  // 0x200 ms before the wrap plus 0x200 after it is 1024 ms.
  TEST_ASSERT_EQUAL_UINT32(1000, stats.rate(0x00000200));
}
int main(int argc, char **argv) {
  (void)argc;
  (void)argv;
  UNITY_BEGIN();
  RUN_TEST(test_trim_strips_whitespace_and_quotes);
  RUN_TEST(test_trim_keeps_clean_string);
  RUN_TEST(test_trim_all_whitespace_becomes_empty);
  RUN_TEST(test_trim_empty_string);
  RUN_TEST(test_toBoolean_missing_uses_default);
  RUN_TEST(test_toBoolean_true_values);
  RUN_TEST(test_toBoolean_false_values);
  RUN_TEST(test_toBoolean_unknown_uses_default);
  RUN_TEST(test_setcharprop_copies_short_value);
  RUN_TEST(test_setcharprop_truncates_long_value);
  RUN_TEST(test_setcharprop_unterminated_source);
  RUN_TEST(test_sortArray_ascending);
  RUN_TEST(test_sortArrayReverse_descending);
  RUN_TEST(test_sortArray_custom_comparator);
  RUN_TEST(test_sortArray_empty_and_single);
  RUN_TEST(test_sortArray_moves_free_ids_last);
  RUN_TEST(test_formatISO_offsets);
  RUN_TEST(test_calcTZOffset_whole_hours);
  RUN_TEST(test_calcTZOffset_half_hour_east);
  RUN_TEST(test_calcTZOffset_half_hour_west);
  RUN_TEST(test_parseUTCTime_in_utc);
  RUN_TEST(test_parseUTCTime_ignores_local_zone);
  RUN_TEST(test_rssiNeedsEmit_channel_change_always_emits);
  RUN_TEST(test_rssiNeedsEmit_small_change_is_ignored);
  RUN_TEST(test_rssiNeedsEmit_real_change_emits);
  RUN_TEST(test_rssiNeedsEmit_either_direction);
  RUN_TEST(test_rssiBroadcast_first_status_is_due);
  RUN_TEST(test_rssiBroadcast_broadcast_moves_baseline);
  RUN_TEST(test_rssiBroadcast_channel_change_is_due);
  RUN_TEST(test_emitAllowed_on_the_loop_task);
  RUN_TEST(test_emitAllowed_refuses_another_task);
  RUN_TEST(test_emitAllowed_before_the_owner_is_known);
  RUN_TEST(test_worthRoaming_needs_the_full_gain);
  RUN_TEST(test_worthRoaming_never_to_a_weaker_ap);
  RUN_TEST(test_worthRoaming_any_ap_while_disconnected);
  RUN_TEST(test_otaProven_after_the_minimum_uptime_with_network);
  RUN_TEST(test_otaProven_not_before_the_minimum_uptime);
  RUN_TEST(test_otaProven_not_without_network);
  RUN_TEST(test_releaseAssetName_matches_the_release_workflow);
  RUN_TEST(test_formatBacktrace_frames_the_dump_holds);
  RUN_TEST(test_formatBacktrace_garbage_depth_stays_in_bounds);
  RUN_TEST(test_formatBacktrace_stops_when_the_buffer_is_full);
  RUN_TEST(test_wifiAuthModeName_matches_the_idf_enum);
  RUN_TEST(test_wifiAuthModeName_unknown_past_the_shared_values);
  RUN_TEST(test_loopStats_rate_is_passes_per_second);
  RUN_TEST(test_loopStats_empty_window_has_no_rate);
  RUN_TEST(test_loopStats_keeps_the_longest_pass);
  RUN_TEST(test_loopStats_nothing_published_before_the_first_window);
  RUN_TEST(test_loopStats_publish_keeps_the_window_and_starts_a_new_one);
  RUN_TEST(test_loopStats_reading_does_not_reset_the_window);
  RUN_TEST(test_loopStats_window_across_millis_wrap);
  return UNITY_END();
}