wenzelm@30826
|
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@34935
|
10 |
val timing : bool Unsynchronized.ref
|
wenzelm@30981
|
11 |
val test_term: Proof.context -> bool -> string option -> int -> int -> term ->
|
wenzelm@30981
|
12 |
(string * term) list option
|
wenzelm@30981
|
13 |
val add_generator: string * (Proof.context -> term -> int -> term list option) -> theory -> theory
|
blanchet@33552
|
14 |
val setup: theory -> theory
|
boehmes@32295
|
15 |
val quickcheck: (string * string) list -> int -> Proof.state -> (string * term) list option
|
haftmann@28256
|
16 |
end;
|
haftmann@28256
|
17 |
|
haftmann@28256
|
18 |
structure Quickcheck : QUICKCHECK =
|
haftmann@28256
|
19 |
struct
|
haftmann@28256
|
20 |
|
wenzelm@30981
|
21 |
(* preferences *)
|
wenzelm@30981
|
22 |
|
wenzelm@32740
|
23 |
val auto = Unsynchronized.ref false;
|
wenzelm@30981
|
24 |
|
bulwahn@34935
|
25 |
val timing = Unsynchronized.ref false;
|
bulwahn@34935
|
26 |
|
wenzelm@30981
|
27 |
val _ =
|
wenzelm@30981
|
28 |
ProofGeneralPgip.add_preference Preferences.category_tracing
|
wenzelm@32966
|
29 |
(setmp_CRITICAL auto true (fn () =>
|
wenzelm@30981
|
30 |
Preferences.bool_pref auto
|
wenzelm@30981
|
31 |
"auto-quickcheck"
|
blanchet@33552
|
32 |
"Whether to run Quickcheck automatically.") ());
|
wenzelm@30981
|
33 |
|
haftmann@30973
|
34 |
|
haftmann@28315
|
35 |
(* quickcheck configuration -- default parameters, test generators *)
|
haftmann@28315
|
36 |
|
haftmann@28309
|
37 |
datatype test_params = Test_Params of
|
blanchet@34125
|
38 |
{ size: int, iterations: int, default_type: typ option, no_assms: bool };
|
haftmann@28309
|
39 |
|
blanchet@34125
|
40 |
fun dest_test_params (Test_Params { size, iterations, default_type, no_assms }) =
|
blanchet@34125
|
41 |
((size, iterations), (default_type, no_assms));
|
blanchet@34125
|
42 |
fun make_test_params ((size, iterations), (default_type, no_assms)) =
|
blanchet@34125
|
43 |
Test_Params { size = size, iterations = iterations, default_type = default_type,
|
blanchet@34125
|
44 |
no_assms = no_assms };
|
blanchet@34125
|
45 |
fun map_test_params f (Test_Params { size, iterations, default_type, no_assms }) =
|
blanchet@34125
|
46 |
make_test_params (f ((size, iterations), (default_type, no_assms)));
|
blanchet@34125
|
47 |
fun merge_test_params (Test_Params { size = size1, iterations = iterations1, default_type = default_type1,
|
blanchet@34125
|
48 |
no_assms = no_assms1 },
|
blanchet@34125
|
49 |
Test_Params { size = size2, iterations = iterations2, default_type = default_type2,
|
blanchet@34125
|
50 |
no_assms = no_assms2 }) =
|
haftmann@31599
|
51 |
make_test_params ((Int.max (size1, size2), Int.max (iterations1, iterations2)),
|
blanchet@34125
|
52 |
(case default_type1 of NONE => default_type2 | _ => default_type1, no_assms1 orelse no_assms2));
|
haftmann@28309
|
53 |
|
wenzelm@33522
|
54 |
structure Data = Theory_Data
|
wenzelm@33522
|
55 |
(
|
haftmann@28309
|
56 |
type T = (string * (Proof.context -> term -> int -> term list option)) list
|
haftmann@28309
|
57 |
* test_params;
|
blanchet@34125
|
58 |
val empty = ([], Test_Params { size = 10, iterations = 100, default_type = NONE, no_assms = false });
|
haftmann@28256
|
59 |
val extend = I;
|
wenzelm@33522
|
60 |
fun merge ((generators1, params1), (generators2, params2)) : T =
|
wenzelm@33522
|
61 |
(AList.merge (op =) (K true) (generators1, generators2),
|
haftmann@28309
|
62 |
merge_test_params (params1, params2));
|
wenzelm@33522
|
63 |
);
|
haftmann@28256
|
64 |
|
haftmann@28309
|
65 |
val add_generator = Data.map o apfst o AList.update (op =);
|
haftmann@28256
|
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@28256
|
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@28256
|
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";
|
haftmann@31138
|
97 |
val frees = Term.add_frees t [];
|
haftmann@28309
|
98 |
in (map fst frees, list_abs_free (frees, t)) end
|
haftmann@28309
|
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;
|
bulwahn@34935
|
103 |
val testers = (*cond_timeit (!timing) "quickcheck compilation"
|
bulwahn@34935
|
104 |
(fn () => *)(case generator_name
|
bulwahn@34935
|
105 |
of NONE => if quiet then mk_testers ctxt t' else mk_testers_strict ctxt t'
|
bulwahn@34935
|
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);
|
bulwahn@34935
|
120 |
in
|
bulwahn@34935
|
121 |
cond_timeit (!timing) "quickcheck execution"
|
bulwahn@34935
|
122 |
(fn () => case with_size 1
|
bulwahn@34935
|
123 |
of NONE => NONE
|
bulwahn@34935
|
124 |
| SOME ts => SOME (names ~~ ts))
|
haftmann@28309
|
125 |
end;
|
haftmann@28309
|
126 |
|
haftmann@28309
|
127 |
fun monomorphic_term thy insts default_T =
|
haftmann@28309
|
128 |
let
|
haftmann@28309
|
129 |
fun subst (T as TFree (v, S)) =
|
haftmann@28309
|
130 |
let
|
haftmann@28309
|
131 |
val T' = AList.lookup (op =) insts v
|
haftmann@28309
|
132 |
|> the_default (the_default T default_T)
|
haftmann@28315
|
133 |
in if Sign.of_sort thy (T, S) then T'
|
haftmann@28309
|
134 |
else error ("Type " ^ Syntax.string_of_typ_global thy T ^
|
haftmann@28309
|
135 |
" to be substituted for variable " ^
|
haftmann@28309
|
136 |
Syntax.string_of_typ_global thy T ^ "\ndoes not have sort " ^
|
haftmann@28309
|
137 |
Syntax.string_of_sort_global thy S)
|
haftmann@28309
|
138 |
end
|
haftmann@28309
|
139 |
| subst T = T;
|
haftmann@28309
|
140 |
in (map_types o map_atyps) subst end;
|
haftmann@28309
|
141 |
|
blanchet@34125
|
142 |
fun test_goal quiet generator_name size iterations default_T no_assms insts i assms state =
|
haftmann@28309
|
143 |
let
|
haftmann@28309
|
144 |
val ctxt = Proof.context_of state;
|
haftmann@28309
|
145 |
val thy = Proof.theory_of state;
|
haftmann@28309
|
146 |
fun strip (Const ("all", _) $ Abs (_, _, t)) = strip t
|
haftmann@28309
|
147 |
| strip t = t;
|
wenzelm@33291
|
148 |
val {goal = st, ...} = Proof.raw_goal state;
|
haftmann@28309
|
149 |
val (gi, frees) = Logic.goal_params (prop_of st) i;
|
blanchet@34125
|
150 |
val gi' = Logic.list_implies (if no_assms then [] else assms,
|
blanchet@34125
|
151 |
subst_bounds (frees, strip gi))
|
haftmann@28309
|
152 |
|> monomorphic_term thy insts default_T
|
haftmann@28309
|
153 |
|> ObjectLogic.atomize_term thy;
|
haftmann@28315
|
154 |
in test_term ctxt quiet generator_name size iterations gi' end;
|
haftmann@28315
|
155 |
|
haftmann@28315
|
156 |
fun pretty_counterex ctxt NONE = Pretty.str "No counterexamples found."
|
haftmann@28315
|
157 |
| pretty_counterex ctxt (SOME cex) =
|
haftmann@28315
|
158 |
Pretty.chunks (Pretty.str "Counterexample found:\n" ::
|
haftmann@28315
|
159 |
map (fn (s, t) =>
|
haftmann@28315
|
160 |
Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) cex);
|
haftmann@28315
|
161 |
|
haftmann@28315
|
162 |
|
haftmann@28315
|
163 |
(* automatic testing *)
|
haftmann@28309
|
164 |
|
blanchet@33552
|
165 |
fun auto_quickcheck state =
|
blanchet@33552
|
166 |
if not (!auto) then
|
blanchet@33552
|
167 |
(false, state)
|
blanchet@33552
|
168 |
else
|
blanchet@33552
|
169 |
let
|
blanchet@33552
|
170 |
val ctxt = Proof.context_of state;
|
blanchet@33552
|
171 |
val assms = map term_of (Assumption.all_assms_of ctxt);
|
blanchet@34125
|
172 |
val Test_Params { size, iterations, default_type, no_assms } =
|
blanchet@33552
|
173 |
(snd o Data.get o Proof.theory_of) state;
|
blanchet@33552
|
174 |
val res =
|
blanchet@34125
|
175 |
try (test_goal true NONE size iterations default_type no_assms [] 1 assms) state;
|
blanchet@33552
|
176 |
in
|
blanchet@33552
|
177 |
case res of
|
blanchet@33552
|
178 |
NONE => (false, state)
|
blanchet@33552
|
179 |
| SOME NONE => (false, state)
|
blanchet@33552
|
180 |
| SOME cex => (true, Proof.goal_message (K (Pretty.chunks [Pretty.str "",
|
blanchet@33552
|
181 |
Pretty.mark Markup.hilite (pretty_counterex ctxt cex)])) state)
|
blanchet@33552
|
182 |
end
|
blanchet@33552
|
183 |
|
blanchet@33552
|
184 |
val setup = Auto_Counterexample.register_tool ("quickcheck", auto_quickcheck)
|
haftmann@28309
|
185 |
|
haftmann@28309
|
186 |
|
wenzelm@30981
|
187 |
(* Isar commands *)
|
haftmann@28315
|
188 |
|
haftmann@28336
|
189 |
fun read_nat s = case (Library.read_int o Symbol.explode) s
|
haftmann@28336
|
190 |
of (k, []) => if k >= 0 then k
|
haftmann@28336
|
191 |
else error ("Not a natural number: " ^ s)
|
haftmann@28336
|
192 |
| (_, _ :: _) => error ("Not a natural number: " ^ s);
|
blanchet@34125
|
193 |
fun read_bool "false" = false
|
blanchet@34125
|
194 |
| read_bool "true" = true
|
blanchet@34125
|
195 |
| read_bool s = error ("Not a Boolean value: " ^ s)
|
haftmann@28315
|
196 |
|
haftmann@28336
|
197 |
fun parse_test_param ctxt ("size", arg) =
|
haftmann@28336
|
198 |
(apfst o apfst o K) (read_nat arg)
|
haftmann@28336
|
199 |
| parse_test_param ctxt ("iterations", arg) =
|
haftmann@28336
|
200 |
(apfst o apsnd o K) (read_nat arg)
|
haftmann@28336
|
201 |
| parse_test_param ctxt ("default_type", arg) =
|
blanchet@34125
|
202 |
(apsnd o apfst o K o SOME) (ProofContext.read_typ ctxt arg)
|
blanchet@34125
|
203 |
| parse_test_param ctxt ("no_assms", arg) =
|
blanchet@34125
|
204 |
(apsnd o apsnd o K) (read_bool arg)
|
haftmann@28336
|
205 |
| parse_test_param ctxt (name, _) =
|
blanchet@34125
|
206 |
error ("Unknown test parameter: " ^ name);
|
haftmann@28315
|
207 |
|
haftmann@28336
|
208 |
fun parse_test_param_inst ctxt ("generator", arg) =
|
haftmann@28336
|
209 |
(apsnd o apfst o K o SOME) arg
|
haftmann@28336
|
210 |
| parse_test_param_inst ctxt (name, arg) =
|
haftmann@28336
|
211 |
case try (ProofContext.read_typ ctxt) name
|
haftmann@28336
|
212 |
of SOME (TFree (v, _)) => (apsnd o apsnd o AList.update (op =))
|
haftmann@28336
|
213 |
(v, ProofContext.read_typ ctxt arg)
|
haftmann@28336
|
214 |
| _ => (apfst o parse_test_param ctxt) (name, arg);
|
haftmann@28315
|
215 |
|
haftmann@28336
|
216 |
fun quickcheck_params_cmd args thy =
|
haftmann@28315
|
217 |
let
|
haftmann@28315
|
218 |
val ctxt = ProofContext.init thy;
|
haftmann@28336
|
219 |
val f = fold (parse_test_param ctxt) args;
|
haftmann@28315
|
220 |
in
|
haftmann@28315
|
221 |
thy
|
haftmann@28336
|
222 |
|> (Data.map o apsnd o map_test_params) f
|
haftmann@28315
|
223 |
end;
|
haftmann@28315
|
224 |
|
boehmes@32295
|
225 |
fun quickcheck args i state =
|
haftmann@28315
|
226 |
let
|
boehmes@32295
|
227 |
val thy = Proof.theory_of state;
|
boehmes@32295
|
228 |
val ctxt = Proof.context_of state;
|
blanchet@34125
|
229 |
val assms = map term_of (Assumption.all_assms_of ctxt);
|
haftmann@28315
|
230 |
val default_params = (dest_test_params o snd o Data.get) thy;
|
haftmann@28336
|
231 |
val f = fold (parse_test_param_inst ctxt) args;
|
blanchet@34125
|
232 |
val (((size, iterations), (default_type, no_assms)), (generator_name, insts)) =
|
haftmann@28336
|
233 |
f (default_params, (NONE, []));
|
boehmes@32295
|
234 |
in
|
blanchet@34125
|
235 |
test_goal false generator_name size iterations default_type no_assms insts i assms state
|
boehmes@32295
|
236 |
end;
|
boehmes@32295
|
237 |
|
boehmes@32295
|
238 |
fun quickcheck_cmd args i state =
|
boehmes@32295
|
239 |
quickcheck args i (Toplevel.proof_of state)
|
boehmes@32295
|
240 |
|> Pretty.writeln o pretty_counterex (Toplevel.context_of state);
|
haftmann@28309
|
241 |
|
haftmann@28309
|
242 |
local structure P = OuterParse and K = OuterKeyword in
|
haftmann@28309
|
243 |
|
blanchet@34125
|
244 |
val parse_arg = P.name -- (Scan.optional (P.$$$ "=" |-- P.name) "true")
|
blanchet@34125
|
245 |
|
haftmann@28336
|
246 |
val parse_args = P.$$$ "[" |-- P.list1 parse_arg --| P.$$$ "]"
|
haftmann@28336
|
247 |
|| Scan.succeed [];
|
haftmann@28336
|
248 |
|
haftmann@28315
|
249 |
val _ = OuterSyntax.command "quickcheck_params" "set parameters for random testing" K.thy_decl
|
haftmann@28336
|
250 |
(parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
|
haftmann@28309
|
251 |
|
haftmann@28315
|
252 |
val _ = OuterSyntax.improper_command "quickcheck" "try to find counterexample for subgoal" K.diag
|
haftmann@28336
|
253 |
(parse_args -- Scan.optional P.nat 1
|
haftmann@28336
|
254 |
>> (fn (args, i) => Toplevel.no_timing o Toplevel.keep (quickcheck_cmd args i)));
|
haftmann@28309
|
255 |
|
haftmann@28309
|
256 |
end; (*local*)
|
haftmann@28309
|
257 |
|
haftmann@28309
|
258 |
end;
|
haftmann@28256
|
259 |
|
haftmann@28315
|
260 |
|
haftmann@28315
|
261 |
val auto_quickcheck = Quickcheck.auto;
|