mirror of
https://github.com/openai/codex.git
synced 2026-04-26 15:45:02 +00:00
## Why `argument-comment-lint` was green in CI even though the repo still had many uncommented literal arguments. The main gap was target coverage: the repo wrapper did not force Cargo to inspect test-only call sites, so examples like the `latest_session_lookup_params(true, ...)` tests in `codex-rs/tui_app_server/src/lib.rs` never entered the blocking CI path. This change cleans up the existing backlog, makes the default repo lint path cover all Cargo targets, and starts rolling that stricter CI enforcement out on the platform where it is currently validated. ## What changed - mechanically fixed existing `argument-comment-lint` violations across the `codex-rs` workspace, including tests, examples, and benches - updated `tools/argument-comment-lint/run-prebuilt-linter.sh` and `tools/argument-comment-lint/run.sh` so non-`--fix` runs default to `--all-targets` unless the caller explicitly narrows the target set - fixed both wrappers so forwarded cargo arguments after `--` are preserved with a single separator - documented the new default behavior in `tools/argument-comment-lint/README.md` - updated `rust-ci` so the macOS lint lane keeps the plain wrapper invocation and therefore enforces `--all-targets`, while Linux and Windows temporarily pass `-- --lib --bins` That temporary CI split keeps the stricter all-targets check where it is already cleaned up, while leaving room to finish the remaining Linux- and Windows-specific target-gated cleanup before enabling `--all-targets` on those runners. The Linux and Windows failures on the intermediate revision were caused by the wrapper forwarding bug, not by additional lint findings in those lanes. ## Validation - `bash -n tools/argument-comment-lint/run.sh` - `bash -n tools/argument-comment-lint/run-prebuilt-linter.sh` - shell-level wrapper forwarding check for `-- --lib --bins` - shell-level wrapper forwarding check for `-- --tests` - `just argument-comment-lint` - `cargo test` in `tools/argument-comment-lint` - `cargo test -p codex-terminal-detection` ## Follow-up - Clean up remaining Linux-only target-gated callsites, then switch the Linux lint lane back to the plain wrapper invocation. - Clean up remaining Windows-only target-gated callsites, then switch the Windows lint lane back to the plain wrapper invocation.
176 lines
5.1 KiB
Rust
176 lines
5.1 KiB
Rust
extern crate codex_execpolicy_legacy;
|
|
|
|
use codex_execpolicy_legacy::ArgType;
|
|
use codex_execpolicy_legacy::Error;
|
|
use codex_execpolicy_legacy::ExecCall;
|
|
use codex_execpolicy_legacy::MatchedArg;
|
|
use codex_execpolicy_legacy::MatchedExec;
|
|
use codex_execpolicy_legacy::MatchedFlag;
|
|
use codex_execpolicy_legacy::Policy;
|
|
use codex_execpolicy_legacy::Result;
|
|
use codex_execpolicy_legacy::ValidExec;
|
|
use codex_execpolicy_legacy::get_default_policy;
|
|
|
|
#[expect(clippy::expect_used)]
|
|
fn setup() -> Policy {
|
|
get_default_policy().expect("failed to load default policy")
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_no_args() {
|
|
let policy = setup();
|
|
let ls = ExecCall::new("ls", &[]);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec::new("ls", vec![], &["/bin/ls", "/usr/bin/ls"])
|
|
}),
|
|
policy.check(&ls)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_dash_a_dash_l() {
|
|
let policy = setup();
|
|
let args = &["-a", "-l"];
|
|
let ls_a_l = ExecCall::new("ls", args);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec {
|
|
program: "ls".into(),
|
|
flags: vec![MatchedFlag::new("-a"), MatchedFlag::new("-l")],
|
|
system_path: ["/bin/ls".into(), "/usr/bin/ls".into()].into(),
|
|
..Default::default()
|
|
}
|
|
}),
|
|
policy.check(&ls_a_l)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_dash_z() {
|
|
let policy = setup();
|
|
|
|
// -z is currently an invalid option for ls, but it has so many options,
|
|
// perhaps it will get added at some point...
|
|
let ls_z = ExecCall::new("ls", &["-z"]);
|
|
assert_eq!(
|
|
Err(Error::UnknownOption {
|
|
program: "ls".into(),
|
|
option: "-z".into()
|
|
}),
|
|
policy.check(&ls_z)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_dash_al() {
|
|
let policy = setup();
|
|
|
|
// This currently fails, but it should pass once option_bundling=True is implemented.
|
|
let ls_al = ExecCall::new("ls", &["-al"]);
|
|
assert_eq!(
|
|
Err(Error::UnknownOption {
|
|
program: "ls".into(),
|
|
option: "-al".into()
|
|
}),
|
|
policy.check(&ls_al)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_one_file_arg() -> Result<()> {
|
|
let policy = setup();
|
|
|
|
let ls_one_file_arg = ExecCall::new("ls", &["foo"]);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec::new(
|
|
"ls",
|
|
vec![MatchedArg::new(
|
|
/*index*/ 0,
|
|
ArgType::ReadableFile,
|
|
"foo"
|
|
)?],
|
|
&["/bin/ls", "/usr/bin/ls"]
|
|
)
|
|
}),
|
|
policy.check(&ls_one_file_arg)
|
|
);
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_multiple_file_args() -> Result<()> {
|
|
let policy = setup();
|
|
|
|
let ls_multiple_file_args = ExecCall::new("ls", &["foo", "bar", "baz"]);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec::new(
|
|
"ls",
|
|
vec![
|
|
MatchedArg::new(/*index*/ 0, ArgType::ReadableFile, "foo")?,
|
|
MatchedArg::new(/*index*/ 1, ArgType::ReadableFile, "bar")?,
|
|
MatchedArg::new(/*index*/ 2, ArgType::ReadableFile, "baz")?,
|
|
],
|
|
&["/bin/ls", "/usr/bin/ls"]
|
|
)
|
|
}),
|
|
policy.check(&ls_multiple_file_args)
|
|
);
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_ls_multiple_flags_and_file_args() -> Result<()> {
|
|
let policy = setup();
|
|
|
|
let ls_multiple_flags_and_file_args = ExecCall::new("ls", &["-l", "-a", "foo", "bar", "baz"]);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec {
|
|
program: "ls".into(),
|
|
flags: vec![MatchedFlag::new("-l"), MatchedFlag::new("-a")],
|
|
args: vec![
|
|
MatchedArg::new(/*index*/ 2, ArgType::ReadableFile, "foo")?,
|
|
MatchedArg::new(/*index*/ 3, ArgType::ReadableFile, "bar")?,
|
|
MatchedArg::new(/*index*/ 4, ArgType::ReadableFile, "baz")?,
|
|
],
|
|
system_path: ["/bin/ls".into(), "/usr/bin/ls".into()].into(),
|
|
..Default::default()
|
|
}
|
|
}),
|
|
policy.check(&ls_multiple_flags_and_file_args)
|
|
);
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_flags_after_file_args() -> Result<()> {
|
|
let policy = setup();
|
|
|
|
// TODO(mbolin): While this is "safe" in that it will not do anything bad
|
|
// to the user's machine, it will fail because apparently `ls` does not
|
|
// allow flags after file arguments (as some commands do). We should
|
|
// extend define_program() to make this part of the configuration so that
|
|
// this command is disallowed.
|
|
let ls_flags_after_file_args = ExecCall::new("ls", &["foo", "-l"]);
|
|
assert_eq!(
|
|
Ok(MatchedExec::Match {
|
|
exec: ValidExec {
|
|
program: "ls".into(),
|
|
flags: vec![MatchedFlag::new("-l")],
|
|
args: vec![MatchedArg::new(
|
|
/*index*/ 0,
|
|
ArgType::ReadableFile,
|
|
"foo"
|
|
)?],
|
|
system_path: ["/bin/ls".into(), "/usr/bin/ls".into()].into(),
|
|
..Default::default()
|
|
}
|
|
}),
|
|
policy.check(&ls_flags_after_file_args)
|
|
);
|
|
Ok(())
|
|
}
|