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