summaryrefslogtreecommitdiff
path: root/src/mongo/s/mock_multi_write_command.h
blob: 95ab98a5f256c67c640518f896b1593ee80ab088 (plain)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/**
 *    Copyright (C) 2013 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 <deque>

#include "mongo/base/owned_pointer_vector.h"
#include "mongo/s/multi_command_dispatch.h"
#include "mongo/s/write_ops/batched_command_response.h"
#include "mongo/unittest/unittest.h"

namespace mongo {

    /**
     * A ConnectionString endpoint registered with some kind of error, to simulate returning when
     * the endpoint is used.
     */
    struct MockWriteResult {

        MockWriteResult( const ConnectionString& endpoint, const WriteErrorDetail& error ) :
                endpoint( endpoint ) {
            WriteErrorDetail* errorCopy = new WriteErrorDetail;
            error.cloneTo( errorCopy );
            errorCopy->setIndex( 0 );
            response.setOk(true);
            response.setN(0);
            response.addToErrDetails( errorCopy );
        }

        MockWriteResult( const ConnectionString& endpoint,
                         const WriteErrorDetail& error,
                         int copies ) :
            endpoint( endpoint ) {

            response.setOk( true );
            response.setN( 0 );

            for ( int i = 0; i < copies; ++i ) {
                WriteErrorDetail* errorCopy = new WriteErrorDetail;
                error.cloneTo( errorCopy );
                errorCopy->setIndex( i );
                response.addToErrDetails( errorCopy );
            }
        }


        MockWriteResult( const ConnectionString& endpoint, const BatchedCommandResponse& response ) :
                endpoint( endpoint ) {
            response.cloneTo( &this->response );
        }

        const ConnectionString endpoint;
        BatchedCommandResponse response;
    };

    /**
     * Implementation of the MultiCommandDispatch interface which allows registering a number of
     * endpoints on which errors are returned.  Note that *only* BatchedCommandResponses are
     * supported here.
     *
     * The first matching MockEndpoint for a request in the MockEndpoint* vector is used for one
     * request, then removed.  This allows simulating retryable errors where a second request
     * succeeds or has a different error reported.
     *
     * If an endpoint isn't registered with a MockEndpoint, just returns BatchedCommandResponses
     * with ok : true.
     */
    class MockMultiWriteCommand : public MultiCommandDispatch {
    public:

        void init( const std::vector<MockWriteResult*> mockEndpoints ) {
            ASSERT( !mockEndpoints.empty() );
            _mockEndpoints.mutableVector().insert( _mockEndpoints.mutableVector().end(),
                                                   mockEndpoints.begin(),
                                                   mockEndpoints.end() );
        }

        void addCommand( const ConnectionString& endpoint,
                         StringData dbName,
                         const BSONSerializable& request ) {
            _pending.push_back( endpoint );
        }

        void sendAll() {
            // No-op
        }

        int numPending() const {
            return static_cast<int>( _pending.size() );
        }

        /**
         * Returns an error response if the next pending endpoint returned has a corresponding
         * MockEndpoint.
         */
        Status recvAny( ConnectionString* endpoint, BSONSerializable* response ) {

            BatchedCommandResponse* batchResponse = //
                static_cast<BatchedCommandResponse*>( response );

            *endpoint = _pending.front();
            MockWriteResult* mockResponse = releaseByHost( _pending.front() );
            _pending.pop_front();

            if ( NULL == mockResponse ) {
                batchResponse->setOk( true );
                batchResponse->setN( 0 ); // TODO: Make this accurate
            }
            else {
                mockResponse->response.cloneTo( batchResponse );
                delete mockResponse;
            }

            ASSERT( batchResponse->isValid( NULL ) );
            return Status::OK();
        }

        const std::vector<MockWriteResult*>& getEndpoints() const {
            return _mockEndpoints.vector();
        }

    private:

        // Find a MockEndpoint* by host, and release it so we don't see it again
        MockWriteResult* releaseByHost( const ConnectionString& endpoint ) {
            std::vector<MockWriteResult*>& endpoints = _mockEndpoints.mutableVector();

            for ( std::vector<MockWriteResult*>::iterator it = endpoints.begin();
                it != endpoints.end(); ++it ) {
                MockWriteResult* storedEndpoint = *it;
                if ( storedEndpoint->endpoint.toString().compare( endpoint.toString() ) == 0 ) {
                    endpoints.erase( it );
                    return storedEndpoint;
                }
            }

            return NULL;
        }

        // Manually-stored ranges
        OwnedPointerVector<MockWriteResult> _mockEndpoints;

        std::deque<ConnectionString> _pending;
    };

} // namespace mongo