clio/tests/unit/util/SignalsHandlerTests.cpp

#include "util/MockAssert.hpp"
#include "util/SignalsHandler.hpp"
#include "util/config/ConfigDefinition.hpp"
#include "util/config/ConfigValue.hpp"
#include "util/config/Types.hpp"

#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include <chrono>
#include <condition_variable>
#include <csignal>
#include <mutex>
#include <string>
#include <thread>

using namespace util;
using namespace util::config;
using testing::MockFunction;
using testing::StrictMock;

struct SignalsHandlerTestsBase : public virtual ::testing::Test {
    void
    allowTestToFinish()
    {
        std::unique_lock const lock{mutex_};
        testCanBeFinished_ = true;
        cv_.notify_one();
    }

    void
    wait()
    {
        std::unique_lock lock{mutex_};
        cv_.wait(lock, [this] { return testCanBeFinished_; });
    }

protected:
    StrictMock<MockFunction<void()>> forceExitHandler_;
    StrictMock<MockFunction<void()>> stopHandler_;
    StrictMock<MockFunction<void()>> anotherStopHandler_;

    std::mutex mutex_;
    std::condition_variable cv_;
    bool testCanBeFinished_{false};
};

struct SignalsHandlerAssertTest : common::util::WithMockAssert {};

TEST_F(SignalsHandlerAssertTest, CantCreateTwoSignalsHandlers)
{
    auto makeHandler = []() {
        return SignalsHandler{
            ClioConfigDefinition{
                {"graceful_period", ConfigValue{ConfigType::Double}.defaultValue(1.f)}
            },
            []() {}
        };
    };
    auto const handler = makeHandler();
    EXPECT_CLIO_ASSERT_FAIL({ makeHandler(); });
}

struct SignalsHandlerTests : SignalsHandlerTestsBase {
protected:
    SignalsHandler handler_{
        ClioConfigDefinition{
            {"graceful_period", ConfigValue{ConfigType::Double}.defaultValue(3.0)}
        },
        forceExitHandler_.AsStdFunction()
    };
};

TEST_F(SignalsHandlerTests, NoSignal)
{
    handler_.subscribeToStop(stopHandler_.AsStdFunction());
    handler_.subscribeToStop(anotherStopHandler_.AsStdFunction());
}

TEST_F(SignalsHandlerTests, OneSignal)
{
    handler_.subscribeToStop(stopHandler_.AsStdFunction());
    handler_.subscribeToStop(anotherStopHandler_.AsStdFunction());
    EXPECT_CALL(stopHandler_, Call());
    EXPECT_CALL(anotherStopHandler_, Call()).WillOnce([this] {
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
        handler_.notifyGracefulShutdownComplete();
        allowTestToFinish();
    });
    std::raise(SIGINT);

    wait();
}

struct SignalsHandlerTimeoutTests : SignalsHandlerTestsBase {
protected:
    SignalsHandler handler_{
        ClioConfigDefinition{
            {"graceful_period", ConfigValue{ConfigType::Double}.defaultValue(0.001)}
        },
        forceExitHandler_.AsStdFunction()
    };
};

TEST_F(SignalsHandlerTimeoutTests, OneSignalTimeout)
{
    handler_.subscribeToStop(stopHandler_.AsStdFunction());
    EXPECT_CALL(stopHandler_, Call()).WillOnce([] {
        // Don't notify completion, let it timeout
        std::this_thread::sleep_for(std::chrono::milliseconds(2));
    });
    EXPECT_CALL(forceExitHandler_, Call()).WillOnce([this]() { allowTestToFinish(); });
    std::raise(SIGINT);

    wait();
}

TEST_F(SignalsHandlerTests, TwoSignals)
{
    handler_.subscribeToStop(stopHandler_.AsStdFunction());
    EXPECT_CALL(stopHandler_, Call()).WillOnce([] {
        // Raise second signal during graceful shutdown
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
        std::raise(SIGINT);
    });
    EXPECT_CALL(forceExitHandler_, Call()).WillOnce([this]() { allowTestToFinish(); });
    std::raise(SIGINT);

    wait();
}

TEST_F(SignalsHandlerTests, GracefulShutdownCompletes)
{
    handler_.subscribeToStop(stopHandler_.AsStdFunction());
    EXPECT_CALL(stopHandler_, Call()).WillOnce([this] {
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
        handler_.notifyGracefulShutdownComplete();
        allowTestToFinish();
    });
    EXPECT_CALL(forceExitHandler_, Call()).Times(0);
    std::raise(SIGINT);

    wait();
}

struct SignalsHandlerPriorityTestsBundle {
    std::string name;
    SignalsHandler::Priority stopHandlerPriority;
    SignalsHandler::Priority anotherStopHandlerPriority;
};

struct SignalsHandlerPriorityTests
    : SignalsHandlerTests,
      testing::WithParamInterface<SignalsHandlerPriorityTestsBundle> {};

INSTANTIATE_TEST_SUITE_P(
    SignalsHandlerPriorityTestsGroup,
    SignalsHandlerPriorityTests,
    testing::Values(
        SignalsHandlerPriorityTestsBundle{
            "StopFirst-Normal",
            SignalsHandler::Priority::StopFirst,
            SignalsHandler::Priority::Normal
        },
        SignalsHandlerPriorityTestsBundle{
            "Normal-StopLast",
            SignalsHandler::Priority::Normal,
            SignalsHandler::Priority::StopLast
        }
    )
);

TEST_P(SignalsHandlerPriorityTests, Priority)
{
    bool stopHandlerCalled = false;

    handler_.subscribeToStop(
        anotherStopHandler_.AsStdFunction(), GetParam().anotherStopHandlerPriority
    );
    handler_.subscribeToStop(stopHandler_.AsStdFunction(), GetParam().stopHandlerPriority);

    EXPECT_CALL(stopHandler_, Call()).WillOnce([&] { stopHandlerCalled = true; });
    EXPECT_CALL(anotherStopHandler_, Call()).WillOnce([&] {
        EXPECT_TRUE(stopHandlerCalled);
        handler_.notifyGracefulShutdownComplete();
        allowTestToFinish();
    });

    std::raise(SIGINT);
    wait();
}