ocamltest: refactoring and implementation of hooks

Author: shindere

ocamltest/.depend

@@ -1,64 +1,88 @@
-run_unix.$(O): run_unix.c run.h run_common.h
-run_stubs.$(O): run_stubs.c run.h ../byterun/caml/mlvalues.h \
+run_unix.$(O): run_unix.c run.h ../byterun/caml/misc.h \
  ../byterun/caml/config.h ../byterun/caml/m.h ../byterun/caml/s.h \
- ../byterun/caml/misc.h ../byterun/caml/memory.h ../byterun/caml/gc.h \
- ../byterun/caml/mlvalues.h ../byterun/caml/major_gc.h \
- ../byterun/caml/freelist.h ../byterun/caml/minor_gc.h \
- ../byterun/caml/address_class.h ../byterun/caml/io.h
+ run_common.h
+run_stubs.$(O): run_stubs.c run.h ../byterun/caml/misc.h \
+ ../byterun/caml/config.h ../byterun/caml/m.h ../byterun/caml/s.h \
+ ../byterun/caml/mlvalues.h ../byterun/caml/misc.h \
+ ../byterun/caml/memory.h ../byterun/caml/gc.h ../byterun/caml/mlvalues.h \
+ ../byterun/caml/major_gc.h ../byterun/caml/freelist.h \
+ ../byterun/caml/minor_gc.h ../byterun/caml/address_class.h \
+ ../byterun/caml/io.h ../byterun/caml/osdeps.h ../byterun/caml/memory.h
 actions.cmo : environments.cmi actions.cmi
 actions.cmx : environments.cmx actions.cmi
 actions.cmi : environments.cmi
-backends.cmo : backends.cmi
-backends.cmx : backends.cmi
-backends.cmi :
-builtin_actions.cmo : variables.cmi testlib.cmi run_command.cmi \
-    ocamltest_config.cmi filetype.cmi filecompare.cmi environments.cmi \
-    builtin_variables.cmi builtin_modifiers.cmi backends.cmi actions.cmi \
+actions_helpers.cmo : variables.cmi run_command.cmi ocamltest_stdlib.cmi \
+    filecompare.cmi environments.cmi builtin_variables.cmi actions.cmi \
+    actions_helpers.cmi
+actions_helpers.cmx : variables.cmx run_command.cmx ocamltest_stdlib.cmx \
+    filecompare.cmx environments.cmx builtin_variables.cmx actions.cmx \
+    actions_helpers.cmi
+actions_helpers.cmi : variables.cmi environments.cmi actions.cmi
+builtin_actions.cmo : ocamltest_stdlib.cmi ocamltest_config.cmi \
+    environments.cmi builtin_variables.cmi actions_helpers.cmi actions.cmi \
     builtin_actions.cmi
-builtin_actions.cmx : variables.cmx testlib.cmx run_command.cmx \
-    ocamltest_config.cmx filetype.cmx filecompare.cmx environments.cmx \
-    builtin_variables.cmx builtin_modifiers.cmx backends.cmx actions.cmx \
+builtin_actions.cmx : ocamltest_stdlib.cmx ocamltest_config.cmx \
+    environments.cmx builtin_variables.cmx actions_helpers.cmx actions.cmx \
     builtin_actions.cmi
 builtin_actions.cmi : actions.cmi
-builtin_modifiers.cmo : environments.cmi builtin_variables.cmi \
-    builtin_modifiers.cmi
-builtin_modifiers.cmx : environments.cmx builtin_variables.cmx \
-    builtin_modifiers.cmi
-builtin_modifiers.cmi : environments.cmi
-builtin_tests.cmo : tests.cmi builtin_actions.cmi builtin_tests.cmi
-builtin_tests.cmx : tests.cmx builtin_actions.cmx builtin_tests.cmi
-builtin_tests.cmi : tests.cmi
 builtin_variables.cmo : variables.cmi builtin_variables.cmi
 builtin_variables.cmx : variables.cmx builtin_variables.cmi
 builtin_variables.cmi : variables.cmi
-environments.cmo : variables.cmi environments.cmi
-environments.cmx : variables.cmx environments.cmi
+environments.cmo : variables.cmi ocamltest_stdlib.cmi environments.cmi
+environments.cmx : variables.cmx ocamltest_stdlib.cmx environments.cmi
 environments.cmi : variables.cmi
-filecompare.cmo : testlib.cmi run_command.cmi filecompare.cmi
-filecompare.cmx : testlib.cmx run_command.cmx filecompare.cmi
+filecompare.cmo : run_command.cmi ocamltest_stdlib.cmi filecompare.cmi
+filecompare.cmx : run_command.cmx ocamltest_stdlib.cmx filecompare.cmi
 filecompare.cmi :
 filetype.cmo : filetype.cmi
 filetype.cmx : filetype.cmi
 filetype.cmi :
 main.cmo : tsl_semantics.cmi tsl_parser.cmi tsl_lexer.cmi tests.cmi \
-    testlib.cmi options.cmi ocamltest_config.cmi environments.cmi \
-    builtin_variables.cmi actions.cmi main.cmi
+    options.cmi ocamltest_stdlib.cmi environments.cmi builtin_variables.cmi \
+    actions_helpers.cmi actions.cmi main.cmi
 main.cmx : tsl_semantics.cmx tsl_parser.cmx tsl_lexer.cmx tests.cmx \
-    testlib.cmx options.cmx ocamltest_config.cmx environments.cmx \
-    builtin_variables.cmx actions.cmx main.cmi
+    options.cmx ocamltest_stdlib.cmx environments.cmx builtin_variables.cmx \
+    actions_helpers.cmx actions.cmx main.cmi
 main.cmi :
+ocaml_actions.cmo : variables.cmi ocamltest_stdlib.cmi ocamltest_config.cmi \
+    ocaml_variables.cmi ocaml_modifiers.cmi ocaml_backends.cmi filetype.cmi \
+    filecompare.cmi environments.cmi builtin_variables.cmi \
+    actions_helpers.cmi actions.cmi ocaml_actions.cmi
+ocaml_actions.cmx : variables.cmx ocamltest_stdlib.cmx ocamltest_config.cmx \
+    ocaml_variables.cmx ocaml_modifiers.cmx ocaml_backends.cmx filetype.cmx \
+    filecompare.cmx environments.cmx builtin_variables.cmx \
+    actions_helpers.cmx actions.cmx ocaml_actions.cmi
+ocaml_actions.cmi : actions.cmi
+ocaml_backends.cmo : ocamltest_stdlib.cmi ocaml_backends.cmi
+ocaml_backends.cmx : ocamltest_stdlib.cmx ocaml_backends.cmi
+ocaml_backends.cmi : ocamltest_stdlib.cmi
+ocaml_modifiers.cmo : ocamltest_stdlib.cmi ocamltest_config.cmi \
+    ocaml_variables.cmi environments.cmi builtin_variables.cmi \
+    ocaml_modifiers.cmi
+ocaml_modifiers.cmx : ocamltest_stdlib.cmx ocamltest_config.cmx \
+    ocaml_variables.cmx environments.cmx builtin_variables.cmx \
+    ocaml_modifiers.cmi
+ocaml_modifiers.cmi : environments.cmi
+ocaml_tests.cmo : tests.cmi ocamltest_config.cmi ocaml_actions.cmi \
+    builtin_actions.cmi ocaml_tests.cmi
+ocaml_tests.cmx : tests.cmx ocamltest_config.cmx ocaml_actions.cmx \
+    builtin_actions.cmx ocaml_tests.cmi
+ocaml_tests.cmi : tests.cmi
+ocaml_variables.cmo : variables.cmi ocaml_variables.cmi
+ocaml_variables.cmx : variables.cmx ocaml_variables.cmi
+ocaml_variables.cmi : variables.cmi
 ocamltest_config.cmo : ocamltest_config.cmi
 ocamltest_config.cmx : ocamltest_config.cmi
 ocamltest_config.cmi :
+ocamltest_stdlib.cmo : ocamltest_stdlib.cmi
+ocamltest_stdlib.cmx : ocamltest_stdlib.cmi
+ocamltest_stdlib.cmi :
 options.cmo : tests.cmi actions.cmi options.cmi
 options.cmx : tests.cmx actions.cmx options.cmi
 options.cmi :
-run_command.cmo : testlib.cmi run_command.cmi
-run_command.cmx : testlib.cmx run_command.cmi
+run_command.cmo : ocamltest_stdlib.cmi run_command.cmi
+run_command.cmx : ocamltest_stdlib.cmx run_command.cmi
 run_command.cmi :
-testlib.cmo : testlib.cmi
-testlib.cmx : testlib.cmi
-testlib.cmi :
 tests.cmo : actions.cmi tests.cmi
 tests.cmx : actions.cmx tests.cmi
 tests.cmi : environments.cmi actions.cmi
@@ -71,10 +95,10 @@ tsl_lexer.cmi : tsl_parser.cmi
 tsl_parser.cmo : tsl_ast.cmi tsl_parser.cmi
 tsl_parser.cmx : tsl_ast.cmx tsl_parser.cmi
 tsl_parser.cmi : tsl_ast.cmi
-tsl_semantics.cmo : variables.cmi tsl_ast.cmi tests.cmi testlib.cmi \
-    environments.cmi actions.cmi tsl_semantics.cmi
-tsl_semantics.cmx : variables.cmx tsl_ast.cmx tests.cmx testlib.cmx \
-    environments.cmx actions.cmx tsl_semantics.cmi
+tsl_semantics.cmo : variables.cmi tsl_ast.cmi tests.cmi environments.cmi \
+    actions.cmi tsl_semantics.cmi
+tsl_semantics.cmx : variables.cmx tsl_ast.cmx tests.cmx environments.cmx \
+    actions.cmx tsl_semantics.cmi
 tsl_semantics.cmi : tsl_ast.cmi tests.cmi environments.cmi actions.cmi
 variables.cmo : variables.cmi
 variables.cmx : variables.cmi

ocamltest/Makefile

@@ -19,7 +19,8 @@ include ../config/Makefile
 
 ifeq "$(UNIX_OR_WIN32)" "win32"
   unix := false
-  ocamlsrcdir := $(shell echo "$(abspath $(shell pwd)/..)"|cygpath -m -f -)
+  ocamlsrcdir := $(shell echo "$(abspath $(shell pwd)/..)"|cygpath -w -f - \
+    | sed 's/\\/\\\\\\\\/g')
 else
   unix := true
   ocamlsrcdir := $(abspath $(shell pwd)/..)
@@ -32,27 +33,37 @@ run := run_$(UNIX_OR_WIN32)
 # List of source files from which ocamltest is compiled
 # (all the different sorts of files are derived from this)
 
-sources := \
+# ocamltest has two components: its core and the OCaml "plugin"
+# which is actually built into the tool but clearly separated from its core
+
+core := \
   $(run).c \
   run_stubs.c \
   ocamltest_config.mli ocamltest_config.ml.in \
-  testlib.mli testlib.ml \
+  ocamltest_stdlib.mli ocamltest_stdlib.ml \
   run_command.mli run_command.ml \
   filetype.mli filetype.ml \
   filecompare.mli filecompare.ml \
-  backends.mli backends.ml \
   variables.mli variables.ml \
   environments.mli environments.ml \
-  builtin_variables.mli builtin_variables.ml \
-  builtin_modifiers.mli builtin_modifiers.ml \
   actions.mli actions.ml \
-  builtin_actions.mli builtin_actions.ml \
   tests.mli tests.ml \
-  builtin_tests.mli builtin_tests.ml \
   tsl_ast.mli tsl_ast.ml \
   tsl_parser.mly \
   tsl_lexer.mli tsl_lexer.mll \
   tsl_semantics.mli tsl_semantics.ml \
+  builtin_variables.mli builtin_variables.ml \
+  actions_helpers.mli actions_helpers.ml \
+  builtin_actions.mli builtin_actions.ml
+
+ocaml_plugin := \
+  ocaml_backends.mli ocaml_backends.ml \
+  ocaml_variables.mli ocaml_variables.ml \
+  ocaml_modifiers.mli ocaml_modifiers.ml \
+  ocaml_actions.mli ocaml_actions.ml \
+  ocaml_tests.mli ocaml_tests.ml
+
+sources := $(core) $(ocaml_plugin) \
   options.mli options.ml \
   main.mli main.ml
 

ocamltest/actions.ml

@@ -29,39 +29,54 @@ let string_of_result = function
   | Fail reason -> string_of_reason "Fail" reason
   | Skip reason -> string_of_reason "Skip" reason
 
-type body = out_channel -> Environments.t -> result
+type code = out_channel -> Environments.t -> result
 
 type t = {
-  action_name : string;
-  action_environment : Environments.t -> Environments.t;
-  action_body : body
+  name : string;
+  body : code;
+  mutable hook : code option
 }
 
-let compare a1 a2 = String.compare a1.action_name a2.action_name
+let action_name a = a.name
+
+let make n c = { name = n; body = c; hook = None }
+
+let compare a1 a2 = String.compare a1.name a2.name
 
 let (actions : (string, t) Hashtbl.t) = Hashtbl.create 10
 
 let register action =
-  Hashtbl.add actions action.action_name action
+  Hashtbl.add actions action.name action
 
 let get_registered_actions () =
-  let f _action_name action acc = action::acc in
+  let f _name action acc = action::acc in
   let unsorted_actions = Hashtbl.fold f actions [] in
   List.sort compare unsorted_actions
 
 let lookup name =
   try Some (Hashtbl.find actions name)
   with Not_found -> None
 
+let set_hook name hook =
+  let action = (Hashtbl.find actions name) in
+  action.hook <- Some hook
+
+let clear_hook name =
+  let action = (Hashtbl.find actions name) in
+  action.hook <- None
+
+let clear_all_hooks () =
+  let f _name action = action.hook <- None in
+  Hashtbl.iter f actions
+
 let run log env action =
-  action.action_body log env
+  let code = match action.hook with
+    | None -> action.body
+    | Some code -> code in
+  code log env
 
 module ActionSet = Set.Make
 (struct
   type nonrec t = t
   let compare = compare
 end)
-
-let update_environment initial_env actions =
-  let f act env = act.action_environment env in
-  ActionSet.fold f actions initial_env

ocamltest/actions.mli

@@ -22,13 +22,13 @@ type result =
 
 val string_of_result : result -> string
 
-type body = out_channel -> Environments.t -> result
+type code = out_channel -> Environments.t -> result
 
-type t = {
-  action_name : string;
-  action_environment : Environments.t -> Environments.t;
-  action_body : body
-}
+type t
+
+val action_name : t -> string
+
+val make : string -> code -> t
 
 val compare : t -> t -> int
 
@@ -38,8 +38,10 @@ val get_registered_actions : unit -> t list
 
 val lookup : string -> t option
 
+val set_hook : string -> code -> unit
+val clear_hook : string -> unit
+val clear_all_hooks : unit -> unit
+
 val run : out_channel -> Environments.t -> t -> result
 
 module ActionSet : Set.S with type elt = t
-
-val update_environment : Environments.t -> ActionSet.t -> Environments.t