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.

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

feat: Add --rust-version flag #202

Merged
merged 2 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,11 @@ OPTIONS:

This flag can only be used together with either --features or --include-features.

--rust-version
Perform commands on `package.rust-version`.

This cannot be used with --version-range.

--version-range [START]..[=END]
Perform commands on a specified (inclusive) range of Rust versions.

Expand Down
37 changes: 32 additions & 5 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ impl Args {
let mut keep_going = false;
let mut print_command_list = false;
let mut no_manifest_path = false;
let mut rust_version = false;
let mut version_range = None;
let mut version_step = None;

Expand Down Expand Up @@ -236,6 +237,7 @@ impl Args {

Long("manifest-path") => parse_opt!(manifest_path, false),
Long("depth") => parse_opt!(depth, false),
Long("rust-version") => parse_flag!(rust_version),
Long("version-range") => parse_opt!(version_range, false),
Long("version-step") => parse_opt!(version_step, false),

Expand Down Expand Up @@ -507,11 +509,28 @@ impl Args {
}
}

if version_range.is_some() {
let rustup = Rustup::new();
if rustup.version < 23 {
bail!("--version-range requires rustup 1.23 or later");
let version_range = match (version_range, rust_version) {
(Some(_), true) => {
conflicts("--version-range", "--rust-version")?;
unreachable!()
}
(Some(version_range), false) => {
let rustup = Rustup::new();
if rustup.version < 23 {
bail!("--version-range requires rustup 1.23 or later");
}
Some(version_range.parse()?)
}
(None, true) => {
let rustup = Rustup::new();
if rustup.version < 23 {
bail!("--rust-version requires rustup 1.23 or later");
}
Some(VersionRange::msrv())
}
(None, false) => None,
};
if version_range.is_some() {
} else {
if version_step.is_some() {
requires("--version-step", &["--version-range"])?;
Expand All @@ -520,7 +539,6 @@ impl Args {
requires("--clean-per-version", &["--version-range"])?;
}
}
let version_range = version_range.map(|v| v.parse()).transpose()?;

if no_dev_deps {
info!(
Expand Down Expand Up @@ -728,6 +746,15 @@ const HELP: &[HelpText<'_>] = &[
"Skip passing --features flag to `cargo` if that feature does not exist in the package",
&["This flag can only be used together with either --features or --include-features."],
),
(
"",
"--rust-version",
"",
"Perform commands on `package.rust-version`",
&[
"This cannot be used with --version-range.",
],
),
(
"",
"--version-range",
Expand Down
60 changes: 43 additions & 17 deletions src/rustup.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use anyhow::{bail, format_err, Result};
use crate::{
cargo,
context::Context,
version::{Version, VersionRange},
version::{MaybeVersion, Version, VersionRange},
};

pub(crate) struct Rustup {
Expand Down Expand Up @@ -41,39 +41,65 @@ pub(crate) fn version_range(
Ok(())
};

let VersionRange { start_inclusive, end_inclusive } = range;
let mut stable_version = None;
let mut get_stable_version = || -> Result<Version> {
if let Some(stable_version) = stable_version {
Ok(stable_version)
} else {
install_toolchain("stable", &[], false)?;
let version = cargo::version(cmd!("cargo", "+stable"))?;
stable_version = Some(version);
Ok(version)
}
};

let start_inclusive = match start_inclusive {
Some(start) => start,
None => {
let mut rust_version = None;
let mut rust_version = None;
let mut get_rust_version = || -> Result<Version> {
if let Some(rust_version) = rust_version {
Ok(rust_version)
} else {
let mut version = None;
for id in cx.workspace_members() {
let v = cx.rust_version(id);
if v.is_none() || v == rust_version {
if v.is_none() || v == version {
// no-op
} else if rust_version.is_none() {
rust_version = v;
} else if version.is_none() {
version = v;
} else {
bail!("automatic detection of the lower bound of the version range is not yet supported when the minimum supported Rust version of the crates in the workspace do not match")
}
}
match rust_version {
let version = match version {
Some(v) => v.parse()?,
None => bail!("no rust-version field in Cargo.toml is specified"),
}
};
rust_version = Some(version);
Ok(version)
}
};
check(&start_inclusive)?;

let VersionRange { start_inclusive, end_inclusive } = range;

let start_inclusive = match start_inclusive {
MaybeVersion::Version(start) => {
check(&start)?;
start
}
MaybeVersion::Msrv => {
let start = get_rust_version()?;
check(&start)?;
start
}
MaybeVersion::Stable => get_stable_version()?,
};

let end_inclusive = match end_inclusive {
Some(end) => {
MaybeVersion::Version(end) => {
check(&end)?;
end
}
None => {
install_toolchain("stable", &[], false)?;
cargo::version(cmd!("cargo", "+stable"))?
}
MaybeVersion::Msrv => get_rust_version()?,
MaybeVersion::Stable => get_stable_version()?,
};

let step = step.map(str::parse::<u8>).transpose()?.unwrap_or(1);
Expand Down
30 changes: 22 additions & 8 deletions src/version.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,32 @@ impl FromStr for Version {
}
}

#[derive(Copy, Clone)]
pub(crate) enum MaybeVersion {
Version(Version),
Msrv,
Stable,
}

#[derive(Copy, Clone)]
pub(crate) struct VersionRange {
pub(crate) start_inclusive: Option<Version>,
pub(crate) end_inclusive: Option<Version>,
pub(crate) start_inclusive: MaybeVersion,
pub(crate) end_inclusive: MaybeVersion,
}

impl VersionRange {
pub(crate) fn msrv() -> Self {
Self { start_inclusive: MaybeVersion::Msrv, end_inclusive: MaybeVersion::Msrv }
}
}

impl fmt::Display for VersionRange {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if let Some(start) = self.start_inclusive {
if let MaybeVersion::Version(start) = self.start_inclusive {
write!(f, "{start}")?;
}
write!(f, "..=")?;
if let Some(end) = self.end_inclusive {
if let MaybeVersion::Version(end) = self.end_inclusive {
write!(f, "{end}")?;
}
Ok(())
Expand All @@ -56,7 +69,7 @@ impl FromStr for VersionRange {
type Err = Error;

fn from_str(s: &str) -> Result<Self, Self::Err> {
let (start, end_inclusive) = if let Some((start, end)) = s.split_once("..") {
let (start, end) = if let Some((start, end)) = s.split_once("..") {
let end = match end.strip_prefix('=') {
Some(end) => end,
None => {
Expand All @@ -71,15 +84,16 @@ impl FromStr for VersionRange {
} else {
(s, None)
};
let start_inclusive = maybe_version(start)?;
let start_inclusive = maybe_version(start)?.unwrap_or(MaybeVersion::Msrv);
let end_inclusive = end.unwrap_or(MaybeVersion::Stable);
Ok(Self { start_inclusive, end_inclusive })
}
}

fn maybe_version(s: &str) -> Result<Option<Version>, Error> {
fn maybe_version(s: &str) -> Result<Option<MaybeVersion>, Error> {
if s.is_empty() {
Ok(None)
} else {
s.parse().map(Some)
s.parse().map(MaybeVersion::Version).map(Some)
}
}
5 changes: 4 additions & 1 deletion tests/auxiliary/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ pub fn cargo_hack<O: AsRef<OsStr>>(args: impl AsRef<[O]>) -> Command {
let mut cmd = cargo_bin_exe();
cmd.arg("hack");
if let Some(toolchain) = test_version() {
if !args.iter().any(|a| a.as_ref().to_str().unwrap().starts_with("--version-range")) {
if !args.iter().any(|a| {
let s = a.as_ref().to_str().unwrap();
s.starts_with("--version-range") || s.starts_with("--rust-version")
}) {
cmd.arg(format!("--version-range=1.{toolchain}..=1.{toolchain}"));
}
}
Expand Down
5 changes: 5 additions & 0 deletions tests/long-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,11 @@ OPTIONS:

This flag can only be used together with either --features or --include-features.

--rust-version
Perform commands on `package.rust-version`.

This cannot be used with --version-range.

--version-range [START]..[=END]
Perform commands on a specified (inclusive) range of Rust versions.

Expand Down
1 change: 1 addition & 0 deletions tests/short-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ OPTIONS:
--ignore-private Skip to perform on `publish = false` packages
--ignore-unknown-features Skip passing --features flag to `cargo` if that feature
does not exist in the package
--rust-version Perform commands on `package.rust-version`
--version-range [START]..[=END] Perform commands on a specified (inclusive) range of Rust
versions
--version-step <NUM> Specify the version interval of --version-range (default
Expand Down
10 changes: 10 additions & 0 deletions tests/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1353,6 +1353,16 @@ fn version_range() {
);
}

#[cfg_attr(windows, ignore)] // rustup bug: https://github.com/rust-lang/rustup/issues/3036
#[test]
fn rust_version() {
cargo_hack(["check", "--rust-version"]).assert_success("rust-version").stderr_contains(
"
running `cargo +1.64 check` on real (1/1)
",
);
}

#[cfg_attr(windows, ignore)] // rustup bug: https://github.com/rust-lang/rustup/issues/3036
#[test]
fn multi_target() {
Expand Down