Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Shrink.bool #299

Merged
merged 7 commits into from
Dec 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## NEXT RELEASE

- Add `Shrink.bool` and use it in `QCheck.bool`
- Remove unread `fun_gen` field from `QCheck2`'s `fun_repr_tbl` type
thereby silencing a compiler warning

Expand Down
8 changes: 4 additions & 4 deletions example/QCheck_runner_test.expected.ocaml4.32
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ exception Dune__exe__QCheck_runner_test.Error

--- Failure --------------------------------------------------------------------

Test FAIL_pred_map_commute failed (47 shrink steps):
Test FAIL_pred_map_commute failed (48 shrink steps):

([1], {_ -> 0}, {0 -> false; _ -> true})
([1], {_ -> 0}, {1 -> true; _ -> false})

--- Failure --------------------------------------------------------------------

Test FAIL_fun2_pred_strings failed (1 shrink steps):
Test FAIL_fun2_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions example/QCheck_runner_test.expected.ocaml4.64
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ Test FAIL_pred_map_commute failed (77 shrink steps):

--- Failure --------------------------------------------------------------------

Test FAIL_fun2_pred_strings failed (1 shrink steps):
Test FAIL_fun2_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions example/QCheck_runner_test.expected.ocaml5.32
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ Test FAIL_pred_map_commute failed (47 shrink steps):

--- Failure --------------------------------------------------------------------

Test FAIL_fun2_pred_strings failed (1 shrink steps):
Test FAIL_fun2_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions example/QCheck_runner_test.expected.ocaml5.64
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ exception Dune__exe__QCheck_runner_test.Error

--- Failure --------------------------------------------------------------------

Test FAIL_pred_map_commute failed (79 shrink steps):
Test FAIL_pred_map_commute failed (89 shrink steps):

([11], {_ -> 0}, {11 -> false; _ -> true})
([1], {_ -> 0}, {0 -> true; _ -> false})

--- Failure --------------------------------------------------------------------

Test FAIL_fun2_pred_strings failed (1 shrink steps):
Test FAIL_fun2_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
9 changes: 6 additions & 3 deletions src/core/QCheck.ml
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,9 @@ module Shrink = struct

let unit = nil

let bool b =
if b then Iter.return false else Iter.empty

(* balanced shrinker for integers (non-exhaustive) *)
let int x yield =
let y = ref x in
Expand Down Expand Up @@ -1085,9 +1088,9 @@ let choose l = match l with
arb.gen st)

let unit : unit arbitrary =
make ~small:small1 ~shrink:Shrink.nil ~print:(fun _ -> "()") Gen.unit

let bool = make_scalar ~print:string_of_bool Gen.bool
make ~small:small1 ~shrink:Shrink.nil ~print:Print.unit Gen.unit
let bool =
make ~small:small1 ~shrink:Shrink.bool ~print:Print.bool Gen.bool
let float = make_scalar ~print:string_of_float Gen.float
let pos_float = make_scalar ~print:string_of_float Gen.pfloat
let neg_float = make_scalar ~print:string_of_float Gen.nfloat
Expand Down
6 changes: 5 additions & 1 deletion src/core/QCheck.mli
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,11 @@ module Shrink : sig
val nil : 'a t
(** No shrink *)

val unit : unit t (** @since 0.6 *)
val unit : unit t
(** @since 0.6 *)

val bool : bool t
(** @since NEXT_RELEASE *)

val char : char t
(** Shrinks towards ['a'].
Expand Down
8 changes: 4 additions & 4 deletions test/core/QCheck_expect_test.expected.ocaml4.32
Original file line number Diff line number Diff line change
Expand Up @@ -503,15 +503,15 @@ Test sum list = 0 failed (0 shrink steps):

--- Failure --------------------------------------------------------------------

Test fail_pred_map_commute failed (47 shrink steps):
Test fail_pred_map_commute failed (48 shrink steps):

([1], {_ -> 0}, {0 -> false; _ -> true})
([1], {_ -> 0}, {1 -> true; _ -> false})

--- Failure --------------------------------------------------------------------

Test fail_pred_strings failed (1 shrink steps):
Test fail_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions test/core/QCheck_expect_test.expected.ocaml4.64
Original file line number Diff line number Diff line change
Expand Up @@ -541,9 +541,9 @@ Test fail_pred_map_commute failed (77 shrink steps):

--- Failure --------------------------------------------------------------------

Test fail_pred_strings failed (1 shrink steps):
Test fail_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions test/core/QCheck_expect_test.expected.ocaml5.32
Original file line number Diff line number Diff line change
Expand Up @@ -519,9 +519,9 @@ Test fail_pred_map_commute failed (47 shrink steps):

--- Failure --------------------------------------------------------------------

Test fail_pred_strings failed (1 shrink steps):
Test fail_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions test/core/QCheck_expect_test.expected.ocaml5.64
Original file line number Diff line number Diff line change
Expand Up @@ -545,15 +545,15 @@ Test sum list = 0 failed (0 shrink steps):

--- Failure --------------------------------------------------------------------

Test fail_pred_map_commute failed (79 shrink steps):
Test fail_pred_map_commute failed (89 shrink steps):

([11], {_ -> 0}, {11 -> false; _ -> true})
([1], {_ -> 0}, {0 -> true; _ -> false})

--- Failure --------------------------------------------------------------------

Test fail_pred_strings failed (1 shrink steps):
Test fail_pred_strings failed (2 shrink steps):

{some other string -> false; _ -> true}
{some random string -> true; _ -> false}

--- Failure --------------------------------------------------------------------

Expand Down
9 changes: 9 additions & 0 deletions test/core/QCheck_unit_tests.ml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ module Shrink = struct
let alco_check typ func msg_suffix (msg,input,expected) =
Alcotest.(check (list typ)) (msg ^ " - " ^ msg_suffix) expected (func input)

let test_bool () =
List.iter (alco_check Alcotest.bool (trace_false Shrink.bool) "on repeated failure")
[ ("bool true", true, [false]);
("bool false", false, []) ];
List.iter (alco_check Alcotest.bool (trace_true Shrink.bool) "on repeated success")
[ ("bool true", true, [false]);
("bool false", false, []) ]

let test_int () =
List.iter (alco_check Alcotest.int (trace_false Shrink.int) "on repeated failure")
[ ("int 100", 100, [50; 75; 88; 94; 97; 99]);
Expand Down Expand Up @@ -154,6 +162,7 @@ module Shrink = struct
Alcotest.(check unit) "doesn't compare elements" () @@ run_test ()

let tests = ("Shrink", Alcotest.[
test_case "bool" `Quick test_bool;
test_case "int" `Quick test_int;
test_case "int32" `Quick test_int32;
test_case "int64" `Quick test_int64;
Expand Down
Loading