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
129
130
131
132
133
134
135
136
137
138
139
140
|
/**
* Copyright (C) 2023-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 <map>
#include <string>
#include <grpcpp/grpcpp.h>
#include "mongo/transport/grpc/bidirectional_pipe.h"
#include "mongo/transport/grpc/metadata.h"
#include "mongo/transport/grpc/mock_util.h"
#include "mongo/transport/grpc/server_stream.h"
#include "mongo/util/future.h"
#include "mongo/util/net/hostandport.h"
namespace mongo::transport::grpc {
class MockServerStream : public ServerStream {
public:
~MockServerStream() = default;
boost::optional<SharedBuffer> read() override;
bool write(ConstSharedBuffer msg) override;
explicit MockServerStream(HostAndPort remote,
Promise<MetadataContainer>&& initialMetadataPromise,
Promise<::grpc::Status>&& rpcTerminationStatusPromise,
std::shared_ptr<MockCancellationState> rpcCancellationState,
BidirectionalPipe::End&& serverPipeEnd,
MetadataView clientMetadata);
private:
friend class MockServerContext;
friend class MockRPC;
class InitialMetadata {
public:
void insert(const std::string& key, const std::string& value) {
invariant(!_sent.load());
_headers.insert({key, value});
}
void trySend() {
if (!_sent.swap(true)) {
_promise.emplaceValue(std::move(_headers));
}
}
private:
friend class MockServerStream;
InitialMetadata(Promise<MetadataContainer> promise)
: _promise{std::move(promise)}, _sent{false} {}
Promise<MetadataContainer> _promise;
/**
* Whether or not the metadata has been made available to the client end of the stream.
*/
AtomicWord<bool> _sent;
MetadataContainer _headers;
};
bool isCancelled() const;
/**
* Cancel the RPC associated with this stream. This is used for mocking situations in
* which an RPC handler was never able to return a final status to the client (e.g. manual
* cancellation or a network interruption).
*
* This method has no effect if the stream is already terminated.
*/
void cancel(::grpc::Status status);
/**
* Closes the stream and sends the final return status of the RPC to the client. This is the
* mocked equivalent of an RPC handler returning a status.
*
* This does not mark the stream as cancelled.
*
* This method must only be called once, and this stream must not be used after this method has
* been called.
*/
void sendReturnStatus(::grpc::Status status);
HostAndPort _remote;
InitialMetadata _initialMetadata;
/**
* _rpcReturnStatus is set in sendReturnStatus(), and it is used to mock returning a status from
* an RPC handler. sendReturnStatus itself is called via MockRPC::sendReturnStatus().
*/
Promise<::grpc::Status> _rpcReturnStatus;
/**
* _finalStatusReturned is also set in sendReturnStatus(), and it is used to denote that a
* status has been returned and the stream should no longer be used.
*/
synchronized_value<bool> _finalStatusReturned;
/**
* _rpcCancellationState is set via cancel(), which is called by either
* MockServerContext::tryCancel() or MockRPC::cancel(). It is used to mock situations in which a
* server RPC handler is unable to return a status to the client (e.g. explicit cancellation or
* a network interruption).
*/
std::shared_ptr<MockCancellationState> _rpcCancellationState;
BidirectionalPipe::End _pipe;
MetadataView _clientMetadata;
};
} // namespace mongo::transport::grpc
|
