mockAsyncOperations.hpp

Go to the documentation of this file.

// GCOVR_EXCL_START
#ifndef OCM_DAQ_TEST_MOCK_ASYNC_OPERATIONS_HPP_
#define OCM_DAQ_TEST_MOCK_ASYNC_OPERATIONS_HPP_
#include <daq/config.hpp>
#include <gmock/gmock.h>
 
#include <daq/daqController.hpp>
#include <daq/op/asyncOpParams.hpp>
/**
 * Simple class that facilitates mocking of the freestanding asynchronous operations in
 * daq::op:
 * - `daq::op::StartAsync`
 * - `daq::op::StopAsync`
 * - `daq::op::AbortAsync`
 *
 * where each method matches the interface of the operations.
 */
struct MockAbort {
    MOCK_METHOD0(Abort, bool());
};
 
struct MockAsyncOperations {
    MOCK_METHOD1(Start, boost::future<void>(daq::op::AsyncOpParams));
    MOCK_METHOD2(Abort,
                 boost::future<daq::Result<void>>(daq::ErrorPolicy, daq::op::AsyncOpParams));
    MOCK_METHOD2(Stop,
                 boost::future<daq::Result<daq::DpParts>>(daq::ErrorPolicy,
                                                              daq::op::AsyncOpParams));
    // Mocks the await function only, not the abort to simplify usage
    MOCK_METHOD1(AwaitPrim, boost::future<daq::Result<daq::DpParts>>(daq::op::AwaitOpParams));
 
    // Helper that simplifies the mocking by setting up the abort mock automatically
    daq::AsyncOperations::AwaitReturnType AwaitPrimHelper(daq::op::AwaitOpParams params) {
        return {
            AwaitPrim(params),
            [&]() -> bool {
                return mock_abort.Abort();
            }
        };
    }
    MockAbort mock_abort;
};
 
 
std::tuple<std::unique_ptr<MockAsyncOperations>, daq::AsyncOperations> CreateMockAsyncOperations() {
    std::tuple<std::unique_ptr<MockAsyncOperations>, daq::AsyncOperations> res(
        std::make_unique<MockAsyncOperations>(), daq::AsyncOperations());
 
    auto& ops = std::get<daq::AsyncOperations>(res);
    auto* mock_ptr = std::get<std::unique_ptr<MockAsyncOperations>>(res).get();
 
    ops.start = [mock_ptr](daq::op::AsyncOpParams params) {
        return mock_ptr->Start(params);
    };
    ops.abort = [mock_ptr](daq::ErrorPolicy policy, daq::op::AsyncOpParams params) {
        return mock_ptr->Abort(policy, params);
    };
    ops.stop = [mock_ptr](daq::ErrorPolicy policy, daq::op::AsyncOpParams params) {
        return mock_ptr->Stop(policy, params);
    };
    ops.await_prim = [mock_ptr](daq::op::AwaitOpParams params) {
        return mock_ptr->AwaitPrimHelper(params);
    };
    return res;
}
#endif  // #define OCM_DAQ_TEST_MOCK_ASYNC_OPERATIONS_HPP_
// GCOVR_EXCL_STOP