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 "mongo/db/concurrency/lock_manager.h"
34 #include "mongo/db/concurrency/lock_state.h"
35 
36 namespace mongo {
37 
38 class LockerForTests : public LockerImpl<false> {
39 public:
LockerForTests(LockMode globalLockMode)40     explicit LockerForTests(LockMode globalLockMode) {
41         lockGlobal(globalLockMode);
42     }
43 
~LockerForTests()44     ~LockerForTests() {
45         unlockGlobal();
46     }
47 };
48 
49 
50 class TrackingLockGrantNotification : public LockGrantNotification {
51 public:
TrackingLockGrantNotification()52     TrackingLockGrantNotification() : numNotifies(0), lastResult(LOCK_INVALID) {}
53 
notify(ResourceId resId,LockResult result)54     virtual void notify(ResourceId resId, LockResult result) {
55         numNotifies++;
56         lastResId = resId;
57         lastResult = result;
58     }
59 
60 public:
61     int numNotifies;
62 
63     ResourceId lastResId;
64     LockResult lastResult;
65 };
66 
67 
68 struct LockRequestCombo : public LockRequest, TrackingLockGrantNotification {
69 public:
LockRequestComboLockRequestCombo70     explicit LockRequestCombo(Locker* locker) {
71         initNew(locker, this);
72     }
73 };
74 
75 /**
76  * A RAII object that temporarily forces setting of the _supportsDocLocking global variable (defined
77  * in db/service_context.cpp and returned by mongo::supportsDocLocking()) for testing purposes.
78  */
79 extern bool _supportsDocLocking;
80 class ForceSupportsDocLocking {
81 public:
ForceSupportsDocLocking(bool supported)82     explicit ForceSupportsDocLocking(bool supported) : _oldSupportsDocLocking(_supportsDocLocking) {
83         _supportsDocLocking = supported;
84     }
85 
~ForceSupportsDocLocking()86     ~ForceSupportsDocLocking() {
87         _supportsDocLocking = _oldSupportsDocLocking;
88     }
89 
90 private:
91     const bool _oldSupportsDocLocking;
92 };
93 
94 }  // namespace mongo
95