Merge branch 'add-json-output-to-mullvad-status-debug-des-1117'

mullvad · Aug 7, 2024 · a82466b · a82466b
2 parents 95fec4f + 9df36ce
commit a82466b
Show file tree

Hide file tree

Showing 15 changed files with 72 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ Line wrap the file at 100 chars.                                              Th
 ## [Unreleased]
 ### Added
 - Add DAITA (Defence against AI-guided Traffic Analysis) setting for Linux and macOS.
+- Add `--json` flag to `mullvad status` CLI.
 
 ### Changed
 - Ignore obfuscation protocol constraints when the obfuscation mode is set to auto.

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -83,6 +83,8 @@ windows-sys = "0.52.0"
 chrono = { version = "0.4.26", default-features = false }
 clap = { version = "4.4.18", features = ["cargo", "derive"] }
 once_cell = "1.13"
+serde = "1.0.204"
+serde_json = "1.0.122"
 
 ipnetwork = "0.20"
 

diff --git a/android/translations-converter/Cargo.toml b/android/translations-converter/Cargo.toml
@@ -15,5 +15,5 @@ thiserror = { workspace = true }
 htmlize = { version = "1.0.2", features = ["unescape"] }
 once_cell = { workspace = true }
 regex = "1"
-serde = { version = "1", features = ["derive"] }
+serde = { workspace = true, features = ["derive"] }
 quick-xml = { version = "0.27.1", features = ["serialize"] }
diff --git a/mullvad-api/Cargo.toml b/mullvad-api/Cargo.toml
@@ -23,8 +23,8 @@ http = "0.2"
 hyper = { version = "0.14", features = ["client", "stream", "http1", "tcp" ] }
 ipnetwork = { workspace = true }
 log = { workspace = true }
-serde = "1"
-serde_json = "1.0"
+serde = { workspace = true }
+serde_json = { workspace = true }
 tokio = { workspace = true, features = ["macros", "time", "rt-multi-thread", "net", "io-std", "io-util", "fs"] }
 tokio-rustls = "0.24.1"
 tokio-socks = "0.5.1"

diff --git a/mullvad-cli/Cargo.toml b/mullvad-cli/Cargo.toml
@@ -29,6 +29,8 @@ talpid-types = { path = "../talpid-types" }
 
 mullvad-management-interface = { path = "../mullvad-management-interface" }
 tokio = { workspace = true, features =  ["macros", "rt-multi-thread", "fs"] }
+serde = { workspace = true }
+serde_json = { workspace = true }
 
 [target.'cfg(all(unix, not(target_os = "android")))'.dependencies]
 clap_complete = { version = "4.4.8" }

diff --git a/mullvad-cli/src/cmds/status.rs b/mullvad-cli/src/cmds/status.rs
@@ -1,8 +1,10 @@
-use anyhow::Result;
+use anyhow::{Context, Result};
 use clap::{Args, Subcommand};
 use futures::StreamExt;
 use mullvad_management_interface::{client::DaemonEvent, MullvadProxyClient};
 use mullvad_types::{device::DeviceState, states::TunnelState};
+use serde::Serialize;
+use std::fmt::Debug;
 
 use crate::format;
 
@@ -19,8 +21,12 @@ pub struct StatusArgs {
     verbose: bool,
 
     /// Enable debug output
-    #[arg(long, short = 'd')]
+    #[arg(long, short = 'd', conflicts_with_all = ["verbose", "json"])]
     debug: bool,
+
+    /// Format output as JSON
+    #[arg(long, short = 'j', conflicts_with_all = ["verbose", "debug"])]
+    json: bool,
 }
 
 impl Status {
@@ -33,6 +39,10 @@ impl Status {
                 DaemonEvent::TunnelState(new_state) => {
                     if args.debug {
                         println!("New tunnel state: {new_state:#?}");
+                    } else if args.json {
+                        let json = serde_json::to_string(&new_state)
+                            .context("Failed to format output as JSON")?;
+                        println!("{json}");
                     } else {
                         // When we enter the connected or disconnected state, am.i.mullvad.net will
                         // be polled to get exit location. When it arrives, we will get another
@@ -70,34 +80,22 @@ impl Status {
                     }
                 }
                 DaemonEvent::Settings(settings) => {
-                    if args.debug {
-                        println!("New settings: {settings:#?}");
-                    }
+                    print_debug_or_json(&args, "New settings", &settings)?;
                 }
                 DaemonEvent::RelayList(relay_list) => {
-                    if args.debug {
-                        println!("New relay list: {relay_list:#?}");
-                    }
+                    print_debug_or_json(&args, "New relay list", &relay_list)?;
                 }
                 DaemonEvent::AppVersionInfo(app_version_info) => {
-                    if args.debug {
-                        println!("New app version info: {app_version_info:#?}");
-                    }
+                    print_debug_or_json(&args, "New app version info", &app_version_info)?;
                 }
                 DaemonEvent::Device(device) => {
-                    if args.debug {
-                        println!("Device event: {device:#?}");
-                    }
+                    print_debug_or_json(&args, "Device event", &device)?;
                 }
                 DaemonEvent::RemoveDevice(device) => {
-                    if args.debug {
-                        println!("Remove device event: {device:#?}");
-                    }
+                    print_debug_or_json(&args, "Remove device event", &device)?;
                 }
                 DaemonEvent::NewAccessMethod(access_method) => {
-                    if args.debug {
-                        println!("New access method: {access_method:#?}");
-                    }
+                    print_debug_or_json(&args, "New access method", &access_method)?;
                 }
             }
         }
@@ -114,6 +112,9 @@ pub async fn handle(cmd: Option<Status>, args: StatusArgs) -> Result<()> {
 
     if args.debug {
         println!("Tunnel state: {state:#?}");
+    } else if args.json {
+        let json = serde_json::to_string(&state).context("Failed to format output as JSON")?;
+        println!("{json}");
     } else {
         format::print_state(&state, args.verbose);
         format::print_location(&state);
@@ -139,3 +140,18 @@ fn print_account_logged_out(state: &TunnelState, device: &DeviceState) {
         TunnelState::Disconnected { .. } | TunnelState::Disconnecting(_) => (),
     }
 }
+
+fn print_debug_or_json<T: Debug + Serialize>(
+    args: &StatusArgs,
+    debug_message: &str,
+    t: &T,
+) -> Result<()> {
+    if args.debug {
+        println!("{debug_message}: {t:#?}");
+    } else if args.json {
+        let json = serde_json::to_string(&t).context("Failed to format output as JSON")?;
+        println!("{json}");
+    }
+
+    Ok(())
+}
diff --git a/mullvad-daemon/Cargo.toml b/mullvad-daemon/Cargo.toml
@@ -23,8 +23,8 @@ once_cell = { workspace = true }
 libc = "0.2"
 log = { workspace = true }
 regex = "1.0"
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
+serde = { workspace = true, features = ["derive"] }
+serde_json = { workspace = true }
 tokio = { workspace = true, features =  ["fs", "io-util", "rt-multi-thread", "sync", "time"] }
 tokio-stream = "0.1"
 

diff --git a/mullvad-relay-selector/Cargo.toml b/mullvad-relay-selector/Cargo.toml
@@ -18,7 +18,7 @@ itertools = "0.12"
 log = { workspace = true }
 once_cell = { workspace = true }
 rand = "0.8.5"
-serde_json = "1.0"
+serde_json = { workspace = true }
 
 talpid-types = { path = "../talpid-types" }
 mullvad-types = { path = "../mullvad-types" }

diff --git a/mullvad-types/Cargo.toml b/mullvad-types/Cargo.toml
@@ -17,7 +17,7 @@ ipnetwork = { workspace = true }
 once_cell = { workspace = true }
 log = { workspace = true }
 regex = "1"
-serde = { version = "1.0", features = ["derive"] }
+serde = { workspace = true, features = ["derive"] }
 uuid = { version = "1.4.1", features = ["v4", "serde" ] }
 
 talpid-types = { path = "../talpid-types" }

diff --git a/mullvad-types/src/device.rs b/mullvad-types/src/device.rs
@@ -86,7 +86,7 @@ impl AccountAndDevice {
 }
 
 /// Reason why a [DeviceEvent] was emitted.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize)]
 pub enum DeviceEventCause {
     /// Logged in on a new device.
     LoggedIn,
@@ -101,15 +101,15 @@ pub enum DeviceEventCause {
 }
 
 /// Emitted when logging in or out of an account, or when the device changes.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize)]
 pub struct DeviceEvent {
     pub cause: DeviceEventCause,
     pub new_state: DeviceState,
 }
 
 /// Emitted when a device is removed using the `RemoveDevice` RPC.
 /// This is not sent by a normal logout or when it is revoked remotely.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize)]
 pub struct RemoveDeviceEvent {
     pub account_token: AccountToken,
     pub new_devices: Vec<Device>,

diff --git a/talpid-core/Cargo.toml b/talpid-core/Cargo.toml
@@ -58,8 +58,8 @@ pcap = { version = "2.0", features = ["capture-stream"] }
 pnet_packet = "0.34"
 tun = { version = "0.5.5", features = ["async"] }
 nix = { version = "0.28", features = ["socket"] }
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
+serde = { workspace = true, features = ["derive"] }
+serde_json = { workspace = true }
 
 [target.'cfg(windows)'.dependencies]
 bitflags = "1.2"

diff --git a/talpid-types/Cargo.toml b/talpid-types/Cargo.toml
@@ -11,7 +11,7 @@ rust-version.workspace = true
 workspace = true
 
 [dependencies]
-serde = { version = "1.0", features = ["derive"] }
+serde = { workspace = true, features = ["derive"] }
 ipnetwork = { workspace = true }
 base64 = "0.22.0"
 x25519-dalek = { version = "2.0.1", features = ["static_secrets", "zeroize", "getrandom"] }

diff --git a/test/Cargo.lock b/test/Cargo.lock
diff --git a/test/connection-checker/Cargo.toml b/test/connection-checker/Cargo.toml
@@ -16,5 +16,5 @@ color-eyre = "0.6.2"
 eyre = "0.6.12"
 ping = "0.5.2"
 reqwest = { version = "0.11.24", default-features = false, features = ["blocking", "rustls-tls", "json"] }
-serde = { version = "1.0.197", features = ["derive"] }
+serde = { workspace = true, features = ["derive"] }
 socket2 = { version = "0.5.4", features = ["all"] }