lib/api/unittest/CMockSearcher.h

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the following additional limitation. Functionality enabled by the
 * files subject to the Elastic License 2.0 may only be used in production when
 * invoked by an Elasticsearch process with a license key installed that permits
 * use of machine learning features. You may not use this file except in
 * compliance with the Elastic License 2.0 and the foregoing additional
 * limitation.
 */
#ifndef INCLUDED_CMockSearcher_h
#define INCLUDED_CMockSearcher_h

#include <core/CDataSearcher.h>

class CMockDataAdder;

//! \brief
//! Mock searcher for unit testing.
//!
//! DESCRIPTION:\n
//! The CSearcher class can search for data in a live server instance,
//! but for unit testing it's desirable to mock this class.
//!
//! IMPLEMENTATION DECISIONS:\n
//! The mock searcher's returns all events added to a mock data adder that
//! appear to be for the searched index.  The actual search string is NOT
//! properly applied.  This is OK for the current scope of the unit testing.
//!
class CMockSearcher : public ml::core::CDataSearcher {
public:
    CMockSearcher(const CMockDataAdder& mockDataAdder);

    //! Do a search that results in an input stream.
    //! A return value of NULL indicates a technical problem with the
    //! creation of the stream.  Other errors may be indicated by the
    //! returned stream going into the "bad" state.
    TIStreamP search(std::size_t currentDocNum, std::size_t limit) override;

private:
    const CMockDataAdder& m_MockDataAdder;
};

#endif // INCLUDED_CMockSearcher_h