Skip to content

Commit

Permalink
Merge pull request #12 from mobilecoinfoundation/bug
Browse files Browse the repository at this point in the history 
Parse target and profile from out dir
  • Loading branch information
@varsha888
varsha888 committed Apr 4, 2023
2 parents 7f2994e + 10caa06 commit 3573b1e
Show file tree
Hide file tree
Showing 4 changed files with 216 additions and 65 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pr.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ jobs:
steps:
- uses: actions/add-to-project@v0.4.1
with:
github-token: "${{ secrets.ADD_TO_PROJECT_PAT }}"
project-url: https://github.com/orgs/mobilecoinfoundation/projects/5
github-token: "${{ secrets.MEOWBLECOIN_PAT }}"
project-url: https://github.com/orgs/mobilecoinfoundation/projects/7

size-label:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ url = "2.3"
walkdir = "2.3"

[dev-dependencies]
fluent-asserter = "0.1.9"
mockall = "0.11.3"
mockall_double = "0.3.0"
rustversion = "1.0"
temp-env = "0.3.2"
12 changes: 2 additions & 10 deletions src/cargo_build.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -593,12 +593,6 @@ mod tests {
use super::*;
use std::str::FromStr;

//TODO: Needs to be removed once rust 1.68 stable is released
#[rustversion::stable]
const IS_RUST_STABLE_VERSION: bool = true;
#[rustversion::any(beta, nightly)]
const IS_RUST_STABLE_VERSION: bool = false;

fn init_mock_env(cargo_path: &str, profile: &str, cargo_locked: bool) -> Environment {
let mut mock = Environment::default();

Expand Down Expand Up @@ -634,10 +628,8 @@ mod tests {
CargoBuilder::new(&mock, &Path::new("/path_to_output_directory"), false);
let cmd = cargo_builder.construct();
let actual_cmd = format!("{:?}", cmd);
let expected_cmd = match IS_RUST_STABLE_VERSION {
true => "\"/path_to_cargo\" \"build\" \"-vv\" \"--locked\"",
false => "cd \"/path_to_output_directory\" && \"/path_to_cargo\" \"build\" \"-vv\" \"--locked\"",
};
let expected_cmd =
"cd \"/path_to_output_directory\" && \"/path_to_cargo\" \"build\" \"-vv\" \"--locked\"";

assert_eq!(actual_cmd, expected_cmd);
}
Expand Down
263 changes: 211 additions & 52 deletions src/env.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,20 +237,20 @@ impl Environment {
let out_dir = PathBuf::from(
var(ENV_OUT_DIR).map_err(|e| EnvironmentError::Var(ENV_OUT_DIR.to_owned(), e))?,
);
// Convert ths to path?
let cargo_target_dir = PathBuf::from(
var(ENV_CARGO_TARGET_DIR)
.map_err(|e| EnvironmentError::Var(ENV_CARGO_TARGET_DIR.to_owned(), e))?,
);
let target =
var(ENV_TARGET).map_err(|e| EnvironmentError::Var(ENV_TARGET.to_owned(), e))?;
let profile =
var(ENV_PROFILE).map_err(|e| EnvironmentError::Var(ENV_PROFILE.to_owned(), e))?;
let profile_target_dir = out_dir
.as_path()
.ancestors()
.find(|path| path.ends_with(&target) || path.ends_with(&profile))
.ok_or_else(|| EnvironmentError::OutDir(out_dir.clone()))?
.to_owned();
let target_dir = profile_target_dir
.parent()
.ok_or_else(|| EnvironmentError::OutDir(out_dir.clone()))?
.to_owned();

let (target_dir, profile_target_dir) =
Self::get_target_profile_dir(&out_dir, &cargo_target_dir, target)
.ok_or_else(|| EnvironmentError::OutDir(out_dir.clone()))
.unwrap();

let target_has_atomic = var(ENV_CARGO_CFG_TARGET_HAS_ATOMIC)
.unwrap_or_default()
Expand Down Expand Up @@ -396,6 +396,27 @@ impl Environment {
})
}

fn get_target_profile_dir(
out_dir: &Path,
target_dir: &PathBuf,
target: String,
) -> Option<(PathBuf, PathBuf)> {
let mut ancestor = out_dir.ancestors().peekable();
while let Some(current_path) = ancestor.next() {
if let Some(parent_path) = ancestor.peek() {
if !target.is_empty() && parent_path.ends_with(&target)
|| !target_dir.as_os_str().is_empty() && parent_path.ends_with(target_dir)
|| parent_path.ends_with("target")
{
let tuple = (PathBuf::from(parent_path), PathBuf::from(current_path));

return Some(tuple);
}
}
}
None
}

/// Get the path to the cargo executables
pub fn cargo(&self) -> &Path {
&self.cargo_path
Expand Down Expand Up @@ -621,7 +642,76 @@ impl Environment {
#[cfg(test)]
mod tests {
use super::*;
use std::str::FromStr;
use fluent_asserter::prelude::*;

fn setup_env(env_values: HashMap<&str, Option<&str>>) -> Environment {
temp_env::with_vars(
[
(
ENV_OUT_DIR,
if env_values.get(ENV_OUT_DIR).is_some() {
env_values.get(ENV_OUT_DIR).cloned().unwrap()
} else {
Some("/path_to_out_dir")
},
),
(
ENV_TARGET,
if env_values.get(ENV_TARGET).is_some() {
env_values.get(ENV_TARGET).cloned().unwrap()
} else {
Some("target")
},
),
(
ENV_PROFILE,
if env_values.get(ENV_PROFILE).is_some() {
env_values.get(ENV_PROFILE).cloned().unwrap()
} else {
Some("profile")
},
),
(
ENV_CARGO,
if env_values.get(ENV_CARGO).is_some() {
env_values.get(ENV_CARGO).cloned().unwrap()
} else {
Some("/path_to_cargo")
},
),
(ENV_HOST, Some("host")),
(ENV_NUM_JOBS, Some("11")),
(ENV_OPT_LEVEL, Some("2")),
(ENV_RUSTC, Some("rustc")),
(ENV_RUSTDOC, Some("rustdoc")),
(
ENV_CARGO_TARGET_DIR,
if env_values.get(ENV_CARGO_TARGET_DIR).is_some() {
env_values.get(ENV_CARGO_TARGET_DIR).cloned().unwrap()
} else {
Some("/path_to_target_dir")
},
),
(ENV_CARGO_PKG_VERSION, Some("2.1.0-pre0")),
(ENV_CARGO_PKG_AUTHORS, Some("MobileCoin")),
(ENV_CARGO_PKG_NAME, Some("mc-build-rs")),
(ENV_CARGO_PKG_DESCRIPTION, Some("")),
(ENV_CARGO_PKG_HOMEPAGE, Some("")),
(ENV_CARGO_PKG_REPOSITORY, Some("")),
(ENV_CARGO_CFG_TARGET_ARCH, Some("x86_64")),
(ENV_CARGO_CFG_TARGET_ENDIAN, Some("little")),
(ENV_CARGO_CFG_TARGET_ENV, Some("")),
(ENV_CARGO_CFG_TARGET_FAMILY, Some("unix")),
(ENV_CARGO_CFG_TARGET_FEATURE, Some("adx,aes,avx,avx2,")),
(ENV_CARGO_CFG_TARGET_OS, Some("linux")),
(ENV_CARGO_CFG_TARGET_POINTER_WIDTH, Some("64")),
(ENV_CARGO_CFG_TARGET_VENDOR, Some("unknown")),
],
|| {
return Environment::default();
},
)
}

#[test]
fn init_env() {
Expand All @@ -631,47 +721,116 @@ mod tests {
let expected_profile = "debug";
let expected_cargo_package_version = "2.1.0-pre0";

temp_env::with_vars(
[
("OUT_DIR", Some(expected_out_dir)),
("TARGET", Some(expected_target)),
("PROFILE", Some(expected_profile)),
("CARGO", Some(expected_cargo_path)),
("HOST", Some("host")),
("NUM_JOBS", Some("11")),
("OPT_LEVEL", Some("2")),
("RUSTC", Some("rustc")),
("RUSTDOC", Some("rustdoc")),
("CARGO_PKG_VERSION", Some(expected_cargo_package_version)),
("CARGO_PKG_AUTHORS", Some("MobileCoin")),
("CARGO_PKG_NAME", Some("mc-build-rs")),
("CARGO_PKG_DESCRIPTION", Some("")),
("CARGO_PKG_HOMEPAGE", Some("")),
("CARGO_PKG_REPOSITORY", Some("")),
("CARGO_CFG_TARGET_ARCH", Some("x86_64")),
("CARGO_CFG_TARGET_ENDIAN", Some("little")),
("CARGO_CFG_TARGET_ENV", Some("")),
("CARGO_CFG_TARGET_FAMILY", Some("unix")),
("CARGO_CFG_TARGET_FEATURE", Some("adx,aes,avx,avx2,")),
("CARGO_CFG_TARGET_OS", Some("linux")),
("CARGO_CFG_TARGET_POINTER_WIDTH", Some("64")),
("CARGO_CFG_TARGET_VENDOR", Some("unknown")),
],
|| {
let env = Environment::default();

assert_eq!(
env.out_dir(),
PathBuf::from_str(expected_out_dir).expect("Fail")
);
assert_eq!(env.target, expected_target);
assert_eq!(env.profile, expected_profile);
assert_eq!(
env.cargo_path,
PathBuf::from_str(expected_cargo_path).expect("Fail")
);
assert_eq!(env.pkg_version, expected_cargo_package_version);
},
let mut values = HashMap::new();
values.insert(ENV_OUT_DIR, Some(expected_out_dir));
values.insert(ENV_TARGET, Some(expected_target));
values.insert(ENV_CARGO, Some(expected_cargo_path));
values.insert(ENV_PROFILE, Some(expected_profile));
values.insert(ENV_CARGO_PKG_VERSION, Some(expected_cargo_package_version));

let env = setup_env(values);

assert_eq!(
env.out_dir(),
PathBuf::from_str(expected_out_dir).expect("Fail")
);
assert_eq!(env.target, expected_target);
assert_eq!(env.profile, expected_profile);
assert_eq!(
env.cargo_path,
PathBuf::from_str(expected_cargo_path).expect("Fail")
);
assert_eq!(env.pkg_version, expected_cargo_package_version);
}

#[test]
fn match_target_type() {
let out_dir = "path_to/target/x86_64-unknown-linux-gnu/debug/path/to/out";
let target = "x86_64-unknown-linux-gnu";
let expected_target_dir = "path_to/target/x86_64-unknown-linux-gnu/";
let expected_profile_dir = "path_to/target/x86_64-unknown-linux-gnu/debug";

let mut values = HashMap::new();
values.insert(ENV_OUT_DIR, Some(out_dir));
values.insert(ENV_TARGET, Some(target));

let env = setup_env(values);

assert_eq!(
env.target_dir,
PathBuf::from_str(expected_target_dir).expect("Fail")
);
assert_eq!(
env.profile_target_dir,
PathBuf::from_str(expected_profile_dir).expect("Fail")
);
}

#[test]
fn match_target_dir() {
let target_dir = "path_to/target";
let out_dir = "path_to/target/debug/path/to/out";
let target = "x86_64-unknown-linux-gnu";
let expected_target_dir = "path_to/target";
let expected_profile_dir = "path_to/target/debug";

let mut values = HashMap::new();
values.insert(ENV_OUT_DIR, Some(out_dir));
values.insert(ENV_CARGO_TARGET_DIR, Some(target_dir));
values.insert(ENV_TARGET, Some(target));

let env = setup_env(values);

assert_eq!(
env.target_dir,
PathBuf::from_str(expected_target_dir).expect("Fail")
);
assert_eq!(
env.profile_target_dir,
PathBuf::from_str(expected_profile_dir).expect("Fail")
);
}

#[test]
fn match_target_string() {
let target_dir = "";
let out_dir = "path_to/target/debug/path/to/out";
let target = "x86_64-unknown-linux-gnu";
let expected_target_dir = "path_to/target/";
let expected_profile_dir = "path_to/target/debug";

let mut values = HashMap::new();
values.insert(ENV_OUT_DIR, Some(out_dir));
values.insert(ENV_CARGO_TARGET_DIR, Some(target_dir));
values.insert(ENV_TARGET, Some(target));

let env = setup_env(values);

assert_eq!(
env.target_dir,
PathBuf::from_str(expected_target_dir).expect("Fail")
);
assert_eq!(
env.profile_target_dir,
PathBuf::from_str(expected_profile_dir).expect("Fail")
);
}

#[test]
fn err_out_dir() {
let target_dir = "different/path_to_target";
let out_dir = "path_to/debug/path/to/out";
let target = "x86_64-unknown-linux-gnu";

let mut values = HashMap::new();
values.insert(ENV_OUT_DIR, Some(out_dir));
values.insert(ENV_CARGO_TARGET_DIR, Some(target_dir));
values.insert(ENV_TARGET, Some(target));

assert_that_code!(|| setup_env(values))
.panics()
.with_message(
"called `Result::unwrap()` on an `Err` value: OutDir(\"path_to/debug/path/to/out\")",
);
}
}

0 comments on commit 3573b1e

Please sign in to comment.