Skip to content

Commit

Permalink
Auto merge of rust-lang#17472 - duncanawoods:master, r=HKalbasi
Browse files Browse the repository at this point in the history
rust-lang#17470 - run unit tests at the crate level not workspace

For rust-lang/rust-analyzer#17470

Use the test path to identify a package in the workspace and run the unit test there instead of at the workspace.
  • Loading branch information
bors committed Jul 28, 2024
2 parents d777f43 + 851fd9a commit d1ba547
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/tools/rust-analyzer/crates/flycheck/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pub mod project_json;
mod test_runner;

use command::{CommandHandle, ParseFromLine};
pub use test_runner::{CargoTestHandle, CargoTestMessage, TestState};
pub use test_runner::{CargoTestHandle, CargoTestMessage, TestState, TestTarget};

#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub enum InvocationStrategy {
Expand Down
23 changes: 21 additions & 2 deletions src/tools/rust-analyzer/crates/flycheck/src/test_runner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,38 @@ pub struct CargoTestHandle {
}

// Example of a cargo test command:
// cargo test --workspace --no-fail-fast -- module::func -Z unstable-options --format=json
// cargo test --workspace --no-fail-fast -- -Z unstable-options --format=json
// or
// cargo test --package my-package --no-fail-fast -- module::func -Z unstable-options --format=json

#[derive(Debug)]
pub enum TestTarget {
Workspace,
Package(String),
}

impl CargoTestHandle {
pub fn new(
path: Option<&str>,
options: CargoOptions,
root: &AbsPath,
test_target: TestTarget,
sender: Sender<CargoTestMessage>,
) -> std::io::Result<Self> {
let mut cmd = Command::new(Tool::Cargo.path());
cmd.env("RUSTC_BOOTSTRAP", "1");
cmd.arg("test");
cmd.arg("--workspace");

match &test_target {
TestTarget::Package(package) => {
cmd.arg("--package");
cmd.arg(package);
}
TestTarget::Workspace => {
cmd.arg("--workspace");
}
};

// --no-fail-fast is needed to ensure that all requested tests will run
cmd.arg("--no-fail-fast");
cmd.arg("--manifest-path");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use lsp_types::{
SemanticTokensResult, SymbolInformation, SymbolTag, TextDocumentIdentifier, Url, WorkspaceEdit,
};
use paths::Utf8PathBuf;
use project_model::{ManifestPath, ProjectWorkspaceKind, TargetKind};
use project_model::{CargoWorkspace, ManifestPath, ProjectWorkspaceKind, TargetKind};
use serde_json::json;
use stdx::{format_to, never};
use syntax::{algo, ast, AstNode, TextRange, TextSize};
Expand Down Expand Up @@ -199,14 +199,28 @@ pub(crate) fn handle_view_item_tree(
Ok(res)
}

// cargo test requires the real package name which might contain hyphens but
// the test identifier passed to this function is the namespace form where hyphens
// are replaced with underscores so we have to reverse this and find the real package name
fn find_package_name(namespace_root: &str, cargo: &CargoWorkspace) -> Option<String> {
cargo.packages().find_map(|p| {
let package_name = &cargo[p].name;
if package_name.replace('-', "_") == namespace_root {
Some(package_name.clone())
} else {
None
}
})
}

pub(crate) fn handle_run_test(
state: &mut GlobalState,
params: lsp_ext::RunTestParams,
) -> anyhow::Result<()> {
if let Some(_session) = state.test_run_session.take() {
state.send_notification::<lsp_ext::EndRunTest>(());
}
// We detect the lowest common ansector of all included tests, and
// We detect the lowest common ancestor of all included tests, and
// run it. We ignore excluded tests for now, the client will handle
// it for us.
let lca = match params.include {
Expand All @@ -225,20 +239,31 @@ pub(crate) fn handle_run_test(
.unwrap_or_default(),
None => "".to_owned(),
};
let test_path = if lca.is_empty() {
None
} else if let Some((_, path)) = lca.split_once("::") {
Some(path)
let (namespace_root, test_path) = if lca.is_empty() {
(None, None)
} else if let Some((namespace_root, path)) = lca.split_once("::") {
(Some(namespace_root), Some(path))
} else {
None
(Some(lca.as_str()), None)
};
let mut handles = vec![];
for ws in &*state.workspaces {
if let ProjectWorkspaceKind::Cargo { cargo, .. } = &ws.kind {
let test_target = if let Some(namespace_root) = namespace_root {
if let Some(package_name) = find_package_name(namespace_root, cargo) {
flycheck::TestTarget::Package(package_name)
} else {
flycheck::TestTarget::Workspace
}
} else {
flycheck::TestTarget::Workspace
};

let handle = flycheck::CargoTestHandle::new(
test_path,
state.config.cargo_test_options(),
cargo.workspace_root(),
test_target,
state.test_run_sender.clone(),
)?;
handles.push(handle);
Expand Down

0 comments on commit d1ba547

Please sign in to comment.