refactor(backend): phase 3 - unify error handling and fix backup timestamp bug
Key improvements: - Extract switch_provider_internal() returning AppError for better testability - Fix backup mtime inheritance: use read+write instead of fs::copy to ensure latest backup survives cleanup - Add 15+ integration tests covering provider commands, atomic writes, and rollback scenarios - Expose write_codex_live_atomic, AppState, and test hooks in public API - Extract tests/support.rs with isolated HOME and mutex utilities Test coverage: - Provider switching with live config backfill and MCP sync - Codex atomic write success and failure rollback - Backup retention policy with proper mtime ordering - Negative cases: missing auth field, invalid provider ID
This commit is contained in:
Jason
@@ -1,52 +1,14 @@
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
use serde_json::json;
|
||||
use std::sync::{Mutex, OnceLock};
|
||||
|
||||
use cc_switch_lib::{
|
||||
create_backup, get_claude_settings_path, read_json_file, sync_current_providers_to_live,
|
||||
update_settings, AppSettings, AppType, MultiAppConfig, Provider,
|
||||
create_backup, get_claude_settings_path, read_json_file, sync_current_providers_to_live, AppType,
|
||||
MultiAppConfig, Provider,
|
||||
};
|
||||
|
||||
fn ensure_test_home() -> &'static Path {
|
||||
static HOME: OnceLock<std::path::PathBuf> = OnceLock::new();
|
||||
HOME.get_or_init(|| {
|
||||
let base = std::env::temp_dir().join("cc-switch-test-home");
|
||||
if base.exists() {
|
||||
let _ = std::fs::remove_dir_all(&base);
|
||||
}
|
||||
std::fs::create_dir_all(&base).expect("create test home");
|
||||
std::env::set_var("HOME", &base);
|
||||
#[cfg(windows)]
|
||||
std::env::set_var("USERPROFILE", &base);
|
||||
base
|
||||
})
|
||||
.as_path()
|
||||
}
|
||||
|
||||
fn reset_test_fs() {
|
||||
let home = ensure_test_home();
|
||||
for sub in [".claude", ".codex", ".cc-switch"] {
|
||||
let path = home.join(sub);
|
||||
if path.exists() {
|
||||
if let Err(err) = fs::remove_dir_all(&path) {
|
||||
eprintln!("failed to clean {}: {}", path.display(), err);
|
||||
}
|
||||
}
|
||||
}
|
||||
let claude_json = home.join(".claude.json");
|
||||
if claude_json.exists() {
|
||||
let _ = fs::remove_file(&claude_json);
|
||||
}
|
||||
// 重置内存中的设置缓存，确保测试环境不受上一次调用影响
|
||||
// 写入默认设置即可刷新 OnceLock 中的缓存数据
|
||||
let _ = update_settings(AppSettings::default());
|
||||
}
|
||||
|
||||
fn test_mutex() -> &'static Mutex<()> {
|
||||
static MUTEX: OnceLock<Mutex<()>> = OnceLock::new();
|
||||
MUTEX.get_or_init(|| Mutex::new(()))
|
||||
}
|
||||
#[path = "support.rs"]
|
||||
mod support;
|
||||
use support::{ensure_test_home, reset_test_fs, test_mutex};
|
||||
|
||||
#[test]
|
||||
fn sync_claude_provider_writes_live_settings() {
|
||||
@@ -287,6 +249,129 @@ fn sync_enabled_to_codex_returns_error_on_invalid_toml() {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sync_codex_provider_missing_auth_returns_error() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
|
||||
let mut config = MultiAppConfig::default();
|
||||
let provider = Provider::with_id(
|
||||
"codex-missing-auth".to_string(),
|
||||
"No Auth".to_string(),
|
||||
json!({
|
||||
"config": "model = \"test\""
|
||||
}),
|
||||
None,
|
||||
);
|
||||
let manager = config
|
||||
.get_manager_mut(&AppType::Codex)
|
||||
.expect("codex manager");
|
||||
manager.providers.insert(provider.id.clone(), provider);
|
||||
manager.current = "codex-missing-auth".to_string();
|
||||
|
||||
let err = sync_current_providers_to_live(&mut config)
|
||||
.expect_err("sync should fail when auth missing");
|
||||
match err {
|
||||
cc_switch_lib::AppError::Config(msg) => {
|
||||
assert!(msg.contains("auth"), "error message should mention auth");
|
||||
}
|
||||
other => panic!("unexpected error variant: {other:?}"),
|
||||
}
|
||||
|
||||
// 确认未产生任何 live 配置文件
|
||||
assert!(
|
||||
!cc_switch_lib::get_codex_auth_path().exists(),
|
||||
"auth.json should not be created on failure"
|
||||
);
|
||||
assert!(
|
||||
!cc_switch_lib::get_codex_config_path().exists(),
|
||||
"config.toml should not be created on failure"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn write_codex_live_atomic_persists_auth_and_config() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
|
||||
let auth = json!({ "OPENAI_API_KEY": "dev-key" });
|
||||
let config_text = r#"
|
||||
[mcp_servers.echo]
|
||||
type = "stdio"
|
||||
command = "echo"
|
||||
args = ["ok"]
|
||||
"#;
|
||||
|
||||
cc_switch_lib::write_codex_live_atomic(&auth, Some(config_text))
|
||||
.expect("atomic write should succeed");
|
||||
|
||||
let auth_path = cc_switch_lib::get_codex_auth_path();
|
||||
let config_path = cc_switch_lib::get_codex_config_path();
|
||||
assert!(auth_path.exists(), "auth.json should be created");
|
||||
assert!(config_path.exists(), "config.toml should be created");
|
||||
|
||||
let stored_auth: serde_json::Value =
|
||||
cc_switch_lib::read_json_file(&auth_path).expect("read auth");
|
||||
assert_eq!(stored_auth, auth, "auth.json should match input");
|
||||
|
||||
let stored_config = std::fs::read_to_string(&config_path).expect("read config");
|
||||
assert!(
|
||||
stored_config.contains("mcp_servers.echo"),
|
||||
"config.toml should contain serialized table"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn write_codex_live_atomic_rolls_back_auth_when_config_write_fails() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
|
||||
let auth_path = cc_switch_lib::get_codex_auth_path();
|
||||
if let Some(parent) = auth_path.parent() {
|
||||
std::fs::create_dir_all(parent).expect("create codex dir");
|
||||
}
|
||||
std::fs::write(&auth_path, r#"{"OPENAI_API_KEY":"legacy"}"#).expect("seed auth");
|
||||
|
||||
let config_path = cc_switch_lib::get_codex_config_path();
|
||||
std::fs::create_dir_all(&config_path).expect("create blocking directory");
|
||||
|
||||
let auth = json!({ "OPENAI_API_KEY": "new-key" });
|
||||
let config_text = r#"[mcp_servers.sample]
|
||||
type = "stdio"
|
||||
command = "noop"
|
||||
"#;
|
||||
|
||||
let err = cc_switch_lib::write_codex_live_atomic(&auth, Some(config_text))
|
||||
.expect_err("config write should fail when target is directory");
|
||||
match err {
|
||||
cc_switch_lib::AppError::Io { path, .. } => {
|
||||
assert!(
|
||||
path.ends_with("config.toml"),
|
||||
"io error path should point to config.toml"
|
||||
);
|
||||
}
|
||||
cc_switch_lib::AppError::IoContext { context, .. } => {
|
||||
assert!(
|
||||
context.contains("config.toml"),
|
||||
"error context should mention config path"
|
||||
);
|
||||
}
|
||||
other => panic!("unexpected error variant: {other:?}"),
|
||||
}
|
||||
|
||||
let stored = std::fs::read_to_string(&auth_path).expect("read existing auth");
|
||||
assert!(
|
||||
stored.contains("legacy"),
|
||||
"auth.json should roll back to legacy content"
|
||||
);
|
||||
assert!(
|
||||
std::fs::metadata(&config_path)
|
||||
.expect("config path metadata")
|
||||
.is_dir(),
|
||||
"config path should remain a directory after failure"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn import_from_codex_adds_servers_from_mcp_servers_table() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
@@ -533,3 +618,56 @@ fn create_backup_generates_snapshot_file() {
|
||||
"backup content should match original config"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_backup_retains_only_latest_entries() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
let home = ensure_test_home();
|
||||
let config_dir = home.join(".cc-switch");
|
||||
let config_path = config_dir.join("config.json");
|
||||
fs::create_dir_all(&config_dir).expect("prepare config dir");
|
||||
fs::write(&config_path, r#"{"version":3}"#).expect("write config file");
|
||||
|
||||
let backups_dir = config_dir.join("backups");
|
||||
fs::create_dir_all(&backups_dir).expect("create backups dir");
|
||||
for idx in 0..12 {
|
||||
let manual = backups_dir.join(format!("manual_{idx:02}.json"));
|
||||
fs::write(&manual, format!("{{\"idx\":{idx}}}")).expect("seed manual backup");
|
||||
}
|
||||
|
||||
std::thread::sleep(std::time::Duration::from_secs(1));
|
||||
|
||||
let latest_backup_id = create_backup(&config_path).expect("create backup with cleanup");
|
||||
assert!(
|
||||
!latest_backup_id.is_empty(),
|
||||
"backup id should not be empty when config exists"
|
||||
);
|
||||
|
||||
let entries: Vec<_> = fs::read_dir(&backups_dir)
|
||||
.expect("read backups dir")
|
||||
.filter_map(|entry| entry.ok())
|
||||
.collect();
|
||||
assert!(
|
||||
entries.len() <= 10,
|
||||
"expected backups to be trimmed to at most 10 files, got {}",
|
||||
entries.len()
|
||||
);
|
||||
|
||||
let latest_path = backups_dir.join(format!("{latest_backup_id}.json"));
|
||||
assert!(
|
||||
latest_path.exists(),
|
||||
"latest backup {} should be preserved",
|
||||
latest_path.display()
|
||||
);
|
||||
|
||||
// 进一步确认保留的条目包含一些历史文件，说明清理逻辑仅裁剪多余部分
|
||||
let manual_kept = entries
|
||||
.iter()
|
||||
.filter_map(|entry| entry.file_name().into_string().ok())
|
||||
.any(|name| name.starts_with("manual_"));
|
||||
assert!(
|
||||
manual_kept,
|
||||
"cleanup should keep part of the older backups to maintain history"
|
||||
);
|
||||
}
|
||||
|
||||
159
src-tauri/tests/provider_commands.rs
Normal file
159
src-tauri/tests/provider_commands.rs
Normal file
@@ -0,0 +1,159 @@
|
||||
use serde_json::json;
|
||||
|
||||
use cc_switch_lib::{
|
||||
get_codex_auth_path, get_codex_config_path, read_json_file, switch_provider_test_hook,
|
||||
write_codex_live_atomic, AppState, AppType, MultiAppConfig, Provider,
|
||||
};
|
||||
|
||||
#[path = "support.rs"]
|
||||
mod support;
|
||||
use support::{ensure_test_home, reset_test_fs, test_mutex};
|
||||
|
||||
#[test]
|
||||
fn switch_provider_updates_codex_live_and_state() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
let _home = ensure_test_home();
|
||||
|
||||
let legacy_auth = json!({"OPENAI_API_KEY": "legacy-key"});
|
||||
let legacy_config = r#"[mcp_servers.legacy]
|
||||
type = "stdio"
|
||||
command = "echo"
|
||||
"#;
|
||||
write_codex_live_atomic(&legacy_auth, Some(legacy_config))
|
||||
.expect("seed existing codex live config");
|
||||
|
||||
let mut config = MultiAppConfig::default();
|
||||
{
|
||||
let manager = config
|
||||
.get_manager_mut(&AppType::Codex)
|
||||
.expect("codex manager");
|
||||
manager.current = "old-provider".to_string();
|
||||
manager.providers.insert(
|
||||
"old-provider".to_string(),
|
||||
Provider::with_id(
|
||||
"old-provider".to_string(),
|
||||
"Legacy".to_string(),
|
||||
json!({
|
||||
"auth": {"OPENAI_API_KEY": "stale"},
|
||||
"config": "stale-config"
|
||||
}),
|
||||
None,
|
||||
),
|
||||
);
|
||||
manager.providers.insert(
|
||||
"new-provider".to_string(),
|
||||
Provider::with_id(
|
||||
"new-provider".to_string(),
|
||||
"Latest".to_string(),
|
||||
json!({
|
||||
"auth": {"OPENAI_API_KEY": "fresh-key"},
|
||||
"config": r#"[mcp_servers.latest]
|
||||
type = "stdio"
|
||||
command = "say"
|
||||
"#
|
||||
}),
|
||||
None,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
config.mcp.codex.servers.insert(
|
||||
"echo-server".into(),
|
||||
json!({
|
||||
"id": "echo-server",
|
||||
"enabled": true,
|
||||
"server": {
|
||||
"type": "stdio",
|
||||
"command": "echo"
|
||||
}
|
||||
}),
|
||||
);
|
||||
|
||||
let app_state = AppState {
|
||||
config: std::sync::Mutex::new(config),
|
||||
};
|
||||
|
||||
switch_provider_test_hook(&app_state, AppType::Codex, "new-provider")
|
||||
.expect("switch provider should succeed");
|
||||
|
||||
let auth_value: serde_json::Value =
|
||||
read_json_file(&get_codex_auth_path()).expect("read auth.json");
|
||||
assert_eq!(
|
||||
auth_value
|
||||
.get("OPENAI_API_KEY")
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or(""),
|
||||
"fresh-key",
|
||||
"live auth.json should reflect new provider"
|
||||
);
|
||||
|
||||
let config_text =
|
||||
std::fs::read_to_string(get_codex_config_path()).expect("read config.toml");
|
||||
assert!(
|
||||
config_text.contains("mcp_servers.echo-server"),
|
||||
"config.toml should contain synced MCP servers"
|
||||
);
|
||||
|
||||
let locked = app_state
|
||||
.config
|
||||
.lock()
|
||||
.expect("lock config after switch");
|
||||
let manager = locked
|
||||
.get_manager(&AppType::Codex)
|
||||
.expect("codex manager after switch");
|
||||
assert_eq!(manager.current, "new-provider", "current provider updated");
|
||||
|
||||
let new_provider = manager
|
||||
.providers
|
||||
.get("new-provider")
|
||||
.expect("new provider exists");
|
||||
let new_config_text = new_provider
|
||||
.settings_config
|
||||
.get("config")
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or_default();
|
||||
assert_eq!(
|
||||
new_config_text, config_text,
|
||||
"provider config snapshot should match live file"
|
||||
);
|
||||
|
||||
let legacy = manager
|
||||
.providers
|
||||
.get("old-provider")
|
||||
.expect("legacy provider still exists");
|
||||
let legacy_auth_value = legacy
|
||||
.settings_config
|
||||
.get("auth")
|
||||
.and_then(|v| v.get("OPENAI_API_KEY"))
|
||||
.and_then(|v| v.as_str())
|
||||
.unwrap_or("");
|
||||
assert_eq!(
|
||||
legacy_auth_value, "legacy-key",
|
||||
"previous provider should be backfilled with live auth"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn switch_provider_missing_provider_returns_error() {
|
||||
let _guard = test_mutex().lock().expect("acquire test mutex");
|
||||
reset_test_fs();
|
||||
|
||||
let mut config = MultiAppConfig::default();
|
||||
config
|
||||
.get_manager_mut(&AppType::Claude)
|
||||
.expect("claude manager")
|
||||
.current = "does-not-exist".to_string();
|
||||
|
||||
let app_state = AppState {
|
||||
config: std::sync::Mutex::new(config),
|
||||
};
|
||||
|
||||
let err = switch_provider_test_hook(&app_state, AppType::Claude, "missing-provider")
|
||||
.expect_err("switching to a missing provider should fail");
|
||||
|
||||
assert!(
|
||||
err.to_string().contains("供应商不存在"),
|
||||
"error message should mention missing provider"
|
||||
);
|
||||
}
|
||||
47
src-tauri/tests/support.rs
Normal file
47
src-tauri/tests/support.rs
Normal file
@@ -0,0 +1,47 @@
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::{Mutex, OnceLock};
|
||||
|
||||
use cc_switch_lib::{update_settings, AppSettings};
|
||||
|
||||
/// 为测试设置隔离的 HOME 目录，避免污染真实用户数据。
|
||||
pub fn ensure_test_home() -> &'static Path {
|
||||
static HOME: OnceLock<PathBuf> = OnceLock::new();
|
||||
HOME.get_or_init(|| {
|
||||
let base = std::env::temp_dir().join("cc-switch-test-home");
|
||||
if base.exists() {
|
||||
let _ = std::fs::remove_dir_all(&base);
|
||||
}
|
||||
std::fs::create_dir_all(&base).expect("create test home");
|
||||
std::env::set_var("HOME", &base);
|
||||
#[cfg(windows)]
|
||||
std::env::set_var("USERPROFILE", &base);
|
||||
base
|
||||
})
|
||||
.as_path()
|
||||
}
|
||||
|
||||
/// 清理测试目录中生成的配置文件与缓存。
|
||||
pub fn reset_test_fs() {
|
||||
let home = ensure_test_home();
|
||||
for sub in [".claude", ".codex", ".cc-switch"] {
|
||||
let path = home.join(sub);
|
||||
if path.exists() {
|
||||
if let Err(err) = std::fs::remove_dir_all(&path) {
|
||||
eprintln!("failed to clean {}: {}", path.display(), err);
|
||||
}
|
||||
}
|
||||
}
|
||||
let claude_json = home.join(".claude.json");
|
||||
if claude_json.exists() {
|
||||
let _ = std::fs::remove_file(&claude_json);
|
||||
}
|
||||
|
||||
// 重置内存中的设置缓存，确保测试环境不受上一次调用影响
|
||||
let _ = update_settings(AppSettings::default());
|
||||
}
|
||||
|
||||
/// 全局互斥锁，避免多测试并发写入相同的 HOME 目录。
|
||||
pub fn test_mutex() -> &'static Mutex<()> {
|
||||
static MUTEX: OnceLock<Mutex<()>> = OnceLock::new();
|
||||
MUTEX.get_or_init(|| Mutex::new(()))
|
||||
}
|
||||
Reference in New Issue
Block a user