package omtl

README.md

Omtl

An OCaml minimalist testing framework with zero dependencies.

Usage

./test/test_omtl.ml

(* A module with functions to test *)
module Suit = struct
  let pass () = ()

  let failed () = "Failed !!!"
end

(* The tests *)
let test_pass () = Suit.pass () |> ok

let test_failed () = Suit.failed () |> err

let test_failure () = failwith "Take it easy, this is just an example of a failed test"

let test_exception () = raise Not_found

let test_function_running_time () =
  for _ = 0 to 100000 do
    ()
  done;
  Ok ()


(* Run it *)
let _ =
  "My_String"
  +:> [
        "pass" >== test_pass;
        "failed" >== test_failed;
        "Examples of test failures" >== test_failure;
        "Examples of undefined exception" >== test_exception;
        "Test function running time" >== test_function_running_time;
      ]
  |> run ~force:true ~backtrace:true ~callstack:true

License

Copyright (c) 2023 Muqiu Han

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of omtl nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.