src/Tools/quickcheck.ML
author wenzelm
Thu Oct 28 22:04:00 2010 +0200 (2010-10-28)
changeset 40235 87998864284e
parent 40225 2de5dd0cd3a2
child 40253 f99ec71de82d
permissions -rw-r--r--
use Exn.interruptible_capture to keep user-code interruptible (Exn.capture not immediately followed by Exn.release here);
wenzelm@30824
     1
(*  Title:      Tools/quickcheck.ML
haftmann@28256
     2
    Author:     Stefan Berghofer, Florian Haftmann, TU Muenchen
haftmann@28256
     3
haftmann@28256
     4
Generic counterexample search engine.
haftmann@28256
     5
*)
haftmann@28256
     6
haftmann@28256
     7
signature QUICKCHECK =
haftmann@28256
     8
sig
bulwahn@37910
     9
  val setup: theory -> theory
bulwahn@37910
    10
  (* configuration *)
wenzelm@32740
    11
  val auto: bool Unsynchronized.ref
bulwahn@34948
    12
  val timing : bool Unsynchronized.ref
bulwahn@35378
    13
  datatype report = Report of
bulwahn@35378
    14
    { iterations : int, raised_match_errors : int,
bulwahn@35378
    15
      satisfied_assms : int list, positive_concl_tests : int }
bulwahn@37929
    16
  datatype expectation = No_Expectation | No_Counterexample | Counterexample;
bulwahn@37910
    17
  datatype test_params = Test_Params of
bulwahn@37929
    18
  { size: int, iterations: int, default_type: typ list, no_assms: bool,
bulwahn@37929
    19
    expect : expectation, report: bool, quiet : bool};
bulwahn@39252
    20
  val test_params_of: Proof.context -> test_params 
bulwahn@39253
    21
  val report : Proof.context -> bool
bulwahn@39656
    22
  val set_reporting : bool -> Context.generic -> Context.generic
bulwahn@37910
    23
  val add_generator:
bulwahn@39253
    24
    string * (Proof.context -> term -> int -> term list option * (bool list * bool))
bulwahn@39252
    25
      -> Context.generic -> Context.generic
bulwahn@37910
    26
  (* testing terms and proof states *)
bulwahn@39253
    27
  val gen_test_term: Proof.context -> bool -> string option -> int -> int -> term ->
bulwahn@35380
    28
    (string * term) list option * ((string * int) list * ((int * report list) list) option)
wenzelm@30980
    29
  val test_term: Proof.context -> bool -> string option -> int -> int -> term ->
wenzelm@30980
    30
    (string * term) list option
bulwahn@37909
    31
  val quickcheck: (string * string list) list -> int -> Proof.state -> (string * term) list option
haftmann@28256
    32
end;
haftmann@28256
    33
haftmann@28256
    34
structure Quickcheck : QUICKCHECK =
haftmann@28256
    35
struct
haftmann@28256
    36
wenzelm@30980
    37
(* preferences *)
wenzelm@30980
    38
wenzelm@32740
    39
val auto = Unsynchronized.ref false;
wenzelm@30980
    40
bulwahn@34948
    41
val timing = Unsynchronized.ref false;
bulwahn@34948
    42
wenzelm@30980
    43
val _ =
wenzelm@30980
    44
  ProofGeneralPgip.add_preference Preferences.category_tracing
wenzelm@39616
    45
  (Unsynchronized.setmp auto true (fn () =>
wenzelm@30980
    46
    Preferences.bool_pref auto
wenzelm@30980
    47
      "auto-quickcheck"
blanchet@39329
    48
      "Run Quickcheck automatically.") ());
wenzelm@30980
    49
bulwahn@35378
    50
(* quickcheck report *)
bulwahn@35378
    51
bulwahn@35378
    52
datatype single_report = Run of bool list * bool | MatchExc
bulwahn@35378
    53
bulwahn@35378
    54
datatype report = Report of
bulwahn@35378
    55
  { iterations : int, raised_match_errors : int,
bulwahn@35378
    56
    satisfied_assms : int list, positive_concl_tests : int }
bulwahn@35378
    57
bulwahn@35378
    58
fun collect_single_report single_report
bulwahn@35378
    59
    (Report {iterations = iterations, raised_match_errors = raised_match_errors,
bulwahn@35378
    60
    satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}) =
bulwahn@35378
    61
  case single_report
bulwahn@35378
    62
  of MatchExc =>
bulwahn@35378
    63
    Report {iterations = iterations + 1, raised_match_errors = raised_match_errors + 1,
bulwahn@35378
    64
      satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}
bulwahn@35378
    65
   | Run (assms, concl) =>
bulwahn@35378
    66
    Report {iterations = iterations + 1, raised_match_errors = raised_match_errors,
bulwahn@35378
    67
      satisfied_assms =
bulwahn@35378
    68
        map2 (fn b => fn s => if b then s + 1 else s) assms
bulwahn@35378
    69
         (if null satisfied_assms then replicate (length assms) 0 else satisfied_assms),
bulwahn@35378
    70
      positive_concl_tests = if concl then positive_concl_tests + 1 else positive_concl_tests}
haftmann@30973
    71
bulwahn@37929
    72
(* expectation *)
bulwahn@37929
    73
bulwahn@37929
    74
datatype expectation = No_Expectation | No_Counterexample | Counterexample; 
bulwahn@37929
    75
bulwahn@37929
    76
fun merge_expectation (expect1, expect2) =
bulwahn@37929
    77
  if expect1 = expect2 then expect1 else No_Expectation
bulwahn@37929
    78
haftmann@28315
    79
(* quickcheck configuration -- default parameters, test generators *)
haftmann@28315
    80
haftmann@28309
    81
datatype test_params = Test_Params of
bulwahn@37929
    82
  { size: int, iterations: int, default_type: typ list, no_assms: bool,
wenzelm@38759
    83
    expect : expectation, report: bool, quiet : bool};
haftmann@28309
    84
bulwahn@37929
    85
fun dest_test_params (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
bulwahn@37929
    86
  ((size, iterations), ((default_type, no_assms), ((expect, report), quiet)));
wenzelm@38759
    87
bulwahn@37929
    88
fun make_test_params ((size, iterations), ((default_type, no_assms), ((expect, report), quiet))) =
blanchet@34128
    89
  Test_Params { size = size, iterations = iterations, default_type = default_type,
wenzelm@38759
    90
    no_assms = no_assms, expect = expect, report = report, quiet = quiet };
wenzelm@38759
    91
bulwahn@37929
    92
fun map_test_params f (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
bulwahn@37929
    93
  make_test_params (f ((size, iterations), ((default_type, no_assms), ((expect, report), quiet))));
wenzelm@38759
    94
wenzelm@38759
    95
fun merge_test_params
wenzelm@38759
    96
 (Test_Params { size = size1, iterations = iterations1, default_type = default_type1,
wenzelm@38759
    97
    no_assms = no_assms1, expect = expect1, report = report1, quiet = quiet1 },
blanchet@34128
    98
  Test_Params { size = size2, iterations = iterations2, default_type = default_type2,
wenzelm@38759
    99
    no_assms = no_assms2, expect = expect2, report = report2, quiet = quiet2 }) =
haftmann@31599
   100
  make_test_params ((Int.max (size1, size2), Int.max (iterations1, iterations2)),
bulwahn@37911
   101
    ((merge (op =) (default_type1, default_type2), no_assms1 orelse no_assms2),
bulwahn@37929
   102
    ((merge_expectation (expect1, expect2), report1 orelse report2), quiet1 orelse quiet2)));
haftmann@28309
   103
bulwahn@39252
   104
structure Data = Generic_Data
wenzelm@33522
   105
(
wenzelm@38759
   106
  type T =
bulwahn@39253
   107
    (string * (Proof.context -> term -> int -> term list option * (bool list * bool))) list
wenzelm@38759
   108
      * test_params;
bulwahn@35378
   109
  val empty = ([], Test_Params
bulwahn@37929
   110
    { size = 10, iterations = 100, default_type = [], no_assms = false,
bulwahn@37929
   111
      expect = No_Expectation, report = false, quiet = false});
haftmann@28256
   112
  val extend = I;
wenzelm@33522
   113
  fun merge ((generators1, params1), (generators2, params2)) : T =
wenzelm@33522
   114
    (AList.merge (op =) (K true) (generators1, generators2),
haftmann@28309
   115
      merge_test_params (params1, params2));
wenzelm@33522
   116
);
haftmann@28256
   117
bulwahn@39252
   118
val test_params_of = snd o Data.get o Context.Proof;
bulwahn@37910
   119
bulwahn@39253
   120
val report = snd o fst o snd o snd o dest_test_params o test_params_of
bulwahn@39253
   121
bulwahn@39253
   122
fun map_report f (Test_Params { size, iterations, default_type, no_assms, expect, report, quiet }) =
bulwahn@39253
   123
  make_test_params ((size, iterations), ((default_type, no_assms), ((expect, f report), quiet)));
bulwahn@39253
   124
bulwahn@39656
   125
fun set_reporting report = Data.map (apsnd (map_report (K report)))
bulwahn@39253
   126
haftmann@28309
   127
val add_generator = Data.map o apfst o AList.update (op =);
haftmann@28309
   128
haftmann@28315
   129
(* generating tests *)
haftmann@28315
   130
haftmann@28309
   131
fun mk_tester_select name ctxt =
bulwahn@39252
   132
  case AList.lookup (op =) ((fst o Data.get o Context.Proof) ctxt) name
haftmann@28309
   133
   of NONE => error ("No such quickcheck generator: " ^ name)
haftmann@28309
   134
    | SOME generator => generator ctxt;
haftmann@28309
   135
bulwahn@39253
   136
fun mk_testers ctxt t =
bulwahn@39252
   137
  (map snd o fst o Data.get o Context.Proof) ctxt
bulwahn@39253
   138
  |> map_filter (fn generator => try (generator ctxt) t);
haftmann@28309
   139
bulwahn@39253
   140
fun mk_testers_strict ctxt t =
haftmann@28309
   141
  let
wenzelm@40235
   142
    val generators = ((map snd o fst o Data.get o Context.Proof) ctxt)
wenzelm@40235
   143
    val testers = map (fn generator => Exn.interruptible_capture (generator ctxt) t) generators;
wenzelm@40235
   144
  in
wenzelm@40235
   145
    if forall (is_none o Exn.get_result) testers
haftmann@28309
   146
    then [(Exn.release o snd o split_last) testers]
haftmann@28309
   147
    else map_filter Exn.get_result testers
haftmann@28309
   148
  end;
haftmann@28309
   149
haftmann@28315
   150
haftmann@28315
   151
(* testing propositions *)
haftmann@28315
   152
haftmann@28309
   153
fun prep_test_term t =
haftmann@28309
   154
  let
wenzelm@29266
   155
    val _ = (null (Term.add_tvars t []) andalso null (Term.add_tfrees t [])) orelse
haftmann@28309
   156
      error "Term to be tested contains type variables";
wenzelm@29266
   157
    val _ = null (Term.add_vars t []) orelse
haftmann@28309
   158
      error "Term to be tested contains schematic variables";
haftmann@31138
   159
    val frees = Term.add_frees t [];
haftmann@28309
   160
  in (map fst frees, list_abs_free (frees, t)) end
haftmann@28256
   161
bulwahn@35324
   162
fun cpu_time description f =
bulwahn@35324
   163
  let
bulwahn@35324
   164
    val start = start_timing ()
bulwahn@35324
   165
    val result = Exn.capture f ()
bulwahn@35324
   166
    val time = Time.toMilliseconds (#cpu (end_timing start))
bulwahn@35324
   167
  in (Exn.release result, (description, time)) end
bulwahn@35324
   168
bulwahn@39253
   169
fun gen_test_term ctxt quiet generator_name size i t =
haftmann@28309
   170
  let
haftmann@28309
   171
    val (names, t') = prep_test_term t;
bulwahn@35324
   172
    val (testers, comp_time) = cpu_time "quickcheck compilation"
bulwahn@35324
   173
      (fn () => (case generator_name
bulwahn@39253
   174
       of NONE => if quiet then mk_testers ctxt t' else mk_testers_strict ctxt t'
bulwahn@39253
   175
        | SOME name => [mk_tester_select name ctxt t']));
bulwahn@35378
   176
    fun iterate f 0 report = (NONE, report)
bulwahn@35378
   177
      | iterate f j report =
bulwahn@35378
   178
        let
bulwahn@35378
   179
          val (test_result, single_report) = apsnd Run (f ()) handle Match => (if quiet then ()
bulwahn@35378
   180
             else warning "Exception Match raised during quickcheck"; (NONE, MatchExc))
bulwahn@35378
   181
          val report = collect_single_report single_report report
bulwahn@35378
   182
        in
bulwahn@35378
   183
          case test_result of NONE => iterate f (j - 1) report | SOME q => (SOME q, report)
bulwahn@35378
   184
        end
bulwahn@35378
   185
    val empty_report = Report { iterations = 0, raised_match_errors = 0,
bulwahn@35378
   186
      satisfied_assms = [], positive_concl_tests = 0 }
bulwahn@35378
   187
    fun with_testers k [] = (NONE, [])
haftmann@28309
   188
      | with_testers k (tester :: testers) =
bulwahn@35378
   189
          case iterate (fn () => tester (k - 1)) i empty_report
bulwahn@35378
   190
           of (NONE, report) => apsnd (cons report) (with_testers k testers)
bulwahn@35378
   191
            | (SOME q, report) => (SOME q, [report]);
wenzelm@40132
   192
    fun with_size k reports =
wenzelm@40132
   193
      if k > size then (NONE, reports)
wenzelm@40132
   194
      else
wenzelm@40132
   195
       (if quiet then () else Output.urgent_message ("Test data size: " ^ string_of_int k);
bulwahn@35378
   196
        let
bulwahn@35378
   197
          val (result, new_report) = with_testers k testers
bulwahn@35378
   198
          val reports = ((k, new_report) :: reports)
bulwahn@35378
   199
        in case result of NONE => with_size (k + 1) reports | SOME q => (SOME q, reports) end);
bulwahn@40136
   200
    val ((result, reports), exec_time) =
bulwahn@40136
   201
      TimeLimit.timeLimit (Time.fromSeconds 20) (fn () => cpu_time "quickcheck execution"
bulwahn@35378
   202
      (fn () => apfst
bulwahn@35378
   203
         (fn result => case result of NONE => NONE
bulwahn@40136
   204
        | SOME ts => SOME (names ~~ ts)) (with_size 1 []))) ()
bulwahn@40136
   205
      handle TimeLimit.TimeOut => error "Reached timeout during Quickcheck"
bulwahn@34948
   206
  in
bulwahn@39253
   207
    (result, ([exec_time, comp_time], if report ctxt then SOME reports else NONE))
haftmann@28309
   208
  end;
haftmann@28309
   209
bulwahn@35324
   210
fun test_term ctxt quiet generator_name size i t =
bulwahn@39253
   211
  ctxt
bulwahn@39656
   212
  |> Context.proof_map (set_reporting false)
bulwahn@39253
   213
  |> (fn ctxt' => fst (gen_test_term ctxt' quiet generator_name size i t))
bulwahn@35324
   214
bulwahn@37913
   215
exception WELLSORTED of string
bulwahn@37913
   216
haftmann@28309
   217
fun monomorphic_term thy insts default_T = 
haftmann@28309
   218
  let
haftmann@28309
   219
    fun subst (T as TFree (v, S)) =
haftmann@28309
   220
          let
haftmann@28309
   221
            val T' = AList.lookup (op =) insts v
bulwahn@37912
   222
              |> the_default default_T
bulwahn@37913
   223
          in if Sign.of_sort thy (T', S) then T'
bulwahn@37913
   224
            else raise (WELLSORTED ("For instantiation with default_type " ^ Syntax.string_of_typ_global thy default_T ^
bulwahn@37913
   225
              ":\n" ^ Syntax.string_of_typ_global thy T' ^
haftmann@28309
   226
              " to be substituted for variable " ^
bulwahn@37913
   227
              Syntax.string_of_typ_global thy T ^ " does not have sort " ^
bulwahn@37913
   228
              Syntax.string_of_sort_global thy S))
haftmann@28309
   229
          end
haftmann@28309
   230
      | subst T = T;
haftmann@28309
   231
  in (map_types o map_atyps) subst end;
haftmann@28309
   232
bulwahn@37913
   233
datatype wellsorted_error = Wellsorted_Error of string | Term of term
bulwahn@37913
   234
bulwahn@39253
   235
fun test_goal quiet generator_name size iterations default_Ts no_assms insts i state =
haftmann@28309
   236
  let
haftmann@37974
   237
    val lthy = Proof.context_of state;
haftmann@28309
   238
    val thy = Proof.theory_of state;
haftmann@28309
   239
    fun strip (Const ("all", _) $ Abs (_, _, t)) = strip t
haftmann@28309
   240
      | strip t = t;
wenzelm@33291
   241
    val {goal = st, ...} = Proof.raw_goal state;
haftmann@28309
   242
    val (gi, frees) = Logic.goal_params (prop_of st) i;
haftmann@38390
   243
    val some_locale = case (Option.map #target o Named_Target.peek) lthy
haftmann@38390
   244
     of NONE => NONE
haftmann@38390
   245
      | SOME "" => NONE
haftmann@38390
   246
      | SOME locale => SOME locale;
haftmann@37974
   247
    val assms = if no_assms then [] else case some_locale
haftmann@37974
   248
     of NONE => Assumption.all_assms_of lthy
haftmann@37974
   249
      | SOME locale => Assumption.local_assms_of lthy (Locale.init locale thy);
haftmann@37974
   250
    val proto_goal = Logic.list_implies (map Thm.term_of assms, subst_bounds (frees, strip gi));
haftmann@37974
   251
    val check_goals = case some_locale
haftmann@37974
   252
     of NONE => [proto_goal]
ballarin@38111
   253
      | SOME locale => map (fn (_, phi) => Morphism.term phi proto_goal) (Locale.registrations_of (Context.Theory thy) (*FIXME*) locale);
haftmann@37974
   254
    val inst_goals = maps (fn check_goal => map (fn T =>
haftmann@37974
   255
      Term ((Object_Logic.atomize_term thy o monomorphic_term thy insts T) check_goal)
haftmann@37974
   256
        handle WELLSORTED s => Wellsorted_Error s) default_Ts) check_goals
bulwahn@37913
   257
    val error_msg = cat_lines (map_filter (fn Term t => NONE | Wellsorted_Error s => SOME s) inst_goals)
bulwahn@37913
   258
    val correct_inst_goals =
bulwahn@37913
   259
      case map_filter (fn Term t => SOME t | Wellsorted_Error s => NONE) inst_goals of
bulwahn@37913
   260
        [] => error error_msg
bulwahn@37913
   261
      | xs => xs
bulwahn@37913
   262
    val _ = if quiet then () else warning error_msg
bulwahn@37912
   263
    fun collect_results f reports [] = (NONE, rev reports)
bulwahn@37912
   264
      | collect_results f reports (t :: ts) =
bulwahn@37912
   265
        case f t of
bulwahn@37912
   266
          (SOME res, report) => (SOME res, rev (report :: reports))
bulwahn@37912
   267
        | (NONE, report) => collect_results f (report :: reports) ts
bulwahn@39253
   268
  in collect_results (gen_test_term lthy quiet generator_name size iterations) [] correct_inst_goals end;
bulwahn@37912
   269
bulwahn@37912
   270
(* pretty printing *)
haftmann@28315
   271
blanchet@40225
   272
fun tool_name auto = (if auto then "Auto " else "") ^ "Quickcheck"
blanchet@40225
   273
blanchet@40225
   274
fun pretty_counterex ctxt auto NONE = Pretty.str (tool_name auto ^ " found no counterexample.")
blanchet@40225
   275
  | pretty_counterex ctxt auto (SOME cex) =
blanchet@40225
   276
      Pretty.chunks (Pretty.str (tool_name auto ^ " found a counterexample:\n") ::
haftmann@28315
   277
        map (fn (s, t) =>
haftmann@28315
   278
          Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) cex);
haftmann@28315
   279
bulwahn@35378
   280
fun pretty_report (Report {iterations = iterations, raised_match_errors = raised_match_errors,
bulwahn@35378
   281
    satisfied_assms = satisfied_assms, positive_concl_tests = positive_concl_tests}) =
bulwahn@35378
   282
  let
bulwahn@35378
   283
    fun pretty_stat s i = Pretty.block ([Pretty.str (s ^ ": " ^ string_of_int i)])
bulwahn@35378
   284
  in
bulwahn@35378
   285
     ([pretty_stat "iterations" iterations,
bulwahn@35378
   286
     pretty_stat "match exceptions" raised_match_errors]
bulwahn@35378
   287
     @ map_index (fn (i, n) => pretty_stat ("satisfied " ^ string_of_int (i + 1) ^ ". assumption") n)
bulwahn@35378
   288
       satisfied_assms
bulwahn@35378
   289
     @ [pretty_stat "positive conclusion tests" positive_concl_tests])
bulwahn@35378
   290
  end
bulwahn@35378
   291
bulwahn@35378
   292
fun pretty_reports' [report] = [Pretty.chunks (pretty_report report)]
bulwahn@35378
   293
  | pretty_reports' reports =
bulwahn@35378
   294
  map_index (fn (i, report) =>
bulwahn@35378
   295
    Pretty.chunks (Pretty.str (string_of_int (i + 1) ^ ". generator:\n") :: pretty_report report))
bulwahn@35378
   296
    reports
bulwahn@35378
   297
bulwahn@35380
   298
fun pretty_reports ctxt (SOME reports) =
bulwahn@35378
   299
  Pretty.chunks (Pretty.str "Quickcheck report:" ::
bulwahn@35378
   300
    maps (fn (size, reports) =>
bulwahn@35378
   301
      Pretty.str ("size " ^ string_of_int size ^ ":") :: pretty_reports' reports @ [Pretty.brk 1])
bulwahn@35378
   302
      (rev reports))
bulwahn@35380
   303
  | pretty_reports ctxt NONE = Pretty.str ""
bulwahn@35378
   304
blanchet@40225
   305
fun pretty_counterex_and_reports ctxt auto (cex, timing_and_reports) =
blanchet@40225
   306
  Pretty.chunks (pretty_counterex ctxt auto cex ::
blanchet@40225
   307
    map (pretty_reports ctxt) (map snd timing_and_reports))
haftmann@28315
   308
haftmann@28315
   309
(* automatic testing *)
haftmann@28309
   310
blanchet@33561
   311
fun auto_quickcheck state =
blanchet@33561
   312
  if not (!auto) then
blanchet@33561
   313
    (false, state)
blanchet@33561
   314
  else
blanchet@33561
   315
    let
blanchet@33561
   316
      val ctxt = Proof.context_of state;
bulwahn@37929
   317
      val Test_Params {size, iterations, default_type, no_assms, ...} =
bulwahn@39252
   318
        (snd o Data.get o Context.Proof) ctxt;
blanchet@33561
   319
      val res =
bulwahn@39253
   320
        state
bulwahn@39656
   321
        |> Proof.map_context (Context.proof_map (set_reporting false))
bulwahn@39253
   322
        |> try (test_goal true NONE size iterations default_type no_assms [] 1);
blanchet@33561
   323
    in
blanchet@33561
   324
      case res of
blanchet@33561
   325
        NONE => (false, state)
bulwahn@35378
   326
      | SOME (NONE, report) => (false, state)
bulwahn@35378
   327
      | SOME (cex, report) => (true, Proof.goal_message (K (Pretty.chunks [Pretty.str "",
blanchet@40225
   328
          Pretty.mark Markup.hilite (pretty_counterex ctxt true cex)])) state)
blanchet@33561
   329
    end
blanchet@33561
   330
blanchet@39324
   331
val setup = Auto_Tools.register_tool ("quickcheck", auto_quickcheck)
haftmann@28315
   332
haftmann@28315
   333
wenzelm@30980
   334
(* Isar commands *)
haftmann@28315
   335
haftmann@28336
   336
fun read_nat s = case (Library.read_int o Symbol.explode) s
haftmann@28336
   337
 of (k, []) => if k >= 0 then k
haftmann@28336
   338
      else error ("Not a natural number: " ^ s)
haftmann@28336
   339
  | (_, _ :: _) => error ("Not a natural number: " ^ s);
bulwahn@37909
   340
blanchet@34128
   341
fun read_bool "false" = false
blanchet@34128
   342
  | read_bool "true" = true
blanchet@34128
   343
  | read_bool s = error ("Not a Boolean value: " ^ s)
haftmann@28315
   344
bulwahn@37929
   345
fun read_expectation "no_expectation" = No_Expectation
bulwahn@37929
   346
  | read_expectation "no_counterexample" = No_Counterexample 
bulwahn@37929
   347
  | read_expectation "counterexample" = Counterexample
bulwahn@37929
   348
  | read_expectation s = error ("Not an expectation value: " ^ s)  
bulwahn@37929
   349
bulwahn@37909
   350
fun parse_test_param ctxt ("size", [arg]) =
haftmann@28336
   351
      (apfst o apfst o K) (read_nat arg)
bulwahn@37909
   352
  | parse_test_param ctxt ("iterations", [arg]) =
haftmann@28336
   353
      (apfst o apsnd o K) (read_nat arg)
haftmann@28336
   354
  | parse_test_param ctxt ("default_type", arg) =
bulwahn@37909
   355
      (apsnd o apfst o apfst o K) (map (ProofContext.read_typ ctxt) arg)
bulwahn@37909
   356
  | parse_test_param ctxt ("no_assms", [arg]) =
bulwahn@35378
   357
      (apsnd o apfst o apsnd o K) (read_bool arg)
bulwahn@37929
   358
  | parse_test_param ctxt ("expect", [arg]) =
bulwahn@37929
   359
      (apsnd o apsnd o apfst o apfst o K) (read_expectation arg)
bulwahn@37909
   360
  | parse_test_param ctxt ("report", [arg]) =
bulwahn@37929
   361
      (apsnd o apsnd o apfst o apsnd o K) (read_bool arg)
bulwahn@37909
   362
  | parse_test_param ctxt ("quiet", [arg]) =
bulwahn@37929
   363
      (apsnd o apsnd o apsnd o K) (read_bool arg)       
haftmann@28336
   364
  | parse_test_param ctxt (name, _) =
blanchet@34128
   365
      error ("Unknown test parameter: " ^ name);
haftmann@28315
   366
bulwahn@37909
   367
fun parse_test_param_inst ctxt ("generator", [arg]) =
haftmann@28336
   368
      (apsnd o apfst o K o SOME) arg
haftmann@28336
   369
  | parse_test_param_inst ctxt (name, arg) =
haftmann@28336
   370
      case try (ProofContext.read_typ ctxt) name
haftmann@28336
   371
       of SOME (TFree (v, _)) => (apsnd o apsnd o AList.update (op =))
bulwahn@37909
   372
              (v, ProofContext.read_typ ctxt (the_single arg))
haftmann@28336
   373
        | _ => (apfst o parse_test_param ctxt) (name, arg);
haftmann@28309
   374
haftmann@28336
   375
fun quickcheck_params_cmd args thy =
haftmann@28315
   376
  let
bulwahn@39252
   377
    val ctxt = ProofContext.init_global thy
haftmann@28336
   378
    val f = fold (parse_test_param ctxt) args;
haftmann@28315
   379
  in
haftmann@28315
   380
    thy
bulwahn@39252
   381
    |> (Context.theory_map o Data.map o apsnd o map_test_params) f
haftmann@28315
   382
  end;
haftmann@28315
   383
bulwahn@35378
   384
fun gen_quickcheck args i state =
haftmann@28315
   385
  let
boehmes@32297
   386
    val ctxt = Proof.context_of state;
bulwahn@39252
   387
    val default_params = (dest_test_params o snd o Data.get o Context.Proof) ctxt;
haftmann@28336
   388
    val f = fold (parse_test_param_inst ctxt) args;
bulwahn@37929
   389
    val (((size, iterations), ((default_type, no_assms), ((expect, report), quiet))), (generator_name, insts)) =
haftmann@28336
   390
      f (default_params, (NONE, []));
boehmes@32297
   391
  in
bulwahn@39253
   392
    state
bulwahn@39656
   393
    |> Proof.map_context (Context.proof_map (set_reporting report))
bulwahn@39253
   394
    |> test_goal quiet generator_name size iterations default_type no_assms insts i
bulwahn@37929
   395
    |> tap (fn (SOME x, _) => if expect = No_Counterexample then
haftmann@37974
   396
                 error ("quickcheck expected to find no counterexample but found one") else ()
bulwahn@37929
   397
             | (NONE, _) => if expect = Counterexample then
bulwahn@37929
   398
                 error ("quickcheck expected to find a counterexample but did not find one") else ())
boehmes@32297
   399
  end;
boehmes@32297
   400
wenzelm@36960
   401
fun quickcheck args i state = fst (gen_quickcheck args i state);
bulwahn@35378
   402
boehmes@32297
   403
fun quickcheck_cmd args i state =
bulwahn@35378
   404
  gen_quickcheck args i (Toplevel.proof_of state)
blanchet@40225
   405
  |> Pretty.writeln o pretty_counterex_and_reports (Toplevel.context_of state) false;
haftmann@28309
   406
bulwahn@37909
   407
val parse_arg = Parse.name -- (Scan.optional (Parse.$$$ "=" |-- 
bulwahn@37909
   408
  ((Parse.name >> single) || (Parse.$$$ "[" |-- Parse.list1 Parse.name --| Parse.$$$ "]"))) ["true"]);
haftmann@28309
   409
wenzelm@36960
   410
val parse_args = Parse.$$$ "[" |-- Parse.list1 parse_arg --| Parse.$$$ "]"
haftmann@28336
   411
  || Scan.succeed [];
haftmann@28336
   412
wenzelm@36960
   413
val _ =
wenzelm@36960
   414
  Outer_Syntax.command "quickcheck_params" "set parameters for random testing" Keyword.thy_decl
wenzelm@36960
   415
    (parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
haftmann@28309
   416
wenzelm@36960
   417
val _ =
wenzelm@36960
   418
  Outer_Syntax.improper_command "quickcheck" "try to find counterexample for subgoal" Keyword.diag
wenzelm@36960
   419
    (parse_args -- Scan.optional Parse.nat 1
wenzelm@36960
   420
      >> (fn (args, i) => Toplevel.no_timing o Toplevel.keep (quickcheck_cmd args i)));
haftmann@28309
   421
haftmann@28315
   422
end;
haftmann@28309
   423
haftmann@28309
   424
haftmann@28315
   425
val auto_quickcheck = Quickcheck.auto;