fix: scripts use project root as current working directory (#3891)

Author: ericswanson-dfinity

CHANGELOG.md

@@ -10,6 +10,17 @@ Support Motoko's enhanced orthogonal persistence by automatically setting the ca
 
 `dfx start --pocketic` no longer requires `--clean`, and can persist replica state between runs.
 
+### fix: Scripts always run with current directory set to the project root
+
+Build scripts and other scripts now always run with the working directory
+set to the project root (directory containing dfx.json).
+
+This applies to the following:
+ - build scripts
+ - extension run
+ - tech stack value computation
+ - packtool (vessel, mops etc)
+
 # 0.23.0
 
 ### feat: Add canister snapshots

docs/dfx-json-schema.json

@@ -288,7 +288,7 @@
           "properties": {
             "build": {
               "title": "Build Commands",
-              "description": "Commands that are executed in order to produce this canister's Wasm module. Expected to produce the Wasm in the path specified by the 'wasm' field. No build commands are allowed if the `wasm` field is a URL.",
+              "description": "Commands that are executed in order to produce this canister's Wasm module. Expected to produce the Wasm in the path specified by the 'wasm' field. No build commands are allowed if the `wasm` field is a URL. These commands are executed in the root of the project.",
               "default": [],
               "allOf": [
                 {
@@ -467,7 +467,7 @@
         },
         "post_install": {
           "title": "Post-Install Commands",
-          "description": "One or more commands to run post canister installation.",
+          "description": "One or more commands to run post canister installation. These commands are executed in the root of the project.",
           "default": [],
           "allOf": [
             {
@@ -698,7 +698,7 @@
           ]
         },
         "packtool": {
-          "description": "Main command to run the packtool.",
+          "description": "Main command to run the packtool. This command is executed in the root of the project.",
           "type": [
             "string",
             "null"

e2e/assets/custom_canister/build.sh

@@ -1,2 +1,3 @@
 #!/usr/bin/env bash
+echo "working directory of build script: '$(pwd)'"
 echo CUSTOM_CANISTER2_BUILD_DONE

e2e/assets/metadata/tech_stack/dfx.json

@@ -114,6 +114,17 @@
         "k": {
             "type": "motoko",
             "main": "main.mo"
+        },
+        "m": {
+            "type": "motoko",
+            "main": "main.mo",
+            "tech_stack": {
+                "other": {
+                    "command": {
+                        "cwd": "$(pwd)"
+                    }
+                }
+            }
         }
     }
 }

e2e/assets/post_install/postinstall.sh

@@ -1,2 +1,3 @@
 #!/usr/bin/env bash
+echo "working directory of post-install script: '$(pwd)'"
 echo hello-script

e2e/tests-dfx/build.bash

@@ -279,6 +279,21 @@ teardown() {
   assert_match CUSTOM_CANISTER2_BUILD_DONE
 }
 
+@test "custom canister build script runs in project root" {
+  install_asset custom_canister
+  install_asset wasm/identity
+
+  dfx_start
+  dfx canister create custom2
+
+  cd src/e2e_project_backend
+  pwd
+
+  assert_command dfx build custom2
+  assert_match CUSTOM_CANISTER2_BUILD_DONE
+  assert_match "working directory of build script: '.*/working-dir/e2e_project'"
+}
+
 @test "build succeeds with network parameter" {
   dfx_start
   dfx canister create --all --network local

e2e/tests-dfx/extension.bash

@@ -675,6 +675,48 @@ EOF
   assert_eq "pamparam the param is 123"
 }
 
+@test "extension run uses project root" {
+  CACHE_DIR=$(dfx cache show)
+  mkdir -p "$CACHE_DIR"/extensions/test_extension
+
+  cat > "$CACHE_DIR"/extensions/test_extension/test_extension << "EOF"
+#!/usr/bin/env bash
+
+echo "the current directory is '$(pwd)'"
+
+EOF
+
+  chmod +x "$CACHE_DIR"/extensions/test_extension/test_extension
+
+  cat > "$CACHE_DIR"/extensions/test_extension/extension.json <<EOF
+{
+  "name": "test_extension",
+  "version": "0.1.0",
+  "homepage": "https://github.com/dfinity/dfx-extensions",
+  "authors": "DFINITY",
+  "summary": "Test extension for e2e purposes.",
+  "categories": [],
+  "keywords": [],
+  "subcommands": {
+  "abc": {
+  "about": "something something",
+  "args": {
+  }
+  }
+  }
+}
+EOF
+
+  mkdir -p project || exit
+  cd project || exit
+  echo "{}" >dfx.json
+  mkdir -p subdir || exit
+  cd subdir || exit
+
+  assert_command dfx test_extension abc
+  assert_match "the current directory is '.*/working-dir/project'"
+}
+
 @test "run with multiple values for the same parameter" {
   CACHE_DIR=$(dfx cache show)
   mkdir -p "$CACHE_DIR"/extensions/test_extension

e2e/tests-dfx/install.bash

@@ -108,6 +108,20 @@ teardown() {
   assert_match 'hello-script'
 }
 
+@test "post-install tasks run in project root" {
+  install_asset post_install
+  dfx_start
+
+  assert_command dfx canister create --all
+  assert_command dfx build
+
+  cd src/e2e_project_backend
+
+  assert_command dfx canister install postinstall_script
+  assert_match 'hello-script'
+  assert_match "working directory of post-install script: '.*/working-dir/e2e_project'"
+}
+
 @test "post-install tasks receive environment variables" {
   install_asset post_install
   dfx_start

e2e/tests-dfx/metadata.bash

@@ -300,3 +300,21 @@ ic-stable-structures"
   assert_command jq -r '.tech_stack.cdk."ic-cdk" | keys[]' e2e_project_backend.json
   assert_eq "version"
 }
+
+# shellcheck disable=SC2154
+@test "tech stack value generation uses project root as working directory" {
+  dfx_new
+  install_asset metadata/tech_stack
+
+  dfx_start
+
+
+  # m exposes other->command->working-directory
+
+  cd src/e2e_project_backend || exit
+  assert_command dfx deploy m
+  assert_command dfx canister metadata m dfx
+  echo "$stdout" > m.json
+  assert_command jq -r '.tech_stack.other.command.cwd' m.json
+  assert_match ".*/working-dir/e2e_project$"
+}

e2e/tests-dfx/packtool.bash

@@ -50,6 +50,25 @@ teardown() {
   assert_eq '("php: No comment.")'
 }
 
+@test "project calls packtool in project root" {
+  install_asset packtool
+  # shellcheck disable=SC1091
+  source configure_packtool.bash
+
+  dfx_start
+
+  cd vessel || exit
+  dfx canister create --all
+  dfx build
+  dfx canister install e2e_project_backend
+
+  assert_command dfx canister call e2e_project_backend rate '("rust")'
+  assert_eq '("rust: So hot right now.")'
+
+  assert_command dfx canister call e2e_project_backend rate '("php")'
+  assert_eq '("php: No comment.")'
+}
+
 @test "failure to invoke the package tool reports the command line and reason" {
   install_asset packtool
   jq '.defaults.build.packtool="./no-such-command that command cannot be invoked"' dfx.json | sponge dfx.json

src/dfx-core/src/config/model/dfinity.rs

@@ -271,6 +271,7 @@ pub struct ConfigCanistersCanister {
 
     /// # Post-Install Commands
     /// One or more commands to run post canister installation.
+    /// These commands are executed in the root of the project.
     #[serde(default)]
     pub post_install: SerdeVec<String>,
 
@@ -379,6 +380,7 @@ pub enum CanisterTypeProperties {
         /// Commands that are executed in order to produce this canister's Wasm module.
         /// Expected to produce the Wasm in the path specified by the 'wasm' field.
         /// No build commands are allowed if the `wasm` field is a URL.
+        /// These commands are executed in the root of the project.
         #[schemars(default)]
         build: SerdeVec<String>,
     },
@@ -617,6 +619,7 @@ impl Default for ConfigDefaultsBootstrap {
 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
 pub struct ConfigDefaultsBuild {
     /// Main command to run the packtool.
+    /// This command is executed in the root of the project.
     pub packtool: Option<String>,
 
     /// Arguments for packtool.

src/dfx-core/src/extension/manager/execute.rs

@@ -2,18 +2,23 @@ use super::ExtensionManager;
 use crate::config::cache::get_bin_cache;
 use crate::error::extension::RunExtensionError;
 use std::ffi::OsString;
+use std::path::PathBuf;
 
 impl ExtensionManager {
     pub fn run_extension(
         &self,
         extension_name: OsString,
         mut params: Vec<OsString>,
+        project_root: Option<PathBuf>,
     ) -> Result<(), RunExtensionError> {
         let extension_name = extension_name
             .into_string()
             .map_err(RunExtensionError::InvalidExtensionName)?;
 
         let mut extension_binary = self.get_extension_binary(&extension_name)?;
+        if let Some(project_root) = project_root {
+            extension_binary.current_dir(project_root);
+        }
         let dfx_cache = get_bin_cache(self.dfx_version.to_string().as_str())?;
 
         params.extend(["--dfx-cache-path".into(), dfx_cache.into_os_string()]);

src/dfx/src/commands/extension/run.rs

@@ -24,6 +24,9 @@ impl From<Vec<OsString>> for RunOpts {
 
 pub fn exec(env: &dyn Environment, opts: RunOpts) -> DfxResult<()> {
     let mgr = env.get_extension_manager();
-    mgr.run_extension(opts.name, opts.params)?;
+    let project_root = env
+        .get_config()?
+        .map(|c| c.get_project_root().to_path_buf());
+    mgr.run_extension(opts.name, opts.params, project_root)?;
     Ok(())
 }

src/dfx/src/commands/language_service.rs

@@ -47,7 +47,11 @@ pub fn exec(env: &dyn Environment, opts: LanguageServiceOpts) -> DfxResult {
             .get_build()
             .get_packtool();
 
-        let mut package_arguments = package_arguments::load(env.get_cache().as_ref(), packtool)?;
+        let mut package_arguments = package_arguments::load(
+            env.get_cache().as_ref(),
+            packtool,
+            config.get_project_root(),
+        )?;
 
         // Include actor alias flags
         let canister_names = config

src/dfx/src/lib/builders/mod.rs

@@ -349,6 +349,7 @@ pub fn execute_command(
         sh_cmd.args(["-c", command]);
         sh_cmd
     };
+    cmd.current_dir(cwd);
 
     if !catch_output {
         cmd.stdin(Stdio::inherit())

src/dfx/src/lib/builders/motoko.rs

@@ -46,6 +46,7 @@ fn get_imports(cache: &dyn Cache, info: &MotokoCanisterInfo) -> DfxResult<BTreeS
     #[context("Failed recursive dependency detection at {}.", file.display())]
     fn get_imports_recursive(
         cache: &dyn Cache,
+        workspace_root: &Path,
         file: &Path,
         result: &mut BTreeSet<MotokoImport>,
     ) -> DfxResult {
@@ -56,6 +57,7 @@ fn get_imports(cache: &dyn Cache, info: &MotokoCanisterInfo) -> DfxResult<BTreeS
         result.insert(MotokoImport::Relative(file.to_path_buf()));
 
         let mut command = cache.get_binary_command("moc")?;
+        command.current_dir(workspace_root);
         let command = command.arg("--print-deps").arg(file);
         let output = command
             .output()
@@ -66,7 +68,7 @@ fn get_imports(cache: &dyn Cache, info: &MotokoCanisterInfo) -> DfxResult<BTreeS
             let import = MotokoImport::try_from(line).context("Failed to create MotokoImport.")?;
             match import {
                 MotokoImport::Relative(path) => {
-                    get_imports_recursive(cache, path.as_path(), result)?;
+                    get_imports_recursive(cache, workspace_root, path.as_path(), result)?;
                 }
                 _ => {
                     result.insert(import);
@@ -78,7 +80,12 @@ fn get_imports(cache: &dyn Cache, info: &MotokoCanisterInfo) -> DfxResult<BTreeS
     }
 
     let mut result = BTreeSet::new();
-    get_imports_recursive(cache, info.get_main_path(), &mut result)?;
+    get_imports_recursive(
+        cache,
+        info.get_workspace_root(),
+        info.get_main_path(),
+        &mut result,
+    )?;
 
     Ok(result)
 }
@@ -154,8 +161,11 @@ impl CanisterBuilder for MotokoBuilder {
             config.env_file.as_deref(),
         )?;
 
-        let package_arguments =
-            package_arguments::load(cache.as_ref(), motoko_info.get_packtool())?;
+        let package_arguments = package_arguments::load(
+            cache.as_ref(),
+            motoko_info.get_packtool(),
+            canister_info.get_workspace_root(),
+        )?;
 
         let moc_arguments = match motoko_info.get_args() {
             Some(args) => [
@@ -190,6 +200,7 @@ impl CanisterBuilder for MotokoBuilder {
             output: output_wasm_path,
             idl_path: idl_dir_path,
             idl_map: &id_map,
+            workspace_root: canister_info.get_workspace_root(),
         };
         motoko_compile(&self.logger, cache.as_ref(), &params)?;
 
@@ -221,6 +232,7 @@ enum BuildTarget {
 
 struct MotokoParams<'a> {
     build_target: BuildTarget,
+    workspace_root: &'a Path,
     idl_path: &'a Path,
     idl_map: &'a CanisterIdMap,
     package_arguments: &'a PackageArguments,
@@ -263,6 +275,7 @@ impl MotokoParams<'_> {
 #[context("Failed to compile Motoko.")]
 fn motoko_compile(logger: &Logger, cache: &dyn Cache, params: &MotokoParams<'_>) -> DfxResult {
     let mut cmd = cache.get_binary_command("moc")?;
+    cmd.current_dir(params.workspace_root);
     params.to_args(&mut cmd);
     run_command(logger, &mut cmd, params.suppress_warning).context("Failed to run 'moc'.")?;
     Ok(())

src/dfx/src/lib/builders/rust.rs

@@ -66,6 +66,7 @@ impl CanisterBuilder for RustBuilder {
         cargo
             .stdout(Stdio::inherit())
             .stderr(Stdio::inherit())
+            .current_dir(canister_info.get_workspace_root())
             .arg("build")
             .arg("--target")
             .arg("wasm32-unknown-unknown")