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