src/Tools/quickcheck.ML
author blanchet
Mon, 15 Sep 2014 10:49:07 +0200
changeset 58335 a5a3b576fcfb
parent 57195 ec0e10f11276
child 58842 22b87ab47d3b
permissions -rw-r--r--
generate 'code' attribute only if 'code' plugin is enabled
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30824
bc6b24882834 fixed header;
wenzelm
parents: 30473
diff changeset
     1
(*  Title:      Tools/quickcheck.ML
40246
c03fc7d3fa97 changed global fixed timeout to a configurable timeout for quickcheck; test parameters in quickcheck are now fully passed around with the context
bulwahn
parents: 40225
diff changeset
     2
    Author:     Stefan Berghofer, Florian Haftmann, Lukas Bulwahn, TU Muenchen
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     3
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     4
Generic counterexample search engine.
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     5
*)
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     6
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     7
signature QUICKCHECK =
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
     8
sig
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
     9
  val quickcheckN: string
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
    10
  val genuineN: string
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
    11
  val noneN: string
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
    12
  val unknownN: string
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    13
  (*configuration*)
43882
05d5696f177f renaming quickcheck_tester to quickcheck_batch_tester; tuned
bulwahn
parents: 43881
diff changeset
    14
  val batch_tester : string Config.T
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    15
  val size : int Config.T
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    16
  val iterations : int Config.T
45213
92e03ea2b5cf adding depth as an quickcheck configuration
bulwahn
parents: 45159
diff changeset
    17
  val depth : int Config.T
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    18
  val no_assms : bool Config.T
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    19
  val report : bool Config.T
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
    20
  val timeout : real Config.T
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    21
  val timing : bool Config.T
45757
e32dd098f57a renaming potential flag to genuine_only flag with an inverse semantics
bulwahn
parents: 45755
diff changeset
    22
  val genuine_only : bool Config.T
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    23
  val abort_potential : bool Config.T
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    24
  val quiet : bool Config.T
45764
1672be34581a adding verbose configuration to quickcheck
bulwahn
parents: 45757
diff changeset
    25
  val verbose : bool Config.T
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
    26
  val use_subtype : bool Config.T
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
    27
  val allow_function_inversion : bool Config.T
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
    28
  val finite_types : bool Config.T
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
    29
  val finite_type_size : int Config.T
46863
56376f6be74f adding tags to quickcheck's result
bulwahn
parents: 46759
diff changeset
    30
  val tag : string Config.T
47348
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
    31
  val locale : string Config.T
43912
13e6a4e70219 exporting function in quickcheck; adapting mutabelle script
bulwahn
parents: 43884
diff changeset
    32
  val set_active_testers: string list -> Context.generic -> Context.generic
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
    33
  datatype expectation = No_Expectation | No_Counterexample | Counterexample;
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    34
  datatype test_params = Test_Params of {default_type: typ list, expect : expectation};
40246
c03fc7d3fa97 changed global fixed timeout to a configurable timeout for quickcheck; test parameters in quickcheck are now fully passed around with the context
bulwahn
parents: 40225
diff changeset
    35
  val test_params_of : Proof.context -> test_params
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
    36
  val map_test_params : (typ list * expectation -> typ list * expectation)
40246
c03fc7d3fa97 changed global fixed timeout to a configurable timeout for quickcheck; test parameters in quickcheck are now fully passed around with the context
bulwahn
parents: 40225
diff changeset
    37
    -> Context.generic -> Context.generic
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    38
  val default_type : Proof.context -> typ list
42089
904897d0c5bd adapting mutabelle; exporting more Quickcheck functions
bulwahn
parents: 42088
diff changeset
    39
  datatype report = Report of
904897d0c5bd adapting mutabelle; exporting more Quickcheck functions
bulwahn
parents: 42088
diff changeset
    40
    { iterations : int, raised_match_errors : int,
904897d0c5bd adapting mutabelle; exporting more Quickcheck functions
bulwahn
parents: 42088
diff changeset
    41
      satisfied_assms : int list, positive_concl_tests : int }
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    42
  (*quickcheck's result*)
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    43
  datatype result =
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    44
    Result of
45727
5e46c225370e extending quickcheck's result by the genuine flag
bulwahn
parents: 45682
diff changeset
    45
     {counterexample : (bool * (string * term) list) option,
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    46
      evaluation_terms : (term * term) list option,
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    47
      timings : (string * int) list,
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
    48
      reports : (int * report) list}
43314
a9090cabca14 adding a nicer error message for quickcheck_narrowing; hiding fact empty_def
bulwahn
parents: 43147
diff changeset
    49
  val empty_result : result
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    50
  val found_counterexample : result -> bool
43585
ea959ab7bbe3 adding timeout to quickcheck narrowing
bulwahn
parents: 43314
diff changeset
    51
  val add_timing : (string * int) -> result Unsynchronized.ref -> unit
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    52
  val add_response : string list -> term list -> (bool * term list) option ->
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    53
    result Unsynchronized.ref -> unit
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    54
  val add_report : int -> report option -> result Unsynchronized.ref -> unit
45727
5e46c225370e extending quickcheck's result by the genuine flag
bulwahn
parents: 45682
diff changeset
    55
  val counterexample_of : result -> (bool * (string * term) list) option
42089
904897d0c5bd adapting mutabelle; exporting more Quickcheck functions
bulwahn
parents: 42088
diff changeset
    56
  val timings_of : result -> (string * int) list
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    57
  (*registering testers & generators*)
43878
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
    58
  type tester =
45419
10ba32c347b0 quickcheck fails with code generator errors only if one tester is invoked
bulwahn
parents: 45418
diff changeset
    59
    Proof.context -> bool -> (string * typ) list -> (term * term list) list -> result list
43878
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
    60
  val add_tester : string * (bool Config.T * tester) -> Context.generic -> Context.generic
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
    61
  val add_batch_generator :
43112
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
    62
    string * (Proof.context -> term list -> (int -> term list option) list)
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
    63
      -> Context.generic -> Context.generic
43878
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
    64
  val add_batch_validator :
43112
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
    65
    string * (Proof.context -> term list -> (int -> bool) list)
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
    66
      -> Context.generic -> Context.generic
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    67
  (*basic operations*)
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    68
  val message : Proof.context -> string -> unit
45765
cb6ddee6a463 making the default behaviour of quickcheck a little bit less verbose;
bulwahn
parents: 45764
diff changeset
    69
  val verbose_message : Proof.context -> string -> unit
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    70
  val limit : Time.time -> (bool * bool) -> (unit -> 'a) -> (unit -> 'a) -> unit -> 'a
45755
b27a06dfb2ef outputing the potentially spurious counterexample and continue search
bulwahn
parents: 45730
diff changeset
    71
  val pretty_counterex : Proof.context -> bool ->
b27a06dfb2ef outputing the potentially spurious counterexample and continue search
bulwahn
parents: 45730
diff changeset
    72
    ((bool * (string * term) list) * (term * term) list) option -> Pretty.T
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    73
  (*testing terms and proof states*)
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    74
  val mk_batch_validator : Proof.context -> term list -> (int -> bool) list option
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    75
  val mk_batch_tester : Proof.context -> term list -> (int -> term list option) list option
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
    76
  val active_testers : Proof.context -> tester list
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    77
  val test_terms : Proof.context -> bool * bool -> (string * typ) list ->
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    78
    (term * term list) list -> result list option
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    79
  val quickcheck: (string * string list) list -> int -> Proof.state ->
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    80
    (bool * (string * term) list) option
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    81
end;
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    82
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    83
structure Quickcheck : QUICKCHECK =
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    84
struct
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
    85
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
    86
val quickcheckN = "quickcheck";
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
    87
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
    88
val genuineN = "genuine";
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
    89
val noneN = "none";
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
    90
val unknownN = "unknown";
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
    91
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
    92
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    93
(* preferences *)
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    94
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
    95
val _ =
52639
df830310e550 system options for Isabelle/HOL proof tools;
wenzelm
parents: 52017
diff changeset
    96
  ProofGeneral.preference_option ProofGeneral.category_tracing
52645
e8c1c5612677 clarified some default options;
wenzelm
parents: 52643
diff changeset
    97
    NONE
56467
8d7d6f17c6a7 more uniform ML/document antiquotations;
wenzelm
parents: 56245
diff changeset
    98
    @{system_option auto_quickcheck}
52017
bc0238c1f73a clarified preferences: "override" re-initialized on prover startup, and "default" sent to PG -- thus recover typical defaults like auto-quickcheck in PG 4.x;
wenzelm
parents: 52007
diff changeset
    99
    "auto-quickcheck"
bc0238c1f73a clarified preferences: "override" re-initialized on prover startup, and "default" sent to PG -- thus recover typical defaults like auto-quickcheck in PG 4.x;
wenzelm
parents: 52007
diff changeset
   100
    "Run Quickcheck automatically";
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
   101
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   102
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   103
(* quickcheck report *)
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   104
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   105
datatype report = Report of
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   106
 {iterations : int,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   107
  raised_match_errors : int,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   108
  satisfied_assms : int list,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   109
  positive_concl_tests : int};
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   110
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   111
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   112
(* Quickcheck Result *)
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   113
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   114
datatype result = Result of
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   115
 {counterexample : (bool * (string * term) list) option,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   116
  evaluation_terms : (term * term) list option,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   117
  timings : (string * int) list,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   118
  reports : (int * report) list};
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   119
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   120
val empty_result =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   121
  Result {counterexample = NONE, evaluation_terms = NONE, timings = [], reports = []};
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   122
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   123
fun counterexample_of (Result r) = #counterexample r;
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   124
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   125
fun found_counterexample (Result r) = is_some (#counterexample r);
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   126
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   127
fun response_of (Result r) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   128
  (case (#counterexample r, #evaluation_terms r) of
45730
6bd0acefaedb outputing if counterexample is potentially spurious or not
bulwahn
parents: 45727
diff changeset
   129
    (SOME ts, SOME evals) => SOME (ts, evals)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   130
  | (NONE, NONE) => NONE);
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   131
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   132
fun timings_of (Result r) = #timings r;
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   133
45727
5e46c225370e extending quickcheck's result by the genuine flag
bulwahn
parents: 45682
diff changeset
   134
fun set_response names eval_terms (SOME (genuine, ts)) (Result r) =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   135
      let
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   136
        val (ts1, ts2) = chop (length names) ts
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   137
        val (eval_terms', _) = chop (length ts2) eval_terms
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   138
      in
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   139
        Result {counterexample = SOME (genuine, (names ~~ ts1)),
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   140
          evaluation_terms = SOME (eval_terms' ~~ ts2),
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   141
          timings = #timings r, reports = #reports r}
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   142
      end
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   143
  | set_response _ _ NONE result = result;
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   144
43585
ea959ab7bbe3 adding timeout to quickcheck narrowing
bulwahn
parents: 43314
diff changeset
   145
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   146
fun cons_timing timing (Result r) =
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   147
  Result {counterexample = #counterexample r, evaluation_terms = #evaluation_terms r,
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   148
    timings = cons timing (#timings r), reports = #reports r};
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   149
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   150
fun cons_report size (SOME report) (Result r) =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   151
      Result {counterexample = #counterexample r, evaluation_terms = #evaluation_terms r,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   152
        timings = #timings r, reports = cons (size, report) (#reports r)}
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   153
  | cons_report _ NONE result = result;
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   154
42198
ded5ba6b7bac use Unsynchronized.change convenience, which also emphasizes the raw access to these references (which happen to be local here);
wenzelm
parents: 42194
diff changeset
   155
fun add_timing timing result_ref =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   156
  Unsynchronized.change result_ref (cons_timing timing);
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   157
42198
ded5ba6b7bac use Unsynchronized.change convenience, which also emphasizes the raw access to these references (which happen to be local here);
wenzelm
parents: 42194
diff changeset
   158
fun add_report size report result_ref =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   159
  Unsynchronized.change result_ref (cons_report size report);
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   160
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   161
fun add_response names eval_terms response result_ref =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   162
  Unsynchronized.change result_ref (set_response names eval_terms response);
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   163
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   164
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   165
(* expectation *)
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   166
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   167
datatype expectation = No_Expectation | No_Counterexample | Counterexample;
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   168
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   169
fun merge_expectation (expect1, expect2) =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   170
  if expect1 = expect2 then expect1 else No_Expectation;
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   171
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   172
(*quickcheck configuration -- default parameters, test generators*)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   173
val batch_tester = Attrib.setup_config_string @{binding quickcheck_batch_tester} (K "");
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   174
val size = Attrib.setup_config_int @{binding quickcheck_size} (K 10);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   175
val iterations = Attrib.setup_config_int @{binding quickcheck_iterations} (K 100);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   176
val depth = Attrib.setup_config_int @{binding quickcheck_depth} (K 10);
45213
92e03ea2b5cf adding depth as an quickcheck configuration
bulwahn
parents: 45159
diff changeset
   177
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   178
val no_assms = Attrib.setup_config_bool @{binding quickcheck_no_assms} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   179
val locale = Attrib.setup_config_string @{binding quickcheck_locale} (K "interpret expand");
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   180
val report = Attrib.setup_config_bool @{binding quickcheck_report} (K true);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   181
val timing = Attrib.setup_config_bool @{binding quickcheck_timing} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   182
val timeout = Attrib.setup_config_real @{binding quickcheck_timeout} (K 30.0);
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
   183
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   184
val genuine_only = Attrib.setup_config_bool @{binding quickcheck_genuine_only} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   185
val abort_potential = Attrib.setup_config_bool @{binding quickcheck_abort_potential} (K false);
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
   186
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   187
val quiet = Attrib.setup_config_bool @{binding quickcheck_quiet} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   188
val verbose = Attrib.setup_config_bool @{binding quickcheck_verbose} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   189
val tag = Attrib.setup_config_string @{binding quickcheck_tag} (K "");
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
   190
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   191
val use_subtype = Attrib.setup_config_bool @{binding quickcheck_use_subtype} (K false);
46565
ad21900e0ee9 subtype preprocessing in Quickcheck;
bulwahn
parents: 46477
diff changeset
   192
45449
eeffd04cd899 adding option allow_function_inversion to quickcheck options
bulwahn
parents: 45419
diff changeset
   193
val allow_function_inversion =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   194
  Attrib.setup_config_bool @{binding quickcheck_allow_function_inversion} (K false);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   195
val finite_types = Attrib.setup_config_bool @{binding quickcheck_finite_types} (K true);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   196
val finite_type_size = Attrib.setup_config_int @{binding quickcheck_finite_type_size} (K 3);
40646
3dfa41e89738 adding option finite_types to quickcheck
bulwahn
parents: 40644
diff changeset
   197
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   198
datatype test_params = Test_Params of
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   199
  {default_type: typ list, expect : expectation};
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   200
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   201
fun dest_test_params (Test_Params {default_type, expect}) = (default_type, expect);
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   202
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   203
fun make_test_params (default_type, expect) =
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   204
  Test_Params {default_type = default_type, expect = expect};
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   205
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   206
fun map_test_params' f (Test_Params {default_type, expect}) =
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   207
  make_test_params (f (default_type, expect));
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   208
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   209
fun merge_test_params
41472
f6ab14e61604 misc tuning and comments based on review of Theory_Data, Proof_Data, Generic_Data usage;
wenzelm
parents: 41086
diff changeset
   210
  (Test_Params {default_type = default_type1, expect = expect1},
f6ab14e61604 misc tuning and comments based on review of Theory_Data, Proof_Data, Generic_Data usage;
wenzelm
parents: 41086
diff changeset
   211
    Test_Params {default_type = default_type2, expect = expect2}) =
f6ab14e61604 misc tuning and comments based on review of Theory_Data, Proof_Data, Generic_Data usage;
wenzelm
parents: 41086
diff changeset
   212
  make_test_params
f6ab14e61604 misc tuning and comments based on review of Theory_Data, Proof_Data, Generic_Data usage;
wenzelm
parents: 41086
diff changeset
   213
    (merge (op =) (default_type1, default_type2), merge_expectation (expect1, expect2));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   214
43878
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
   215
type tester =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   216
  Proof.context -> bool -> (string * typ) list -> (term * term list) list -> result list;
43878
eeb10fdd9535 changed every tester to have a configuration in quickcheck; enabling parallel testing of different testers in quickcheck
bulwahn
parents: 43877
diff changeset
   217
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   218
structure Data = Generic_Data
33522
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   219
(
38759
37a9092de102 simplification/standardization of some theory data;
wenzelm
parents: 38390
diff changeset
   220
  type T =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   221
    ((string * (bool Config.T * tester)) list *
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   222
      ((string * (Proof.context -> term list -> (int -> term list option) list)) list *
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   223
      ((string * (Proof.context -> term list -> (int -> bool) list)) list))) *
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   224
      test_params;
43877
abd1f074cb98 removing generator registration
bulwahn
parents: 43876
diff changeset
   225
  val empty = (([], ([], [])), Test_Params {default_type = [], expect = No_Expectation});
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
   226
  val extend = I;
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   227
  fun merge
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   228
   (((testers1, (batch_generators1, batch_validators1)), params1),
43877
abd1f074cb98 removing generator registration
bulwahn
parents: 43876
diff changeset
   229
    ((testers2, (batch_generators2, batch_validators2)), params2)) : T =
abd1f074cb98 removing generator registration
bulwahn
parents: 43876
diff changeset
   230
    ((AList.merge (op =) (K true) (testers1, testers2),
43112
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
   231
      (AList.merge (op =) (K true) (batch_generators1, batch_generators2),
3117573292b8 adding registration of testers in Quickcheck for its use in Quickcheck_Narrowing
bulwahn
parents: 43029
diff changeset
   232
       AList.merge (op =) (K true) (batch_validators1, batch_validators2))),
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   233
      merge_test_params (params1, params2));
33522
737589bb9bb8 adapted Theory_Data;
wenzelm
parents: 33291
diff changeset
   234
);
28256
4e7f7d52f855 added quickcheck.ML
haftmann
parents:
diff changeset
   235
39252
8f176e575a49 changing the container for the quickcheck options to a generic data
bulwahn
parents: 39138
diff changeset
   236
val test_params_of = snd o Data.get o Context.Proof;
37910
555287ba8d8d reordering quickcheck signature; exporting test_params and inspection function
bulwahn
parents: 37909
diff changeset
   237
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   238
val default_type = fst o dest_test_params o test_params_of;
40246
c03fc7d3fa97 changed global fixed timeout to a configurable timeout for quickcheck; test parameters in quickcheck are now fully passed around with the context
bulwahn
parents: 40225
diff changeset
   239
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   240
val expect = snd o dest_test_params o test_params_of;
40246
c03fc7d3fa97 changed global fixed timeout to a configurable timeout for quickcheck; test parameters in quickcheck are now fully passed around with the context
bulwahn
parents: 40225
diff changeset
   241
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   242
val map_test_params = Data.map o apsnd o map_test_params';
39253
0c47d615a69b removing report from the arguments of the quickcheck functions and refering to it by picking it from the context
bulwahn
parents: 39252
diff changeset
   243
43877
abd1f074cb98 removing generator registration
bulwahn
parents: 43876
diff changeset
   244
val add_tester = Data.map o apfst o apfst o AList.update (op =);
41862
a38536bf2736 adding function Quickcheck.test_terms to provide checking a batch of terms
bulwahn
parents: 41754
diff changeset
   245
42194
bd416284a432 adding general interface for batch validators in quickcheck
bulwahn
parents: 42188
diff changeset
   246
val add_batch_generator = Data.map o apfst o apsnd o apfst o AList.update (op =);
bd416284a432 adding general interface for batch validators in quickcheck
bulwahn
parents: 42188
diff changeset
   247
bd416284a432 adding general interface for batch validators in quickcheck
bulwahn
parents: 42188
diff changeset
   248
val add_batch_validator = Data.map o apfst o apsnd o apsnd o AList.update (op =);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   249
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   250
fun active_testers ctxt =
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   251
  let
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   252
    val testers = map snd (fst (fst (Data.get (Context.Proof ctxt))));
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   253
  in
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   254
    map snd (filter (fn (active, _) => Config.get ctxt active) testers)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   255
  end;
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   256
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   257
fun set_active_testers [] context = context
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   258
  | set_active_testers testers context =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   259
      let
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   260
        val registered_testers = fst (fst (Data.get context));
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   261
      in
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   262
        fold (fn (name, (config, _)) => Config.put_generic config (member (op =) testers name))
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   263
          registered_testers context
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   264
      end;
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   265
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   266
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   267
(* generating tests *)
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   268
41862
a38536bf2736 adding function Quickcheck.test_terms to provide checking a batch of terms
bulwahn
parents: 41754
diff changeset
   269
fun gen_mk_tester lookup ctxt v =
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   270
  let
43882
05d5696f177f renaming quickcheck_tester to quickcheck_batch_tester; tuned
bulwahn
parents: 43881
diff changeset
   271
    val name = Config.get ctxt batch_tester
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   272
    val tester =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   273
      (case lookup ctxt name of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   274
        NONE => error ("No such quickcheck batch-tester: " ^ name)
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   275
      | SOME tester => tester ctxt);
40235
87998864284e use Exn.interruptible_capture to keep user-code interruptible (Exn.capture not immediately followed by Exn.release here);
wenzelm
parents: 40225
diff changeset
   276
  in
40909
e006d1e06920 renamed parameter from generator to tester; quickcheck only applies one tester on invocation
bulwahn
parents: 40908
diff changeset
   277
    if Config.get ctxt quiet then
41862
a38536bf2736 adding function Quickcheck.test_terms to provide checking a batch of terms
bulwahn
parents: 41754
diff changeset
   278
      try tester v
40909
e006d1e06920 renamed parameter from generator to tester; quickcheck only applies one tester on invocation
bulwahn
parents: 40908
diff changeset
   279
    else
43761
e72ba84ae58f tuned signature -- corresponding to Scala version;
wenzelm
parents: 43585
diff changeset
   280
      let (* FIXME !?!? *)
41862
a38536bf2736 adding function Quickcheck.test_terms to provide checking a batch of terms
bulwahn
parents: 41754
diff changeset
   281
        val tester = Exn.interruptible_capture tester v
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   282
      in
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   283
        (case Exn.get_res tester of
40909
e006d1e06920 renamed parameter from generator to tester; quickcheck only applies one tester on invocation
bulwahn
parents: 40908
diff changeset
   284
          NONE => SOME (Exn.release tester)
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   285
        | SOME tester => SOME tester)
40909
e006d1e06920 renamed parameter from generator to tester; quickcheck only applies one tester on invocation
bulwahn
parents: 40908
diff changeset
   286
      end
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   287
  end;
43882
05d5696f177f renaming quickcheck_tester to quickcheck_batch_tester; tuned
bulwahn
parents: 43881
diff changeset
   288
42194
bd416284a432 adding general interface for batch validators in quickcheck
bulwahn
parents: 42188
diff changeset
   289
val mk_batch_tester =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   290
  gen_mk_tester (AList.lookup (op =) o fst o snd o fst o Data.get o Context.Proof);
42194
bd416284a432 adding general interface for batch validators in quickcheck
bulwahn
parents: 42188
diff changeset
   291
val mk_batch_validator =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   292
  gen_mk_tester (AList.lookup (op =) o snd o snd o fst o Data.get o Context.Proof);
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   293
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   294
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   295
(* testing propositions *)
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   296
43876
b8fa7287ee4c parametrized test_term functions in quickcheck
bulwahn
parents: 43875
diff changeset
   297
type compile_generator =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   298
  Proof.context -> (term * term list) list -> int list -> term list option * report option;
43876
b8fa7287ee4c parametrized test_term functions in quickcheck
bulwahn
parents: 43875
diff changeset
   299
43585
ea959ab7bbe3 adding timeout to quickcheck narrowing
bulwahn
parents: 43314
diff changeset
   300
fun limit timeout (limit_time, is_interactive) f exc () =
41754
aa94a003dcdf quickcheck can be invoked with its internal timelimit or without
bulwahn
parents: 41753
diff changeset
   301
  if limit_time then
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   302
    TimeLimit.timeLimit timeout f ()
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   303
      handle TimeLimit.TimeOut =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   304
        if is_interactive then exc () else raise TimeLimit.TimeOut
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   305
  else f ();
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   306
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   307
fun message ctxt s = if Config.get ctxt quiet then () else Output.urgent_message s;
41753
dbd00d8a4784 quickcheck invokes TimeLimit.timeLimit only in one separate function
bulwahn
parents: 41735
diff changeset
   308
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   309
fun verbose_message ctxt s =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   310
  if not (Config.get ctxt quiet) andalso Config.get ctxt verbose
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   311
  then Output.urgent_message s else ();
45765
cb6ddee6a463 making the default behaviour of quickcheck a little bit less verbose;
bulwahn
parents: 45764
diff changeset
   312
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
   313
fun test_terms ctxt (limit_time, is_interactive) insts goals =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   314
  (case active_testers ctxt of
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   315
    [] => error "No active testers for quickcheck"
45765
cb6ddee6a463 making the default behaviour of quickcheck a little bit less verbose;
bulwahn
parents: 45764
diff changeset
   316
  | testers =>
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   317
      limit (seconds (Config.get ctxt timeout)) (limit_time, is_interactive)
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   318
        (fn () =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   319
          Par_List.get_some (fn tester =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   320
            tester ctxt (length testers > 1) insts goals |>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   321
            (fn result => if exists found_counterexample result then SOME result else NONE))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   322
          testers)
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   323
        (fn () => (message ctxt "Quickcheck ran out of time"; NONE)) ());
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   324
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   325
fun all_axioms_of ctxt t =
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   326
  let
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   327
    val intros = Locale.get_intros ctxt;
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   328
    val unfolds = Locale.get_unfolds ctxt;
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   329
    fun retrieve_prems thms t =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   330
       (case filter (fn th => Term.could_unify (Thm.concl_of th, t)) thms of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   331
         [] => NONE
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   332
       | [th] =>
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   333
           let
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   334
             val (tyenv, tenv) =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   335
               Pattern.match (Proof_Context.theory_of ctxt)
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   336
                (Thm.concl_of th, t) (Vartab.empty, Vartab.empty)
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   337
           in SOME (map (Envir.subst_term (tyenv, tenv)) (Thm.prems_of th)) end);
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   338
    fun all t =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   339
      (case retrieve_prems intros t of
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   340
        NONE => retrieve_prems unfolds t
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   341
      | SOME ts => SOME (maps (fn t => the_default [t] (all t)) ts));
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   342
  in
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   343
    all t
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   344
  end;
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   345
47348
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   346
fun locale_config_of s =
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   347
  let
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   348
    val cs = space_explode " " s;
47348
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   349
  in
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   350
    if forall (fn c => c = "expand" orelse c = "interpret") cs then cs
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   351
    else
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   352
     (warning ("Invalid quickcheck_locale setting: falling back to the default setting.");
47348
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   353
      ["interpret", "expand"])
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   354
  end;
47348
9a82999ebbd6 added option quickcheck_locale to allow different behaviours for handling locales in Quickcheck;
bulwahn
parents: 46961
diff changeset
   355
42026
da9b58f1db42 adding option of evaluating terms after invocation in quickcheck
bulwahn
parents: 42025
diff changeset
   356
fun test_goal (time_limit, is_interactive) (insts, eval_terms) i state =
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   357
  let
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   358
    val lthy = Proof.context_of state;
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   359
    val thy = Proof.theory_of state;
45765
cb6ddee6a463 making the default behaviour of quickcheck a little bit less verbose;
bulwahn
parents: 45764
diff changeset
   360
    val _ = message lthy "Quickchecking..."
56245
84fc7dfa3cd4 more qualified names;
wenzelm
parents: 55630
diff changeset
   361
    fun strip (Const (@{const_name Pure.all}, _) $ Abs (_, _, t)) = strip t
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   362
      | strip t = t;
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   363
    val {goal = st, ...} = Proof.raw_goal state;
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   364
    val (gi, frees) = Logic.goal_params (prop_of st) i;
57195
ec0e10f11276 recovered level-free fishing for locale, accidentally lost in dce365931721
haftmann
parents: 57182
diff changeset
   365
    val some_locale = Named_Target.bottom_locale_of lthy;
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   366
    val assms =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   367
      if Config.get lthy no_assms then []
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   368
      else
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   369
        (case some_locale of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   370
          NONE => Assumption.all_assms_of lthy
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   371
        | SOME locale => Assumption.local_assms_of lthy (Locale.init locale thy));
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   372
    val proto_goal = Logic.list_implies (map Thm.term_of assms, subst_bounds (frees, strip gi));
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   373
    fun axioms_of locale =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   374
      (case fst (Locale.specification_of thy locale) of
46759
a6ea1c68fa52 collecting all axioms in a locale context in quickcheck;
bulwahn
parents: 46565
diff changeset
   375
        NONE => []
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   376
      | SOME t => the_default [] (all_axioms_of lthy t));
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   377
    val config = locale_config_of (Config.get lthy locale);
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   378
    val goals =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   379
      (case some_locale of
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   380
        NONE => [(proto_goal, eval_terms)]
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   381
      | SOME locale =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   382
          fold (fn c =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   383
            if c = "expand" then
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   384
              cons (Logic.list_implies (axioms_of locale, proto_goal), eval_terms)
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   385
            else if c = "interpret" then
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   386
              append (map (fn (_, phi) =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   387
                  (Morphism.term phi proto_goal, map (Morphism.term phi) eval_terms))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   388
                (Locale.registrations_of (Context.Theory thy) (* FIXME !? *) locale))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   389
            else I) config []);
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   390
    val _ =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   391
      verbose_message lthy
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   392
        (Pretty.string_of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   393
          (Pretty.big_list ("Checking goals: ") (map (Syntax.pretty_term lthy o fst) goals)));
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   394
  in
45159
3f1d1ce024cb moving some common functions from quickcheck to the more HOL-specific quickcheck_common; renamed inductive_SML's configurations to more canonical names; adds automatically left and right hand sides of equations as evaluation terms
bulwahn
parents: 43915
diff changeset
   395
    test_terms lthy (time_limit, is_interactive) insts goals
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   396
  end;
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   397
40648
1598ec648b0d splitting test_goal function in two functions; exporting new configurations in quickcheck; iterations depend on generator_name in quickcheck
bulwahn
parents: 40647
diff changeset
   398
37912
247042107f93 using multiple default types in quickcheck
bulwahn
parents: 37911
diff changeset
   399
(* pretty printing *)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   400
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   401
fun tool_name auto = (if auto then "Auto " else "") ^ "Quickcheck";
40225
2de5dd0cd3a2 clear identification
blanchet
parents: 40148
diff changeset
   402
46863
56376f6be74f adding tags to quickcheck's result
bulwahn
parents: 46759
diff changeset
   403
fun pretty_counterex ctxt auto NONE =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   404
      Pretty.str (tool_name auto ^ " found no counterexample." ^ Config.get ctxt tag)
45730
6bd0acefaedb outputing if counterexample is potentially spurious or not
bulwahn
parents: 45727
diff changeset
   405
  | pretty_counterex ctxt auto (SOME ((genuine, cex), eval_terms)) =
52694
da646aa4a3bb tuned message;
wenzelm
parents: 52645
diff changeset
   406
      (Pretty.text_fold o Pretty.fbreaks)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   407
       (Pretty.str (tool_name auto ^ " found a " ^
52694
da646aa4a3bb tuned message;
wenzelm
parents: 52645
diff changeset
   408
         (if genuine then "counterexample:"
da646aa4a3bb tuned message;
wenzelm
parents: 52645
diff changeset
   409
          else "potentially spurious counterexample due to underspecified functions:") ^
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   410
        Config.get ctxt tag) ::
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   411
        Pretty.str "" ::
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   412
        map (fn (s, t) =>
52694
da646aa4a3bb tuned message;
wenzelm
parents: 52645
diff changeset
   413
          Pretty.block [Pretty.str (s ^ " ="), Pretty.brk 1, Syntax.pretty_term ctxt t]) (rev cex) @
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   414
        (if null eval_terms then []
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   415
         else
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   416
          Pretty.str "" :: Pretty.str "Evaluated terms:" ::
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   417
            map (fn (t, u) =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   418
              Pretty.block [Syntax.pretty_term ctxt t, Pretty.str " =", Pretty.brk 1,
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   419
                Syntax.pretty_term ctxt u]) (rev eval_terms)));
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   420
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   421
30980
fe0855471964 misc cleanup of auto_solve and quickcheck:
wenzelm
parents: 30973
diff changeset
   422
(* Isar commands *)
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   423
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   424
fun read_nat s =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   425
  (case Library.read_int (Symbol.explode s) of
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   426
    (k, []) =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   427
      if k >= 0 then k
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   428
      else error ("Not a natural number: " ^ s)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   429
  | _ => error ("Not a natural number: " ^ s));
37909
583543ad6ad1 changed default types to a list of types; extended quickcheck parameters to be a list of values to parse a list of default types
bulwahn
parents: 36960
diff changeset
   430
34128
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   431
fun read_bool "false" = false
8650a073dd9b made Quickcheck take structured proof assumptions into account (like Refute and Nitpick) by default;
blanchet
parents: 33583
diff changeset
   432
  | read_bool "true" = true
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   433
  | read_bool s = error ("Not a Boolean value: " ^ s);
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   434
40366
a2866dbfbe6b changing timeout to real value; handling Interrupt and Timeout more like nitpick does
bulwahn
parents: 40253
diff changeset
   435
fun read_real s =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   436
  (case Real.fromString s of
40366
a2866dbfbe6b changing timeout to real value; handling Interrupt and Timeout more like nitpick does
bulwahn
parents: 40253
diff changeset
   437
    SOME s => s
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   438
  | NONE => error ("Not a real number: " ^ s));
40366
a2866dbfbe6b changing timeout to real value; handling Interrupt and Timeout more like nitpick does
bulwahn
parents: 40253
diff changeset
   439
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   440
fun read_expectation "no_expectation" = No_Expectation
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   441
  | read_expectation "no_counterexample" = No_Counterexample
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   442
  | read_expectation "counterexample" = Counterexample
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   443
  | read_expectation s = error ("Not an expectation value: " ^ s);
37929
22e0797857e6 adding checking of expected result for the tool quickcheck; annotated a few quickcheck examples
bulwahn
parents: 37913
diff changeset
   444
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   445
fun valid_tester_name genctxt name =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   446
  AList.defined (op =) (fst (fst (Data.get genctxt))) name;
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   447
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   448
fun parse_tester name (testers, genctxt) =
40912
1108529100ce checking if parameter is name of a tester which allows e.g. quickcheck[random]
bulwahn
parents: 40911
diff changeset
   449
  if valid_tester_name genctxt name then
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   450
    (insert (op =) name testers, genctxt)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   451
  else error ("Unknown tester: " ^ name);
40912
1108529100ce checking if parameter is name of a tester which allows e.g. quickcheck[random]
bulwahn
parents: 40911
diff changeset
   452
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   453
fun parse_test_param ("tester", args) = fold parse_tester args
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   454
  | parse_test_param ("size", [arg]) = apsnd (Config.put_generic size (read_nat arg))
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   455
  | parse_test_param ("iterations", [arg]) = apsnd (Config.put_generic iterations (read_nat arg))
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   456
  | parse_test_param ("depth", [arg]) = apsnd (Config.put_generic depth (read_nat arg))
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   457
  | parse_test_param ("default_type", arg) =
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   458
      (fn (testers, context) =>
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   459
        (testers, map_test_params
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   460
          (apfst (K (map (Proof_Context.read_typ (Context.proof_of context)) arg))) context))
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   461
  | parse_test_param ("no_assms", [arg]) = apsnd (Config.put_generic no_assms (read_bool arg))
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   462
  | parse_test_param ("expect", [arg]) = apsnd (map_test_params (apsnd (K (read_expectation arg))))
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   463
  | parse_test_param ("report", [arg]) = apsnd (Config.put_generic report (read_bool arg))
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   464
  | parse_test_param ("genuine_only", [arg]) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   465
      apsnd (Config.put_generic genuine_only (read_bool arg))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   466
  | parse_test_param ("abort_potential", [arg]) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   467
      apsnd (Config.put_generic abort_potential (read_bool arg))
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   468
  | parse_test_param ("quiet", [arg]) = apsnd (Config.put_generic quiet (read_bool arg))
45764
1672be34581a adding verbose configuration to quickcheck
bulwahn
parents: 45757
diff changeset
   469
  | parse_test_param ("verbose", [arg]) = apsnd (Config.put_generic verbose (read_bool arg))
46863
56376f6be74f adding tags to quickcheck's result
bulwahn
parents: 46759
diff changeset
   470
  | parse_test_param ("tag", [arg]) = apsnd (Config.put_generic tag arg)
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   471
  | parse_test_param ("use_subtype", [arg]) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   472
      apsnd (Config.put_generic use_subtype (read_bool arg))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   473
  | parse_test_param ("timeout", [arg]) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   474
      apsnd (Config.put_generic timeout (read_real arg))
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   475
  | parse_test_param ("finite_types", [arg]) =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   476
      apsnd (Config.put_generic finite_types (read_bool arg))
45449
eeffd04cd899 adding option allow_function_inversion to quickcheck options
bulwahn
parents: 45419
diff changeset
   477
  | parse_test_param ("allow_function_inversion", [arg]) =
eeffd04cd899 adding option allow_function_inversion to quickcheck options
bulwahn
parents: 45419
diff changeset
   478
      apsnd (Config.put_generic allow_function_inversion (read_bool arg))
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   479
  | parse_test_param ("finite_type_size", [arg]) =
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   480
      apsnd (Config.put_generic finite_type_size (read_nat arg))
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   481
  | parse_test_param (name, _) =
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   482
      (fn (testers, genctxt) =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   483
        if valid_tester_name genctxt name then
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   484
          (insert (op =) name testers, genctxt)
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   485
        else error ("Unknown tester or test parameter: " ^ name));
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   486
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   487
fun parse_test_param_inst (name, arg) ((insts, eval_terms), (testers, ctxt)) =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   488
  (case try (Proof_Context.read_typ ctxt) name of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   489
    SOME (TFree (v, _)) =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   490
      ((AList.update (op =) (v, Proof_Context.read_typ ctxt (the_single arg)) insts, eval_terms),
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   491
        (testers, ctxt))
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   492
  | NONE =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   493
      (case name of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   494
        "eval" => ((insts, eval_terms @ map (Syntax.read_term ctxt) arg), (testers, ctxt))
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   495
      | _ =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   496
        ((insts, eval_terms),
55630
wenzelm
parents: 55629
diff changeset
   497
          let
wenzelm
parents: 55629
diff changeset
   498
            val (testers', Context.Proof ctxt') =
wenzelm
parents: 55629
diff changeset
   499
              parse_test_param (name, arg) (testers, Context.Proof ctxt);
wenzelm
parents: 55629
diff changeset
   500
          in (testers', ctxt') end)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   501
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   502
fun quickcheck_params_cmd args =
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   503
  Context.theory_map
55629
50f155005ea0 proper naming convention;
wenzelm
parents: 55627
diff changeset
   504
    (fn context => uncurry set_active_testers (fold parse_test_param args ([], context)));
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   505
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   506
fun check_expectation state results =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   507
  if is_some results andalso expect (Proof.context_of state) = No_Counterexample then
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   508
    error "quickcheck expected to find no counterexample but found one"
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   509
  else if is_none results andalso expect (Proof.context_of state) = Counterexample then
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   510
    error "quickcheck expected to find a counterexample but did not find one"
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   511
  else ();
42088
8d00484551fe making quickcheck's result value more formal; allowing more result information to be returned after timeout; adding output of timing information in quickcheck
bulwahn
parents: 42087
diff changeset
   512
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   513
fun gen_quickcheck args i state =
40644
0850a2a16dce changed old-style quickcheck configurations to new Config.T configurations
bulwahn
parents: 40643
diff changeset
   514
  state
43881
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   515
  |> Proof.map_context_result (fn ctxt =>
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   516
    apsnd (fn (testers, ctxt) => Context.proof_map (set_active_testers testers) ctxt)
cabe74eab19a changing parser in quickcheck to activate and deactivate the testers
bulwahn
parents: 43879
diff changeset
   517
      (fold parse_test_param_inst args (([], []), ([], ctxt))))
55627
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   518
  |> (fn ((insts, eval_terms), state') =>
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   519
      test_goal (true, true) (insts, eval_terms) i state'
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   520
      |> tap (check_expectation state')
95c8ef02f04b tuned whitespace;
wenzelm
parents: 52694
diff changeset
   521
      |> rpair state');
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   522
43879
c8308a8faf9f enabling parallel execution of testers but removing more informative quickcheck output
bulwahn
parents: 43878
diff changeset
   523
fun quickcheck args i state =
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   524
  Option.map (the o get_first counterexample_of) (fst (gen_quickcheck args i state));
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   525
32297
3a4081abb3f7 Quickcheck callable from ML
boehmes
parents: 31599
diff changeset
   526
fun quickcheck_cmd args i state =
35378
95d0e3adf38e added basic reporting of test cases to quickcheck
bulwahn
parents: 35324
diff changeset
   527
  gen_quickcheck args i (Toplevel.proof_of state)
46863
56376f6be74f adding tags to quickcheck's result
bulwahn
parents: 46759
diff changeset
   528
  |> apfst (Option.map (the o get_first response_of))
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   529
  |> (fn (r, state) =>
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   530
      Output.urgent_message (Pretty.string_of
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   531
        (pretty_counterex (Proof.context_of state) false r)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   532
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   533
val parse_arg =
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   534
  Parse.name --
46949
94aa7b81bcf6 prefer formally checked @{keyword} parser;
wenzelm
parents: 46863
diff changeset
   535
    (Scan.optional (@{keyword "="} |--
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   536
      (((Parse.name || Parse.float_number) >> single) ||
46949
94aa7b81bcf6 prefer formally checked @{keyword} parser;
wenzelm
parents: 46863
diff changeset
   537
        (@{keyword "["} |-- Parse.list1 Parse.name --| @{keyword "]"}))) ["true"]);
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   538
41517
7267fb5b724b observe line length limit;
wenzelm
parents: 41472
diff changeset
   539
val parse_args =
46949
94aa7b81bcf6 prefer formally checked @{keyword} parser;
wenzelm
parents: 46863
diff changeset
   540
  @{keyword "["} |-- Parse.list1 parse_arg --| @{keyword "]"} || Scan.succeed [];
28336
a8edf4c69a79 fixed quickcheck parameter syntax
haftmann
parents: 28315
diff changeset
   541
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   542
val _ =
46961
5c6955f487e5 outer syntax command definitions based on formal command_spec derived from theory header declarations;
wenzelm
parents: 46949
diff changeset
   543
  Outer_Syntax.command @{command_spec "quickcheck_params"} "set parameters for random testing"
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   544
    (parse_args >> (fn args => Toplevel.theory (quickcheck_params_cmd args)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   545
36960
01594f816e3a prefer structure Keyword, Parse, Parse_Spec, Outer_Syntax;
wenzelm
parents: 36610
diff changeset
   546
val _ =
46961
5c6955f487e5 outer syntax command definitions based on formal command_spec derived from theory header declarations;
wenzelm
parents: 46949
diff changeset
   547
  Outer_Syntax.improper_command @{command_spec "quickcheck"}
5c6955f487e5 outer syntax command definitions based on formal command_spec derived from theory header declarations;
wenzelm
parents: 46949
diff changeset
   548
    "try to find counterexample for subgoal"
51557
4e4b56b7a3a5 more robust access Toplevel.proof_of -- prefer warning via Toplevel.unknown_proof over hard crash (notably for skipped proofs);
wenzelm
parents: 51302
diff changeset
   549
    (parse_args -- Scan.optional Parse.nat 1 >> (fn (args, i) =>
51658
21c10672633b discontinued Toplevel.no_timing complication -- also recovers timing of diagnostic commands, e.g. 'find_theorems';
wenzelm
parents: 51557
diff changeset
   550
      Toplevel.unknown_proof o Toplevel.keep (quickcheck_cmd args i)));
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   551
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   552
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   553
(* automatic testing *)
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   554
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   555
fun try_quickcheck auto state =
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   556
  let
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   557
    val ctxt = Proof.context_of state;
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   558
    val i = 1;
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   559
    val res =
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   560
      state
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   561
      |> Proof.map_context (Config.put report false #> Config.put quiet true)
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   562
      |> try (test_goal (false, false) ([], []) i);
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   563
  in
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   564
    (case res of
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   565
      NONE => (unknownN, state)
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   566
    | SOME results =>
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   567
        let
43879
c8308a8faf9f enabling parallel execution of testers but removing more informative quickcheck output
bulwahn
parents: 43878
diff changeset
   568
          val msg = pretty_counterex ctxt auto (Option.map (the o get_first response_of) results)
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   569
        in
43879
c8308a8faf9f enabling parallel execution of testers but removing more informative quickcheck output
bulwahn
parents: 43878
diff changeset
   570
          if is_some results then
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   571
            (genuineN,
43029
3e060b1c844b use helpers and tweak Quickcheck's priority to it comes second (to give Solve Direct slightly more time before another prover runs)
blanchet
parents: 43024
diff changeset
   572
             state
3e060b1c844b use helpers and tweak Quickcheck's priority to it comes second (to give Solve Direct slightly more time before another prover runs)
blanchet
parents: 43024
diff changeset
   573
             |> (if auto then
52643
34c29356930e more explicit Markup.information for messages produced by "auto" tools;
wenzelm
parents: 52641
diff changeset
   574
                   Proof.goal_message (K (Pretty.mark Markup.information msg))
43029
3e060b1c844b use helpers and tweak Quickcheck's priority to it comes second (to give Solve Direct slightly more time before another prover runs)
blanchet
parents: 43024
diff changeset
   575
                 else
3e060b1c844b use helpers and tweak Quickcheck's priority to it comes second (to give Solve Direct slightly more time before another prover runs)
blanchet
parents: 43024
diff changeset
   576
                   tap (fn _ => Output.urgent_message (Pretty.string_of msg))))
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   577
          else
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   578
            (noneN, state)
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   579
        end)
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   580
  end
51302
de47a499bc04 tuned whitespace and indentation;
wenzelm
parents: 50201
diff changeset
   581
  |> `(fn (outcome_code, _) => outcome_code = genuineN);
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   582
56467
8d7d6f17c6a7 more uniform ML/document antiquotations;
wenzelm
parents: 56245
diff changeset
   583
val _ = Try.tool_setup (quickcheckN, (20, @{system_option auto_quickcheck}, try_quickcheck));
43020
abb5d1f907e4 added "try" command, to launch Solve Direct, Quickcheck, Nitpick, Sledgehammer, and Try Methods
blanchet
parents: 43018
diff changeset
   584
28315
d3cf88fe77bc generic quickcheck framework
haftmann
parents: 28309
diff changeset
   585
end;
28309
c24bc53c815c some steps towards generic quickcheck framework
haftmann
parents: 28256
diff changeset
   586