1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/**
* 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/db/logical_session_id.h"
#include "mongo/db/sessions_collection.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/mutex.h"
#include "mongo/stdx/unordered_map.h"
namespace mongo {
/**
* To allow us to move a MockSessionCollection into the session cache while
* maintaining a hold on it from within our unit tests, the MockSessionCollection
* will have an internal pointer to a MockSessionsCollectionImpl object that the
* test creates and controls.
*
* This class can operate in two modes:
*
* - if no custom hooks are set, then the test caller may add() and remove() items
* from the _sessions map, and this class will simply perform the required
* operations against that set.
*
* - if custom hooks are set, then the hooks will be run instead of the provided
* defaults, and the internal _sessions map will NOT be updated.
*/
class MockSessionsCollectionImpl {
public:
using SessionMap =
stdx::unordered_map<LogicalSessionId, LogicalSessionRecord, LogicalSessionIdHash>;
MockSessionsCollectionImpl();
using FetchHook = stdx::function<StatusWith<LogicalSessionRecord>(const LogicalSessionId&)>;
using RefreshHook = stdx::function<Status(const LogicalSessionRecordSet&)>;
using RemoveHook = stdx::function<Status(const LogicalSessionIdSet&)>;
// Set custom hooks to override default behavior
void setFetchHook(FetchHook hook);
void setRefreshHook(RefreshHook hook);
void setRemoveHook(RemoveHook hook);
// Reset all hooks to their defaults
void clearHooks();
// Forwarding methods from the MockSessionsCollection
StatusWith<LogicalSessionRecord> fetchRecord(const LogicalSessionId& id);
Status refreshSessions(const LogicalSessionRecordSet& sessions);
Status removeRecords(const LogicalSessionIdSet& sessions);
// Test-side methods that operate on the _sessions map
void add(LogicalSessionRecord record);
void remove(LogicalSessionId lsid);
bool has(LogicalSessionId lsid);
void clearSessions();
const SessionMap& sessions() const;
private:
// Default implementations, may be overridden with custom hooks.
StatusWith<LogicalSessionRecord> _fetchRecord(const LogicalSessionId& id);
Status _refreshSessions(const LogicalSessionRecordSet& sessions);
Status _removeRecords(const LogicalSessionIdSet& sessions);
stdx::mutex _mutex;
SessionMap _sessions;
FetchHook _fetch;
RefreshHook _refresh;
RemoveHook _remove;
};
/**
* To allow us to move this into the session cache while maintaining a hold
* on it from the test side, the MockSessionCollection will have an internal pointer
* to an impl that we maintain access to.
*/
class MockSessionsCollection : public SessionsCollection {
public:
explicit MockSessionsCollection(std::shared_ptr<MockSessionsCollectionImpl> impl)
: _impl(std::move(impl)) {}
StatusWith<LogicalSessionRecord> fetchRecord(OperationContext* opCtx,
const LogicalSessionId& id) override {
return _impl->fetchRecord(id);
}
Status refreshSessions(OperationContext* opCtx,
const LogicalSessionRecordSet& sessions,
Date_t refreshTime) override {
return _impl->refreshSessions(sessions);
}
Status removeRecords(OperationContext* opCtx, const LogicalSessionIdSet& sessions) override {
return _impl->removeRecords(sessions);
}
private:
std::shared_ptr<MockSessionsCollectionImpl> _impl;
};
} // namespace mongo
|
