src/Tools/quickcheck.ML
author bulwahn
Thu, 09 Sep 2010 17:23:03 +0200
changeset 39253 0c47d615a69b
parent 39252 8f176e575a49
child 39324 05452dd66b2b
permissions -rw-r--r--
removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30824
bc6b24882834 fixed header;
wenzelm
parents: 30473
diff changeset
     1
(*  Title:      Tools/quickcheck.ML
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     2
    Author:     Stefan Berghofer, Florian Haftmann, TU Muenchen
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     3
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     4
Generic counterexample search engine.
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     5
*)
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     6
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     7
signature QUICKCHECK =
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     8
sig
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
     9
  val setup: theory -> theory
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
    10
  (* configuration *)
32740
9dd0a2f83429 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32297
diff changeset
    11
  val auto: bool Unsynchronized.ref
34948
2d5f2a9f7601 refactoring the predicate compiler; adding theories for Sequences; adding retrieval to Spec_Rules; adding timing to Quickcheck
bulwahn
parents: 34128
diff changeset
    12
  val timing : bool Unsynchronized.ref
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    13
  datatype report = Report of
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    14
    { iterations : int, raised_match_errors : int,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    15
      satisfied_assms : int list, positive_concl_tests : int }
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    16
  datatype expectation = No_Expectation | No_Counterexample | Counterexample;
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
    17
  datatype test_params = Test_Params of
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    18
  { size: int, iterations: int, default_type: typ list, no_assms: bool,
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    19
    expect : expectation, report: bool, quiet : bool};
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
    20
  val test_params_of: Proof.context -> test_params 
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
    21
  val report : Proof.context -> bool
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
    22
  val set_reporting : bool -> Proof.context -> Proof.context
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
    23
  val add_generator:
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
    24
    string * (Proof.context -> term -> int -> term list option * (bool list * bool))
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
    25
      -> Context.generic -> Context.generic
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
    26
  (* testing terms and proof states *)
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
    27
  val gen_test_term: Proof.context -> bool -> string option -> int -> int -> term ->
35380
6ac5b81a763d adopting Mutabelle to quickcheck reporting; improving quickcheck reporting
bulwahn
parents: 35379
diff changeset
    28
    (string * term) list option * ((string * int) list * ((int * report list) list) option)
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    29
  val test_term: Proof.context -> bool -> string option -> int -> int -> term ->
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    30
    (string * term) list option
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
    31
  val quickcheck: (string * string list) list -> int -> Proof.state -> (string * term) list option
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    32
end;
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    33
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    34
structure Quickcheck : QUICKCHECK =
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    35
struct
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    36
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    37
(* preferences *)
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    38
32740
9dd0a2f83429 explicit indication of Unsynchronized.ref;
wenzelm
parents: 32297
diff changeset
    39
val auto = Unsynchronized.ref false;
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    40
34948
2d5f2a9f7601 refactoring the predicate compiler; adding theories for Sequences; adding retrieval to Spec_Rules; adding timing to Quickcheck
bulwahn
parents: 34128
diff changeset
    41
val timing = Unsynchronized.ref false;
2d5f2a9f7601 refactoring the predicate compiler; adding theories for Sequences; adding retrieval to Spec_Rules; adding timing to Quickcheck
bulwahn
parents: 34128
diff changeset
    42
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    43
val _ =
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    44
  ProofGeneralPgip.add_preference Preferences.category_tracing
39138
53886463f559 use setmp_noncritical for sequential Pure bootstrap;
wenzelm
parents: 38759
diff changeset
    45
  (setmp_noncritical auto true (fn () =>
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    46
    Preferences.bool_pref auto
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    47
      "auto-quickcheck"
33561
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
    48
      "Whether to run Quickcheck automatically.") ());
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    49
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    50
(* quickcheck report *)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    51
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    52
datatype single_report = Run of bool list * bool | MatchExc
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    53
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    54
datatype report = Report of
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    55
  { iterations : int, raised_match_errors : int,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    56
    satisfied_assms : int list, positive_concl_tests : int }
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    57
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    58
fun collect_single_report single_report
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    59
    (Report {iterations = iterations, raised_match_errors = raised_match_errors,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    60
    satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}) =
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    61
  case single_report
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    62
  of MatchExc =>
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    63
    Report {iterations = iterations + 1, raised_match_errors = raised_match_errors + 1,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    64
      satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    65
   | Run (assms, concl) =>
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    66
    Report {iterations = iterations + 1, raised_match_errors = raised_match_errors,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    67
      satisfied_assms =
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    68
        map2 (fn b => fn s => if b then s + 1 else s) assms
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    69
         (if null satisfied_assms then replicate (length assms) 0 else satisfied_assms),
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
    70
      positive_concl_tests = if concl then positive_concl_tests + 1 else positive_concl_tests}
30973
304ab57afa6e observe distinction between Pure/Tools and Tools more closely
haftmann
parents: 30824
diff changeset
    71
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    72
(* expectation *)
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    73
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    74
datatype expectation = No_Expectation | No_Counterexample | Counterexample; 
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    75
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    76
fun merge_expectation (expect1, expect2) =
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    77
  if expect1 = expect2 then expect1 else No_Expectation
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    78
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
    79
(* quickcheck configuration -- default parameters, test generators *)
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
    80
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
    81
datatype test_params = Test_Params of
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    82
  { size: int, iterations: int, default_type: typ list, no_assms: bool,
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    83
    expect : expectation, report: bool, quiet : bool};
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
    84
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    85
fun dest_test_params (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    86
  ((size, iterations), ((default_type, no_assms), ((expect, report), quiet)));
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    87
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    88
fun make_test_params ((size, iterations), ((default_type, no_assms), ((expect, report), quiet))) =
34128
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
    89
  Test_Params { size = size, iterations = iterations, default_type = default_type,
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    90
    no_assms = no_assms, expect = expect, report = report, quiet = quiet };
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    91
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    92
fun map_test_params f (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
    93
  make_test_params (f ((size, iterations), ((default_type, no_assms), ((expect, report), quiet))));
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    94
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    95
fun merge_test_params
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    96
 (Test_Params { size = size1, iterations = iterations1, default_type = default_type1,
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    97
    no_assms = no_assms1, expect = expect1, report = report1, quiet = quiet1 },
34128
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
    98
  Test_Params { size = size2, iterations = iterations2, default_type = default_type2,
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
    99
    no_assms = no_assms2, expect = expect2, report = report2, quiet = quiet2 }) =
31599
97b4d289c646 tuned make/map/merge combinators
haftmann
parents: 31153
diff changeset
   100
  make_test_params ((Int.max (size1, size2), Int.max (iterations1, iterations2)),
37911
8f99e3880864 correcting merging of default_types
bulwahn
parents: 37910
diff changeset
   101
    ((merge (op =) (default_type1, default_type2), no_assms1 orelse no_assms2),
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   102
    ((merge_expectation (expect1, expect2), report1 orelse report2), quiet1 orelse quiet2)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   103
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   104
structure Data = Generic_Data
33522
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   105
(
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   106
  type T =
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   107
    (string * (Proof.context -> term -> int -> term list option * (bool list * bool))) list
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   108
      * test_params;
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   109
  val empty = ([], Test_Params
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   110
    { size = 10, iterations = 100, default_type = [], no_assms = false,
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   111
      expect = No_Expectation, report = false, quiet = false});
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
   112
  val extend = I;
33522
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   113
  fun merge ((generators1, params1), (generators2, params2)) : T =
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   114
    (AList.merge (op =) (K true) (generators1, generators2),
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   115
      merge_test_params (params1, params2));
33522
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   116
);
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
   117
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   118
val test_params_of = snd o Data.get o Context.Proof;
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
   119
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   120
val report = snd o fst o snd o snd o dest_test_params o test_params_of
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   121
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   122
fun map_report f (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   123
  make_test_params ((size, iterations), ((default_type, no_assms), ((expect, f report), quiet)));
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   124
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   125
fun set_reporting report = Context.proof_map (Data.map (apsnd (map_report (K report))))
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   126
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   127
val add_generator = Data.map o apfst o AList.update (op =);
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   128
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   129
(* generating tests *)
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   130
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   131
fun mk_tester_select name ctxt =
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   132
  case AList.lookup (op =) ((fst o Data.get o Context.Proof) ctxt) name
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   133
   of NONE => error ("No such quickcheck generator: " ^ name)
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   134
    | SOME generator => generator ctxt;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   135
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   136
fun mk_testers ctxt t =
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   137
  (map snd o fst o Data.get o Context.Proof) ctxt
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   138
  |> map_filter (fn generator => try (generator ctxt) t);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   139
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   140
fun mk_testers_strict ctxt t =
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   141
  let
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   142
    val generators = ((map snd o fst o Data.get  o Context.Proof) ctxt)
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   143
    val testers = map (fn generator => Exn.capture (generator ctxt) t) generators;
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   144
  in if forall (is_none o Exn.get_result) testers
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   145
    then [(Exn.release o snd o split_last) testers]
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   146
    else map_filter Exn.get_result testers
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   147
  end;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   148
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   149
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   150
(* testing propositions *)
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   151
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   152
fun prep_test_term t =
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   153
  let
29266
4a478f9d2847 use regular Term.add_vars, Term.add_frees etc.;
wenzelm
parents: 28952
diff changeset
   154
    val _ = (null (Term.add_tvars t []) andalso null (Term.add_tfrees t [])) orelse
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   155
      error "Term to be tested contains type variables";
29266
4a478f9d2847 use regular Term.add_vars, Term.add_frees etc.;
wenzelm
parents: 28952
diff changeset
   156
    val _ = null (Term.add_vars t []) orelse
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   157
      error "Term to be tested contains schematic variables";
31138
a51ce445d498 dropped legacy operations
haftmann
parents: 30980
diff changeset
   158
    val frees = Term.add_frees t [];
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   159
  in (map fst frees, list_abs_free (frees, t)) end
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
   160
35324
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   161
fun cpu_time description f =
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   162
  let
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   163
    val start = start_timing ()
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   164
    val result = Exn.capture f ()
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   165
    val time = Time.toMilliseconds (#cpu (end_timing start))
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   166
  in (Exn.release result, (description, time)) end
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   167
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   168
fun gen_test_term ctxt quiet generator_name size i t =
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   169
  let
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   170
    val (names, t') = prep_test_term t;
35324
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   171
    val (testers, comp_time) = cpu_time "quickcheck compilation"
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   172
      (fn () => (case generator_name
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   173
       of NONE => if quiet then mk_testers ctxt t' else mk_testers_strict ctxt t'
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   174
        | SOME name => [mk_tester_select name ctxt t']));
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   175
    fun iterate f 0 report = (NONE, report)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   176
      | iterate f j report =
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   177
        let
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   178
          val (test_result, single_report) = apsnd Run (f ()) handle Match => (if quiet then ()
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   179
             else warning "Exception Match raised during quickcheck"; (NONE, MatchExc))
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   180
          val report = collect_single_report single_report report
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   181
        in
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   182
          case test_result of NONE => iterate f (j - 1) report | SOME q => (SOME q, report)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   183
        end
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   184
    val empty_report = Report { iterations = 0, raised_match_errors = 0,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   185
      satisfied_assms = [], positive_concl_tests = 0 }
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   186
    fun with_testers k [] = (NONE, [])
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   187
      | with_testers k (tester :: testers) =
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   188
          case iterate (fn () => tester (k - 1)) i empty_report
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   189
           of (NONE, report) => apsnd (cons report) (with_testers k testers)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   190
            | (SOME q, report) => (SOME q, [report]);
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   191
    fun with_size k reports = if k > size then (NONE, reports)
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   192
      else (if quiet then () else priority ("Test data size: " ^ string_of_int k);
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   193
        let
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   194
          val (result, new_report) = with_testers k testers
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   195
          val reports = ((k, new_report) :: reports)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   196
        in case result of NONE => with_size (k + 1) reports | SOME q => (SOME q, reports) end);
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   197
    val ((result, reports), exec_time) = cpu_time "quickcheck execution"
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   198
      (fn () => apfst
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   199
         (fn result => case result of NONE => NONE
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   200
        | SOME ts => SOME (names ~~ ts)) (with_size 1 []))
34948
2d5f2a9f7601 refactoring the predicate compiler; adding theories for Sequences; adding retrieval to Spec_Rules; adding timing to Quickcheck
bulwahn
parents: 34128
diff changeset
   201
  in
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   202
    (result, ([exec_time, comp_time], if report ctxt then SOME reports else NONE))
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   203
  end;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   204
35324
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   205
fun test_term ctxt quiet generator_name size i t =
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   206
  ctxt
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   207
  |> set_reporting false
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   208
  |> (fn ctxt' => fst (gen_test_term ctxt' quiet generator_name size i t))
35324
c9f428269b38 adopting mutabelle and quickcheck to return timing information; exporting make_case_combs in datatype package for predicate compiler; adding Spec_Rules declaration for tail recursive functions; improving the predicate compiler and function flattening
bulwahn
parents: 35077
diff changeset
   209
37913
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   210
exception WELLSORTED of string
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   211
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   212
fun monomorphic_term thy insts default_T = 
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   213
  let
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   214
    fun subst (T as TFree (v, S)) =
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   215
          let
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   216
            val T' = AList.lookup (op =) insts v
37912
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   217
              |> the_default default_T
37913
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   218
          in if Sign.of_sort thy (T', S) then T'
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   219
            else raise (WELLSORTED ("For instantiation with default_type " ^ Syntax.string_of_typ_global thy default_T ^
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   220
              ":\n" ^ Syntax.string_of_typ_global thy T' ^
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   221
              " to be substituted for variable " ^
37913
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   222
              Syntax.string_of_typ_global thy T ^ " does not have sort " ^
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   223
              Syntax.string_of_sort_global thy S))
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   224
          end
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   225
      | subst T = T;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   226
  in (map_types o map_atyps) subst end;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   227
37913
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   228
datatype wellsorted_error = Wellsorted_Error of string | Term of term
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   229
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   230
fun test_goal quiet generator_name size iterations default_Ts no_assms insts i state =
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   231
  let
37974
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   232
    val lthy = Proof.context_of state;
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   233
    val thy = Proof.theory_of state;
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   234
    fun strip (Const ("all", _) $ Abs (_, _, t)) = strip t
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   235
      | strip t = t;
33291
93f0238151f6 back to Proof.raw_goal;
wenzelm
parents: 32966
diff changeset
   236
    val {goal = st, ...} = Proof.raw_goal state;
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   237
    val (gi, frees) = Logic.goal_params (prop_of st) i;
38390
cb72d89bb444 named target is optional
haftmann
parents: 38350
diff changeset
   238
    val some_locale = case (Option.map #target o Named_Target.peek) lthy
cb72d89bb444 named target is optional
haftmann
parents: 38350
diff changeset
   239
     of NONE => NONE
cb72d89bb444 named target is optional
haftmann
parents: 38350
diff changeset
   240
      | SOME "" => NONE
cb72d89bb444 named target is optional
haftmann
parents: 38350
diff changeset
   241
      | SOME locale => SOME locale;
37974
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   242
    val assms = if no_assms then [] else case some_locale
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   243
     of NONE => Assumption.all_assms_of lthy
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   244
      | SOME locale => Assumption.local_assms_of lthy (Locale.init locale thy);
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   245
    val proto_goal = Logic.list_implies (map Thm.term_of assms, subst_bounds (frees, strip gi));
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   246
    val check_goals = case some_locale
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   247
     of NONE => [proto_goal]
38111
77f56abf158b More consistent naming of locale api functions.
ballarin
parents: 38107
diff changeset
   248
      | SOME locale => map (fn (_, phi) => Morphism.term phi proto_goal) (Locale.registrations_of (Context.Theory thy) (*FIXME*) locale);
37974
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   249
    val inst_goals = maps (fn check_goal => map (fn T =>
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   250
      Term ((Object_Logic.atomize_term thy o monomorphic_term thy insts T) check_goal)
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   251
        handle WELLSORTED s => Wellsorted_Error s) default_Ts) check_goals
37913
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   252
    val error_msg = cat_lines (map_filter (fn Term t => NONE | Wellsorted_Error s => SOME s) inst_goals)
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   253
    val correct_inst_goals =
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   254
      case map_filter (fn Term t => SOME t | Wellsorted_Error s => NONE) inst_goals of
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   255
        [] => error error_msg
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   256
      | xs => xs
e85f5ad02a8f correcting wellsortedness check and improving error message
bulwahn
parents: 37912
diff changeset
   257
    val _ = if quiet then () else warning error_msg
37912
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   258
    fun collect_results f reports [] = (NONE, rev reports)
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   259
      | collect_results f reports (t :: ts) =
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   260
        case f t of
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   261
          (SOME res, report) => (SOME res, rev (report :: reports))
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   262
        | (NONE, report) => collect_results f (report :: reports) ts
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   263
  in collect_results (gen_test_term lthy quiet generator_name size iterations) [] correct_inst_goals end;
37912
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   264
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   265
(* pretty printing *)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   266
35077
c1dac8ace020 make Quickcheck identify itself, so people don't submit bug reports to me thinking that it was Nitpick
blanchet
parents: 34948
diff changeset
   267
fun pretty_counterex ctxt NONE = Pretty.str "Quickcheck found no counterexample."
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   268
  | pretty_counterex ctxt (SOME cex) =
35077
c1dac8ace020 make Quickcheck identify itself, so people don't submit bug reports to me thinking that it was Nitpick
blanchet
parents: 34948
diff changeset
   269
      Pretty.chunks (Pretty.str "Quickcheck found a counterexample:\n" ::
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   270
        map (fn (s, t) =>
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   271
          Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) cex);
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   272
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   273
fun pretty_report (Report {iterations = iterations, raised_match_errors = raised_match_errors,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   274
    satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}) =
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   275
  let
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   276
    fun pretty_stat s i = Pretty.block ([Pretty.str (s ^ ": " ^ string_of_int i)])
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   277
  in
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   278
     ([pretty_stat "iterations" iterations,
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   279
     pretty_stat "match exceptions" raised_match_errors]
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   280
     @ map_index (fn (i, n) => pretty_stat ("satisfied " ^ string_of_int (i + 1) ^ ". assumption") n)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   281
       satisfied_assms
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   282
     @ [pretty_stat "positive conclusion tests" positive_concl_tests])
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   283
  end
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   284
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   285
fun pretty_reports' [report] = [Pretty.chunks (pretty_report report)]
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   286
  | pretty_reports' reports =
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   287
  map_index (fn (i, report) =>
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   288
    Pretty.chunks (Pretty.str (string_of_int (i + 1) ^ ". generator:\n") :: pretty_report report))
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   289
    reports
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   290
35380
6ac5b81a763d adopting Mutabelle to quickcheck reporting; improving quickcheck reporting
bulwahn
parents: 35379
diff changeset
   291
fun pretty_reports ctxt (SOME reports) =
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   292
  Pretty.chunks (Pretty.str "Quickcheck report:" ::
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   293
    maps (fn (size, reports) =>
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   294
      Pretty.str ("size " ^ string_of_int size ^ ":") :: pretty_reports' reports @ [Pretty.brk 1])
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   295
      (rev reports))
35380
6ac5b81a763d adopting Mutabelle to quickcheck reporting; improving quickcheck reporting
bulwahn
parents: 35379
diff changeset
   296
  | pretty_reports ctxt NONE = Pretty.str ""
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   297
37912
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   298
fun pretty_counterex_and_reports ctxt (cex, timing_and_reports) =
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   299
  Pretty.chunks (pretty_counterex ctxt cex :: map (pretty_reports ctxt) (map snd timing_and_reports))
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   300
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   301
(* automatic testing *)
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   302
33561
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   303
fun auto_quickcheck state =
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   304
  if not (!auto) then
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   305
    (false, state)
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   306
  else
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   307
    let
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   308
      val ctxt = Proof.context_of state;
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   309
      val Test_Params {size, iterations, default_type, no_assms, ...} =
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   310
        (snd o Data.get o Context.Proof) ctxt;
33561
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   311
      val res =
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   312
        state
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   313
        |> Proof.map_context (set_reporting false)
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   314
        |> try (test_goal true NONE size iterations default_type no_assms [] 1);
33561
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   315
    in
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   316
      case res of
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   317
        NONE => (false, state)
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   318
      | SOME (NONE, report) => (false, state)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   319
      | SOME (cex, report) => (true, Proof.goal_message (K (Pretty.chunks [Pretty.str "",
33561
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   320
          Pretty.mark Markup.hilite (pretty_counterex ctxt cex)])) state)
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   321
    end
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   322
ab01b72715ef introduced Auto Nitpick in addition to Auto Quickcheck;
blanchet
parents: 33560
diff changeset
   323
val setup = Auto_Counterexample.register_tool ("quickcheck", auto_quickcheck)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   324
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   325
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
   326
(* Isar commands *)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   327
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   328
fun read_nat s = case (Library.read_int o Symbol.explode) s
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   329
 of (k, []) => if k >= 0 then k
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   330
      else error ("Not a natural number: " ^ s)
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   331
  | (_, _ :: _) => error ("Not a natural number: " ^ s);
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   332
34128
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   333
fun read_bool "false" = false
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   334
  | read_bool "true" = true
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   335
  | read_bool s = error ("Not a Boolean value: " ^ s)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   336
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   337
fun read_expectation "no_expectation" = No_Expectation
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   338
  | read_expectation "no_counterexample" = No_Counterexample 
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   339
  | read_expectation "counterexample" = Counterexample
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   340
  | read_expectation s = error ("Not an expectation value: " ^ s)  
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   341
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   342
fun parse_test_param ctxt ("size", [arg]) =
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   343
      (apfst o apfst o K) (read_nat arg)
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   344
  | parse_test_param ctxt ("iterations", [arg]) =
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   345
      (apfst o apsnd o K) (read_nat arg)
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   346
  | parse_test_param ctxt ("default_type", arg) =
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   347
      (apsnd o apfst o apfst o K) (map (ProofContext.read_typ ctxt) arg)
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   348
  | parse_test_param ctxt ("no_assms", [arg]) =
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   349
      (apsnd o apfst o apsnd o K) (read_bool arg)
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   350
  | parse_test_param ctxt ("expect", [arg]) =
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   351
      (apsnd o apsnd o apfst o apfst o K) (read_expectation arg)
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   352
  | parse_test_param ctxt ("report", [arg]) =
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   353
      (apsnd o apsnd o apfst o apsnd o K) (read_bool arg)
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   354
  | parse_test_param ctxt ("quiet", [arg]) =
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   355
      (apsnd o apsnd o apsnd o K) (read_bool arg)       
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   356
  | parse_test_param ctxt (name, _) =
34128
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   357
      error ("Unknown test parameter: " ^ name);
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   358
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   359
fun parse_test_param_inst ctxt ("generator", [arg]) =
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   360
      (apsnd o apfst o K o SOME) arg
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   361
  | parse_test_param_inst ctxt (name, arg) =
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   362
      case try (ProofContext.read_typ ctxt) name
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   363
       of SOME (TFree (v, _)) => (apsnd o apsnd o AList.update (op =))
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   364
              (v, ProofContext.read_typ ctxt (the_single arg))
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   365
        | _ => (apfst o parse_test_param ctxt) (name, arg);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   366
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   367
fun quickcheck_params_cmd args thy =
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   368
  let
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   369
    val ctxt = ProofContext.init_global thy
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   370
    val f = fold (parse_test_param ctxt) args;
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   371
  in
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   372
    thy
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   373
    |> (Context.theory_map o Data.map o apsnd o map_test_params) f
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   374
  end;
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   375
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   376
fun gen_quickcheck args i state =
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   377
  let
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   378
    val ctxt = Proof.context_of state;
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   379
    val default_params = (dest_test_params o snd o Data.get o Context.Proof) ctxt;
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   380
    val f = fold (parse_test_param_inst ctxt) args;
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   381
    val (((size, iterations), ((default_type, no_assms), ((expect, report), quiet))), (generator_name, insts)) =
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   382
      f (default_params, (NONE, []));
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   383
  in
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   384
    state
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   385
    |> Proof.map_context (set_reporting report)
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   386
    |> test_goal quiet generator_name size iterations default_type no_assms insts i
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   387
    |> tap (fn (SOME x, _) => if expect = No_Counterexample then
37974
d9549f9da779 quickcheck images of goals under registration morphisms
haftmann
parents: 37929
diff changeset
   388
                 error ("quickcheck expected to find no counterexample but found one") else ()
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   389
             | (NONE, _) => if expect = Counterexample then
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   390
                 error ("quickcheck expected to find a counterexample but did not find one") else ())
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   391
  end;
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   392
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   393
fun quickcheck args i state = fst (gen_quickcheck args i state);
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   394
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   395
fun quickcheck_cmd args i state =
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   396
  gen_quickcheck args i (Toplevel.proof_of state)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   397
  |> Pretty.writeln o pretty_counterex_and_reports (Toplevel.context_of state);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   398
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   399
val parse_arg = Parse.name -- (Scan.optional (Parse.$$$ "=" |-- 
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   400
  ((Parse.name >> single) || (Parse.$$$ "[" |-- Parse.list1 Parse.name --| Parse.$$$ "]"))) ["true"]);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   401
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   402
val parse_args = Parse.$$$ "[" |-- Parse.list1 parse_arg --| Parse.$$$ "]"
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   403
  || Scan.succeed [];
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   404
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   405
val _ =
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   406
  Outer_Syntax.command "quickcheck_params" "set parameters for random testing" Keyword.thy_decl
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   407
    (parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   408
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   409
val _ =
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   410
  Outer_Syntax.improper_command "quickcheck" "try to find counterexample for subgoal" Keyword.diag
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   411
    (parse_args -- Scan.optional Parse.nat 1
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   412
      >> (fn (args, i) => Toplevel.no_timing o Toplevel.keep (quickcheck_cmd args i)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   413
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   414
end;
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   415
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   416
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   417
val auto_quickcheck = Quickcheck.auto;