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.

Sign up for GitHub

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

fix: support adding dependencies for project's unsupported platforms #668

Merged
merged 6 commits into from
Jan 16, 2024
Merged

fix: support adding dependencies for project's unsupported platforms #668

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cdc8d46
fix: support adding dependencies for project's unsupported platforms
orhun Jan 15, 2024
1cce968
refactor: automate --no-install behavior
orhun Jan 15, 2024
91b87fb
refactor: add return value to sanity_check_project
orhun Jan 15, 2024
95e8435
refactor: check platform separately
orhun Jan 15, 2024
e9a99c6
refactor: do not check platform if no_install is true
orhun Jan 16, 2024
bf16f2c
Update src/environment.rs
ruben-arts Jan 16, 2024
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
35 changes: 13 additions & 22 deletions src/environment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use crate::{
consts, default_authenticated_client, install, install_pypi, lock_file, prefix::Prefix,
progress, Project,
};
use miette::{Context, IntoDiagnostic, LabeledSpan};
use miette::{Context, IntoDiagnostic};

use crate::lock_file::lock_file_satisfies_project;
use crate::project::virtual_packages::verify_current_platform_has_required_virtual_packages;
Expand Down Expand Up @@ -53,31 +53,13 @@ fn create_prefix_location_file(prefix_file: &Path) -> miette::Result<()> {
Ok(())
}

/// Runs a number of different checks to make sure the project is in a sane state:
/// Runs the following checks to make sure the project is in a sane state:
/// 1. It verifies that the prefix location is unchanged.
/// 2. It verifies that the project supports the current platform.
/// 3. It verifies that the system requirements are met.
/// 2. It verifies that the system requirements are met.
pub fn sanity_check_project(project: &Project) -> miette::Result<()> {
// Sanity check of prefix location
verify_prefix_location_unchanged(project.pixi_dir().join(consts::PREFIX_FILE_NAME).as_path())?;

// Make sure the project supports the current platform
let platform = Platform::current();
if !project.platforms().contains(&platform) {
let span = project.manifest.parsed.project.platforms.span();
return Err(miette::miette!(
help = format!(
"The project needs to be configured to support your platform ({platform})."
),
labels = vec![LabeledSpan::at(
span.unwrap_or_default(),
format!("add '{platform}' here"),
)],
"the project is not configured for your current platform"
)
.with_source_code(project.manifest_named_source()));
}

// Make sure the system requirements are met
verify_current_platform_has_required_virtual_packages(&project.default_environment())?;

Expand Down Expand Up @@ -124,9 +106,18 @@ impl LockFileUsage {
pub async fn get_up_to_date_prefix(
project: &Project,
usage: LockFileUsage,
no_install: bool,
mut no_install: bool,
sparse_repo_data: Option<Vec<SparseRepoData>>,
) -> miette::Result<Prefix> {
// Do not install if the platform is not supported
if !no_install {
let current_platform = Platform::current();
if !project.platforms().contains(&current_platform) {
tracing::warn!("Not installing dependency on current platform: ({current_platform}) as it is not part of this project's supported platforms.");
no_install = true;
}
}

// Make sure the project is in a sane state
sanity_check_project(project)?;

Expand Down
Loading