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

Add validation for pants_version format #338

Merged
merged 4 commits into from
Jan 5, 2024
Merged

Add validation for pants_version format #338

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f463e4
Add validation for pants_version format
Seaweed0112 Dec 19, 2023
d6b72f6
improve error message with patch version suggestion
Seaweed0112 Dec 20, 2023
b26dbf2
add test for bad pex version
Seaweed0112 Dec 27, 2023
01169d4
modify the suggestion in error message
Seaweed0112 Dec 28, 2023
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
31 changes: 31 additions & 0 deletions package/src/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ pub(crate) fn run_integration_tests(
test_ignore_empty_pants_version_pants_sha(scie_pants_scie);

test_pants_from_pex_version(scie_pants_scie);
test_pants_from_bad_pex_version(scie_pants_scie);

let clone_root = create_tempdir()?;
test_use_in_repo_with_pants_script(scie_pants_scie, &clone_root);
Expand Down Expand Up @@ -460,6 +461,36 @@ fn test_pants_from_pex_version(scie_pants_scie: &Path) {
);
}

fn test_pants_from_bad_pex_version(scie_pants_scie: &Path) {
integration_test!(
"Verify the output of scie-pants is user-friendly if they provide an invalid pants version"
);

let tmpdir = create_tempdir().unwrap();

let pants_release = "2.18";
let pants_toml_content = format!(
r#"
[GLOBAL]
pants_version = "{pants_release}"
"#
);
let pants_toml = tmpdir.path().join("pants.toml");
write_file(&pants_toml, false, pants_toml_content).unwrap();

let err = execute(
Command::new(scie_pants_scie)
.arg("-V")
.current_dir(&tmpdir)
.stderr(Stdio::piped()),
)
.unwrap_err();

let error_text = err.to_string();
assert!(error_text.contains("Wasn't able to fetch the Pants PEX at"));
assert!(error_text.contains("Pants version format not recognized. Please add `.<patch_version>` to the end of the version. For example: `2.18` -> `2.18.0`"));
}

fn test_use_in_repo_with_pants_script(scie_pants_scie: &Path, clone_root: &TempDir) {
integration_test!("Verify scie-pants can be used as `pants` in a repo with the `pants` script");
// This verifies a fix for https://github.com/pantsbuild/scie-pants/issues/28.
Expand Down
7 changes: 7 additions & 0 deletions tools/src/scie_pants/install_pants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,15 @@ def install_pants_from_pex(
try:
ptex.fetch_to_fp(pex_url, pants_pex.file)
except subprocess.CalledProcessError as e:
# if there's only one dot in version, specifically suggest adding the `.patch`)
suggestion = (
"Pants version format not recognized. Please add `.<patch_version>` to the end of the version. For example: `2.18` -> `2.18.0`"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest we make two minor adjustments:

  • have this be a full sentence (i.e. . on the end)
  • ensure that if there's no suggestion, we don't end up with 3 blank lines, by including the \n\n here
Suggested change
"Pants version format not recognized. Please add `.<patch_version>` to the end of the version. For example: `2.18` -> `2.18.0`"
"Pants version format not recognized. Please add `.<patch_version>` to the end of the version. For example: `2.18` -> `2.18.0`.\n\n"

Then change f"{suggestion}\n\n" to be just f"{suggestion}" or maybe include {suggestion} at the end of the first line.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank so much! I just pushed another commit. Please check!

if version.base_version.count(".") < 2
else ""
)
fatal(
f"Wasn't able to fetch the Pants PEX at {pex_url}.\n\n"
f"{suggestion}\n\n"
"Check to see if the URL is reachable (i.e. GitHub isn't down) and if"
f" {pex_name} asset exists within the release."
" If the asset doesn't exist it may be that this platform isn't yet supported."
Expand Down