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

fix(forge): make recursive forge update optional via --recursive flag #5980

Merged
merged 3 commits into from
Nov 1, 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
14 changes: 13 additions & 1 deletion crates/cli/src/utils/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,7 @@ https://github.com/foundry-rs/foundry/issues/new/choose"
force: bool,
remote: bool,
no_fetch: bool,
recursive: bool,
paths: I,
) -> Result<()>
where
Expand All @@ -571,16 +572,27 @@ https://github.com/foundry-rs/foundry/issues/new/choose"
{
self.cmd()
.stderr(self.stderr())
.args(["submodule", "update", "--progress", "--init", "--recursive"])
.args(["submodule", "update", "--progress", "--init"])
.args(self.shallow.then_some("--depth=1"))
.args(force.then_some("--force"))
.args(remote.then_some("--remote"))
.args(no_fetch.then_some("--no-fetch"))
.args(recursive.then_some("--recursive"))
.args(paths)
.exec()
.map(drop)
}

pub fn submodule_foreach(self, recursive: bool, cmd: impl AsRef<OsStr>) -> Result<()> {
self.cmd()
.stderr(self.stderr())
.args(["submodule", "foreach"])
.args(recursive.then_some("--recursive"))
.arg(cmd)
.exec()
.map(drop)
}

pub fn submodule_init(self) -> Result<()> {
self.cmd().stderr(self.stderr()).args(["submodule", "init"]).exec().map(drop)
}
Expand Down
2 changes: 1 addition & 1 deletion crates/forge/bin/cmd/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ impl InitArgs {
git.submodule_init()?;
} else {
// if not shallow, initialize and clone submodules (without fetching latest)
git.submodule_update(false, false, true, None::<PathBuf>)?;
git.submodule_update(false, false, true, true, None::<PathBuf>)?;
}
} else {
// if target is not empty
Expand Down
7 changes: 4 additions & 3 deletions crates/forge/bin/cmd/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ impl DependencyInstallOpts {

if dependencies.is_empty() && !self.no_git {
p_println!(!self.quiet => "Updating dependencies in {}", libs.display());
git.submodule_update(false, false, false, Some(&libs))?;
// recursively fetch all submodules (without fetching latest)
git.submodule_update(false, false, false, true, Some(&libs))?;
}
fs::create_dir_all(&libs)?;

Expand Down Expand Up @@ -303,8 +304,8 @@ impl Installer<'_> {
trace!(?dep, url, ?path, "installing git submodule");
self.git.submodule_add(true, url, path)?;

trace!("updating submodule recursively");
self.git.submodule_update(false, false, false, Some(path))
trace!("initializing submodule recursively");
self.git.submodule_update(false, false, false, true, Some(path))
}

fn git_checkout(self, dep: &Dependency, path: &Path, recurse: bool) -> Result<String> {
Expand Down
17 changes: 16 additions & 1 deletion crates/forge/bin/cmd/update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,29 @@ pub struct UpdateArgs {
/// Override the up-to-date check.
#[clap(short, long)]
force: bool,

/// Recursively update submodules.
#[clap(short, long)]
recursive: bool,
}
impl_figment_convert_basic!(UpdateArgs);

impl UpdateArgs {
pub fn run(self) -> Result<()> {
let config = self.try_load_config_emit_warnings()?;
let (root, paths) = dependencies_paths(&self.dependencies, &config)?;
Git::new(&root).submodule_update(self.force, true, false, paths)
// fetch the latest changes for each submodule (recursively if flag is set)
let git = Git::new(&root);
if self.recursive {
// update submodules recursively
git.submodule_update(self.force, true, false, true, paths)
} else {
// update root submodules
git.submodule_update(self.force, true, false, false, paths)?;
// initialize submodules of each submodule recursively (otherwise direct submodule
// dependencies will revert to last commit)
git.submodule_foreach(false, "git submodule update --init --progress --recursive ")
}
}
}

Expand Down
47 changes: 35 additions & 12 deletions crates/forge/tests/cli/cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -975,7 +975,6 @@ forgetest!(can_install_latest_release_tag, |prj: TestProject, mut cmd: TestComma
// Tests that forge update doesn't break a working dependency by recursively updating nested
// dependencies
forgetest!(
#[ignore]
can_update_library_with_outdated_nested_dependency,
|prj: TestProject, mut cmd: TestCommand| {
cmd.git_init();
Expand All @@ -984,39 +983,63 @@ forgetest!(
let git_mod = prj.root().join(".git/modules/lib");
let git_mod_file = prj.root().join(".gitmodules");

let package = libs.join("issue-2264-repro");
let package_mod = git_mod.join("issue-2264-repro");
// get paths to check inside install fn
let package = libs.join("forge-5980-test");
let package_mod = git_mod.join("forge-5980-test");

let install = |cmd: &mut TestCommand| {
cmd.forge_fuse().args(["install", "foundry-rs/issue-2264-repro", "--no-commit"]);
// install main dependency
cmd.forge_fuse().args(["install", "evalir/forge-5980-test", "--no-commit"]);
cmd.assert_non_empty_stdout();

// assert pathbufs exist
assert!(package.exists());
assert!(package_mod.exists());

let submods = read_string(&git_mod_file);
assert!(submods.contains("https://github.com/foundry-rs/issue-2264-repro"));
assert!(submods.contains("https://github.com/evalir/forge-5980-test"));
};

install(&mut cmd);
cmd.forge_fuse().args(["update", "lib/issue-2264-repro"]);
// try to update the top-level dependency; there should be no update for this dependency,
// but its sub-dependency has upstream (breaking) changes; forge should not attempt to
// update the sub-dependency
cmd.forge_fuse().args(["update", "lib/forge-5980-test"]);
cmd.stdout_lossy();

// add explicit remappings for test file
let config = Config {
remappings: vec![
Remapping::from_str("forge-5980-test/=lib/forge-5980-test/src/").unwrap().into(),
// explicit remapping for sub-dependendy seems necessary for some reason
Remapping::from_str(
"forge-5980-test-dep/=lib/forge-5980-test/lib/forge-5980-test-dep/src/",
)
.unwrap()
.into(),
],
..Default::default()
};
prj.write_config(config);

// create test file that uses the top-level dependency; if the sub-dependency is updated,
// compilation will fail
prj.inner()
.add_source(
"MyTokenCopy",
"CounterCopy",
r#"
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.6.0;
import "issue-2264-repro/MyToken.sol";
contract MyTokenCopy is MyToken {
pragma solidity ^0.8.0;
import "forge-5980-test/Counter.sol";
contract CounterCopy is Counter {
}
"#,
)
.unwrap();

cmd.forge_fuse().args(["build"]);
// build and check output
cmd.forge_fuse().arg("build");
let output = cmd.stdout_lossy();

assert!(output.contains("Compiler run successful",));
}
);
Expand Down