diff --git a/CHANGELOG.md b/CHANGELOG.md index a37edbb2..6ba574a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changes +## 0.9 + +- add `qcheck-ounit` sublibrary +- use environment variables to configure `qcheck-alcotest` tests +- alcotest backend for qcheck +- make `qcheck.ounit` tests verbose by default +- make `qcheck` is a compatibility library, depends on `qcheck-core` +- split lib into `qcheck` and `qcheck.ounit` +- add `TestResult.is_success` helper +- give access to list of instances in test results +- allow setting `time_between_msg` in runner + +- chore: remove submodule +- chore: add travis support +- doc: explanations about qcheck.ounit runners +- doc: update readme + ## 0.8 - migrate to jbuilder diff --git a/Makefile b/Makefile index d8b04249..bc52cfe1 100644 --- a/Makefile +++ b/Makefile @@ -29,8 +29,8 @@ VERSION=$(shell awk '/^version:/ {print $$2}' qcheck.opam) update_next_tag: @echo "update version to $(VERSION)..." - sed -i "s/NEXT_VERSION/$(VERSION)/g" src/*.ml src/*.mli - sed -i "s/NEXT_RELEASE/$(VERSION)/g" src/*.ml src/*.mli + sed -i "s/NEXT_VERSION/$(VERSION)/g" `find src -name '*.ml' -or -name '*.mli'` + sed -i "s/NEXT_RELEASE/$(VERSION)/g" `find src -name '*.ml' -or -name '*.mli'` release: update_next_tag @echo "release version $(VERSION)..." diff --git a/src/alcotest/QCheck_alcotest.mli b/src/alcotest/QCheck_alcotest.mli index c51747f9..2bcb6b1d 100644 --- a/src/alcotest/QCheck_alcotest.mli +++ b/src/alcotest/QCheck_alcotest.mli @@ -7,6 +7,8 @@ [QCHECK_VERBOSE] if "1" or "true", will make tests verbose [QCHECK_SEED] if an integer, will fix the seed [QCHECK_LONG] is present, will trigger long tests + + @since 0.9 *) val to_alcotest : @@ -14,4 +16,6 @@ val to_alcotest : QCheck.Test.t -> unit Alcotest.test_case (** Convert a qcheck test into an alcotest test @param verbose used to print information on stdout (default: [verbose()]) - @param rand the random generator to use (default: [random_state ()]) *) + @param rand the random generator to use (default: [random_state ()]) + @since 0.9 +*) diff --git a/src/core/QCheck.mli b/src/core/QCheck.mli index 5e7cb87a..b27d6d70 100644 --- a/src/core/QCheck.mli +++ b/src/core/QCheck.mli @@ -620,7 +620,7 @@ module TestResult : sig stats_tbl: ('a stat * (int, int) Hashtbl.t) list; (** @since 0.6 *) mutable instances: 'a list; (** List of instances used for this test, in no particular order. - @since NEXT_RELEASE *) + @since 0.9 *) } val collect : _ t -> (string,int) Hashtbl.t option @@ -633,7 +633,7 @@ module TestResult : sig val is_success : _ t -> bool (** Returns true iff the state if [Success] - @since NEXT_RELEASE *) + @since 0.9 *) end module Test : sig diff --git a/src/ounit/QCheck_ounit.mli b/src/ounit/QCheck_ounit.mli index e8481960..7822c15d 100644 --- a/src/ounit/QCheck_ounit.mli +++ b/src/ounit/QCheck_ounit.mli @@ -1,5 +1,8 @@ -(** {1 Conversion of tests to OUnit Tests} *) +(** {1 Conversion of tests to OUnit Tests} + + @since 0.9 +*) val to_ounit_test : ?verbose:bool -> ?long:bool -> ?rand:Random.State.t -> diff --git a/src/runner/QCheck_base_runner.mli b/src/runner/QCheck_base_runner.mli index 6c9ea160..cec04764 100644 --- a/src/runner/QCheck_base_runner.mli +++ b/src/runner/QCheck_base_runner.mli @@ -52,11 +52,11 @@ val set_long_tests : bool -> unit val get_time_between_msg : unit -> float (** Get the minimum time to wait between printing messages. - @since NEXT_RELEASE *) + @since 0.9 *) val set_time_between_msg : float -> unit (** Set the minimum tiem between messages. - @since NEXT_RELEASE *) + @since 0.9 *) (** {2 Run a Suite of Tests and Get Results} *)