Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: Add test codebase for shell completions #14681

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

test: Add test codebase for shell completions #14681

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e1e43f4
refactor: Make custom completers testable and reuse `new_gctx_for_com…
shannmu Oct 12, 2024
ae0363c
test: Add a test codebase for shell completions
shannmu Oct 12, 2024
b9d09f0
test: Add test case for `get_registry_candidates`
shannmu Oct 12, 2024
64b9b0d
test: Add test case for `get_example_candidates`
shannmu Oct 12, 2024
95d9be2
test: Add test case for `get_test_candidates`
shannmu Oct 12, 2024
9ebdd49
test: Add test code for `get_bench_candidates`
shannmu Oct 13, 2024
1ba0169
test: Add test case for `get_bin_candidates`
shannmu Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/bin/cargo/commands/add.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,8 @@ This is the catch all, handling hashes to named references in remote repositorie
.value_name("NAME")
.help("Package registry for this dependency")
.add(clap_complete::ArgValueCandidates::new(|| {
let candidates = get_registry_candidates();
let cwd = std::env::current_dir();
let candidates = get_registry_candidates(cwd.ok());
candidates.unwrap_or_default()
})),
])
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/uninstall.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
Ok(())
}

fn get_installed_crates() -> Vec<clap_complete::CompletionCandidate> {
pub fn get_installed_crates() -> Vec<clap_complete::CompletionCandidate> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This being pub doesn't make a difference as this only exists in the bin

get_installed_crates_().unwrap_or_default()
}

Expand Down
7 changes: 4 additions & 3 deletions src/bin/cargo/commands/update.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ pub fn cli() -> Command {
.help_heading(heading::PACKAGE_SELECTION)
.group("package-group")
.help("Package to update")
.add(clap_complete::ArgValueCandidates::new(
get_pkg_id_spec_candidates,
))])
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_pkg_id_spec_candidates(cwd.ok())
}))])
.arg(
optional_multi_opt("package", "SPEC", "Package to update")
.short('p')
Expand Down
116 changes: 72 additions & 44 deletions src/cargo/util/command_prelude.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,19 @@ pub trait CommandExt: Sized {
._arg(
optional_multi_opt("test", "NAME", test)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(get_test_candidates)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_test_candidates(cwd.ok())
})),
)
._arg(flag("benches", benches).help_heading(heading::TARGET_SELECTION))
._arg(
optional_multi_opt("bench", "NAME", bench)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(get_bench_candidates)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_bench_candidates(cwd.ok())
})),
)
._arg(flag("all-targets", all).help_heading(heading::TARGET_SELECTION))
}
Expand All @@ -187,15 +193,19 @@ pub trait CommandExt: Sized {
._arg(
optional_multi_opt("bin", "NAME", bin)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(get_bin_candidates)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_bin_candidates(cwd.ok())
})),
)
._arg(flag("examples", examples).help_heading(heading::TARGET_SELECTION))
._arg(
optional_multi_opt("example", "NAME", example)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(
get_example_candidates,
)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_example_candidates(cwd.ok())
})),
)
}

Expand All @@ -209,15 +219,19 @@ pub trait CommandExt: Sized {
self._arg(
optional_multi_opt("bin", "NAME", bin)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(get_bin_candidates)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_bin_candidates(cwd.ok())
})),
)
._arg(flag("bins", bins).help_heading(heading::TARGET_SELECTION))
._arg(
optional_multi_opt("example", "NAME", example)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(
get_example_candidates,
)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_example_candidates(cwd.ok())
})),
)
._arg(flag("examples", examples).help_heading(heading::TARGET_SELECTION))
}
Expand All @@ -226,14 +240,18 @@ pub trait CommandExt: Sized {
self._arg(
optional_multi_opt("bin", "NAME", bin)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(get_bin_candidates)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_bin_candidates(cwd.ok())
})),
)
._arg(
optional_multi_opt("example", "NAME", example)
.help_heading(heading::TARGET_SELECTION)
.add(clap_complete::ArgValueCandidates::new(
get_example_candidates,
)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_example_candidates(cwd.ok())
})),
)
}

Expand Down Expand Up @@ -294,7 +312,10 @@ pub trait CommandExt: Sized {
self._arg(
optional_multi_opt("target", "TRIPLE", target)
.help_heading(heading::COMPILATION_OPTIONS)
.add(clap_complete::ArgValueCandidates::new(get_target_triples)),
.add(clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_target_triples(cwd.ok())
})),
)
._arg(unsupported_short_arg)
}
Expand Down Expand Up @@ -367,8 +388,12 @@ pub trait CommandExt: Sized {
.value_parser(["git", "hg", "pijul", "fossil", "none"]),
)
._arg(
flag("bin", "Use a binary (application) template [default]")
.add(clap_complete::ArgValueCandidates::new(get_bin_candidates)),
flag("bin", "Use a binary (application) template [default]").add(
clap_complete::ArgValueCandidates::new(|| {
let cwd = std::env::current_dir();
get_bin_candidates(cwd.ok())
}),
),
)
._arg(flag("lib", "Use a library template"))
._arg(
Expand All @@ -388,7 +413,8 @@ pub trait CommandExt: Sized {
fn arg_registry(self, help: &'static str) -> Self {
self._arg(opt("registry", help).value_name("REGISTRY").add(
clap_complete::ArgValueCandidates::new(|| {
let candidates = get_registry_candidates();
let cwd = std::env::current_dir();
let candidates = get_registry_candidates(cwd.ok());
candidates.unwrap_or_default()
}),
))
Expand Down Expand Up @@ -1068,8 +1094,10 @@ pub fn lockfile_path(
return Ok(Some(path));
}

pub fn get_registry_candidates() -> CargoResult<Vec<clap_complete::CompletionCandidate>> {
let gctx = new_gctx_for_completions()?;
pub fn get_registry_candidates(
cwd: Option<PathBuf>,
) -> CargoResult<Vec<clap_complete::CompletionCandidate>> {
let gctx = new_gctx_for_completions(cwd)?;

if let Ok(Some(registries)) =
gctx.get::<Option<HashMap<String, HashMap<String, String>>>>("registries")
Expand All @@ -1083,8 +1111,8 @@ pub fn get_registry_candidates() -> CargoResult<Vec<clap_complete::CompletionCan
}
}

fn get_example_candidates() -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata()
fn get_example_candidates(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata(cwd)
.unwrap_or_default()
.into_iter()
.filter_map(|target| match target.kind() {
Expand All @@ -1094,8 +1122,8 @@ fn get_example_candidates() -> Vec<clap_complete::CompletionCandidate> {
.collect::<Vec<_>>()
}

fn get_bench_candidates() -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata()
fn get_bench_candidates(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata(cwd)
.unwrap_or_default()
.into_iter()
.filter_map(|target| match target.kind() {
Expand All @@ -1105,8 +1133,8 @@ fn get_bench_candidates() -> Vec<clap_complete::CompletionCandidate> {
.collect::<Vec<_>>()
}

fn get_test_candidates() -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata()
fn get_test_candidates(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata(cwd)
.unwrap_or_default()
.into_iter()
.filter_map(|target| match target.kind() {
Expand All @@ -1116,8 +1144,8 @@ fn get_test_candidates() -> Vec<clap_complete::CompletionCandidate> {
.collect::<Vec<_>>()
}

fn get_bin_candidates() -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata()
pub fn get_bin_candidates(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
get_targets_from_metadata(cwd)
.unwrap_or_default()
.into_iter()
.filter_map(|target| match target.kind() {
Expand All @@ -1127,10 +1155,9 @@ fn get_bin_candidates() -> Vec<clap_complete::CompletionCandidate> {
.collect::<Vec<_>>()
}

fn get_targets_from_metadata() -> CargoResult<Vec<Target>> {
let cwd = std::env::current_dir()?;
let gctx = GlobalContext::new(shell::Shell::new(), cwd.clone(), cargo_home_with_cwd(&cwd)?);
let ws = Workspace::new(&find_root_manifest_for_wd(&cwd)?, &gctx)?;
fn get_targets_from_metadata(cwd: Option<PathBuf>) -> CargoResult<Vec<Target>> {
let gctx = new_gctx_for_completions(cwd)?;
let ws = Workspace::new(&find_root_manifest_for_wd(gctx.cwd())?, &gctx)?;

let packages = ws.members().collect::<Vec<_>>();

Expand All @@ -1142,15 +1169,15 @@ fn get_targets_from_metadata() -> CargoResult<Vec<Target>> {
Ok(targets)
}

fn get_target_triples() -> Vec<clap_complete::CompletionCandidate> {
pub fn get_target_triples(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
let mut candidates = Vec::new();

if let Ok(targets) = get_target_triples_from_rustup() {
candidates = targets;
}

if candidates.is_empty() {
if let Ok(targets) = get_target_triples_from_rustc() {
if let Ok(targets) = get_target_triples_from_rustc(cwd) {
candidates = targets;
}
}
Expand Down Expand Up @@ -1182,10 +1209,11 @@ fn get_target_triples_from_rustup() -> CargoResult<Vec<clap_complete::Completion
.collect())
}

fn get_target_triples_from_rustc() -> CargoResult<Vec<clap_complete::CompletionCandidate>> {
let cwd = std::env::current_dir()?;
let gctx = GlobalContext::new(shell::Shell::new(), cwd.clone(), cargo_home_with_cwd(&cwd)?);
let ws = Workspace::new(&find_root_manifest_for_wd(&PathBuf::from(&cwd))?, &gctx);
fn get_target_triples_from_rustc(
cwd: Option<PathBuf>,
) -> CargoResult<Vec<clap_complete::CompletionCandidate>> {
let gctx = new_gctx_for_completions(cwd)?;
let ws = Workspace::new(&find_root_manifest_for_wd(gctx.cwd())?, &gctx);

let rustc = gctx.load_global_rustc(ws.as_ref().ok())?;

Expand All @@ -1198,12 +1226,12 @@ fn get_target_triples_from_rustc() -> CargoResult<Vec<clap_complete::CompletionC
.collect())
}

pub fn get_pkg_id_spec_candidates() -> Vec<clap_complete::CompletionCandidate> {
pub fn get_pkg_id_spec_candidates(cwd: Option<PathBuf>) -> Vec<clap_complete::CompletionCandidate> {
let mut candidates = vec![];

let package_map = HashMap::<&str, Vec<Package>>::new();
let package_map =
get_packages()
get_packages(cwd)
.unwrap_or_default()
.into_iter()
.fold(package_map, |mut map, package| {
Expand Down Expand Up @@ -1285,8 +1313,8 @@ pub fn get_pkg_id_spec_candidates() -> Vec<clap_complete::CompletionCandidate> {
candidates
}

fn get_packages() -> CargoResult<Vec<Package>> {
let gctx = new_gctx_for_completions()?;
fn get_packages(cwd: Option<PathBuf>) -> CargoResult<Vec<Package>> {
let gctx = new_gctx_for_completions(cwd)?;

let ws = Workspace::new(&find_root_manifest_for_wd(gctx.cwd())?, &gctx)?;

Expand Down Expand Up @@ -1318,8 +1346,8 @@ fn get_packages() -> CargoResult<Vec<Package>> {
Ok(packages)
}

fn new_gctx_for_completions() -> CargoResult<GlobalContext> {
let cwd = std::env::current_dir()?;
pub fn new_gctx_for_completions(cwd: Option<PathBuf>) -> CargoResult<GlobalContext> {
let cwd = cwd.unwrap_or(std::env::current_dir()?);
let mut gctx = GlobalContext::new(shell::Shell::new(), cwd.clone(), cargo_home_with_cwd(&cwd)?);

let verbose = 0;
Expand Down
1 change: 1 addition & 0 deletions tests/testsuite/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ mod rustflags;
mod rustup;
mod script;
mod search;
mod shell_completions;
mod shell_quoting;
mod source_replacement;
mod ssh;
Expand Down
33 changes: 33 additions & 0 deletions tests/testsuite/shell_completions/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
use std::path::PathBuf;

use cargo::util::command_prelude::*;
use cargo_test_support::cargo_test;

#[cargo_test]
fn test_get_registry_candidates() {
let current_dir = std::env::current_dir().expect("Failed to get current directory");
let cwd = PathBuf::from(file!()).parent().unwrap().join("template");
let cwd = current_dir.join(cwd);
Comment on lines +65 to +67
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A temp directory is created for each test. I'd recommend going ahead and writing to that and using that as the "cwd" for the test case. We have ProjectBuilder to help in creating these. You can also publish packages to a dev registry.


let expected = snapbox::str![
"my-registry1
my-registry2"
];
let actual = print_candidates(get_registry_candidates(Some(cwd)).unwrap());
snapbox::assert_data_eq!(actual, expected);
}

fn print_candidates(candidates: Vec<clap_complete::CompletionCandidate>) -> String {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

render_candidates since this doesn't print to stdout/stderr

candidates
.into_iter()
.map(|candidate| {
let compl = candidate.get_value().to_str().unwrap();
if let Some(help) = candidate.get_help() {
format!("{compl}\t{help}")
} else {
compl.to_owned()
}
})
.collect::<Vec<_>>()
.join("\n")
}
3 changes: 3 additions & 0 deletions tests/testsuite/shell_completions/template/.cargo/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[registries]
my-registry1 = { index = "my-registry1"}
my-registry2 = { index = "my-registry2"}
Empty file added tests/testsuite/shell_completions/template/Cargo.toml
View file
Open in desktop
Empty file.
Empty file added tests/testsuite/shell_completions/template/src/lib.rs
View file
Open in desktop
Empty file.