src/Tools/quickcheck.ML
author wenzelm
Sat Apr 25 21:28:04 2009 +0200 (2009-04-25)
changeset 30980 fe0855471964
parent 30973 304ab57afa6e
child 31138 a51ce445d498
permissions -rw-r--r--
misc cleanup of auto_solve and quickcheck:
tools are in src/Tools and loaded uniformly in HOL;
preferences are configured in their proper place -- despite old misleading comments in the source;
use predefined preferences categories;
setmp preferences in-place;
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
haftmann@28315
     9
  val auto: bool ref
haftmann@28315
    10
  val auto_time_limit: int ref
wenzelm@30980
    11
  val test_term: Proof.context -> bool -> string option -> int -> int -> term ->
wenzelm@30980
    12
    (string * term) list option
wenzelm@30980
    13
  val add_generator: string * (Proof.context -> term -> int -> term list option) -> theory -> theory
haftmann@28256
    14
end;
haftmann@28256
    15
haftmann@28256
    16
structure Quickcheck : QUICKCHECK =
haftmann@28256
    17
struct
haftmann@28256
    18
wenzelm@30980
    19
(* preferences *)
wenzelm@30980
    20
wenzelm@30980
    21
val auto = ref false;
wenzelm@30980
    22
val auto_time_limit = ref 2500;
wenzelm@30980
    23
wenzelm@30980
    24
val _ =
wenzelm@30980
    25
  ProofGeneralPgip.add_preference Preferences.category_tracing
wenzelm@30980
    26
  (setmp auto true (fn () =>
wenzelm@30980
    27
    Preferences.bool_pref auto
wenzelm@30980
    28
      "auto-quickcheck"
wenzelm@30980
    29
      "Whether to enable quickcheck automatically.") ());
wenzelm@30980
    30
wenzelm@30980
    31
val _ =
wenzelm@30980
    32
  ProofGeneralPgip.add_preference Preferences.category_tracing
wenzelm@30980
    33
    (Preferences.nat_pref auto_time_limit
wenzelm@30980
    34
      "auto-quickcheck-time-limit"
wenzelm@30980
    35
      "Time limit for automatic quickcheck (in milliseconds).");
wenzelm@30980
    36
haftmann@30973
    37
haftmann@28315
    38
(* quickcheck configuration -- default parameters, test generators *)
haftmann@28315
    39
haftmann@28309
    40
datatype test_params = Test_Params of
haftmann@28309
    41
  { size: int, iterations: int, default_type: typ option };
haftmann@28309
    42
haftmann@30973
    43
fun dest_test_params (Test_Params { size, iterations, default_type }) =
haftmann@28315
    44
  ((size, iterations), default_type);
haftmann@28309
    45
fun mk_test_params ((size, iterations), default_type) =
haftmann@28309
    46
  Test_Params { size = size, iterations = iterations, default_type = default_type };
haftmann@28309
    47
fun map_test_params f (Test_Params { size, iterations, default_type}) =
haftmann@28309
    48
  mk_test_params (f ((size, iterations), default_type));
haftmann@30973
    49
fun merge_test_params (Test_Params { size = size1, iterations = iterations1, default_type = default_type1 },
haftmann@30973
    50
  Test_Params { size = size2, iterations = iterations2, default_type = default_type2 }) =
haftmann@28309
    51
  mk_test_params ((Int.max (size1, size2), Int.max (iterations1, iterations2)),
haftmann@28309
    52
    case default_type1 of NONE => default_type2 | _ => default_type1);
haftmann@28309
    53
haftmann@28309
    54
structure Data = TheoryDataFun(
haftmann@28309
    55
  type T = (string * (Proof.context -> term -> int -> term list option)) list
haftmann@28309
    56
    * test_params;
haftmann@28309
    57
  val empty = ([], Test_Params { size = 10, iterations = 100, default_type = NONE });
haftmann@28256
    58
  val copy = I;
haftmann@28256
    59
  val extend = I;
haftmann@28309
    60
  fun merge pp ((generators1, params1), (generators2, params2)) =
haftmann@28309
    61
    (AList.merge (op = : string * string -> bool) (K true) (generators1, generators2),
haftmann@28309
    62
      merge_test_params (params1, params2));
haftmann@28256
    63
)
haftmann@28256
    64
haftmann@28309
    65
val add_generator = Data.map o apfst o AList.update (op =);
haftmann@28309
    66
haftmann@28315
    67
haftmann@28315
    68
(* generating tests *)
haftmann@28315
    69
haftmann@28309
    70
fun mk_tester_select name ctxt =
haftmann@28309
    71
  case AList.lookup (op =) ((fst o Data.get o ProofContext.theory_of) ctxt) name
haftmann@28309
    72
   of NONE => error ("No such quickcheck generator: " ^ name)
haftmann@28309
    73
    | SOME generator => generator ctxt;
haftmann@28309
    74
haftmann@28309
    75
fun mk_testers ctxt t =
haftmann@28309
    76
  (map snd o fst o Data.get o ProofContext.theory_of) ctxt
haftmann@28309
    77
  |> map_filter (fn generator => try (generator ctxt) t);
haftmann@28309
    78
haftmann@28309
    79
fun mk_testers_strict ctxt t =
haftmann@28309
    80
  let
haftmann@28309
    81
    val generators = ((map snd o fst o Data.get o ProofContext.theory_of) ctxt)
haftmann@28309
    82
    val testers = map (fn generator => Exn.capture (generator ctxt) t) generators;
haftmann@28309
    83
  in if forall (is_none o Exn.get_result) testers
haftmann@28309
    84
    then [(Exn.release o snd o split_last) testers]
haftmann@28309
    85
    else map_filter Exn.get_result testers
haftmann@28309
    86
  end;
haftmann@28309
    87
haftmann@28315
    88
haftmann@28315
    89
(* testing propositions *)
haftmann@28315
    90
haftmann@28309
    91
fun prep_test_term t =
haftmann@28309
    92
  let
wenzelm@29266
    93
    val _ = (null (Term.add_tvars t []) andalso null (Term.add_tfrees t [])) orelse
haftmann@28309
    94
      error "Term to be tested contains type variables";
wenzelm@29266
    95
    val _ = null (Term.add_vars t []) orelse
haftmann@28309
    96
      error "Term to be tested contains schematic variables";
wenzelm@29266
    97
    val frees = map dest_Free (OldTerm.term_frees t);
haftmann@28309
    98
  in (map fst frees, list_abs_free (frees, t)) end
haftmann@28256
    99
haftmann@28315
   100
fun test_term ctxt quiet generator_name size i t =
haftmann@28309
   101
  let
haftmann@28309
   102
    val (names, t') = prep_test_term t;
haftmann@28309
   103
    val testers = case generator_name
haftmann@28309
   104
     of NONE => if quiet then mk_testers ctxt t' else mk_testers_strict ctxt t'
haftmann@28309
   105
      | SOME name => [mk_tester_select name ctxt t'];
haftmann@28309
   106
    fun iterate f 0 = NONE
haftmann@28309
   107
      | iterate f k = case f () handle Match => (if quiet then ()
haftmann@28309
   108
             else warning "Exception Match raised during quickcheck"; NONE)
haftmann@28309
   109
          of NONE => iterate f (k - 1) | SOME q => SOME q;
haftmann@28309
   110
    fun with_testers k [] = NONE
haftmann@28309
   111
      | with_testers k (tester :: testers) =
haftmann@28309
   112
          case iterate (fn () => tester k) i
haftmann@28309
   113
           of NONE => with_testers k testers
haftmann@28309
   114
            | SOME q => SOME q;
haftmann@28309
   115
    fun with_size k = if k > size then NONE
haftmann@28309
   116
      else (if quiet then () else priority ("Test data size: " ^ string_of_int k);
haftmann@28309
   117
        case with_testers k testers
haftmann@28309
   118
         of NONE => with_size (k + 1) | SOME q => SOME q);
haftmann@28309
   119
  in case with_size 1
haftmann@28309
   120
   of NONE => NONE
haftmann@28309
   121
    | SOME ts => SOME (names ~~ ts)
haftmann@28309
   122
  end;
haftmann@28309
   123
haftmann@28309
   124
fun monomorphic_term thy insts default_T = 
haftmann@28309
   125
  let
haftmann@28309
   126
    fun subst (T as TFree (v, S)) =
haftmann@28309
   127
          let
haftmann@28309
   128
            val T' = AList.lookup (op =) insts v
haftmann@28309
   129
              |> the_default (the_default T default_T)
haftmann@28315
   130
          in if Sign.of_sort thy (T, S) then T'
haftmann@28309
   131
            else error ("Type " ^ Syntax.string_of_typ_global thy T ^
haftmann@28309
   132
              " to be substituted for variable " ^
haftmann@28309
   133
              Syntax.string_of_typ_global thy T ^ "\ndoes not have sort " ^
haftmann@28309
   134
              Syntax.string_of_sort_global thy S)
haftmann@28309
   135
          end
haftmann@28309
   136
      | subst T = T;
haftmann@28309
   137
  in (map_types o map_atyps) subst end;
haftmann@28309
   138
haftmann@28315
   139
fun test_goal quiet generator_name size iterations default_T insts i assms state =
haftmann@28309
   140
  let
haftmann@28309
   141
    val ctxt = Proof.context_of state;
haftmann@28309
   142
    val thy = Proof.theory_of state;
haftmann@28309
   143
    fun strip (Const ("all", _) $ Abs (_, _, t)) = strip t
haftmann@28309
   144
      | strip t = t;
haftmann@28309
   145
    val (_, (_, st)) = Proof.get_goal state;
haftmann@28309
   146
    val (gi, frees) = Logic.goal_params (prop_of st) i;
haftmann@28309
   147
    val gi' = Logic.list_implies (assms, subst_bounds (frees, strip gi))
haftmann@28309
   148
      |> monomorphic_term thy insts default_T
haftmann@28309
   149
      |> ObjectLogic.atomize_term thy;
haftmann@28315
   150
  in test_term ctxt quiet generator_name size iterations gi' end;
haftmann@28315
   151
haftmann@28315
   152
fun pretty_counterex ctxt NONE = Pretty.str "No counterexamples found."
haftmann@28315
   153
  | pretty_counterex ctxt (SOME cex) =
haftmann@28315
   154
      Pretty.chunks (Pretty.str "Counterexample found:\n" ::
haftmann@28315
   155
        map (fn (s, t) =>
haftmann@28315
   156
          Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) cex);
haftmann@28315
   157
haftmann@28315
   158
haftmann@28315
   159
(* automatic testing *)
haftmann@28309
   160
wenzelm@30980
   161
val _ = Context.>> (Specification.add_theorem_hook (fn int => fn state =>
haftmann@28309
   162
  let
haftmann@28309
   163
    val ctxt = Proof.context_of state;
wenzelm@30473
   164
    val assms = map term_of (Assumption.all_assms_of ctxt);
haftmann@28309
   165
    val Test_Params { size, iterations, default_type } =
haftmann@28309
   166
      (snd o Data.get o Proof.theory_of) state;
haftmann@28309
   167
    fun test () =
haftmann@28309
   168
      let
haftmann@28309
   169
        val res = TimeLimit.timeLimit (Time.fromMilliseconds (!auto_time_limit))
haftmann@28315
   170
          (try (test_goal true NONE size iterations default_type [] 1 assms)) state;
haftmann@28309
   171
      in
haftmann@28309
   172
        case res of
haftmann@28309
   173
          NONE => state
haftmann@28309
   174
        | SOME NONE => state
haftmann@28309
   175
        | SOME cex => Proof.goal_message (fn () => Pretty.chunks [Pretty.str "",
haftmann@28309
   176
            Pretty.mark Markup.hilite (pretty_counterex ctxt cex)]) state
haftmann@28309
   177
      end handle TimeLimit.TimeOut => (warning "Auto quickcheck: timeout."; state);
haftmann@28309
   178
  in
haftmann@28309
   179
    if int andalso !auto andalso not (!Toplevel.quiet)
haftmann@28309
   180
    then test ()
haftmann@28309
   181
    else state
wenzelm@30980
   182
  end));
haftmann@28315
   183
haftmann@28315
   184
wenzelm@30980
   185
(* Isar commands *)
haftmann@28315
   186
haftmann@28336
   187
fun read_nat s = case (Library.read_int o Symbol.explode) s
haftmann@28336
   188
 of (k, []) => if k >= 0 then k
haftmann@28336
   189
      else error ("Not a natural number: " ^ s)
haftmann@28336
   190
  | (_, _ :: _) => error ("Not a natural number: " ^ s);
haftmann@28315
   191
haftmann@28336
   192
fun parse_test_param ctxt ("size", arg) =
haftmann@28336
   193
      (apfst o apfst o K) (read_nat arg)
haftmann@28336
   194
  | parse_test_param ctxt ("iterations", arg) =
haftmann@28336
   195
      (apfst o apsnd o K) (read_nat arg)
haftmann@28336
   196
  | parse_test_param ctxt ("default_type", arg) =
haftmann@28336
   197
      (apsnd o K o SOME) (ProofContext.read_typ ctxt arg)
haftmann@28336
   198
  | parse_test_param ctxt (name, _) =
haftmann@28336
   199
      error ("Bad test parameter: " ^ name);
haftmann@28315
   200
haftmann@28336
   201
fun parse_test_param_inst ctxt ("generator", arg) =
haftmann@28336
   202
      (apsnd o apfst o K o SOME) arg
haftmann@28336
   203
  | parse_test_param_inst ctxt (name, arg) =
haftmann@28336
   204
      case try (ProofContext.read_typ ctxt) name
haftmann@28336
   205
       of SOME (TFree (v, _)) => (apsnd o apsnd o AList.update (op =))
haftmann@28336
   206
              (v, ProofContext.read_typ ctxt arg)
haftmann@28336
   207
        | _ => (apfst o parse_test_param ctxt) (name, arg);
haftmann@28309
   208
haftmann@28336
   209
fun quickcheck_params_cmd args thy =
haftmann@28315
   210
  let
haftmann@28315
   211
    val ctxt = ProofContext.init thy;
haftmann@28336
   212
    val f = fold (parse_test_param ctxt) args;
haftmann@28315
   213
  in
haftmann@28315
   214
    thy
haftmann@28336
   215
    |> (Data.map o apsnd o map_test_params) f
haftmann@28315
   216
  end;
haftmann@28315
   217
haftmann@28336
   218
fun quickcheck_cmd args i state =
haftmann@28315
   219
  let
haftmann@28315
   220
    val prf = Toplevel.proof_of state;
haftmann@28315
   221
    val thy = Toplevel.theory_of state;
haftmann@28315
   222
    val ctxt = Toplevel.context_of state;
haftmann@28315
   223
    val default_params = (dest_test_params o snd o Data.get) thy;
haftmann@28336
   224
    val f = fold (parse_test_param_inst ctxt) args;
haftmann@28315
   225
    val (((size, iterations), default_type), (generator_name, insts)) =
haftmann@28336
   226
      f (default_params, (NONE, []));
haftmann@28315
   227
    val counterex = test_goal false generator_name size iterations
haftmann@28315
   228
      default_type insts i [] prf;
haftmann@28315
   229
  in (Pretty.writeln o pretty_counterex ctxt) counterex end;
haftmann@28309
   230
haftmann@28309
   231
local structure P = OuterParse and K = OuterKeyword in
haftmann@28309
   232
haftmann@28336
   233
val parse_arg = P.name --| P.$$$ "=" -- P.name;
haftmann@28336
   234
val parse_args = P.$$$ "[" |-- P.list1 parse_arg --| P.$$$ "]"
haftmann@28336
   235
  || Scan.succeed [];
haftmann@28336
   236
haftmann@28315
   237
val _ = OuterSyntax.command "quickcheck_params" "set parameters for random testing" K.thy_decl
haftmann@28336
   238
  (parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
haftmann@28309
   239
haftmann@28315
   240
val _ = OuterSyntax.improper_command "quickcheck" "try to find counterexample for subgoal" K.diag
haftmann@28336
   241
  (parse_args -- Scan.optional P.nat 1
haftmann@28336
   242
    >> (fn (args, i) => Toplevel.no_timing o Toplevel.keep (quickcheck_cmd args i)));
haftmann@28309
   243
haftmann@28309
   244
end; (*local*)
haftmann@28309
   245
haftmann@28315
   246
end;
haftmann@28309
   247
haftmann@28309
   248
haftmann@28315
   249
val auto_quickcheck = Quickcheck.auto;
haftmann@28315
   250
val auto_quickcheck_time_limit = Quickcheck.auto_time_limit;