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