Tactility/Modules/app-module/tests/source/env_test.cpp

#include "doctest.h"

#include <app/env.h>
#include <app/event.h>
#include <app/loader.h>
#include <app/manager.h>
#include <app/private/env_internal.h>
#include <app/scheduler.h>
#include <app/start.h>

#include <service/manager.h>

#include <tactility/delay.h>
#include <tactility/freertos/task.h>

#include <algorithm>
#include <atomic>
#include <cstring>
#include <string>
#include <vector>

extern ServiceManifest app_internal_loader_service_manifest;

namespace {

// See manager_test.cpp's own copy of this helper for why this checks the registry directly
// rather than a per-translation-unit static bool, and why APP_LOCATION_MEMORY (the real,
// already-shared app_internal_loader_service_manifest) is used here instead of a second
// competing fake APP_LOCATION_PATH loader.
void ensure_memory_loader_registered() {
    if (service_manager_find_instance(APP_LOADER_MEMORY_SERVICE_ID) == nullptr) {
        service_manager_add(&app_internal_loader_service_manifest, /*auto_start=*/true);
    }
}

// Set by env_test_app_main() (below) once it has finished exercising app_env_*() - a test thread
// waits on this before reading the results_* variables, since reaching
// APP_INSTANCE_STATE_ACTIVE only means the instance's task has started, not that
// env_test_app_main() has gotten this far.
std::atomic<bool> results_ready { false };

bool result_get_before_set_is_null;
bool result_set_returns_ok;
bool result_get_after_set_matches;
bool result_no_overwrite_returns_ok;
bool result_no_overwrite_value_unchanged;
bool result_overwrite_returns_ok;
bool result_overwrite_value_changed;
bool result_put_returns_ok;
bool result_get_after_put_matches;
bool result_unset_returns_ok;
bool result_get_after_unset_is_null;
bool result_seeded_value_matches;

// Runs entirely on the app's own task, so app_scheduler_current_app_id() (which every
// app_env_*() call resolves against) actually names this instance - exercising the same call
// path a real app's own main() would use, not the test runner's task.
int32_t env_test_app_main(int, char**) {
    result_get_before_set_is_null = app_env_get("TEST_VAR") == nullptr;

    result_set_returns_ok = app_env_set("TEST_VAR", "one", true) == ERROR_NONE;
    const char* after_set = app_env_get("TEST_VAR");
    result_get_after_set_matches = after_set != nullptr && strcmp(after_set, "one") == 0;

    result_no_overwrite_returns_ok = app_env_set("TEST_VAR", "two", false) == ERROR_NONE;
    const char* after_no_overwrite = app_env_get("TEST_VAR");
    result_no_overwrite_value_unchanged = after_no_overwrite != nullptr && strcmp(after_no_overwrite, "one") == 0;

    result_overwrite_returns_ok = app_env_set("TEST_VAR", "three", true) == ERROR_NONE;
    const char* after_overwrite = app_env_get("TEST_VAR");
    result_overwrite_value_changed = after_overwrite != nullptr && strcmp(after_overwrite, "three") == 0;

    result_put_returns_ok = app_env_put("PUT_VAR=put_value") == ERROR_NONE;
    const char* after_put = app_env_get("PUT_VAR");
    result_get_after_put_matches = after_put != nullptr && strcmp(after_put, "put_value") == 0;

    result_unset_returns_ok = app_env_unset("TEST_VAR") == ERROR_NONE;
    result_get_after_unset_is_null = app_env_get("TEST_VAR") == nullptr;

    const char* seeded = app_env_get("SEEDED_VAR");
    result_seeded_value_matches = seeded != nullptr && strcmp(seeded, "seeded_value") == 0;

    results_ready.store(true, std::memory_order_release);

    // Same subscribe-until-close contract as every other fake app in this test suite.
    TaskEventGroup event_group {};
    task_event_group_construct(&event_group);
    AppEventSubscription sub {};
    app_event_subscribe(&sub, &event_group);
    while (true) {
        if (task_event_group_wait_any(&event_group, nullptr, pdMS_TO_TICKS(5000)) != ERROR_NONE) {
            break; // safety net so a bug here can't hang the test suite
        }
        bool done = false;
        AppEvent event {};
        while (app_event_poll(&sub, &event) == ERROR_NONE) {
            if (event.type == APP_EVENT_CLOSE) {
                done = true;
                break;
            }
        }
        if (done) break;
    }
    app_event_unsubscribe(&sub);
    task_event_group_destruct(&event_group);
    return 0;
}

// Set by env_child_main() (below) once it has checked its own inherited/overridden environment.
std::atomic<bool> child_results_ready { false };

bool result_child_inherited_var_matches;
bool result_child_override_var_matches;
bool result_child_only_var_matches;

// The child in the parent/child inheritance test below - checks what it sees, stashes the
// result, and returns immediately (no subscribe loop needed: nothing sends it APP_EVENT_CLOSE).
int32_t env_child_main(int, char**) {
    const char* inherited = app_env_get("INHERITED_VAR");
    result_child_inherited_var_matches = inherited != nullptr && strcmp(inherited, "parent_value") == 0;

    const char* overridden = app_env_get("OVERRIDE_VAR");
    result_child_override_var_matches = overridden != nullptr && strcmp(overridden, "child_value") == 0;

    const char* child_only = app_env_get("CHILD_ONLY_VAR");
    result_child_only_var_matches = child_only != nullptr && strcmp(child_only, "child_value") == 0;

    child_results_ready.store(true, std::memory_order_release);
    return 0;
}

// The parent in the parent/child inheritance test below: sets its own environment, then starts
// env_child_main() as a modal child (app_start_context_set_parent()) with its own explicit
// environment that overrides one of the parent's variables and adds a new one.
int32_t env_parent_main(int, char**) {
    // Subscribed before the child is started, not after: env_child_main() can finish and set
    // child_results_ready before this task gets back around to subscribing, so the test thread
    // is free to call app_manager_stop() (APP_EVENT_CLOSE) the moment it observes that - which
    // would otherwise have no subscriber to deliver to, leaving this task stuck in its wait loop
    // until the stop call's own timeout.
    TaskEventGroup event_group {};
    task_event_group_construct(&event_group);
    AppEventSubscription sub {};
    app_event_subscribe(&sub, &event_group);

    app_env_set("INHERITED_VAR", "parent_value", true);
    app_env_set("OVERRIDE_VAR", "parent_value", true);

    AppLocation child_location { APP_LOCATION_MEMORY, reinterpret_cast<void*>(env_child_main) };
    AppStartContext child_context = app_start_context_for_location(child_location);
    const char* child_env[] = { "OVERRIDE_VAR=child_value", "CHILD_ONLY_VAR=child_value", nullptr };
    app_start_context_set_environment(&child_context, const_cast<char**>(child_env));
    app_start_context_set_parent(&child_context, app_scheduler_current_app_id());

    uint32_t child_id = 0;
    app_start_with_context(&child_context, &child_id);

    // Same subscribe-until-close contract as every other fake app in this test suite; the test
    // thread stops this (the parent) once it has observed child_results_ready.
    while (true) {
        if (task_event_group_wait_any(&event_group, nullptr, pdMS_TO_TICKS(5000)) != ERROR_NONE) {
            break; // safety net so a bug here can't hang the test suite
        }
        bool done = false;
        AppEvent event {};
        while (app_event_poll(&sub, &event) == ERROR_NONE) {
            if (event.type == APP_EVENT_CLOSE) {
                done = true;
                break;
            }
        }
        if (done) break;
    }
    app_event_unsubscribe(&sub);
    task_event_group_destruct(&event_group);
    return 0;
}

bool wait_for_state(uint32_t instance_id, AppInstanceState target, uint32_t timeout_ms) {
    uint32_t waited = 0;
    while (waited < timeout_ms) {
        if (app_manager_get_state(instance_id) == target) {
            return true;
        }
        delay_millis(10);
        waited += 10;
    }
    return app_manager_get_state(instance_id) == target;
}

bool wait_for_results(uint32_t timeout_ms) {
    uint32_t waited = 0;
    while (waited < timeout_ms) {
        if (results_ready.load(std::memory_order_acquire)) {
            return true;
        }
        delay_millis(10);
        waited += 10;
    }
    return results_ready.load(std::memory_order_acquire);
}

bool wait_for_child_results(uint32_t timeout_ms) {
    uint32_t waited = 0;
    while (waited < timeout_ms) {
        if (child_results_ready.load(std::memory_order_acquire)) {
            return true;
        }
        delay_millis(10);
        waited += 10;
    }
    return child_results_ready.load(std::memory_order_acquire);
}

} // namespace

TEST_CASE("app_env_* operate on the calling app instance's own environment") {
    ensure_memory_loader_registered();

    AppLocation location { APP_LOCATION_MEMORY, reinterpret_cast<void*>(env_test_app_main) };
    AppStartContext context = app_start_context_for_location(location);
    const char* seeded_env[] = { "SEEDED_VAR=seeded_value", nullptr };
    app_start_context_set_environment(&context, const_cast<char**>(seeded_env));

    results_ready.store(false, std::memory_order_release);
    uint32_t instance_id = 0;
    REQUIRE_EQ(app_start_with_context(&context, &instance_id), ERROR_NONE);
    CHECK(wait_for_state(instance_id, APP_INSTANCE_STATE_ACTIVE, 1000));
    REQUIRE(wait_for_results(1000));

    CHECK(result_get_before_set_is_null);
    CHECK(result_set_returns_ok);
    CHECK(result_get_after_set_matches);
    CHECK(result_no_overwrite_returns_ok);
    CHECK(result_no_overwrite_value_unchanged);
    CHECK(result_overwrite_returns_ok);
    CHECK(result_overwrite_value_changed);
    CHECK(result_put_returns_ok);
    CHECK(result_get_after_put_matches);
    CHECK(result_unset_returns_ok);
    CHECK(result_get_after_unset_is_null);
    CHECK(result_seeded_value_matches);

    app_manager_stop(instance_id);
}

TEST_CASE("app_env_* reject invalid names/strings without touching any instance") {
    CHECK_EQ(app_env_set(nullptr, "value", true), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_set("", "value", true), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_set("NAME=X", "value", true), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_set("NAME", nullptr, true), ERROR_INVALID_ARGUMENT);

    CHECK_EQ(app_env_unset(nullptr), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_unset(""), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_unset("NAME=X"), ERROR_INVALID_ARGUMENT);

    CHECK_EQ(app_env_get(nullptr), nullptr);
    CHECK_EQ(app_env_get(""), nullptr);
    CHECK_EQ(app_env_get("NAME=X"), nullptr);

    CHECK_EQ(app_env_put(nullptr), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_put("NO_EQUALS_SIGN"), ERROR_INVALID_ARGUMENT);
    CHECK_EQ(app_env_put("=NO_NAME"), ERROR_INVALID_ARGUMENT);
}

TEST_CASE("app_env_* report ERROR_NOT_FOUND when the calling task isn't a running app instance") {
    CHECK_EQ(app_env_set("NAME", "value", true), ERROR_NOT_FOUND);
    CHECK_EQ(app_env_unset("NAME"), ERROR_NOT_FOUND);
    CHECK_EQ(app_env_get("NAME"), nullptr);
}

TEST_CASE("app_env_apply overlays NAME=VALUE entries, overriding existing names and appending new ones") {
    AppEnv env = { "INHERITED=parent", "OVERRIDE=parent" };
    const char* overlay[] = { "OVERRIDE=child", "NEW=child", nullptr };
    app_env_apply(env, overlay);

    CHECK_EQ(env.size(), 3);
    CHECK(std::find(env.begin(), env.end(), "INHERITED=parent") != env.end());
    CHECK(std::find(env.begin(), env.end(), "OVERRIDE=child") != env.end());
    CHECK(std::find(env.begin(), env.end(), "NEW=child") != env.end());
}

TEST_CASE("app_env_apply is a no-op for a NULL overlay") {
    AppEnv env = { "A=1" };
    app_env_apply(env, nullptr);
    CHECK_EQ(env.size(), 1);
    CHECK_EQ(env[0], "A=1");
}

TEST_CASE("app_env_apply skips a malformed overlay entry") {
    AppEnv env = { "A=1" };
    const char* overlay[] = { "NOEQUALS", "=NONAME", nullptr };
    app_env_apply(env, overlay);
    CHECK_EQ(env.size(), 1);
}

TEST_CASE("a child started with a parent inherits the parent's environment, with its own overriding") {
    ensure_memory_loader_registered();

    AppLocation parent_location { APP_LOCATION_MEMORY, reinterpret_cast<void*>(env_parent_main) };
    AppStartContext parent_context = app_start_context_for_location(parent_location);

    child_results_ready.store(false, std::memory_order_release);
    uint32_t parent_id = 0;
    REQUIRE_EQ(app_start_with_context(&parent_context, &parent_id), ERROR_NONE);
    CHECK(wait_for_state(parent_id, APP_INSTANCE_STATE_ACTIVE, 1000));
    REQUIRE(wait_for_child_results(1000));

    CHECK(result_child_inherited_var_matches);
    CHECK(result_child_override_var_matches);
    CHECK(result_child_only_var_matches);

    app_manager_stop(parent_id);
}