File: webrtc_connection_matchers.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (225 lines) | stat: -rw-r--r-- 8,427 bytes parent folder | download | duplicates (5)
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_WEBRTC_CONNECTION_MATCHERS_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_WEBRTC_CONNECTION_MATCHERS_H_

#include <algorithm>
#include <iterator>
#include <ostream>
#include <vector>

#include "base/strings/strcat.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "third_party/webrtc/api/rtc_error.h"
#include "third_party/webrtc/p2p/base/connection.h"
#include "third_party/webrtc/p2p/base/ice_controller_interface.h"
#include "third_party/webrtc/p2p/base/ice_switch_reason.h"
#include "third_party/webrtc_overrides/p2p/base/ice_switch_proposal.h"

namespace webrtc {

// Pretty prints a connection object for tests.
inline void PrintTo(const Connection* conn, std::ostream* os) {
  *os << (conn ? conn->ToString() : "(nullptr)");
}

// Pretty prints an optional connection object for tests.
inline void PrintTo(std::optional<const Connection*> conn, std::ostream* os) {
  if (conn.has_value()) {
    PrintTo(conn.value(), os);
  } else {
    *os << "<no connection>";
  }
}

// Pretty prints a ping result for tests.
inline void PrintTo(const IceControllerInterface::PingResult& result,
                    std::ostream* os) {
  *os << "PingResult[";
  PrintTo(result.connection, os);
  *os << ":" << result.recheck_delay_ms << "]";
}

// Pretty prints an ICE switch reason for tests.
inline void PrintTo(const IceSwitchReason reason, std::ostream* os) {
  *os << IceSwitchReasonToString(reason);
}

// Pretty prints an ICE recheck event for tests.
inline void PrintTo(const IceRecheckEvent& event, std::ostream* os) {
  *os << event.ToString();
}

// Pretty prints a switch result for tests.
inline void PrintTo(const IceControllerInterface::SwitchResult& result,
                    std::ostream* os) {
  *os << "SwitchResult[";
  PrintTo(result.connection, os);
  *os << ":"
      << (result.recheck_event.has_value() ? result.recheck_event->ToString()
                                           : "<no recheck>");
  int ctr = 1;
  for (const Connection* conn : result.connections_to_forget_state_on) {
    *os << "(" << ctr++ << ":";
    PrintTo(conn, os);
    *os << ")";
  }
  *os << "]";
}

// Pretty prints an RTCError for tests.
inline void PrintTo(const RTCErrorType error, std::ostream* os) {
  *os << ToString(error);
}

}  // namespace webrtc

namespace blink {

namespace {

using ::testing::ExplainMatchResult;
using ::testing::Optional;
using ::testing::PrintToString;
using ::testing::UnorderedPointwise;

}  // unnamed namespace

// Tests the equality of a blink::IceConnection and a webrtc::Connection.
MATCHER_P(ConnectionEq,
          /* const blink::IceConnection& arg, */
          /* const webrtc::Connection* */ conn,
          base::StrCat({negation ? "doesn't match " : "matches ",
                        PrintToString(conn)})) {
  return conn != nullptr && arg.id() == conn->id() &&
         arg.local_candidate() == conn->local_candidate() &&
         arg.remote_candidate() == conn->remote_candidate() &&
         arg.connected() == conn->connected() &&
         arg.selected() == conn->selected() &&
         arg.last_ping_sent() == conn->last_ping_sent() &&
         arg.last_ping_received() == conn->last_ping_received() &&
         arg.last_data_received() == conn->last_data_received() &&
         arg.last_ping_response_received() ==
             conn->last_ping_response_received() &&
         arg.num_pings_sent() == conn->num_pings_sent();
}

// Tests the equality of two optionals containing a blink::IceConnection and a
// webrtc::Connection each.
MATCHER_P(ConnectionOptionalsEq,
          /* const std::optional<blink::IceConnection> arg, */
          /* const std::optional<webrtc::Connection*> */ conn,
          "") {
  if (arg.has_value()) {
    return ExplainMatchResult(ConnectionEq(conn.value_or(nullptr)), arg.value(),
                              result_listener);
  }
  return !conn.has_value() || conn.value() == nullptr;
}

// Helper to test the equality of a (blink::IceConnection, webrtc::Connection)
// tuple using ConnectionEq for use with container matchers.
MATCHER(CricketBlinkConnectionTupleEq,
        /* std::tuple<const blink::IceConnection&, const webrtc::Connection*>
           arg, */
        "") {
  return ExplainMatchResult(ConnectionEq(std::get<1>(arg)), std::get<0>(arg),
                            result_listener);
}

// Tests the equality of two sequences containing blink::IceConnection and
// webrtc::Connection objects each, ignoring null webrtc::Connections and
// ordering.
MATCHER_P(ConnectionSequenceEq,
          /* std::vector<blink::IceConnection> arg, */
          /* std::vector<const webrtc::Connection*> */ connections,
          "") {
  std::vector<const webrtc::Connection*> non_null_connections;
  std::ranges::copy_if(connections, std::back_inserter(non_null_connections),
                       [](auto conn) { return conn != nullptr; });
  return ExplainMatchResult(
      UnorderedPointwise(CricketBlinkConnectionTupleEq(), non_null_connections),
      arg, result_listener);
}

// Tests the equality of a blink::IcePingProposal and a webrtc::PingResult.
MATCHER_P2(PingProposalEq,
           /* const blink::IcePingProposal& arg, */
           /* const webrtc::IceControllerInterface::PingResult& */ result,
           /* bool */ reply_expected,
           base::StrCat({negation ? "doesn't match " : "matches ",
                         PrintToString(result)})) {
  if (!ExplainMatchResult(ConnectionOptionalsEq(result.connection),
                          arg.connection(), result_listener)) {
    return false;
  }
  if (!ExplainMatchResult(Optional(result.recheck_delay_ms),
                          arg.recheck_delay_ms(), result_listener)) {
    return false;
  }
  return arg.reply_expected() == reply_expected;
}

// Tests the equality of a blink::IceRecheckEvent and a
// webrtc::IceRecheckEvent.
MATCHER_P(RecheckEventEq,
          /* const blink::IceRecheckEvent& arg, */
          /* const webrtc::IceRecheckEvent& */ event,
          base::StrCat({negation ? "doesn't match " : "matches ",
                        PrintToString(event)})) {
  return blink::ConvertFromWebrtcIceSwitchReason(event.reason) == arg.reason &&
         event.recheck_delay_ms == arg.recheck_delay_ms;
}

// Tests the equality of a blink::IceSwitchProposal and a webrtc::SwitchResult.
MATCHER_P3(SwitchProposalEq,
           /* const blink::IceSwitchProposal& arg, */
           /* const webrtc::IceSwitchReason */ reason,
           /* const webrtc::IceControllerInterface::SwitchResult& */ result,
           /* bool */ reply_expected,
           base::StrCat({negation ? "doesn't match " : "matches ",
                         PrintToString(result)})) {
  if (blink::ConvertFromWebrtcIceSwitchReason(reason) != arg.reason()) {
    return false;
  }
  if (!ExplainMatchResult(ConnectionOptionalsEq(result.connection),
                          arg.connection(), result_listener)) {
    return false;
  }
  if (result.recheck_event.has_value() != arg.recheck_event().has_value()) {
    return false;
  }
  if (result.recheck_event.has_value() &&
      !ExplainMatchResult(
          Optional(RecheckEventEq(result.recheck_event.value())),
          arg.recheck_event(), result_listener)) {
    return false;
  }
  if (!ExplainMatchResult(
          ConnectionSequenceEq(result.connections_to_forget_state_on),
          arg.connections_to_forget_state_on(), result_listener)) {
    return false;
  }
  return arg.reply_expected() == reply_expected;
}

// Tests the equality of a blink::IceOruneProposal and a collection of
// webrtc::Connections selected for pruning.
MATCHER_P2(PruneProposalEq,
           /* const blink::IcePruneProposal& arg, */
           /* std::vector<const webrtc::Connection*> */ connections,
           /* bool */ reply_expected,
           base::StrCat({negation ? "doesn't match " : "matches ",
                         PrintToString(connections)})) {
  if (!ExplainMatchResult(ConnectionSequenceEq(connections),
                          arg.connections_to_prune(), result_listener)) {
    return false;
  }
  return arg.reply_expected() == reply_expected;
}

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_PEERCONNECTION_WEBRTC_CONNECTION_MATCHERS_H_