<html><head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="OUnit" rel="Chapter" href="OUnit.html"> <link title="OUnit2" rel="Chapter" href="OUnit2.html"> <link title="OUnitThreads" rel="Chapter" href="OUnitThreads.html"> <link title="OUnitUtils" rel="Chapter" href="OUnitUtils.html"> <link title="OUnitPropList" rel="Chapter" href="OUnitPropList.html"> <link title="OUnitPlugin" rel="Chapter" href="OUnitPlugin.html"> <link title="OUnitChooser" rel="Chapter" href="OUnitChooser.html"> <link title="OUnitResultSummary" rel="Chapter" href="OUnitResultSummary.html"> <link title="OUnitLoggerStd" rel="Chapter" href="OUnitLoggerStd.html"> <link title="OUnitLoggerHTML" rel="Chapter" href="OUnitLoggerHTML.html"> <link title="OUnitLoggerHTMLData" rel="Chapter" href="OUnitLoggerHTMLData.html"> <link title="OUnitLoggerJUnit" rel="Chapter" href="OUnitLoggerJUnit.html"> <link title="OUnitAssert" rel="Chapter" href="OUnitAssert.html"> <link title="OUnitBracket" rel="Chapter" href="OUnitBracket.html"> <link title="OUnitTest" rel="Chapter" href="OUnitTest.html"> <link title="OUnitState" rel="Chapter" href="OUnitState.html"> <link title="OUnitRunner" rel="Chapter" href="OUnitRunner.html"> <link title="OUnitRunnerProcesses" rel="Chapter" href="OUnitRunnerProcesses.html"> <link title="OUnitCore" rel="Chapter" href="OUnitCore.html"> <link title="OUnitLogger" rel="Chapter" href="OUnitLogger.html"> <link title="OUnitConf" rel="Chapter" href="OUnitConf.html"> <link title="OUnitShared" rel="Chapter" href="OUnitShared.html"> <link title="OUnitCache" rel="Chapter" href="OUnitCache.html"> <link title="OUnitTestData" rel="Chapter" href="OUnitTestData.html"> <link title="OUnitCheckEnv" rel="Chapter" href="OUnitCheckEnv.html"> <link title="OUnitDiff" rel="Chapter" href="OUnitDiff.html"><title>OUnit user guide : OUnit2</title> </head> <body> <code class="code"><span class="keyword">sig</span><br> <span class="keyword">type</span> test_ctxt = <span class="constructor">OUnitTest</span>.ctxt<br> <span class="keyword">type</span> test_fun = <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> unit<br> <span class="keyword">type</span> test = <span class="constructor">OUnitTest</span>.test<br> <span class="keyword">type</span> test_length = <span class="constructor">OUnitTest</span>.test_length<br> <span class="keyword">val</span> assert_failure : string <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br> <span class="keyword">val</span> assert_bool : string <span class="keywordsign">-></span> bool <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> assert_string : string <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> assert_command :<br> ?exit_code:<span class="constructor">Unix</span>.process_status <span class="keywordsign">-></span><br> ?sinput:char <span class="constructor">Stream</span>.t <span class="keywordsign">-></span><br> ?foutput:(char <span class="constructor">Stream</span>.t <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br> ?use_stderr:bool <span class="keywordsign">-></span><br> ?backtrace:bool <span class="keywordsign">-></span><br> ?chdir:string <span class="keywordsign">-></span><br> ?env:string array <span class="keywordsign">-></span><br> ctxt:<span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string <span class="keywordsign">-></span> string list <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> assert_equal :<br> ?ctxt:<span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span><br> ?cmp:(<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span><br> ?printer:(<span class="keywordsign">'</span>a <span class="keywordsign">-></span> string) <span class="keywordsign">-></span><br> ?pp_diff:(<span class="constructor">Format</span>.formatter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a * <span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br> ?msg:string <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> assert_raises : ?msg:string <span class="keywordsign">-></span> exn <span class="keywordsign">-></span> (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a) <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> skip_if : bool <span class="keywordsign">-></span> string <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> todo : string <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> cmp_float : ?epsilon:float <span class="keywordsign">-></span> float <span class="keywordsign">-></span> float <span class="keywordsign">-></span> bool<br> <span class="keyword">val</span> bracket :<br> (<span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> <span class="keywordsign">'</span>a) <span class="keywordsign">-></span><br> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br> <span class="keyword">val</span> bracket_tmpfile :<br> ?prefix:string <span class="keywordsign">-></span><br> ?suffix:string <span class="keywordsign">-></span><br> ?mode:<span class="constructor">Pervasives</span>.open_flag list <span class="keywordsign">-></span><br> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string * <span class="constructor">Pervasives</span>.out_channel<br> <span class="keyword">val</span> bracket_tmpdir :<br> ?prefix:string <span class="keywordsign">-></span> ?suffix:string <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> with_bracket_chdir :<br> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string <span class="keywordsign">-></span> (<span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> <span class="keywordsign">'</span>a) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br> <span class="keyword">val</span> ( >: ) : string <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test<br> <span class="keyword">val</span> ( >:: ) : string <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_fun <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test<br> <span class="keyword">val</span> ( >::: ) : string <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test list <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test<br> <span class="keyword">val</span> test_case :<br> ?length:<span class="constructor">OUnit2</span>.test_length <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_fun <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test<br> <span class="keyword">val</span> test_list : <span class="constructor">OUnit2</span>.test list <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test<br> <span class="keyword">type</span> log_severity = [ <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Info</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Warning</span> ]<br> <span class="keyword">val</span> logf :<br> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span><br> <span class="constructor">OUnit2</span>.log_severity <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a, unit, string, unit) <span class="constructor">Pervasives</span>.format4 <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br> <span class="keyword">val</span> in_testdata_dir : <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string list <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> non_fatal : <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> (<span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br> <span class="keyword">module</span> <span class="constructor">Conf</span> :<br> <span class="keyword">sig</span><br> <span class="keyword">type</span> <span class="keywordsign">'</span>a conf_t = string <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="constructor">Arg</span>.doc <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br> <span class="keyword">val</span> make_string : string <span class="constructor">OUnit2</span>.<span class="constructor">Conf</span>.conf_t<br> <span class="keyword">val</span> make_string_opt : string option <span class="constructor">OUnit2</span>.<span class="constructor">Conf</span>.conf_t<br> <span class="keyword">val</span> make_int : int <span class="constructor">OUnit2</span>.<span class="constructor">Conf</span>.conf_t<br> <span class="keyword">val</span> make_float : float <span class="constructor">OUnit2</span>.<span class="constructor">Conf</span>.conf_t<br> <span class="keyword">val</span> make_bool : bool <span class="constructor">OUnit2</span>.<span class="constructor">Conf</span>.conf_t<br> <span class="keyword">val</span> make_exec : string <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test_ctxt <span class="keywordsign">-></span> string<br> <span class="keyword">end</span><br> <span class="keyword">val</span> run_test_tt_main : ?exit:(int <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> <span class="constructor">OUnit2</span>.test <span class="keywordsign">-></span> unit<br> <span class="keyword">end</span></code></body></html>