/**
 *    Copyright (C) 2017 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include "mongo/s/sharding_mongod_test_fixture.h"
#include "mongo/unittest/unittest.h"

namespace mongo {

class ClockSourceMock;
class DBDirectClient;
class LogicalClock;
class LogicalTime;

/**
 * A test fixture that installs a LogicalClock instance with a TimeProofService onto a service
 * context, in addition to the mock storage engine, network, and OpObserver provided by
 * ShardingMongodTestFixture.
 */
class LogicalClockTestFixture : public ShardingMongodTestFixture {
public:
    LogicalClockTestFixture();
    ~LogicalClockTestFixture();

protected:
    /**
     * Sets up this fixture as the primary node in a shard server replica set with a LogicalClock
     * (with a TimeProofService), storage engine, DBClient, OpObserver, and a mocked clock source.
     */
    void setUp() override;

    void tearDown() override;

    LogicalClock* resetClock();

    LogicalClock* getClock() const;

    ClockSourceMock* getMockClockSource() const;

    void setMockClockSourceTime(Date_t time) const;

    Date_t getMockClockSourceTime() const;

    DBDirectClient* getDBClient() const;

private:
    LogicalClock* _clock;
    std::shared_ptr<ClockSourceMock> _mockClockSource = std::make_shared<ClockSourceMock>();
    std::unique_ptr<DBDirectClient> _dbDirectClient;
};

}  // namespace mongo