From e808ccbdb5e1aa9423eea48f6ba52328ead988d4 Mon Sep 17 00:00:00 2001 From: Kevin Yue Date: Sat, 27 Jun 2026 14:26:28 +0800 Subject: [PATCH] fix: allow configurable gpclient lock file --- apps/gpclient/src/cli.rs | 46 ++++++++++++++++++++++++++-- apps/gpclient/src/connect/gateway.rs | 21 +++++++------ apps/gpclient/src/disconnect.rs | 10 +++--- 3 files changed, 60 insertions(+), 17 deletions(-) diff --git a/apps/gpclient/src/cli.rs b/apps/gpclient/src/cli.rs index ad44c09..886637c 100644 --- a/apps/gpclient/src/cli.rs +++ b/apps/gpclient/src/cli.rs @@ -1,4 +1,9 @@ -use std::{env::temp_dir, fs::File, str::FromStr}; +use std::{ + env::temp_dir, + fs::File, + path::{Path, PathBuf}, + str::FromStr, +}; use anyhow::bail; use clap::{Parser, Subcommand}; @@ -31,6 +36,7 @@ const VERSION: &str = concat!( pub(crate) struct SharedArgs<'a> { pub(crate) fix_openssl: bool, pub(crate) ignore_tls_errors: bool, + pub(crate) lock_file: &'a Path, pub(crate) verbose: &'a InfoLevelVerbosity, } @@ -75,6 +81,13 @@ struct Cli { fix_openssl: bool, #[arg(long, help = "Ignore the TLS errors")] ignore_tls_errors: bool, + #[arg( + long, + global = true, + default_value = GP_CLIENT_LOCK_FILE, + help = "Path to the gpclient PID lock file" + )] + lock_file: PathBuf, #[command(flatten)] verbose: InfoLevelVerbosity, @@ -92,7 +105,7 @@ impl Args for Cli { impl Cli { async fn is_running(&self) -> bool { - let Ok(c) = fs::read_to_string(GP_CLIENT_LOCK_FILE).await else { + let Ok(c) = fs::read_to_string(&self.lock_file).await else { return false; }; @@ -131,6 +144,7 @@ impl Cli { let shared_args = SharedArgs { fix_openssl: self.fix_openssl, ignore_tls_errors: self.ignore_tls_errors, + lock_file: &self.lock_file, verbose: &self.verbose, }; @@ -140,7 +154,7 @@ impl Cli { match &self.command { CliCommand::Connect(args) => ConnectHandler::new(args, &shared_args).handle().await, - CliCommand::Disconnect(args) => DisconnectHandler::new(args).handle().await, + CliCommand::Disconnect(args) => DisconnectHandler::new(args, shared_args.lock_file).handle().await, CliCommand::LaunchGui(args) => LaunchGuiHandler::new(args).handle().await, CliCommand::Hip(args) => HipHandler::new(args).handle().await, } @@ -177,3 +191,29 @@ pub(crate) async fn run() { std::process::exit(1); } } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn lock_file_defaults_to_standard_path() { + let cli = Cli::try_parse_from(["gpclient", "connect", "portal.example.com"]).expect("cli should parse"); + + assert_eq!(cli.lock_file, PathBuf::from(GP_CLIENT_LOCK_FILE)); + } + + #[test] + fn lock_file_can_be_overridden_after_subcommand() { + let cli = Cli::try_parse_from([ + "gpclient", + "connect", + "portal.example.com", + "--lock-file", + "/tmp/gpclient-portal.lock", + ]) + .expect("global lock file option should parse after subcommand"); + + assert_eq!(cli.lock_file, PathBuf::from("/tmp/gpclient-portal.lock")); + } +} diff --git a/apps/gpclient/src/connect/gateway.rs b/apps/gpclient/src/connect/gateway.rs index 3b29480..001070c 100644 --- a/apps/gpclient/src/connect/gateway.rs +++ b/apps/gpclient/src/connect/gateway.rs @@ -1,5 +1,6 @@ use std::{ fs, + path::Path, sync::{ Arc, Mutex, atomic::{AtomicBool, Ordering}, @@ -21,9 +22,8 @@ use log::{info, warn}; use openconnect::{Vpn, VpnBuilder}; use tokio::{runtime::Handle, task::JoinHandle}; -use crate::{ - GP_CLIENT_LOCK_FILE, - session::{SessionContextInput, build_session_context, session_info_from_vpn, spawn_session_runtime_with_info}, +use crate::session::{ + SessionContextInput, build_session_context, session_info_from_vpn, spawn_session_runtime_with_info, }; use super::{ConnectHandler, args::cookie_cache_path}; @@ -384,9 +384,12 @@ impl ConnectHandler<'_> { vpn_clone.disconnect(); }); + let lock_file = self.shared_args.lock_file.to_path_buf(); + let lock_file_on_connect = lock_file.clone(); + let connect_result = vpn.connect(move |vpn_session_info| { tunnel_established_on_connect.store(true, Ordering::SeqCst); - write_pid_file(); + write_pid_file(&lock_file_on_connect); let Some(session_ctx) = session_ctx_on_connect.lock().unwrap().take() else { return; @@ -403,9 +406,9 @@ impl ConnectHandler<'_> { task.abort(); } - if fs::metadata(GP_CLIENT_LOCK_FILE).is_ok() { + if fs::metadata(&lock_file).is_ok() { info!("Removing PID file"); - fs::remove_file(GP_CLIENT_LOCK_FILE).map_err(|err| GatewayConnectError::after_tunnel(err.into()))?; + fs::remove_file(&lock_file).map_err(|err| GatewayConnectError::after_tunnel(err.into()))?; } let disconnect_requested = disconnect_requested.load(Ordering::SeqCst); @@ -458,13 +461,13 @@ fn direct_gateway_command(gateway: &str) -> String { format!("gpauth --gateway {gateway} | sudo gpclient connect {gateway} --as-gateway --cookie-on-stdin") } -fn write_pid_file() { +fn write_pid_file(lock_file: &Path) { let pid = std::process::id(); - if let Err(err) = fs::write(GP_CLIENT_LOCK_FILE, pid.to_string()) { + if let Err(err) = fs::write(lock_file, pid.to_string()) { warn!("Failed to write PID file: {}", err); } else { - info!("Wrote PID {} to {}", pid, GP_CLIENT_LOCK_FILE); + info!("Wrote PID {} to {}", pid, lock_file.display()); } } diff --git a/apps/gpclient/src/disconnect.rs b/apps/gpclient/src/disconnect.rs index a0c6d66..060e288 100644 --- a/apps/gpclient/src/disconnect.rs +++ b/apps/gpclient/src/disconnect.rs @@ -1,8 +1,7 @@ -use crate::GP_CLIENT_LOCK_FILE; use clap::Args; use gpapi::utils::lock_file::gpservice_lock_info; use log::{info, warn}; -use std::{fs, str::FromStr, thread, time::Duration}; +use std::{fs, path::Path, str::FromStr, thread, time::Duration}; use sysinfo::{Pid, Signal, System}; #[derive(Args)] @@ -17,16 +16,17 @@ pub struct DisconnectArgs { pub struct DisconnectHandler<'a> { args: &'a DisconnectArgs, + lock_file: &'a Path, } impl<'a> DisconnectHandler<'a> { - pub fn new(args: &'a DisconnectArgs) -> Self { - Self { args } + pub fn new(args: &'a DisconnectArgs, lock_file: &'a Path) -> Self { + Self { args, lock_file } } pub async fn handle(&self) -> anyhow::Result<()> { // Try to disconnect the CLI client - if let Ok(c) = fs::read_to_string(GP_CLIENT_LOCK_FILE) { + if let Ok(c) = fs::read_to_string(self.lock_file) { send_signal(c.trim(), Signal::Interrupt).unwrap_or_else(|err| { warn!("Failed to send signal to client: {}", err); });