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
226
227
228
229
230
231
232
233
234
|
#![cfg(feature = "integration-tests")]
use futures::{stream::Stream, Future};
use mullvad_tests::{
mock_openvpn::search_openvpn_args, watch_event, DaemonRunner, MockOpenVpnPluginRpcClient,
PathWatcher,
};
use mullvad_types::DaemonEvent;
use std::{fs, path::Path, time::Duration};
use talpid_types::{
net::{Endpoint, TransportProtocol, TunnelEndpoint, TunnelType},
tunnel::{ActionAfterDisconnect, TunnelStateTransition},
};
#[cfg(target_os = "linux")]
const OPENVPN_PLUGIN_NAME: &str = "libtalpid_openvpn_plugin.so";
#[cfg(windows)]
const OPENVPN_PLUGIN_NAME: &str = "talpid_openvpn_plugin.dll";
#[test]
fn spawns_openvpn() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let openvpn_args_file = daemon.mock_openvpn_args_file();
let mut openvpn_args_file_events = PathWatcher::watch(&openvpn_args_file).unwrap();
assert!(!openvpn_args_file.exists());
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
openvpn_args_file_events.assert_create_write_close_sequence();
}
#[test]
fn respawns_openvpn_if_it_crashes() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let openvpn_args_file = daemon.mock_openvpn_args_file();
let mut openvpn_args_file_events = PathWatcher::watch(&openvpn_args_file).unwrap();
openvpn_args_file_events.set_timeout(Duration::from_secs(10));
assert!(!openvpn_args_file.exists());
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
openvpn_args_file_events.assert_create_write_close_sequence();
// Stop OpenVPN by removing the mock OpenVPN arguments file
fs::remove_file(&openvpn_args_file).expect("Failed to remove the mock OpenVPN arguments file");
assert_eq!(openvpn_args_file_events.next(), Some(watch_event::REMOVE));
openvpn_args_file_events.assert_create_write_close_sequence();
}
#[test]
fn changes_to_connecting_state() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let state_events = rpc_client.daemon_event_subscribe().wait().unwrap();
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
let _ = assert_state_event(
state_events,
TunnelStateTransition::Connecting(get_default_endpoint()),
);
assert_eq!(
rpc_client.get_state().unwrap(),
TunnelStateTransition::Connecting(get_default_endpoint())
);
}
#[test]
fn changes_to_connected_state() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let openvpn_args_file = daemon.mock_openvpn_args_file();
let mut openvpn_args_file_events = PathWatcher::watch(&openvpn_args_file).unwrap();
let state_events = rpc_client.daemon_event_subscribe().wait().unwrap();
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Connecting(get_default_endpoint()),
);
openvpn_args_file_events.assert_create_write_close_sequence();
let mut mock_plugin_client = create_mock_openvpn_plugin_client(openvpn_args_file);
mock_plugin_client.up().unwrap();
assert_state_event(
state_events,
TunnelStateTransition::Connected(get_default_endpoint()),
);
assert_eq!(
rpc_client.get_state().unwrap(),
TunnelStateTransition::Connected(get_default_endpoint())
);
}
#[test]
fn returns_to_connecting_state() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let openvpn_args_file = daemon.mock_openvpn_args_file();
let mut openvpn_args_file_events = PathWatcher::watch(&openvpn_args_file).unwrap();
let state_events = rpc_client.daemon_event_subscribe().wait().unwrap();
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Connecting(get_default_endpoint()),
);
openvpn_args_file_events.assert_create_write_close_sequence();
let mut mock_plugin_client = create_mock_openvpn_plugin_client(openvpn_args_file);
mock_plugin_client.up().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Connected(get_default_endpoint()),
);
mock_plugin_client.route_predown().unwrap();
// Wait for new OpenVPN instance
assert_eq!(openvpn_args_file_events.next(), Some(watch_event::REMOVE));
openvpn_args_file_events.assert_create_write_close_sequence();
let _ = assert_state_event(
state_events,
TunnelStateTransition::Disconnecting(ActionAfterDisconnect::Reconnect),
);
}
#[test]
fn disconnects() {
let mut daemon = DaemonRunner::spawn();
let mut rpc_client = daemon.rpc_client().unwrap();
let openvpn_args_file = daemon.mock_openvpn_args_file();
let mut openvpn_args_file_events = PathWatcher::watch(&openvpn_args_file).unwrap();
let state_events = rpc_client.daemon_event_subscribe().wait().unwrap();
rpc_client.set_account(Some("123456".to_owned())).unwrap();
rpc_client.connect().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Connecting(get_default_endpoint()),
);
openvpn_args_file_events.assert_create_write_close_sequence();
let mut mock_plugin_client = create_mock_openvpn_plugin_client(openvpn_args_file);
mock_plugin_client.up().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Connected(get_default_endpoint()),
);
rpc_client.disconnect().unwrap();
let state_events = assert_state_event(
state_events,
TunnelStateTransition::Disconnecting(ActionAfterDisconnect::Nothing),
);
let _ = assert_state_event(state_events, TunnelStateTransition::Disconnected);
}
fn get_default_endpoint() -> TunnelEndpoint {
TunnelEndpoint {
endpoint: Endpoint {
address: "192.168.0.100:1000".parse().unwrap(),
protocol: TransportProtocol::Udp,
},
tunnel_type: TunnelType::OpenVpn,
}
}
fn assert_state_event<
S: Stream<Item = DaemonEvent, Error = jsonrpc_client_core::Error> + std::fmt::Debug,
>(
mut receiver: S,
expected_state: TunnelStateTransition,
) -> S {
use futures::future::Either;
let mut transition = None;
while transition.is_none() {
let timer = tokio_timer::Timer::default();
let timeout = timer.sleep(Duration::from_secs(3));
let (event, receiver2) = match receiver.into_future().select2(timeout).wait() {
Ok(Either::A((stream_result, _timer))) => stream_result,
_ => panic!("Timed out waiting for tunnel state transition"),
};
receiver = receiver2;
if let DaemonEvent::StateTransition(new_state) = event.unwrap() {
transition = Some(new_state);
}
}
assert_eq!(transition.unwrap(), expected_state);
receiver
}
fn create_mock_openvpn_plugin_client<P: AsRef<Path>>(
openvpn_args_file_path: P,
) -> MockOpenVpnPluginRpcClient {
let address = get_plugin_arguments(openvpn_args_file_path);
MockOpenVpnPluginRpcClient::new(address)
.expect("Failed to create mock RPC client to connect to OpenVPN plugin event listener")
}
fn get_plugin_arguments<P: AsRef<Path>>(openvpn_args_file_path: P) -> String {
let mut arguments = search_openvpn_args(openvpn_args_file_path, OPENVPN_PLUGIN_NAME).skip(1);
arguments
.next()
.expect("Missing OpenVPN plugin RPC listener address argument")
.expect("Failed to read from mock OpenVPN arguments file")
}
|
