WIP

Author: craigfe

src/alcotest-async/alcotest_async_intf.ml

@@ -26,10 +26,11 @@ module type Alcotest_async = sig
     open Alcotest_engine.Unstable
 
     include
-      Cli.S
+      Core.S
         with type 'a m := 'a Async_kernel.Deferred.t
          and type 'a test_args := 'a
          and type config := Config.User.t
+         and type source_code_position := Source_code_position.here
          and type tag_set := Tag.Set.t
 
     val test :

src/alcotest-async/dune

@@ -2,9 +2,9 @@
  (name alcotest_async)
  (public_name alcotest-async)
  (libraries
-  alcotest
   alcotest.engine
   alcotest.stdlib_ext
+  alcotest
   async_kernel
   async_unix
   base

src/alcotest-engine/cli.ml

@@ -171,6 +171,5 @@ module V1 = struct
 end
 
 module Unstable = struct
-  include Unstable_types
   module Make = Make
 end

src/alcotest-engine/cli_intf.ml

@@ -58,15 +58,6 @@ module V1_types = struct
     S with type return = unit M.t
 end
 
-module Unstable_types = struct
-  module type S = sig
-    include Core.Unstable.S
-    (** @inline *)
-  end
-
-  module type MAKER = Core.Unstable.MAKER
-end
-
 module type Cli = sig
   module V1 : sig
     module type S = V1_types.S
@@ -76,9 +67,6 @@ module type Cli = sig
   end
 
   module Unstable : sig
-    module type S = Unstable_types.S
-    module type MAKER = Unstable_types.MAKER
-
-    module Make : MAKER
+    module Make : Core.Unstable.MAKER
   end
 end

src/alcotest-engine/core.ml

@@ -107,7 +107,6 @@ module Make (P : Platform.MAKER) (M : Monad.S) = struct
     { suite; errors = []; loc; config; run_id; log_trap; progress_reporter }
 
   type 'a test = 'a Suite.test
-  type 'a extra_info = ?here:Source_code_position.here -> ?tags:Tag.Set.t -> 'a
 
   let bt () = match Printexc.get_backtrace () with "" -> "" | s -> "\n" ^ s
 

src/alcotest-engine/core_intf.ml

@@ -106,37 +106,50 @@ module Types = struct
 end
 
 module Unstable_types = struct
-  module type S = sig
+  module type Test_constructors = sig
     (* These types are intended to be destructively-substituted by various
        backends. *)
 
     type 'a m
     type 'a test_args
     type tag_set
-    type config
+    type source_code_position
 
     type 'a test
     (** The type of unit tests. *)
 
-    type 'a extra_info = ?here:Source_code_position.here -> ?tags:tag_set -> 'a
-    (** Tests and test groups can be located by attaching source code positions
-        to them. *)
-
-    val test : (name:string -> ('a -> unit m) test_args -> 'a test) extra_info
+    val test :
+      ?here:source_code_position ->
+      ?tags:tag_set ->
+      name:string ->
+      ('a -> unit m) test_args ->
+      'a test
     (** [test ~name f] is a suite containing a single named test that runs [f].*)
 
-    val group : (name:string -> 'a test list -> 'a test) extra_info
+    val group :
+      ?here:source_code_position ->
+      ?tags:tag_set ->
+      name:string ->
+      'a test list ->
+      'a test
     (** [test_group ~name ts] *)
+  end
+
+  module type Test_runners = sig
+    type 'a m
+    type 'a test
+    type config
+    type source_code_position
 
     val run :
-      ?here:Source_code_position.here ->
+      ?here:source_code_position ->
       ?config:config ->
       name:string ->
       unit test list ->
       unit m
 
     val run_with_args :
-      ?here:Source_code_position.here ->
+      ?here:source_code_position ->
       ?config:config ->
       name:string ->
       'a ->
@@ -145,22 +158,29 @@ module Unstable_types = struct
   end
 
   (** Extensions to {!S} for use by backends. *)
-  module type EXT = sig
-    include S
+  module type S = sig
+    include Test_constructors
+
+    include
+      Test_runners
+        with type 'a m := 'a m
+         and type 'a test := 'a test
+         and type source_code_position := source_code_position
 
     val list_tests :
-      ?here:Source_code_position.here ->
+      ?here:source_code_position ->
       ?config:config ->
       name:string ->
       _ test list ->
       unit m
   end
 
   module type MAKER = functor (P : Platform.MAKER) (M : Monad.S) ->
-    EXT
+    S
       with type 'a m := 'a M.t
        and type 'a test_args := 'a
        and type config := Config.User.t
+       and type source_code_position := Source_code_position.here
        and type tag_set := Tag.Set.t
 end
 
@@ -181,9 +201,7 @@ module type Core = sig
   module Unstable : sig
     type nonrec 'a identified = 'a identified
 
-    module type S = Unstable_types.S
-    module type MAKER = Unstable_types.MAKER
-
+    include module type of Unstable_types
     module Make : MAKER
   end
 end

src/alcotest-lwt/alcotest_lwt_intf.ml

@@ -24,10 +24,11 @@ module type Alcotest_lwt = sig
     open Alcotest_engine.Unstable
 
     include
-      Cli.S
+      Core.S
         with type 'a m := 'a Lwt.t
          and type 'a test_args := Lwt_switch.t -> 'a
          and type config := Config.User.t
+         and type source_code_position := Source_code_position.here
          and type tag_set := Tag.Set.t
 
     val test_sync : (('a -> unit) -> 'a test) Core.identified

src/alcotest-mirage/alcotest_mirage.mli

@@ -36,10 +36,11 @@ module Unstable : sig
 
   module Make (C : Mirage_clock.MCLOCK) : sig
     include
-      Cli.S
+      Core.S
         with type 'a m := 'a Lwt.t
          and type 'a test_args := Lwt_switch.t -> 'a
          and type config := Config.User.t
+         and type source_code_position := Source_code_position.here
          and type tag_set := Tag.Set.t
 
     val test_sync :

src/alcotest/alcotest.mli

@@ -40,6 +40,7 @@ include Alcotest_engine.V1.Cli.S with type return := unit
     functions below. *)
 
 include module type of Alcotest_engine.V1.Test
+(** @inline *)
 
 (** {1 Versioned APIs} *)
 
@@ -54,6 +55,7 @@ end
 
 module Unstable : sig
   open Alcotest_engine.Unstable
+  (** The latest, cutting-edge API of Alcotest. Still under active development. *)
 
   module Source_code_position : sig
     type here = Lexing.position
@@ -67,6 +69,7 @@ module Unstable : sig
         documentation of [__POS__] for more information. *)
   end
 
+  (** A {i tag} is an attribute that is attached to a test. *)
   module Tag : sig
     include module type of Tag with type t = Tag.t
     (** @inline *)
@@ -113,10 +116,11 @@ module Unstable : sig
 
   (** @inline *)
   include
-    Cli.S
+    Core.S
       with type 'a m := 'a
        and type 'a test_args := 'a
        and type tag_set := Tag.Set.t
+       and type source_code_position := Source_code_position.here
        and type config := Config.t
 end