1 //! See `CargoTargetSpec`
3 use cfg::{CfgAtom, CfgExpr};
4 use ide::{FileId, RunnableKind, TestId};
5 use project_model::{self, TargetKind};
8 use crate::{global_state::GlobalStateSnapshot, Result};
10 /// Abstract representation of Cargo target.
12 /// We use it to cook up the set of cli args we need to pass to Cargo to
13 /// build/test/run the target.
15 pub(crate) struct CargoTargetSpec {
16 pub(crate) workspace_root: AbsPathBuf,
17 pub(crate) package: String,
18 pub(crate) target: String,
19 pub(crate) target_kind: TargetKind,
22 impl CargoTargetSpec {
23 pub(crate) fn runnable_args(
24 snap: &GlobalStateSnapshot,
25 spec: Option<CargoTargetSpec>,
28 ) -> Result<(Vec<String>, Vec<String>)> {
29 let mut args = Vec::new();
30 let mut extra_args = Vec::new();
32 RunnableKind::Test { test_id, attr } => {
33 args.push("test".to_string());
34 if let Some(spec) = spec {
35 spec.push_to(&mut args, kind);
37 extra_args.push(test_id.to_string());
38 if let TestId::Path(_) = test_id {
39 extra_args.push("--exact".to_string());
41 extra_args.push("--nocapture".to_string());
43 extra_args.push("--ignored".to_string());
46 RunnableKind::TestMod { path } => {
47 args.push("test".to_string());
48 if let Some(spec) = spec {
49 spec.push_to(&mut args, kind);
51 extra_args.push(path.to_string());
52 extra_args.push("--nocapture".to_string());
54 RunnableKind::Bench { test_id } => {
55 args.push("bench".to_string());
56 if let Some(spec) = spec {
57 spec.push_to(&mut args, kind);
59 extra_args.push(test_id.to_string());
60 if let TestId::Path(_) = test_id {
61 extra_args.push("--exact".to_string());
63 extra_args.push("--nocapture".to_string());
65 RunnableKind::DocTest { test_id } => {
66 args.push("test".to_string());
67 args.push("--doc".to_string());
68 if let Some(spec) = spec {
69 spec.push_to(&mut args, kind);
71 extra_args.push(test_id.to_string());
72 extra_args.push("--nocapture".to_string());
74 RunnableKind::Bin => {
75 let subcommand = match spec {
76 Some(CargoTargetSpec { target_kind: TargetKind::Test, .. }) => "test",
79 args.push(subcommand.to_string());
80 if let Some(spec) = spec {
81 spec.push_to(&mut args, kind);
86 if snap.config.cargo.all_features {
87 args.push("--all-features".to_string());
89 let mut features = Vec::new();
91 required_features(cfg, &mut features);
93 for feature in &snap.config.cargo.features {
94 features.push(feature.clone());
97 for feature in features {
98 args.push("--features".to_string());
103 Ok((args, extra_args))
106 pub(crate) fn for_file(
107 global_state_snapshot: &GlobalStateSnapshot,
109 ) -> Result<Option<CargoTargetSpec>> {
110 let crate_id = match global_state_snapshot.analysis.crate_for(file_id)?.first() {
111 Some(crate_id) => *crate_id,
112 None => return Ok(None),
114 let (cargo_ws, target) = match global_state_snapshot.cargo_target_for_crate_root(crate_id) {
116 None => return Ok(None),
118 let res = CargoTargetSpec {
119 workspace_root: cargo_ws.workspace_root().to_path_buf(),
120 package: cargo_ws.package_flag(&cargo_ws[cargo_ws[target].package]),
121 target: cargo_ws[target].name.clone(),
122 target_kind: cargo_ws[target].kind,
127 pub(crate) fn push_to(self, buf: &mut Vec<String>, kind: &RunnableKind) {
128 buf.push("--package".to_string());
129 buf.push(self.package);
131 // Can't mix --doc with other target flags
132 if let RunnableKind::DocTest { .. } = kind {
135 match self.target_kind {
137 buf.push("--bin".to_string());
138 buf.push(self.target);
140 TargetKind::Test => {
141 buf.push("--test".to_string());
142 buf.push(self.target);
144 TargetKind::Bench => {
145 buf.push("--bench".to_string());
146 buf.push(self.target);
148 TargetKind::Example => {
149 buf.push("--example".to_string());
150 buf.push(self.target);
153 buf.push("--lib".to_string());
155 TargetKind::Other => (),
160 /// Fill minimal features needed
161 fn required_features(cfg_expr: &CfgExpr, features: &mut Vec<String>) {
163 CfgExpr::Atom(CfgAtom::KeyValue { key, value }) if key == "feature" => {
164 features.push(value.to_string())
166 CfgExpr::All(preds) => {
167 preds.iter().for_each(|cfg| required_features(cfg, features));
169 CfgExpr::Any(preds) => {
171 let len_features = features.len();
172 required_features(cfg, features);
173 if len_features != features.len() {
187 use mbe::ast_to_token_tree;
189 ast::{self, AstNode},
193 fn check(cfg: &str, expected_features: &[&str]) {
195 let source_file = ast::SourceFile::parse(cfg).ok().unwrap();
196 let tt = source_file.syntax().descendants().find_map(ast::TokenTree::cast).unwrap();
197 let (tt, _) = ast_to_token_tree(&tt).unwrap();
201 let mut features = vec![];
202 required_features(&cfg_expr, &mut features);
204 let expected_features =
205 expected_features.iter().map(|&it| SmolStr::new(it)).collect::<Vec<_>>();
207 assert_eq!(features, expected_features);
211 fn test_cfg_expr_minimal_features_needed() {
212 check(r#"#![cfg(feature = "baz")]"#, &["baz"]);
213 check(r#"#![cfg(all(feature = "baz", feature = "foo"))]"#, &["baz", "foo"]);
214 check(r#"#![cfg(any(feature = "baz", feature = "foo", unix))]"#, &["baz"]);
215 check(r#"#![cfg(foo)]"#, &[]);