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

Improve forge configuration acquired from tomls #2497

Merged

Conversation

kkawula
Copy link
Collaborator

@kkawula kkawula commented Sep 23, 2024

Closes #2433

Introduced changes

  • Configuration parsing logic was moved to the stage of loading it from the file, instead of the previous version - when performing tests

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

@kkawula kkawula changed the title Kkawula/2433 improve forge configuration acquired from tomls Improve forge configuration acquired from tomls Sep 23, 2024
@kkawula kkawula marked this pull request as ready for review September 24, 2024 07:46
@kkawula
Copy link
Collaborator Author

kkawula commented Sep 24, 2024

In the linked issue there is listed Block id (e.g. "Latest") is hardcoded, we need to introduce constants, is this still required?
Now we validate this before running tests and this value is used only in two places.

Copy link
Member

@cptartur cptartur left a comment

Choose a reason for hiding this comment

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

Let's add a test to see if it's actually being correctly loaded from file. We can improve the overall flow of loading the configuration later.

@kkawula
Copy link
Collaborator Author

kkawula commented Sep 25, 2024

Fortunately, these changes are still covered by older tests, e.g. here ->

#[test]
fn get_forge_config_for_package_fails_on_same_fork_name() {
let temp = setup_package("simple_package");
let content = indoc!(
r#"
[package]
name = "simple_package"
version = "0.1.0"
[[tool.snforge.fork]]
name = "SAME_NAME"
url = "http://some.rpc.url"
block_id.number = "1"
[[tool.snforge.fork]]
name = "SAME_NAME"
url = "http://some.rpc.url"
block_id.hash = "1"
"#
);
temp.child("Scarb.toml").write_str(content).unwrap();
let scarb_metadata = ScarbCommand::metadata()
.inherit_stderr()
.current_dir(temp.path())
.run()
.unwrap();
let err = load_package_config::<ForgeConfigFromScarb>(
&scarb_metadata,
&scarb_metadata.workspace.members[0],
)
.unwrap_err();
assert!(format!("{err:?}").contains("Some fork names are duplicated"));
}
#[test]
fn get_forge_config_for_package_fails_on_multiple_block_id() {
let temp = setup_package("simple_package");
let content = indoc!(
r#"
[package]
name = "simple_package"
version = "0.1.0"
[[tool.snforge.fork]]
name = "SAME_NAME"
url = "http://some.rpc.url"
block_id.number = "1"
block_id.hash = "2"
"#
);
temp.child("Scarb.toml").write_str(content).unwrap();
let scarb_metadata = ScarbCommand::metadata()
.inherit_stderr()
.current_dir(temp.path())
.run()
.unwrap();
let err = load_package_config::<ForgeConfigFromScarb>(
&scarb_metadata,
&scarb_metadata.workspace.members[0],
)
.unwrap_err();
assert!(format!("{err:?}").contains("block_id should be set once per fork"));
}
#[test]
fn get_forge_config_for_package_fails_on_wrong_block_id() {
let temp = setup_package("simple_package");
let content = indoc!(
r#"
[package]
name = "simple_package"
version = "0.1.0"
[[tool.snforge.fork]]
name = "SAME_NAME"
url = "http://some.rpc.url"
block_id.wrong_variant = "1"
"#
);
temp.child("Scarb.toml").write_str(content).unwrap();
let scarb_metadata = ScarbCommand::metadata()
.inherit_stderr()
.current_dir(temp.path())
.run()
.unwrap();
let err = load_package_config::<ForgeConfigFromScarb>(
&scarb_metadata,
&scarb_metadata.workspace.members[0],
)
.unwrap_err();
assert!(
format!("{err:?}").contains("block_id = wrong_variant is not valid. Possible values are = \"number\", \"hash\" and \"tag\"")
);
}
#[test]
fn get_forge_config_for_package_fails_on_wrong_block_tag() {
let temp = setup_package("simple_package");
let content = indoc!(
r#"
[package]
name = "simple_package"
version = "0.1.0"
[[tool.snforge.fork]]
name = "SAME_NAME"
url = "http://some.rpc.url"
block_id.tag = "Pending"
"#
);
temp.child("Scarb.toml").write_str(content).unwrap();
let scarb_metadata = ScarbCommand::metadata()
.inherit_stderr()
.current_dir(temp.path())
.run()
.unwrap();
let err = load_package_config::<ForgeConfigFromScarb>(
&scarb_metadata,
&scarb_metadata.workspace.members[0],
)
.unwrap_err();
assert!(format!("{err:?}").contains("block_id.tag can only be equal to latest"));
}
#[test]
fn get_forge_config_resolves_env_variables() {
let temp = setup_package("simple_package");
let content = indoc!(
r#"
[package]
name = "simple_package"
version = "0.1.0"
[[tool.snforge.fork]]
name = "ENV_URL_FORK"
url = "$ENV_URL_FORK234980670176"
block_id.number = "1"
"#
);
temp.child("Scarb.toml").write_str(content).unwrap();
let scarb_metadata = ScarbCommand::metadata()
.inherit_stderr()
.current_dir(temp.path())
.run()
.unwrap();
env::set_var("ENV_URL_FORK234980670176", "http://some.rpc.url_from_env");
let config = load_package_config::<ForgeConfigFromScarb>(
&scarb_metadata,
&scarb_metadata.workspace.members[0],
)
.unwrap();
assert_eq!(
config,
ForgeConfigFromScarb {
exit_first: false,
fork: vec![ForkTarget::new(
"ENV_URL_FORK".to_string(),
"http://some.rpc.url_from_env".to_string(),
"number".to_string(),
"1".to_string(),
)],
fuzzer_runs: None,
fuzzer_seed: None,
max_n_steps: None,
detailed_resources: false,
save_trace_data: false,
build_profile: false,
coverage: false
}
);
}
}

@kkawula
Copy link
Collaborator Author

kkawula commented Sep 25, 2024

Further changes are addressed in issue #2514

@kkawula kkawula added this pull request to the merge queue Sep 29, 2024
Merged via the queue into master with commit 25044b0 Sep 29, 2024
24 checks passed
@kkawula kkawula deleted the kkawula/2433-improve-forge-configuration-acquired-from-tomls branch September 29, 2024 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Forge configuration acquired from .tomls
2 participants