fix: show clear error when running uninstalled dev tool

benodiwal · benodiwal · commit 9bd82aca2fd2 · 2025-12-16T05:30:14.000+05:30
Signed-off-by: Sachin Beniwal &lt;s474996633@gmail.com&gt;
diff --git a/bin/tools/tools_common.ml b/bin/tools/tools_common.ml
@@ -127,12 +127,24 @@ let install_command dev_tool =
 
 let exec_command dev_tool =
   let exe_name = Pkg_dev_tool.exe_name dev_tool in
+  let exe_path = dev_tool_exe_path dev_tool in
   let term =
     let+ builder = Common.Builder.term
     (* CR-someday Alizter: document this option *)
     and+ args = Arg.(value & pos_all string [] (info [] ~docv:"ARGS" ~doc:None)) in
-    let common, config = Common.init builder in
-    lock_build_and_run_dev_tool ~common ~config builder dev_tool ~args
+    let common, _config = Common.init builder in
+    if Path.exists exe_path
+    then run_dev_tool (Common.root common) dev_tool ~args
+    else
+      User_error.raise
+        [ Pp.textf "The tool %s is not installed." exe_name ]
+        ~hints:
+          [ Pp.concat
+              ~sep:Pp.space
+              [ Pp.text "Try running"
+              ; User_message.command (sprintf "dune tools install %s" exe_name)
+              ]
+          ]
   in
   let info =
     let doc =
diff --git a/test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-which.t b/test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-which.t
@@ -20,9 +20,11 @@ The command will fail because the dev tool is not installed:
   _build/_private/default/.dev-tool/ocamlformat/target/bin/ocamlformat
 
 Install the dev tool:
-  $ dune tools exec ocamlformat
+  $ dune tools install ocamlformat
   Solution for _build/.dev-tools.locks/ocamlformat:
   - ocamlformat.0.26.2
+
+  $ dune tools exec ocamlformat
        Running 'ocamlformat'
   formatted with version 0.26.2
 
diff --git a/test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-wrapper.t b/test/blackbox-tests/test-cases/pkg/ocamlformat/ocamlformat-wrapper.t
@@ -7,8 +7,10 @@ Exercise running the ocamlformat wrapper command.
   $ make_ocamlformat_opam_pkg "0.26.2"
   $ make_project_with_dev_tool_lockdir
 
-  $ DUNE_CONFIG__LOCK_DEV_TOOL=enabled dune tools exec ocamlformat
+  $ DUNE_CONFIG__LOCK_DEV_TOOL=enabled dune tools install ocamlformat
   Solution for _build/.dev-tools.locks/ocamlformat:
   - ocamlformat.0.26.2
+
+  $ dune tools exec ocamlformat
        Running 'ocamlformat'
   formatted with version 0.26.2
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-basic.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-basic.t
@@ -1,6 +1,5 @@
-Test that the "dune tools exec ocamllsp" command causes ocamllsp to be
-locked, built and run when the command is run from a dune project with
-a lockdir containing an "ocaml" lockfile.
+Test that the "dune tools exec ocamllsp" command runs ocamllsp after it
+has been installed with "dune tools install ocamllsp".
 
   $ . ../helpers.sh
   $ . ./helpers.sh
@@ -24,10 +23,16 @@ a lockdir containing an "ocaml" lockfile.
   > (version 5.2.0)
   > EOF
 
-  $ dune tools exec ocamllsp
+First install the tool:
+
+  $ dune tools install ocamllsp
   Solution for _build/.dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.2.0
   - ocaml-lsp-server.0.0.1
+
+Then exec runs it:
+
+  $ dune tools exec ocamllsp
        Running 'ocamllsp'
   hello from fake ocamllsp
 
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-env-path-var.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-env-path-var.t
@@ -22,11 +22,14 @@ Make a fake ocamllsp package that prints out the PATH variable:
   > (version 5.2.0)
   > EOF
 
-Confirm that each dev tool's bin directory is now in PATH:
-  $ dune tools exec ocamllsp | tr : '\n' | grep '_build/_private/default/.dev-tool'
+First install the tool:
+  $ dune tools install ocamllsp
   Solution for _build/.dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.2.0
   - ocaml-lsp-server.0.0.1
+
+Confirm that each dev tool's bin directory is now in PATH:
+  $ dune tools exec ocamllsp | tr : '\n' | grep '_build/_private/default/.dev-tool'
        Running 'ocamllsp'
   $TESTCASE_ROOT/_build/_private/default/.dev-tool/ocaml-index/target/bin
   $TESTCASE_ROOT/_build/_private/default/.dev-tool/dune-release/target/bin
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-install-concurrent-with-watch-server.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-install-concurrent-with-watch-server.t
@@ -33,10 +33,12 @@ Test that ocamllsp can be installed while dune is running in watch mode.
   Success, waiting for filesystem changes...
   Success, waiting for filesystem changes...
 
-  $ dune tools exec ocamllsp
+  $ dune tools install ocamllsp
   Solution for dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.2.0
   - ocaml-lsp-server.0.0.1
+
+  $ dune tools exec ocamllsp
        Running 'ocamllsp'
   hello from fake ocamllsp
 
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-no-lock-dir.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-no-lock-dir.t
@@ -10,6 +10,6 @@ dune project with no lockdir.
   > EOF
 
   $ dune tools exec ocamllsp
-  Error: Unable to load the lockdir for the default build context.
-  Hint: Try running 'dune pkg lock'
+  Error: The tool ocamllsp is not installed.
+  Hint: Try running 'dune tools install ocamllsp'
   [1]
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-no-ocaml-lockfile.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-no-ocaml-lockfile.t
@@ -14,7 +14,6 @@ doesn't contain a lockfile for the "ocaml" package.
   $ make_lockdir
 
   $ dune tools exec ocamllsp
-  Error: The lockdir doesn't contain a lockfile for the package "ocaml".
-  Hint: Add a dependency on "ocaml" to one of the packages in dune-project and
-  then run 'dune pkg lock'
+  Error: The tool ocamllsp is not installed.
+  Hint: Try running 'dune tools install ocamllsp'
   [1]
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-ocamlformat.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-ocamlformat.t
@@ -48,10 +48,12 @@ Make a fake ocamlformat
   Solution for dev-tools.locks/ocamlformat:
   - ocamlformat.0.0.1
 
-  $ dune tools exec ocamllsp
+  $ dune tools install ocamllsp
   Solution for dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.2.0
   - ocaml-lsp-server.0.0.1
+
+  $ dune tools exec ocamllsp
        Running 'ocamllsp'
   fake ocamllsp will now run fake ocamlformat:
   hello from fake ocamlformat
diff --git a/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-relock-on-ocaml-version-change.t b/test/blackbox-tests/test-cases/pkg/ocamllsp/dev-tool-ocamllsp-relock-on-ocaml-version-change.t
@@ -28,10 +28,12 @@ same version of the ocaml compiler as the code that it's analyzing.
   > EOF
 
 Initially ocamllsp will be depend on ocaml.5.2.0 to match the project.
-  $ dune tools exec ocamllsp
+  $ dune tools install ocamllsp
   Solution for _build/.dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.2.0
   - ocaml-lsp-server.0.0.1
+
+  $ dune tools exec ocamllsp
        Running 'ocamllsp'
   hello from fake ocamllsp
   $ cat "${dev_tool_lock_dir}"/ocaml.pkg
@@ -47,16 +49,18 @@ Change the version of ocaml that the project depends on.
   > (version 5.1.0)
   > EOF
 
-Running "dune tools exec ocamllsp" causes ocamllsp to be relocked and rebuilt
-before running. Ocamllsp now depends on ocaml.5.1.0.
-  $ DUNE_CONFIG__LOCK_DEV_TOOL=enabled dune tools exec ocamllsp
+Running "dune tools install ocamllsp" causes ocamllsp to be relocked and rebuilt.
+Ocamllsp now depends on ocaml.5.1.0.
+  $ DUNE_CONFIG__LOCK_DEV_TOOL=enabled dune tools install ocamllsp
   The version of the compiler package ("ocaml") in this project's lockdir has
   changed to 5.1.0 (formerly the compiler version was 5.2.0). The dev-tool
   "ocaml-lsp-server" will be re-locked and rebuilt with this version of the
   compiler.
   Solution for _build/.dev-tools.locks/ocaml-lsp-server:
   - ocaml.5.1.0
   - ocaml-lsp-server.0.0.1
+
+  $ dune tools exec ocamllsp
        Running 'ocamllsp'
   hello from fake ocamllsp
   $ cat "${dev_tool_lock_dir}"/ocaml.pkg
