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
|
mod access_methods;
mod account;
pub mod config;
mod dns;
mod helpers;
mod install;
mod relay_ip_overrides;
mod settings;
mod software;
mod split_tunnel;
mod test_metadata;
mod tunnel;
mod tunnel_state;
mod ui;
use crate::{
mullvad_daemon::{MullvadClientArgument, RpcClientProvider},
tests::helpers::get_app_env,
};
use anyhow::Context;
pub use test_metadata::TestMetadata;
use test_rpc::ServiceClient;
use futures::future::BoxFuture;
use std::time::Duration;
const WAIT_FOR_TUNNEL_STATE_TIMEOUT: Duration = Duration::from_secs(40);
#[derive(Clone)]
pub struct TestContext {
pub rpc_provider: RpcClientProvider,
}
pub type TestWrapperFunction =
fn(TestContext, ServiceClient, MullvadClientArgument) -> BoxFuture<'static, anyhow::Result<()>>;
#[derive(thiserror::Error, Debug)]
pub enum Error {
#[error("RPC call failed")]
Rpc(#[from] test_rpc::Error),
#[error("geoip lookup failed")]
GeoipLookup(#[source] test_rpc::Error),
#[error("Found running daemon unexpectedly")]
DaemonRunning,
#[error("Daemon unexpectedly not running")]
DaemonNotRunning,
#[error("The daemon returned an error: {0}")]
Daemon(String),
#[error("The daemon ended up in the error state")]
UnexpectedErrorState(talpid_types::tunnel::ErrorState),
#[error("The gRPC client ran into an error: {0}")]
ManagementInterface(#[from] mullvad_management_interface::Error),
#[cfg(target_os = "macos")]
#[error("An error occurred: {0}")]
Other(String),
}
/// Get a list of all tests, sorted by priority.
pub fn get_tests() -> Vec<&'static TestMetadata> {
let mut tests: Vec<_> = inventory::iter::<TestMetadata>().collect();
tests.sort_by_key(|test| test.priority.unwrap_or(0));
tests
}
/// Restore settings to the defaults.
pub async fn cleanup_after_test(
rpc: ServiceClient,
rpc_provider: &RpcClientProvider,
) -> anyhow::Result<()> {
log::debug!("Cleaning up daemon in test cleanup");
// Check if daemon should be restarted
restart_daemon(rpc).await?;
let mut mullvad_client = rpc_provider.new_client().await;
helpers::disconnect_and_wait(&mut mullvad_client).await?;
// Bring all the settings into scope so we remember to reset them.
let mullvad_types::settings::Settings {
relay_settings,
bridge_settings,
obfuscation_settings,
bridge_state,
custom_lists,
api_access_methods,
allow_lan,
block_when_disconnected,
auto_connect,
tunnel_options,
relay_overrides,
show_beta_releases,
settings_version: _, // N/A
} = Default::default();
mullvad_client
.clear_custom_access_methods()
.await
.context("Could not clear custom api access methods")?;
for access_method in api_access_methods.iter() {
mullvad_client
.update_access_method(access_method.clone())
.await
.context("Could not reset default access method")?;
}
mullvad_client
.set_relay_settings(relay_settings)
.await
.context("Could not set relay settings")?;
let _ = relay_overrides;
mullvad_client
.clear_all_relay_overrides()
.await
.context("Could not set relay overrides")?;
mullvad_client
.set_auto_connect(auto_connect)
.await
.context("Could not set auto connect in cleanup")?;
mullvad_client
.set_allow_lan(allow_lan)
.await
.context("Could not set allow lan in cleanup")?;
mullvad_client
.set_show_beta_releases(show_beta_releases)
.await
.context("Could not set show beta releases in cleanup")?;
mullvad_client
.set_bridge_state(bridge_state)
.await
.context("Could not set bridge state in cleanup")?;
mullvad_client
.set_bridge_settings(bridge_settings.clone())
.await
.context("Could not set bridge settings in cleanup")?;
mullvad_client
.set_obfuscation_settings(obfuscation_settings.clone())
.await
.context("Could set obfuscation settings in cleanup")?;
mullvad_client
.set_block_when_disconnected(block_when_disconnected)
.await
.context("Could not set block when disconnected setting in cleanup")?;
mullvad_client
.clear_split_tunnel_apps()
.await
.context("Could not clear split tunnel apps in cleanup")?;
mullvad_client
.clear_split_tunnel_processes()
.await
.context("Could not clear split tunnel processes in cleanup")?;
mullvad_client
.set_dns_options(tunnel_options.dns_options.clone())
.await
.context("Could not clear dns options in cleanup")?;
mullvad_client
.set_quantum_resistant_tunnel(tunnel_options.wireguard.quantum_resistant)
.await
.context("Could not clear PQ options in cleanup")?;
let _ = custom_lists;
mullvad_client
.clear_custom_lists()
.await
.context("Could not remove custom list")?;
Ok(())
}
/// Conditionally restart the running daemon
///
/// If the daemon was started with non-standard environment variables, subsequent tests may break
/// due to assuming a default configuration. In that case, reset the environment variables and
/// restart.
async fn restart_daemon(rpc: ServiceClient) -> anyhow::Result<()> {
let current_env = rpc.get_daemon_environment().await?;
let default_env = get_app_env();
if current_env != default_env {
log::debug!("Restarting daemon due changed environment variables. Values since last test {current_env:?}");
rpc.set_daemon_environment(default_env).await?;
}
Ok(())
}
|
