agent/codex
2
0
Fork 0
mirror of https://github.com/pchuan98/codex.git synced 2026-07-01 00:31:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(plugins): tabulate plugin list output (#23727)

Browse Source 
## Summary
- render `codex plugin list` as one table per marketplace with the
marketplace manifest path shown above each table
- surface the installed plugin version in the CLI output by threading
`installed_version` through marketplace listing state
- narrow the system-root exemption so only known bundled/runtime
marketplaces skip missing-manifest failures, and keep `VERSION` empty
for cached-but-unconfigured plugins

## Rationale
The plugin list UX was hard to scan as a flat list and did not show
which installed version was active. This change makes the CLI output
easier to read in the real multi-marketplace case, keeps the plugin path
visible, fixes the Sapphire regression where bundled/runtime marketplace
roots were blocking `plugin list`, and addresses the two review findings
that came out of the follow-up deep review.

## Key Decisions
- kept the CLI output grouped per marketplace instead of one global
table so the marketplace path can live with the rows it owns
- kept `VERSION` as the installed version, which means it is empty until
a plugin is actually installed
- handled the bundled/runtime regression in the CLI snapshot validation
path rather than widening app-server protocol or changing marketplace
loading behavior
- narrowed the exemption to known system marketplace names plus expected
system paths, so user-configured marketplaces under those directories
still fail loudly
- gated `installed_version` on actual installed state so `VERSION`
cannot show stale cache state for `not installed` rows

## Validation
- `just fmt`
- Sapphire: `cargo test -p codex-cli --test plugin_cli` (`14 passed; 0
failed`)
- Sapphire smoke test: bundled/runtime roots still work
  - `cargo run -q -p codex-cli -- plugin add sample@debug`
  - `cargo run -q -p codex-cli -- plugin list`
- verified the bundled/runtime-root scenario no longer errors and shows
the expected marketplace table output
- Sapphire smoke test: custom marketplace under bundled path still
errors
- verified `failed to load configured marketplace snapshot(s)` for
`custom-marketplace`
- Sapphire smoke test: cached-but-unconfigured plugin hides version
- verified `sample@debug not installed` renders with an empty `VERSION`
column

## Sample Output
```text
/tmp/custom-marketplace/plugin.json
NAME          VERSION  STATUS         DESCRIPTION
sample@debug  1.0.0    enabled        Debug sample plugin
other@local            not installed  Local development plugin
```
This commit is contained in:
Casey Chow
2026-05-20 18:04:49 -04:00
committed by GitHub
parent eee3e60db3
commit 3075061bdd
4 changed files with 336 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
codex-rs/cli/tests/plugin_cli.rs
+204 -14
View File
@@ -41,10 +41,13 @@ plugins = true
}
fn write_marketplace_source(source: &Path) -> Result<()> {
std::fs::create_dir_all(source.join(".agents/plugins"))?;
std::fs::create_dir_all(source.join("plugins/sample/.codex-plugin"))?;
std::fs::create_dir_all(source.join(".agents").join("plugins"))?;
std::fs::create_dir_all(source.join("plugins").join("sample").join(".codex-plugin"))?;
std::fs::write(
source.join(".agents/plugins/marketplace.json"),
source
.join(".agents")
.join("plugins")
.join("marketplace.json"),
r#"{
"name": "debug",
"plugins": [
@@ -59,8 +62,12 @@ fn write_marketplace_source(source: &Path) -> Result<()> {
}"#,
)?;
std::fs::write(
source.join("plugins/sample/.codex-plugin/plugin.json"),
r#"{"name":"sample","description":"Sample plugin"}"#,
source
.join("plugins")
.join("sample")
.join(".codex-plugin")
.join("plugin.json"),
r#"{"name":"sample","version":"1.2.3","description":"Sample plugin"}"#,
)?;
Ok(())
}
@@ -104,9 +111,13 @@ fn setup_configured_marketplace_with_malformed_manifest() -> Result<(TempDir, Te
let codex_home = TempDir::new()?;
let source = TempDir::new()?;
write_plugins_enabled_config(codex_home.path())?;
std::fs::create_dir_all(source.path().join(".agents/plugins"))?;
std::fs::create_dir_all(source.path().join(".agents").join("plugins"))?;
std::fs::write(
source.path().join(".agents/plugins/marketplace.json"),
source
.path()
.join(".agents")
.join("plugins")
.join("marketplace.json"),
"{not valid json",
)?;
let source_path = source.path().to_string_lossy().into_owned();
@@ -118,6 +129,84 @@ fn setup_configured_marketplace_with_malformed_manifest() -> Result<(TempDir, Te
Ok((codex_home, source))
}
fn setup_local_marketplace_with_implicit_system_roots() -> Result<(TempDir, TempDir, TempDir)> {
let (codex_home, source) = setup_local_marketplace()?;
let bundled_root = codex_home
.path()
.join(".tmp")
.join("bundled-marketplaces")
.join("openai-bundled");
std::fs::create_dir_all(&bundled_root)?;
let bundled_source = bundled_root.display().to_string();
record_user_marketplace(
codex_home.path(),
"openai-bundled",
&configured_local_marketplace(&bundled_source),
)?;
let cache_home = TempDir::new()?;
let runtime_root = cache_home
.path()
.join("codex-runtimes")
.join("codex-primary-runtime")
.join("plugins")
.join("openai-primary-runtime");
std::fs::create_dir_all(&runtime_root)?;
let runtime_source = runtime_root.display().to_string();
record_user_marketplace(
codex_home.path(),
"openai-primary-runtime",
&configured_local_marketplace(&runtime_source),
)?;
Ok((codex_home, source, cache_home))
}
fn setup_custom_marketplace_under_implicit_system_root() -> Result<(TempDir, std::path::PathBuf)> {
let codex_home = TempDir::new()?;
write_plugins_enabled_config(codex_home.path())?;
let custom_root = codex_home
.path()
.join(".tmp")
.join("bundled-marketplaces")
.join("custom-marketplace");
std::fs::create_dir_all(&custom_root)?;
let custom_source = custom_root.display().to_string();
record_user_marketplace(
codex_home.path(),
"custom-marketplace",
&configured_local_marketplace(&custom_source),
)?;
Ok((codex_home, custom_root))
}
fn remove_installed_plugin_config(codex_home: &Path, plugin_key: &str) -> Result<()> {
let config_path = codex_home.join(CONFIG_TOML_FILE);
let plugin_header = format!("[plugins.\"{plugin_key}\"]");
let config = std::fs::read_to_string(&config_path)?;
let mut rewritten = Vec::new();
let mut skipping = false;
for line in config.lines() {
if line == plugin_header {
skipping = true;
continue;
}
if skipping && line.starts_with('[') {
skipping = false;
}
if !skipping {
rewritten.push(line);
}
}
std::fs::write(config_path, format!("{}\n", rewritten.join("\n")))?;
Ok(())
}
#[tokio::test]
async fn marketplace_list_shows_configured_marketplace_names() -> Result<()> {
let (codex_home, source) = setup_local_marketplace()?;
@@ -133,15 +222,48 @@ async fn marketplace_list_shows_configured_marketplace_names() -> Result<()> {
}
#[tokio::test]
async fn plugin_list_shows_plugins_grouped_by_marketplace() -> Result<()> {
let (codex_home, _source) = setup_local_marketplace()?;
async fn plugin_list_prints_plugins_in_a_table() -> Result<()> {
let (codex_home, source) = setup_local_marketplace()?;
let marketplace_manifest = source
.path()
.join(".agents")
.join("plugins")
.join("marketplace.json");
let plugin_path = source.path().join("plugins").join("sample");
codex_command(codex_home.path())?
.args(["plugin", "list"])
.assert()
.success()
.stdout(contains("Marketplace `debug`"))
.stdout(contains("sample@debug (not installed)"));
.stdout(contains("PLUGIN"))
.stdout(contains("STATUS"))
.stdout(contains("VERSION"))
.stdout(contains("PATH"))
.stdout(contains(marketplace_manifest.display().to_string()))
.stdout(contains("sample@debug"))
.stdout(contains("not installed"))
.stdout(contains(plugin_path.display().to_string()));
Ok(())
}
#[tokio::test]
async fn plugin_list_shows_installed_version_when_plugin_is_installed() -> Result<()> {
let (codex_home, _source) = setup_local_marketplace()?;
codex_command(codex_home.path())?
.args(["plugin", "add", "sample@debug"])
.assert()
.success();
codex_command(codex_home.path())?
.args(["plugin", "list"])
.assert()
.success()
.stdout(contains("sample@debug"))
.stdout(contains("1.2.3"))
.stdout(contains("installed, enabled"));
Ok(())
}
@@ -151,10 +273,10 @@ async fn plugin_list_excludes_unconfigured_repo_local_marketplaces() -> Result<(
let (codex_home, source) = setup_unconfigured_local_marketplace()?;
codex_command_in(codex_home.path(), source.path())?
.args(["plugin", "list"])
.args(["plugin", "list", "--marketplace", "debug"])
.assert()
.success()
.stdout(contains("No marketplace plugins found."))
.stdout(contains("No plugins found in marketplace `debug`."))
.stdout(predicates::str::is_match("sample@debug").unwrap().not());
Ok(())
@@ -180,6 +302,74 @@ async fn plugin_list_fails_when_configured_marketplace_snapshot_is_missing() ->
Ok(())
}
#[tokio::test]
async fn plugin_list_ignores_implicit_system_marketplace_roots_without_manifests() -> Result<()> {
let (codex_home, source, cache_home) = setup_local_marketplace_with_implicit_system_roots()?;
codex_command(codex_home.path())?
.env("XDG_CACHE_HOME", cache_home.path())
.args(["plugin", "list"])
.assert()
.success()
.stdout(contains("Marketplace `debug`"))
.stdout(contains(
source
.path()
.join(".agents")
.join("plugins")
.join("marketplace.json")
.display()
.to_string(),
))
.stderr(
predicates::str::contains("failed to load configured marketplace snapshot(s):").not(),
);
Ok(())
}
#[tokio::test]
async fn plugin_list_fails_for_custom_marketplace_under_system_root() -> Result<()> {
let (codex_home, custom_root) = setup_custom_marketplace_under_implicit_system_root()?;
codex_command(codex_home.path())?
.args(["plugin", "list"])
.assert()
.failure()
.stderr(contains(
"failed to load configured marketplace snapshot(s):",
))
.stderr(contains("`custom-marketplace`"))
.stderr(contains(custom_root.display().to_string()))
.stderr(contains(
"marketplace root does not contain a supported manifest",
));
Ok(())
}
#[tokio::test]
async fn plugin_list_hides_version_for_cached_but_unconfigured_plugin() -> Result<()> {
let (codex_home, _source) = setup_local_marketplace()?;
codex_command(codex_home.path())?
.args(["plugin", "add", "sample@debug"])
.assert()
.success();
remove_installed_plugin_config(codex_home.path(), "sample@debug")?;
codex_command(codex_home.path())?
.args(["plugin", "list"])
.assert()
.success()
.stdout(contains("sample@debug"))
.stdout(contains("not installed"))
.stdout(predicates::str::contains("1.2.3").not());
Ok(())
}
#[tokio::test]
async fn plugin_add_and_remove_updates_installed_plugin_config() -> Result<()> {
let (codex_home, _source) = setup_local_marketplace()?;
@@ -258,7 +448,7 @@ async fn plugin_add_reinstalls_from_configured_marketplace_snapshot() -> Result<
assert!(
codex_home
.path()
.join("plugins/cache/debug/sample/local/.codex-plugin/plugin.json")
.join("plugins/cache/debug/sample/1.2.3/.codex-plugin/plugin.json")
.is_file()
);
@@ -311,7 +501,7 @@ async fn plugin_add_rejects_cached_plugins_without_authorizing_marketplace_snaps
assert!(
codex_home
.path()
.join("plugins/cache/debug/sample/local/.codex-plugin/plugin.json")
.join("plugins/cache/debug/sample/1.2.3/.codex-plugin/plugin.json")
.is_file()
);