src/Tools/quickcheck.ML
author bulwahn
Tue Feb 23 13:36:15 2010 +0100 (2010-02-23)
changeset 35324 c9f428269b38
parent 35077 c1dac8ace020
child 35378 95d0e3adf38e
permissions -rw-r--r--
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
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
wenzelm@32740
     9
  val auto: bool Unsynchronized.ref
bulwahn@34948
    10
  val timing : bool Unsynchronized.ref
wenzelm@30980
    11
  val test_term: Proof.context -> bool -> string option -> int -> int -> term ->
wenzelm@30980
    12
    (string * term) list option
bulwahn@35324
    13
  val timed_test_term: Proof.context -> bool -> string option -> int -> int -> term ->
bulwahn@35324
    14
    ((string * term) list option * (string * int) list)
wenzelm@30980
    15
  val add_generator: string * (Proof.context -> term -> int -> term list option) -> theory -> theory
blanchet@33561
    16
  val setup: theory -> theory
boehmes@32297
    17
  val quickcheck: (string * string) list -> int -> Proof.state -> (string * term) list option
haftmann@28256
    18
end;
haftmann@28256
    19
haftmann@28256
    20
structure Quickcheck : QUICKCHECK =
haftmann@28256
    21
struct
haftmann@28256
    22
wenzelm@30980
    23
(* preferences *)
wenzelm@30980
    24
wenzelm@32740
    25
val auto = Unsynchronized.ref false;
wenzelm@30980
    26
bulwahn@34948
    27
val timing = Unsynchronized.ref false;
bulwahn@34948
    28
wenzelm@30980
    29
val _ =
wenzelm@30980
    30
  ProofGeneralPgip.add_preference Preferences.category_tracing
wenzelm@32966
    31
  (setmp_CRITICAL auto true (fn () =>
wenzelm@30980
    32
    Preferences.bool_pref auto
wenzelm@30980
    33
      "auto-quickcheck"
blanchet@33561
    34
      "Whether to run Quickcheck automatically.") ());
wenzelm@30980
    35
haftmann@30973
    36
haftmann@28315
    37
(* quickcheck configuration -- default parameters, test generators *)
haftmann@28315
    38
haftmann@28309
    39
datatype test_params = Test_Params of
blanchet@34128
    40
  { size: int, iterations: int, default_type: typ option, no_assms: bool };
haftmann@28309
    41
blanchet@34128
    42
fun dest_test_params (Test_Params { size, iterations, default_type, no_assms }) =
blanchet@34128
    43
  ((size, iterations), (default_type, no_assms));
blanchet@34128
    44
fun make_test_params ((size, iterations), (default_type, no_assms)) =
blanchet@34128
    45
  Test_Params { size = size, iterations = iterations, default_type = default_type,
blanchet@34128
    46
                no_assms = no_assms };
blanchet@34128
    47
fun map_test_params f (Test_Params { size, iterations, default_type, no_assms }) =
blanchet@34128
    48
  make_test_params (f ((size, iterations), (default_type, no_assms)));
blanchet@34128
    49
fun merge_test_params (Test_Params { size = size1, iterations = iterations1, default_type = default_type1,
blanchet@34128
    50
                                     no_assms = no_assms1 },
blanchet@34128
    51
  Test_Params { size = size2, iterations = iterations2, default_type = default_type2,
blanchet@34128
    52
                no_assms = no_assms2 }) =
haftmann@31599
    53
  make_test_params ((Int.max (size1, size2), Int.max (iterations1, iterations2)),
blanchet@34128
    54
    (case default_type1 of NONE => default_type2 | _ => default_type1, no_assms1 orelse no_assms2));
haftmann@28309
    55
wenzelm@33522
    56
structure Data = Theory_Data
wenzelm@33522
    57
(
haftmann@28309
    58
  type T = (string * (Proof.context -> term -> int -> term list option)) list
haftmann@28309
    59
    * test_params;
blanchet@34128
    60
  val empty = ([], Test_Params { size = 10, iterations = 100, default_type = NONE, no_assms = false });
haftmann@28256
    61
  val extend = I;
wenzelm@33522
    62
  fun merge ((generators1, params1), (generators2, params2)) : T =
wenzelm@33522
    63
    (AList.merge (op =) (K true) (generators1, generators2),
haftmann@28309
    64
      merge_test_params (params1, params2));
wenzelm@33522
    65
);
haftmann@28256
    66
haftmann@28309
    67
val add_generator = Data.map o apfst o AList.update (op =);
haftmann@28309
    68
haftmann@28315
    69
haftmann@28315
    70
(* generating tests *)
haftmann@28315
    71
haftmann@28309
    72
fun mk_tester_select name ctxt =
haftmann@28309
    73
  case AList.lookup (op =) ((fst o Data.get o ProofContext.theory_of) ctxt) name
haftmann@28309
    74
   of NONE => error ("No such quickcheck generator: " ^ name)
haftmann@28309
    75
    | SOME generator => generator ctxt;
haftmann@28309
    76
haftmann@28309
    77
fun mk_testers ctxt t =
haftmann@28309
    78
  (map snd o fst o Data.get o ProofContext.theory_of) ctxt
haftmann@28309
    79
  |> map_filter (fn generator => try (generator ctxt) t);
haftmann@28309
    80
haftmann@28309
    81
fun mk_testers_strict ctxt t =
haftmann@28309
    82
  let
haftmann@28309
    83
    val generators = ((map snd o fst o Data.get o ProofContext.theory_of) ctxt)
haftmann@28309
    84
    val testers = map (fn generator => Exn.capture (generator ctxt) t) generators;
haftmann@28309
    85
  in if forall (is_none o Exn.get_result) testers
haftmann@28309
    86
    then [(Exn.release o snd o split_last) testers]
haftmann@28309
    87
    else map_filter Exn.get_result testers
haftmann@28309
    88
  end;
haftmann@28309
    89
haftmann@28315
    90
haftmann@28315
    91
(* testing propositions *)
haftmann@28315
    92
haftmann@28309
    93
fun prep_test_term t =
haftmann@28309
    94
  let
wenzelm@29266
    95
    val _ = (null (Term.add_tvars t []) andalso null (Term.add_tfrees t [])) orelse
haftmann@28309
    96
      error "Term to be tested contains type variables";
wenzelm@29266
    97
    val _ = null (Term.add_vars t []) orelse
haftmann@28309
    98
      error "Term to be tested contains schematic variables";
haftmann@31138
    99
    val frees = Term.add_frees t [];
haftmann@28309
   100
  in (map fst frees, list_abs_free (frees, t)) end
haftmann@28256
   101
bulwahn@35324
   102
fun cpu_time description f =
bulwahn@35324
   103
  let
bulwahn@35324
   104
    val start = start_timing ()
bulwahn@35324
   105
    val result = Exn.capture f ()
bulwahn@35324
   106
    val time = Time.toMilliseconds (#cpu (end_timing start))
bulwahn@35324
   107
  in (Exn.release result, (description, time)) end
bulwahn@35324
   108
bulwahn@35324
   109
fun timed_test_term ctxt quiet generator_name size i t =
haftmann@28309
   110
  let
haftmann@28309
   111
    val (names, t') = prep_test_term t;
bulwahn@35324
   112
    val (testers, comp_time) = cpu_time "quickcheck compilation"
bulwahn@35324
   113
      (fn () => (case generator_name
bulwahn@34948
   114
       of NONE => if quiet then mk_testers ctxt t' else mk_testers_strict ctxt t'
bulwahn@35324
   115
        | SOME name => [mk_tester_select name ctxt t']));
haftmann@28309
   116
    fun iterate f 0 = NONE
haftmann@31153
   117
      | iterate f j = case f () handle Match => (if quiet then ()
haftmann@28309
   118
             else warning "Exception Match raised during quickcheck"; NONE)
haftmann@31153
   119
          of NONE => iterate f (j - 1) | SOME q => SOME q;
haftmann@28309
   120
    fun with_testers k [] = NONE
haftmann@28309
   121
      | with_testers k (tester :: testers) =
haftmann@31153
   122
          case iterate (fn () => tester (k - 1)) i
haftmann@28309
   123
           of NONE => with_testers k testers
haftmann@28309
   124
            | SOME q => SOME q;
haftmann@28309
   125
    fun with_size k = if k > size then NONE
haftmann@28309
   126
      else (if quiet then () else priority ("Test data size: " ^ string_of_int k);
haftmann@28309
   127
        case with_testers k testers
haftmann@28309
   128
         of NONE => with_size (k + 1) | SOME q => SOME q);
bulwahn@35324
   129
    val (result, exec_time) = cpu_time "quickcheck execution"
bulwahn@35324
   130
      (fn () => case with_size 1
bulwahn@35324
   131
        of NONE => NONE
bulwahn@35324
   132
        | SOME ts => SOME (names ~~ ts))
bulwahn@34948
   133
  in
bulwahn@35324
   134
    (result, [exec_time, comp_time])
haftmann@28309
   135
  end;
haftmann@28309
   136
bulwahn@35324
   137
fun test_term ctxt quiet generator_name size i t =
bulwahn@35324
   138
  fst (timed_test_term ctxt quiet generator_name size i t)
bulwahn@35324
   139
haftmann@28309
   140
fun monomorphic_term thy insts default_T = 
haftmann@28309
   141
  let
haftmann@28309
   142
    fun subst (T as TFree (v, S)) =
haftmann@28309
   143
          let
haftmann@28309
   144
            val T' = AList.lookup (op =) insts v
haftmann@28309
   145
              |> the_default (the_default T default_T)
haftmann@28315
   146
          in if Sign.of_sort thy (T, S) then T'
haftmann@28309
   147
            else error ("Type " ^ Syntax.string_of_typ_global thy T ^
haftmann@28309
   148
              " to be substituted for variable " ^
haftmann@28309
   149
              Syntax.string_of_typ_global thy T ^ "\ndoes not have sort " ^
haftmann@28309
   150
              Syntax.string_of_sort_global thy S)
haftmann@28309
   151
          end
haftmann@28309
   152
      | subst T = T;
haftmann@28309
   153
  in (map_types o map_atyps) subst end;
haftmann@28309
   154
blanchet@34128
   155
fun test_goal quiet generator_name size iterations default_T no_assms insts i assms state =
haftmann@28309
   156
  let
haftmann@28309
   157
    val ctxt = Proof.context_of state;
haftmann@28309
   158
    val thy = Proof.theory_of state;
haftmann@28309
   159
    fun strip (Const ("all", _) $ Abs (_, _, t)) = strip t
haftmann@28309
   160
      | strip t = t;
wenzelm@33291
   161
    val {goal = st, ...} = Proof.raw_goal state;
haftmann@28309
   162
    val (gi, frees) = Logic.goal_params (prop_of st) i;
blanchet@34128
   163
    val gi' = Logic.list_implies (if no_assms then [] else assms,
blanchet@34128
   164
                                  subst_bounds (frees, strip gi))
haftmann@28309
   165
      |> monomorphic_term thy insts default_T
haftmann@28309
   166
      |> ObjectLogic.atomize_term thy;
haftmann@28315
   167
  in test_term ctxt quiet generator_name size iterations gi' end;
haftmann@28315
   168
blanchet@35077
   169
fun pretty_counterex ctxt NONE = Pretty.str "Quickcheck found no counterexample."
haftmann@28315
   170
  | pretty_counterex ctxt (SOME cex) =
blanchet@35077
   171
      Pretty.chunks (Pretty.str "Quickcheck found a counterexample:\n" ::
haftmann@28315
   172
        map (fn (s, t) =>
haftmann@28315
   173
          Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) cex);
haftmann@28315
   174
haftmann@28315
   175
haftmann@28315
   176
(* automatic testing *)
haftmann@28309
   177
blanchet@33561
   178
fun auto_quickcheck state =
blanchet@33561
   179
  if not (!auto) then
blanchet@33561
   180
    (false, state)
blanchet@33561
   181
  else
blanchet@33561
   182
    let
blanchet@33561
   183
      val ctxt = Proof.context_of state;
blanchet@33561
   184
      val assms = map term_of (Assumption.all_assms_of ctxt);
blanchet@34128
   185
      val Test_Params { size, iterations, default_type, no_assms } =
blanchet@33561
   186
        (snd o Data.get o Proof.theory_of) state;
blanchet@33561
   187
      val res =
blanchet@34128
   188
        try (test_goal true NONE size iterations default_type no_assms [] 1 assms) state;
blanchet@33561
   189
    in
blanchet@33561
   190
      case res of
blanchet@33561
   191
        NONE => (false, state)
blanchet@33561
   192
      | SOME NONE => (false, state)
blanchet@33561
   193
      | SOME cex => (true, Proof.goal_message (K (Pretty.chunks [Pretty.str "",
blanchet@33561
   194
          Pretty.mark Markup.hilite (pretty_counterex ctxt cex)])) state)
blanchet@33561
   195
    end
blanchet@33561
   196
blanchet@33561
   197
val setup = Auto_Counterexample.register_tool ("quickcheck", auto_quickcheck)
haftmann@28315
   198
haftmann@28315
   199
wenzelm@30980
   200
(* Isar commands *)
haftmann@28315
   201
haftmann@28336
   202
fun read_nat s = case (Library.read_int o Symbol.explode) s
haftmann@28336
   203
 of (k, []) => if k >= 0 then k
haftmann@28336
   204
      else error ("Not a natural number: " ^ s)
haftmann@28336
   205
  | (_, _ :: _) => error ("Not a natural number: " ^ s);
blanchet@34128
   206
fun read_bool "false" = false
blanchet@34128
   207
  | read_bool "true" = true
blanchet@34128
   208
  | read_bool s = error ("Not a Boolean value: " ^ s)
haftmann@28315
   209
haftmann@28336
   210
fun parse_test_param ctxt ("size", arg) =
haftmann@28336
   211
      (apfst o apfst o K) (read_nat arg)
haftmann@28336
   212
  | parse_test_param ctxt ("iterations", arg) =
haftmann@28336
   213
      (apfst o apsnd o K) (read_nat arg)
haftmann@28336
   214
  | parse_test_param ctxt ("default_type", arg) =
blanchet@34128
   215
      (apsnd o apfst o K o SOME) (ProofContext.read_typ ctxt arg)
blanchet@34128
   216
  | parse_test_param ctxt ("no_assms", arg) =
blanchet@34128
   217
      (apsnd o apsnd o K) (read_bool arg)
haftmann@28336
   218
  | parse_test_param ctxt (name, _) =
blanchet@34128
   219
      error ("Unknown test parameter: " ^ name);
haftmann@28315
   220
haftmann@28336
   221
fun parse_test_param_inst ctxt ("generator", arg) =
haftmann@28336
   222
      (apsnd o apfst o K o SOME) arg
haftmann@28336
   223
  | parse_test_param_inst ctxt (name, arg) =
haftmann@28336
   224
      case try (ProofContext.read_typ ctxt) name
haftmann@28336
   225
       of SOME (TFree (v, _)) => (apsnd o apsnd o AList.update (op =))
haftmann@28336
   226
              (v, ProofContext.read_typ ctxt arg)
haftmann@28336
   227
        | _ => (apfst o parse_test_param ctxt) (name, arg);
haftmann@28309
   228
haftmann@28336
   229
fun quickcheck_params_cmd args thy =
haftmann@28315
   230
  let
haftmann@28315
   231
    val ctxt = ProofContext.init thy;
haftmann@28336
   232
    val f = fold (parse_test_param ctxt) args;
haftmann@28315
   233
  in
haftmann@28315
   234
    thy
haftmann@28336
   235
    |> (Data.map o apsnd o map_test_params) f
haftmann@28315
   236
  end;
haftmann@28315
   237
boehmes@32297
   238
fun quickcheck args i state =
haftmann@28315
   239
  let
boehmes@32297
   240
    val thy = Proof.theory_of state;
boehmes@32297
   241
    val ctxt = Proof.context_of state;
blanchet@34128
   242
    val assms = map term_of (Assumption.all_assms_of ctxt);
haftmann@28315
   243
    val default_params = (dest_test_params o snd o Data.get) thy;
haftmann@28336
   244
    val f = fold (parse_test_param_inst ctxt) args;
blanchet@34128
   245
    val (((size, iterations), (default_type, no_assms)), (generator_name, insts)) =
haftmann@28336
   246
      f (default_params, (NONE, []));
boehmes@32297
   247
  in
blanchet@34128
   248
    test_goal false generator_name size iterations default_type no_assms insts i assms state
boehmes@32297
   249
  end;
boehmes@32297
   250
boehmes@32297
   251
fun quickcheck_cmd args i state =
boehmes@32297
   252
  quickcheck args i (Toplevel.proof_of state)
boehmes@32297
   253
  |> Pretty.writeln o pretty_counterex (Toplevel.context_of state);
haftmann@28309
   254
haftmann@28309
   255
local structure P = OuterParse and K = OuterKeyword in
haftmann@28309
   256
blanchet@34128
   257
val parse_arg = P.name -- (Scan.optional (P.$$$ "=" |-- P.name) "true")
blanchet@34128
   258
haftmann@28336
   259
val parse_args = P.$$$ "[" |-- P.list1 parse_arg --| P.$$$ "]"
haftmann@28336
   260
  || Scan.succeed [];
haftmann@28336
   261
haftmann@28315
   262
val _ = OuterSyntax.command "quickcheck_params" "set parameters for random testing" K.thy_decl
haftmann@28336
   263
  (parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
haftmann@28309
   264
haftmann@28315
   265
val _ = OuterSyntax.improper_command "quickcheck" "try to find counterexample for subgoal" K.diag
haftmann@28336
   266
  (parse_args -- Scan.optional P.nat 1
haftmann@28336
   267
    >> (fn (args, i) => Toplevel.no_timing o Toplevel.keep (quickcheck_cmd args i)));
haftmann@28309
   268
haftmann@28309
   269
end; (*local*)
haftmann@28309
   270
haftmann@28315
   271
end;
haftmann@28309
   272
haftmann@28309
   273
haftmann@28315
   274
val auto_quickcheck = Quickcheck.auto;