Skip to content

Commit c41e05f

Browse files
borsbors
committed
Auto merge of #2131 - alexcrichton:cargo-clean, r=brson
* Clean out both host/target platforms if any are available. * Clean out build script output. * Add a --release flag to also be able to clean out release folder * Be sure to clean out benchmarks, tests, etc. * Cleaning out registry packages no longer panics Closes #2121
2 parents f191c24 + 595ac1d commit c41e05f

File tree

3 files changed

+175
-24
lines changed

3 files changed

+175
-24
lines changed

‎src/bin/clean.rs

+3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ struct Options {
1212
flag_verbose: bool,
1313
flag_quiet: bool,
1414
flag_color: Option<String>,
15+
flag_release: bool,
1516
}
1617

1718
pub const USAGE: &'static str = "
@@ -25,6 +26,7 @@ Options:
2526
-p SPEC, --package SPEC ... Package to clean artifacts for
2627
--manifest-path PATH Path to the manifest to the package to clean
2728
--target TRIPLE Target triple to clean output for (default all)
29+
--release Whether or not to clean release artifacts
2830
-v, --verbose Use verbose output
2931
-q, --quiet No output printed to stdout
3032
--color WHEN Coloring: auto, always, never
@@ -45,6 +47,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
4547
config: config,
4648
spec: &options.flag_package,
4749
target: options.flag_target.as_ref().map(|s| &s[..]),
50+
release: options.flag_release,
4851
};
4952
ops::clean(&root, &opts).map(|_| None).map_err(|err| {
5053
CliError::from_boxed(err, 101)

‎src/cargo/ops/cargo_clean.rs

+37-23
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@ use std::fs;
33
use std::io::prelude::*;
44
use std::path::Path;
55

6-
use core::{Package, PackageSet, Profiles, Profile};
6+
use core::{Package, PackageSet, Profiles};
77
use core::source::{Source, SourceMap};
8+
use core::registry::PackageRegistry;
89
use util::{CargoResult, human, ChainError, Config};
910
use ops::{self, Layout, Context, BuildConfig, Kind, Unit};
1011

1112
pub struct CleanOptions<'a> {
1213
pub spec: &'a [String],
1314
pub target: Option<&'a str>,
1415
pub config: &'a Config,
16+
pub release: bool,
1517
}
1618

1719
/// Cleans the project from build artifacts.
@@ -37,39 +39,51 @@ pub fn clean(manifest_path: &Path, opts: &CleanOptions) -> CargoResult<()> {
3739
// filenames and such
3840
let srcs = SourceMap::new();
3941
let pkgs = PackageSet::new(&[]);
40-
let profiles = Profiles::default();
42+
43+
let dest = if opts.release {"release"} else {"debug"};
44+
let host_layout = Layout::new(opts.config, &root, None, dest);
45+
let target_layout = opts.target.map(|target| {
46+
Layout::new(opts.config, &root, Some(target), dest)
47+
});
48+
4149
let cx = try!(Context::new(&resolve, &srcs, &pkgs, opts.config,
42-
Layout::at(target_dir),
43-
None, BuildConfig::default(),
44-
&profiles));
50+
host_layout, target_layout,
51+
BuildConfig::default(),
52+
root.manifest().profiles()));
53+
54+
let mut registry = PackageRegistry::new(opts.config);
4555

4656
// resolve package specs and remove the corresponding packages
4757
for spec in opts.spec {
4858
let pkgid = try!(resolve.query(spec));
4959

5060
// Translate the PackageId to a Package
5161
let pkg = {
52-
let mut source = pkgid.source_id().load(opts.config);
53-
try!(source.update());
54-
(try!(source.get(&[pkgid.clone()]))).into_iter().next().unwrap()
62+
try!(registry.add_sources(&[pkgid.source_id().clone()]));
63+
(try!(registry.get(&[pkgid.clone()]))).into_iter().next().unwrap()
5564
};
5665

5766
// And finally, clean everything out!
58-
for target in pkg.targets().iter() {
59-
// TODO: `cargo clean --release`
60-
let layout = Layout::new(opts.config, &root, opts.target, "debug");
61-
try!(rm_rf(&layout.fingerprint(&pkg)));
62-
let profiles = [Profile::default_dev(), Profile::default_test()];
63-
for profile in profiles.iter() {
64-
let unit = Unit {
65-
pkg: &pkg,
66-
target: target,
67-
profile: profile,
68-
kind: Kind::Target,
69-
};
70-
for filename in try!(cx.target_filenames(&unit)).iter() {
71-
try!(rm_rf(&layout.dest().join(&filename)));
72-
try!(rm_rf(&layout.deps().join(&filename)));
67+
for target in pkg.targets() {
68+
for kind in [Kind::Host, Kind::Target].iter() {
69+
let layout = cx.layout(&pkg, *kind);
70+
try!(rm_rf(&layout.proxy().fingerprint(&pkg)));
71+
try!(rm_rf(&layout.build(&pkg)));
72+
let Profiles {
73+
ref release, ref dev, ref test, ref bench, ref doc,
74+
ref custom_build,
75+
} = *root.manifest().profiles();
76+
for profile in [release, dev, test, bench, doc, custom_build].iter() {
77+
let unit = Unit {
78+
pkg: &pkg,
79+
target: target,
80+
profile: profile,
81+
kind: *kind,
82+
};
83+
let root = cx.out_dir(&unit);
84+
for filename in try!(cx.target_filenames(&unit)).iter() {
85+
try!(rm_rf(&root.join(&filename)));
86+
}
7387
}
7488
}
7589
}

‎tests/test_cargo_clean.rs

+135-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
use std::env;
22

3-
use support::{project, execs, main_file, basic_bin_manifest};
3+
use support::{git, project, execs, main_file, basic_bin_manifest};
4+
use support::{COMPILING, RUNNING};
5+
use support::registry::Package;
46
use hamcrest::{assert_that, existing_dir, existing_file, is_not};
57

68
fn setup() {
@@ -93,3 +95,135 @@ test!(clean_multiple_packages {
9395
assert_that(d1_path, is_not(existing_file()));
9496
assert_that(d2_path, is_not(existing_file()));
9597
});
98+
99+
test!(clean_release {
100+
let p = project("foo")
101+
.file("Cargo.toml", r#"
102+
[package]
103+
name = "foo"
104+
version = "0.0.1"
105+
authors = []
106+
107+
[dependencies]
108+
a = { path = "a" }
109+
"#)
110+
.file("src/main.rs", "fn main() {}")
111+
.file("a/Cargo.toml", r#"
112+
[package]
113+
name = "a"
114+
version = "0.0.1"
115+
authors = []
116+
"#)
117+
.file("a/src/lib.rs", "");
118+
p.build();
119+
120+
assert_that(p.cargo_process("build").arg("--release"),
121+
execs().with_status(0));
122+
123+
assert_that(p.cargo("clean").arg("-p").arg("foo"),
124+
execs().with_status(0));
125+
assert_that(p.cargo("build").arg("--release"),
126+
execs().with_status(0).with_stdout(""));
127+
128+
assert_that(p.cargo("clean").arg("-p").arg("foo").arg("--release"),
129+
execs().with_status(0));
130+
assert_that(p.cargo("build").arg("--release"),
131+
execs().with_status(0).with_stdout(&format!("\
132+
{compiling} foo v0.0.1 ([..])
133+
", compiling = COMPILING)));
134+
});
135+
136+
test!(build_script {
137+
let p = project("foo")
138+
.file("Cargo.toml", r#"
139+
[package]
140+
name = "foo"
141+
version = "0.0.1"
142+
authors = []
143+
build = "build.rs"
144+
"#)
145+
.file("src/main.rs", "fn main() {}")
146+
.file("build.rs", r#"
147+
use std::path::PathBuf;
148+
use std::env;
149+
150+
fn main() {
151+
let out = PathBuf::from(env::var_os("OUT_DIR").unwrap());
152+
if env::var("FIRST").is_ok() {
153+
std::fs::File::create(out.join("out")).unwrap();
154+
} else {
155+
assert!(!std::fs::metadata(out.join("out")).is_ok());
156+
}
157+
}
158+
"#)
159+
.file("a/src/lib.rs", "");
160+
p.build();
161+
162+
assert_that(p.cargo_process("build").env("FIRST", "1"),
163+
execs().with_status(0));
164+
assert_that(p.cargo("clean").arg("-p").arg("foo"),
165+
execs().with_status(0));
166+
assert_that(p.cargo("build").arg("-v"),
167+
execs().with_status(0).with_stdout(&format!("\
168+
{compiling} foo v0.0.1 ([..])
169+
{running} `rustc build.rs [..]`
170+
{running} `[..]build-script-build[..]`
171+
{running} `rustc src[..]main.rs [..]`
172+
", compiling = COMPILING, running = RUNNING)));
173+
});
174+
175+
test!(clean_git {
176+
let git = git::new("dep", |project| {
177+
project.file("Cargo.toml", r#"
178+
[project]
179+
name = "dep"
180+
version = "0.5.0"
181+
authors = []
182+
"#)
183+
.file("src/lib.rs", "")
184+
}).unwrap();
185+
186+
let p = project("foo")
187+
.file("Cargo.toml", &format!(r#"
188+
[package]
189+
name = "foo"
190+
version = "0.0.1"
191+
authors = []
192+
193+
[dependencies]
194+
dep = {{ git = '{}' }}
195+
"#, git.url()))
196+
.file("src/main.rs", "fn main() {}");
197+
p.build();
198+
199+
assert_that(p.cargo_process("build"),
200+
execs().with_status(0));
201+
assert_that(p.cargo("clean").arg("-p").arg("dep"),
202+
execs().with_status(0).with_stdout(""));
203+
assert_that(p.cargo("build"),
204+
execs().with_status(0));
205+
});
206+
207+
test!(registry {
208+
let p = project("foo")
209+
.file("Cargo.toml", r#"
210+
[package]
211+
name = "foo"
212+
version = "0.0.1"
213+
authors = []
214+
215+
[dependencies]
216+
bar = "0.1"
217+
"#)
218+
.file("src/main.rs", "fn main() {}");
219+
p.build();
220+
221+
Package::new("bar", "0.1.0").publish();
222+
223+
assert_that(p.cargo_process("build"),
224+
execs().with_status(0));
225+
assert_that(p.cargo("clean").arg("-p").arg("bar"),
226+
execs().with_status(0).with_stdout(""));
227+
assert_that(p.cargo("build"),
228+
execs().with_status(0));
229+
});

0 commit comments

Comments
 (0)