cram_exec - add shell_spec to action spec

Signed-off-by: Haochen Kotoi-Xie <hx@kxc.inc>

Author: haochenx

src/dune_rules/action_unexpanded.ml

@@ -480,7 +480,7 @@ let rec expand (t : Dune_lang.Action.t) ~context : Action.t Action_expander.t =
     O.Pipe (outputs, l)
   | Cram script ->
     let+ script = E.dep script in
-    Cram_exec.action script
+    Cram_exec.(action { script; shell_spec = Shell_spec.default })
   | Withenv _ | Substitute _ | Patch _ ->
     (* these can only be provided by the package language which isn't expanded here *)
     assert false

src/dune_rules/cram/cram_exec.ml

@@ -1,5 +1,19 @@
 open Import
 
+module Shell_spec = struct
+  type 'path t =
+    | System_shell
+    | Bash_shell
+    | Exec_file_shell of 'path
+
+  let default = System_shell
+
+  let conv f = function
+    | System_shell -> System_shell
+    | Bash_shell -> Bash_shell
+    | Exec_file_shell p -> Exec_file_shell (f p)
+end
+
 module Sanitizer : sig
   [@@@ocaml.warning "-32"]
 
@@ -376,7 +390,7 @@ let create_sh_script cram_stanzas ~temp_dir : sh_script Fiber.t =
 let _display_with_bars s =
   List.iter (String.split_lines s) ~f:(Printf.eprintf "| %s\n")
 
-let run ~env ~script lexbuf : string Fiber.t =
+let run ~env ~script ~shell_spec lexbuf : string Fiber.t =
   let temp_dir =
     let suffix =
       let basename = Path.basename script in
@@ -414,8 +428,14 @@ let run ~env ~script lexbuf : string Fiber.t =
   let open Fiber.O in
   let+ () =
     let sh =
-      let path = Env_path.path Env.initial in
-      Option.value_exn (Bin.which ~path "sh")
+      let which shell_name =
+        let path = Env_path.path Env.initial in
+        Option.value_exn (Bin.which ~path shell_name)
+      in
+      match shell_spec with
+      | Shell_spec.System_shell -> which "sh"
+      | Bash_shell -> which "bash"
+      | Exec_file_shell sh -> sh
     in
     let metadata =
       let name =
@@ -436,24 +456,38 @@ let run ~env ~script lexbuf : string Fiber.t =
   let sanitized = sanitize ~parent_script:sh_script.script raw in
   compose_cram_output sanitized
 
-let run ~env ~script =
-  run_expect_test script ~f:(fun lexbuf -> run ~env ~script lexbuf)
+let run ~env ~script ~shell_spec =
+  run_expect_test script ~f:(fun lexbuf -> run ~env ~script ~shell_spec lexbuf)
+
+type ('path, _) spec =
+  { script : 'path
+  ; shell_spec : 'path Shell_spec.t
+  }
 
 module Spec = struct
-  type ('path, _) t = 'path
+  type ('path, 'target) t = ('path, 'target) spec
 
   let name = "cram"
 
   let version = 1
 
-  let bimap path f _ = f path
+  let bimap spec f _ =
+    { script = f spec.script; shell_spec = Shell_spec.conv f spec.shell_spec }
 
   let is_useful_to ~distribute:_ ~memoize:_ = true
 
-  let encode script path _ : Dune_lang.t =
-    List [ Dune_lang.atom_or_quoted_string "cram"; path script ]
+  let encode { script; shell_spec } path _ : Dune_sexp.t =
+    let atom = Dune_lang.atom_or_quoted_string in
+    let sh : Dune_lang.t =
+      match shell_spec with
+      | System_shell -> List [ atom "system" ]
+      | Bash_shell -> List [ atom "bash" ]
+      | Exec_file_shell p -> List [ atom "executable"; path p ]
+    in
+    List [ atom "cram"; path script; List [ atom "shell"; sh ] ]
 
-  let action script ~ectx:_ ~(eenv : Action.Ext.env) = run ~env:eenv.env ~script
+  let action { script; shell_spec } ~ectx:_ ~(eenv : Action.Ext.env) =
+    run ~env:eenv.env ~script ~shell_spec
 end
 
 let action script =

src/dune_rules/cram/cram_exec.mli

@@ -1,3 +1,19 @@
 open Import
 
-val action : Path.t -> Action.t
+module Shell_spec : sig
+  type 'path t =
+    | System_shell
+    | Bash_shell
+    | Exec_file_shell of 'path
+
+  val conv : ('p1 -> 'p2) -> 'p1 t -> 'p2 t
+
+  val default : _ t
+end
+
+type ('path, _) spec =
+  { script : 'path
+  ; shell_spec : 'path Shell_spec.t
+  }
+
+val action : (Path.t, Import.Path.Build.t) spec -> Action.t

src/dune_rules/cram/cram_rules.ml

@@ -61,7 +61,10 @@ let test_rule ~sctx ~expander ~dir (spec : effective)
       in
       let action =
         Action.progn
-          [ Cram_exec.action (Path.build script)
+          [ Cram_exec.action
+              { script = Path.build script
+              ; shell_spec = Cram_exec.Shell_spec.default
+              }
           ; Diff
               { Diff.optional = true
               ; mode = Text