pebble/tests/fw/util/test_stringlist.c

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "util/stringlist.h"

#include "clar.h"

// Setup
////////////////////////////////////////////////////////////////

void test_stringlist__initialize(void) {
}

void test_stringlist__cleanup(void) {
}

// Tests
////////////////////////////////////////////////////////////////

void test_stringlist__test(void) {
  StringList *list = malloc(20);
  memset(list, 0, 20);
  // no data
  list->serialized_byte_length = 0;
  cl_assert_equal_i(0, string_list_count(list));

  list->serialized_byte_length = 3;
  // 4 empty strings
  cl_assert_equal_i(4, string_list_count(list));
  cl_assert_equal_s("", string_list_get_at(list, 0));
  cl_assert_equal_s("", string_list_get_at(list, 1));
  cl_assert_equal_s("", string_list_get_at(list, 2));
  cl_assert_equal_s("", string_list_get_at(list, 3));

  // non-null-terminated string is treated as one string - this is the standard case
  // please note that the string will only be terminated if there's another \0 following
  // when deserializing the data, the deserializer will append the needed \0
  list->serialized_byte_length = 3;
  list->data[0] = 'a';
  list->data[1] = 'b';
  list->data[2] = 'c'; // end of data
  list->data[3] = 'd';
  list->data[4] = '\0';
  cl_assert_equal_i(1, string_list_count(list));
  cl_assert_equal_s("abcd", string_list_get_at(list, 0));

  // 1 string (null terminated) => 2 strings, last is empty
  list->serialized_byte_length = 3;
  list->data[0] = 'a';
  list->data[1] = 'b';
  list->data[2] = '\0'; // end of data
  list->data[3] = '\0';
  cl_assert_equal_i(2, string_list_count(list));
  cl_assert_equal_s("ab", string_list_get_at(list, 0));
  cl_assert_equal_s("", string_list_get_at(list, 1));

  // 2 strings (non-null terminated) - this is the standard case
  list->serialized_byte_length = 4;
  list->data[0] = 'a';
  list->data[1] = 'b';
  list->data[2] = '\0';
  list->data[3] = 'c'; // end of data
  list->data[4] = '\0';
  cl_assert_equal_i(2, string_list_count(list));
  cl_assert_equal_s("ab", string_list_get_at(list, 0));
  cl_assert_equal_s("c", string_list_get_at(list, 1));

  // 3 strings (last two are is empty)
  list->serialized_byte_length = 4;
  list->data[0] = 'a';
  list->data[1] = 'b';
  list->data[2] = '\0';
  list->data[3] = '\0'; // end of data
  list->data[4] = '\0';
  cl_assert_equal_i(3, string_list_count(list));
  cl_assert_equal_s("ab", string_list_get_at(list, 0));
  cl_assert_equal_s("", string_list_get_at(list, 1));
  cl_assert_equal_s("", string_list_get_at(list, 2));
  cl_assert_equal_s(NULL, string_list_get_at(list, 3));

  // 4 strings (first and last two are empty)
  list->serialized_byte_length = 4;
  list->data[0] = '\0';
  list->data[1] = 'b';
  list->data[2] = '\0';
  list->data[3] = '\0'; // end of data
  list->data[4] = '\0';
  cl_assert_equal_i(4, string_list_count(list));
  cl_assert_equal_s("", string_list_get_at(list, 0));
  cl_assert_equal_s("b", string_list_get_at(list, 1));
  cl_assert_equal_s("", string_list_get_at(list, 2));
  cl_assert_equal_s("", string_list_get_at(list, 3));

  // 2 strings (last is not terminated and will fall through) will return 2 strings
  // when deserializing, the deserializer puts a \0 at the end
  // this case demonstrates the problem with incorrectly initialized data
  list->serialized_byte_length = 3;
  list->data[0] = 'a';
  list->data[1] = '\0';
  list->data[2] = 'b'; // end of data
  list->data[3] = 'c';
  list->data[4] = '\0';
  cl_assert_equal_i(2, string_list_count(list));
  cl_assert_equal_s("a", string_list_get_at(list, 0));
  cl_assert_equal_s("bc", string_list_get_at(list, 1));

  // add a string to an empty string list
  list->serialized_byte_length = 0;
  string_list_add_string(list, 20, "hello", 10);
  cl_assert_equal_i(5, list->serialized_byte_length);
  cl_assert_equal_i(1, string_list_count(list));
  cl_assert_equal_s("hello", string_list_get_at(list, 0));

  // add a string to string list with strings
  string_list_add_string(list, 20, "world", 10);
  cl_assert_equal_i(11, list->serialized_byte_length);
  cl_assert_equal_i(2, string_list_count(list));
  cl_assert_equal_s("world", string_list_get_at(list, 1));

  // truncated because of the max string size
  string_list_add_string(list, 20, "foobar", 3);
  cl_assert_equal_i(15, list->serialized_byte_length);
  cl_assert_equal_i(3, string_list_count(list));
  cl_assert_equal_s("foo", string_list_get_at(list, 2));

  // truncated because of the max list size
  string_list_add_string(list, 20, "abc", 10);
  cl_assert_equal_i(17, list->serialized_byte_length);
  cl_assert_equal_i(4, string_list_count(list));
  cl_assert_equal_s("a", string_list_get_at(list, 3));
}