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/unittest/task_executor_proxy.h"
34 
35 namespace mongo {
36 namespace repl {
37 
38 /**
39  * Mock executor::TaskExecutorProxy.
40  * Supports injecting errors into scheduleWork(), scheduleWorkAt() and scheduleRemoteCommand().
41  */
42 class TaskExecutorMock : public unittest::TaskExecutorProxy {
43 public:
44     using ShouldFailScheduleWorkRequestFn = stdx::function<bool()>;
45     using ShouldFailScheduleRemoteCommandRequestFn =
46         stdx::function<bool(const executor::RemoteCommandRequest&)>;
47 
48     explicit TaskExecutorMock(executor::TaskExecutor* executor);
49 
50     StatusWith<CallbackHandle> scheduleWork(const CallbackFn& work) override;
51     StatusWith<CallbackHandle> scheduleWorkAt(Date_t when, const CallbackFn& work) override;
52     StatusWith<CallbackHandle> scheduleRemoteCommand(const executor::RemoteCommandRequest& request,
53                                                      const RemoteCommandCallbackFn& cb) override;
54 
55     // Override to make scheduleWork() fail during testing.
56     ShouldFailScheduleWorkRequestFn shouldFailScheduleWorkRequest = []() { return false; };
57 
58     // Override to make scheduleWorkAt() fail during testing.
59     ShouldFailScheduleWorkRequestFn shouldFailScheduleWorkAtRequest = []() { return false; };
60 
61     // If the predicate returns true, scheduleWork() will schedule the task 1 second later instead
62     // of running immediately. This allows us to test cancellation handling in callbacks scheduled
63     // using scheduleWork().
64     ShouldFailScheduleWorkRequestFn shouldDeferScheduleWorkRequestByOneSecond = []() {
65         return false;
66     };
67 
68     // Override to make scheduleRemoteCommand fail during testing.
69     ShouldFailScheduleRemoteCommandRequestFn shouldFailScheduleRemoteCommandRequest =
70         [](const executor::RemoteCommandRequest&) { return false; };
71 };
72 
73 }  // namespace repl
74 }  // namespace mongo
75