Merge branch 'add-unit-test-for-resetting-daemon-settings-des-2584'

Author: MarkusPettersson98

mullvad-types/src/settings/dns.rs

@@ -19,7 +19,7 @@ pub struct DnsOptions {
 }
 
 /// Default DNS config
-#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
 #[serde(default)]
 pub struct DefaultDnsOptions {
     pub block_ads: bool,
@@ -30,15 +30,57 @@ pub struct DefaultDnsOptions {
     pub block_social_media: bool,
 }
 
-/// Custom DNS config
-#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
-pub struct CustomDnsOptions {
-    pub addresses: Vec<IpAddr>,
-}
-
 impl DefaultDnsOptions {
+    /// Create [`DefaultDnsOptions`] which does not configure DNS.
+    pub const fn new() -> Self {
+        Self {
+            block_ads: false,
+            block_trackers: false,
+            block_malware: false,
+            block_adult_content: false,
+            block_gambling: false,
+            block_social_media: false,
+        }
+    }
+
+    /// Enable ads DNS content blocker.
+    pub const fn block_ads(mut self) -> Self {
+        self.block_ads = true;
+        self
+    }
+
+    /// Enable trackers DNS content blocker.
+    pub const fn block_trackers(mut self) -> Self {
+        self.block_trackers = true;
+        self
+    }
+
+    /// Enable malware DNS content blocker.
+    pub const fn block_malware(mut self) -> Self {
+        self.block_malware = true;
+        self
+    }
+
+    /// Enable adult content DNS content blocker.
+    pub const fn block_adult_content(mut self) -> Self {
+        self.block_adult_content = true;
+        self
+    }
+
+    /// Enable gambling DNS content blocker.
+    pub const fn block_gambling(mut self) -> Self {
+        self.block_gambling = true;
+        self
+    }
+
+    /// Enable social media DNS content blocker.
+    pub const fn block_social_media(mut self) -> Self {
+        self.block_social_media = true;
+        self
+    }
+
     /// Return whether any content blockers are enabled.
-    pub fn any_blockers_enabled(&self) -> bool {
+    pub const fn any_blockers_enabled(&self) -> bool {
         let DefaultDnsOptions {
             block_ads,
             block_trackers,
@@ -56,3 +98,15 @@ impl DefaultDnsOptions {
             || block_social_media
     }
 }
+
+impl Default for DefaultDnsOptions {
+    fn default() -> DefaultDnsOptions {
+        DefaultDnsOptions::new()
+    }
+}
+
+/// Custom DNS config
+#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
+pub struct CustomDnsOptions {
+    pub addresses: Vec<IpAddr>,
+}

test/test-manager/src/tests/settings.rs

@@ -3,7 +3,9 @@ use super::{
     helpers::{connect_and_wait, send_guest_probes},
 };
 
+use anyhow::{Context, ensure};
 use mullvad_management_interface::MullvadProxyClient;
+use mullvad_types::settings::{DefaultDnsOptions, DnsOptions, Settings};
 use std::net::SocketAddr;
 use test_macro::test_function;
 use test_rpc::ServiceClient;
@@ -185,3 +187,64 @@ pub async fn test_lockdown(
 
     Ok(())
 }
+
+/// Reset settings to their default values.
+///
+/// The account should still be logged in after resetting settings.
+#[test_function]
+pub async fn test_reset_settings(
+    _: TestContext,
+    _: ServiceClient,
+    mut mullvad_client: MullvadProxyClient,
+) -> anyhow::Result<()> {
+    // Change some settings to non-default values.
+    {
+        let err = "Failed to generate random settings";
+        mullvad_client.set_allow_lan(true).await.context(err)?;
+        mullvad_client
+            .set_dns_options(DnsOptions {
+                default_options: DefaultDnsOptions::new().block_ads().block_malware(),
+                ..Default::default()
+            })
+            .await
+            .context(err)?;
+        mullvad_client.set_lockdown_mode(true).await.context(err)?;
+    }
+    // Note: We do not double-check that the daemon reports these settings changes. We trust other
+    // E2E tests to cover this.
+    // Soft-reset settings by invoking the `reset-settings` rpc.
+    mullvad_client
+        .reset_settings()
+        .await
+        .context("Failed to reset settings")?;
+    // Check that all changed settings have indeed been reset.
+    let daemon = mullvad_client
+        .get_settings()
+        .await
+        .context("Failed to get settings")?;
+    let default = Settings::default();
+    // Santiy-check that data that shouldn't have been touched have indeed been kept intact.
+    // Are we still logged in?
+    // Are the custom lists intact?
+    ensure!(
+        mullvad_client.get_account_history().await?.is_some(),
+        "Logged out after reset settings RPC"
+    );
+    // Note: We can not compare `daemon` with `default` directly because Settings::default is
+    // non-deterministic ..
+    ensure!(
+        daemon.lockdown_mode == default.lockdown_mode,
+        "Lockdown mode was not reset"
+    );
+    ensure!(
+        daemon.allow_lan == default.allow_lan,
+        "Lockdown mode was not reset"
+    );
+    ensure!(
+        daemon.tunnel_options == default.tunnel_options,
+        "Lockdown mode was not reset"
+    );
+    // TODO: check other data as well, such as log files. Do this after having written such a test
+    // first.
+    Ok(())
+}