1 
2 /**
3  *    Copyright (C) 2018-present MongoDB, Inc.
4  *
5  *    This program is free software: you can redistribute it and/or modify
6  *    it under the terms of the Server Side Public License, version 1,
7  *    as published by MongoDB, Inc.
8  *
9  *    This program is distributed in the hope that it will be useful,
10  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *    Server Side Public License for more details.
13  *
14  *    You should have received a copy of the Server Side Public License
15  *    along with this program. If not, see
16  *    <http://www.mongodb.com/licensing/server-side-public-license>.
17  *
18  *    As a special exception, the copyright holders give permission to link the
19  *    code of portions of this program with the OpenSSL library under certain
20  *    conditions as described in each individual source file and distribute
21  *    linked combinations including the program with the OpenSSL library. You
22  *    must comply with the Server Side Public License in all respects for
23  *    all of the code used other than as permitted herein. If you modify file(s)
24  *    with this exception, you may extend this exception to your version of the
25  *    file(s), but you are not obligated to do so. If you do not wish to do so,
26  *    delete this exception statement from your version. If you delete this
27  *    exception statement from all source files in the program, then also delete
28  *    it in the license file.
29  */
30 
31 #pragma once
32 
33 #include <string>
34 #include <vector>
35 
36 #include "mongo/s/catalog/dist_lock_catalog.h"
37 #include "mongo/s/catalog/dist_lock_manager.h"
38 #include "mongo/stdx/functional.h"
39 
40 namespace mongo {
41 
42 class DistLockManagerMock : public DistLockManager {
43 public:
44     DistLockManagerMock(std::unique_ptr<DistLockCatalog> catalog);
45 
46     virtual ~DistLockManagerMock() = default;
47 
48     void startUp() override;
49     void shutDown(OperationContext* opCtx) override;
50 
51     std::string getProcessID() override;
52 
53     StatusWith<DistLockHandle> lockWithSessionID(OperationContext* opCtx,
54                                                  StringData name,
55                                                  StringData whyMessage,
56                                                  const OID& lockSessionID,
57                                                  Milliseconds waitFor) override;
58 
59     StatusWith<DistLockHandle> tryLockWithLocalWriteConcern(OperationContext* opCtx,
60                                                             StringData name,
61                                                             StringData whyMessage,
62                                                             const OID& lockSessionID) override;
63 
64     void unlockAll(OperationContext* opCtx, const std::string& processID) override;
65 
66     using LockFunc =
67         stdx::function<void(StringData name, StringData whyMessage, Milliseconds waitFor)>;
68 
69     void expectLock(LockFunc checkerFunc, Status lockStatus);
70 
71 protected:
72     void unlock(OperationContext* opCtx, const DistLockHandle& lockHandle) override;
73 
74     void unlock(OperationContext* opCtx,
75                 const DistLockHandle& lockHandle,
76                 StringData name) override;
77 
78     Status checkStatus(OperationContext* opCtx, const DistLockHandle& lockHandle) override;
79 
80 private:
81     struct LockInfo {
82         DistLockHandle lockID;
83         std::string name;
84     };
85 
86     /**
87      * Unused, but needed so that test code mirrors the ownership semantics of production code.
88      */
89     const std::unique_ptr<DistLockCatalog> _catalog;
90 
91     std::vector<LockInfo> _locks;
92     Status _lockReturnStatus;
93     LockFunc _lockChecker;
94 };
95 
96 }  // namespace mongo
97