lifecycleTest.cpp

/**
 * Copyright 2025 Comcast Cable Communications Management, 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include "firebolt/firebolt.h"
#include "json_engine.h"
#include "utils.h"
#include <condition_variable>
#include <gtest/gtest.h>
#include <iostream>
#include <mutex>

class LifecycleCTest : public ::testing::Test
{
protected:
    void SetUp() override { eventReceived = false; }

    std::condition_variable cv;
    std::mutex mtx;
    bool eventReceived;

    JsonEngine jsonEngine;
};

TEST_F(LifecycleCTest, close)

{
    auto result =
        Firebolt::IFireboltAccessor::Instance().LifecycleInterface().close(Firebolt::Lifecycle::CloseType::DEACTIVATE);
    ASSERT_TRUE(result) << "Error on calling LifecycleInterface.close() method";
}

TEST_F(LifecycleCTest, state)
{
    Firebolt::Result<Firebolt::Lifecycle::LifecycleState> result =
        Firebolt::IFireboltAccessor::Instance().LifecycleInterface().state();
    ASSERT_TRUE(result) << "Error on calling LifecycleInterface.state() method";

    auto expectedValue = jsonEngine.get_value("Lifecycle.state");
    EXPECT_EQ(*result, Firebolt::Lifecycle::LifecycleState::ACTIVE);
}

TEST_F(LifecycleCTest, subscribeOnState_JSON_RPC_compliant)
{
    auto id = Firebolt::IFireboltAccessor::Instance().LifecycleInterface().subscribeOnStateChanged(
        [&](const std::vector<Firebolt::Lifecycle::StateChange>& changes)
        {
            EXPECT_TRUE(changes.size() > 0);
            std::cout << "[Subscription] Lifecycle state changed: " << static_cast<int>(changes[0].newState)
                      << ", old state: " << static_cast<int>(changes[0].oldState) << std::endl;

            EXPECT_EQ(changes[0].newState, Firebolt::Lifecycle::LifecycleState::PAUSED);
            EXPECT_EQ(changes[0].oldState, Firebolt::Lifecycle::LifecycleState::INITIALIZING);

            {
                std::lock_guard<std::mutex> lock(mtx);
                eventReceived = true;
            }
            cv.notify_one();
        });
    verifyEventSubscription(id);

    triggerEvent("Lifecycle2.onStateChanged", R"({"value":[{"newState":"paused","oldState":"initializing"}]})");

    verifyEventReceived(mtx, cv, eventReceived);

    SetUp();
    triggerEvent("Lifecycle2.onStateChanged", R"([{"newState":"paused","oldState":"badstate"}])");
    verifyEventNotReceived(mtx, cv, eventReceived);

    auto result = Firebolt::IFireboltAccessor::Instance().LifecycleInterface().unsubscribe(id.value());
    verifyUnsubscribeResult(result);
}

TEST_F(LifecycleCTest, subscribeOnState_noValue)
{
    auto id = Firebolt::IFireboltAccessor::Instance().LifecycleInterface().subscribeOnStateChanged(
        [&](const std::vector<Firebolt::Lifecycle::StateChange>& changes)
        {
            EXPECT_TRUE(changes.size() > 0);
            std::cout << "[Subscription] Lifecycle state changed: " << static_cast<int>(changes[0].newState)
                      << ", old state: " << static_cast<int>(changes[0].oldState) << std::endl;

            EXPECT_EQ(changes[0].newState, Firebolt::Lifecycle::LifecycleState::PAUSED);
            EXPECT_EQ(changes[0].oldState, Firebolt::Lifecycle::LifecycleState::INITIALIZING);

            {
                std::lock_guard<std::mutex> lock(mtx);
                eventReceived = true;
            }
            cv.notify_one();
        });
    verifyEventSubscription(id);

    Firebolt::Config config;
    if (config.legacyRPCv1)
    {
        std::cout << "Commented out as it cannot be tested in CI/CI due to unknown 'id' value" << std::endl;
        /*
        nlohmann::json p;
        p["id"] = 30;
        p["result"] = {{{"newState", "paused"}, {"oldState", "initializing"}}};
        triggerRaw(p.dump());
        */
    }
    else
    {
        triggerRaw(
            R"({ "method": "Lifecycle2.onStateChanged", "params": [{"newState":"paused","oldState":"initializing"}]})");
    }

    verifyEventReceived(mtx, cv, eventReceived);

    SetUp();
    triggerEvent("Lifecycle2.onStateChanged", R"([{"newState":"paused","oldState":"badstate"}])");
    verifyEventNotReceived(mtx, cv, eventReceived);

    auto result = Firebolt::IFireboltAccessor::Instance().LifecycleInterface().unsubscribe(id.value());
    verifyUnsubscribeResult(result);
}