/**
* Copyright (C) 2015 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 .
*
* 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/base/status_with.h"
#include "mongo/s/catalog/dist_lock_catalog.h"
#include "mongo/s/catalog/type_lockpings.h"
#include "mongo/s/catalog/type_locks.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/mutex.h"
namespace mongo {
/**
* Mock implementation of DistLockCatalog for testing.
*
* Example usage:
*
* DistLockCatalogMock mock;
* LocksType badLock;
* mock.expectGrabLock([](StringData lockID,
* const OID& lockSessionID,
* StringData who,
* StringData processId,
* Date_t time,
* StringData why) {
* ASSERT_EQUALS("test", lockID);
* }, badLock);
*
* mock.grabLock("test", OID(), "me", "x", Date_t::now(), "end");
*
* It is also possible to chain the callbacks. For example, if we want to set the test
* such that grabLock can only be called once, you can do this:
*
* DistLockCatalogMock mock;
* mock.expectGrabLock([&mock](...) {
* mock.expectNoGrabLock();
* }, Status::OK());
*/
class DistLockCatalogMock : public DistLockCatalog {
public:
DistLockCatalogMock();
virtual ~DistLockCatalogMock();
using GrabLockFunc = stdx::function;
using OvertakeLockFunc = stdx::function;
using UnlockFunc = stdx::function;
using PingFunc = stdx::function;
using StopPingFunc = stdx::function;
using GetPingFunc = StopPingFunc;
using GetLockByTSFunc = stdx::function;
using GetLockByNameFunc = stdx::function;
using GetServerInfoFunc = stdx::function;
virtual StatusWith getPing(OperationContext* opCtx,
StringData processID) override;
virtual Status ping(OperationContext* opCtx, StringData processID, Date_t ping) override;
virtual StatusWith grabLock(OperationContext* opCtx,
StringData lockID,
const OID& lockSessionID,
StringData who,
StringData processId,
Date_t time,
StringData why,
const WriteConcernOptions& writeConcern) override;
virtual StatusWith overtakeLock(OperationContext* opCtx,
StringData lockID,
const OID& lockSessionID,
const OID& currentHolderTS,
StringData who,
StringData processId,
Date_t time,
StringData why) override;
virtual Status unlock(OperationContext* opCtx, const OID& lockSessionID) override;
virtual Status unlock(OperationContext* opCtx,
const OID& lockSessionID,
StringData name) override;
virtual Status unlockAll(OperationContext* opCtx, const std::string& processID) override;
virtual StatusWith getServerInfo(OperationContext* opCtx) override;
virtual StatusWith getLockByTS(OperationContext* opCtx,
const OID& lockSessionID) override;
virtual StatusWith getLockByName(OperationContext* opCtx, StringData name) override;
virtual Status stopPing(OperationContext* opCtx, StringData processId) override;
/**
* Sets the checker method to use and the return value for grabLock to return every
* time it is called.
*/
void expectGrabLock(GrabLockFunc checkerFunc, StatusWith returnThis);
/**
* Expect grabLock to never be called after this is called.
*/
void expectNoGrabLock();
/**
* Sets the checker method to use and the return value for unlock to return every
* time it is called.
*/
void expectUnLock(UnlockFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time ping is called.
*/
void expectPing(PingFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time stopPing is called.
*/
void expectStopPing(StopPingFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time
* getLockByTS is called.
*/
void expectGetLockByTS(GetLockByTSFunc checkerFunc, StatusWith returnThis);
/**
* Sets the checker method to use and its return value the every time
* getLockByName is called.
*/
void expectGetLockByName(GetLockByNameFunc checkerFunc, StatusWith returnThis);
/**
* Sets the checker method to use and its return value the every time
* overtakeLock is called.
*/
void expectOvertakeLock(OvertakeLockFunc checkerFunc, StatusWith returnThis);
/**
* Sets the checker method to use and its return value the every time
* getPing is called.
*/
void expectGetPing(GetPingFunc checkerFunc, StatusWith returnThis);
/**
* Sets the checker method to use and its return value the every time
* getServerInfo is called.
*/
void expectGetServerInfo(GetServerInfoFunc checkerFunc,
StatusWith returnThis);
private:
// Protects all the member variables.
stdx::mutex _mutex;
GrabLockFunc _grabLockChecker;
StatusWith _grabLockReturnValue;
UnlockFunc _unlockChecker;
Status _unlockReturnValue;
PingFunc _pingChecker;
Status _pingReturnValue;
StopPingFunc _stopPingChecker;
Status _stopPingReturnValue;
GetLockByTSFunc _getLockByTSChecker;
StatusWith _getLockByTSReturnValue;
GetLockByNameFunc _getLockByNameChecker;
StatusWith _getLockByNameReturnValue;
OvertakeLockFunc _overtakeLockChecker;
StatusWith _overtakeLockReturnValue;
GetPingFunc _getPingChecker;
StatusWith _getPingReturnValue;
GetServerInfoFunc _getServerInfoChecker;
StatusWith _getServerInfoReturnValue;
};
}