forked from krestenkrab/triq
-
Notifications
You must be signed in to change notification settings - Fork 0
/
triq_dom.erl
1431 lines (1154 loc) · 39.2 KB
/
triq_dom.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%%
%% This file is part of Triq - Trifork QuickCheck
%%
%% Copyright (c) 2010 by Trifork
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
-module(triq_dom).
-include_lib("eunit/include/eunit.hrl").
%% the name of te special record for domains
-define(DOM,'@').
-define(DEFAULT_PROP_PREFIX, "prop_").
%% must correspond to the definitions in triq.hrl, but we don't want to
%% include that file.
-define(DELAY(X), fun()->X end).
-define(LAZY(X), fun()->X end).
-define(SIZED(Size,Gen),
sized(fun(Size) -> Gen end)).
%% How many times we try pick a value in order to satisfy a ?SUCHTHAT property.
-define(SUCHTHAT_LOOPS,100).
%% how many times we try to shrink a value before we bail out
-define(SHRINK_LOOPS,100).
%% @type pick_fun(T). Picks members of the `domain(T)'.
%% Return pair of `{domain(T),T}'; the "output domain" is what will
%% be used for shrinking the value.
-type pick_fun(T) :: fun( (domain(T),integer()) -> {domain(T),T} | no_return() ).
%% @type shrink_fun(T). Shrinks members of the `domain(T)'.
%% Return pair of `{domain(T),T}'; the "output domain" is what will
%% be used for further shrinking the value.
-type shrink_fun(T) :: fun( (domain(T),T) -> {domain(T),T} | no_return() ).
-type domrec(T) :: {?DOM,
atom() | tuple(),
pick_fun(T),
shrink_fun(T),
boolean()}.
-define(BOX,'@box').
-record(?BOX, {dom :: domain(T), value :: T}).
%%--------------------------------------
%% @doc A box(T) contains a value of type T, along with
%% information needed to shrink T.
%%
%% For example, not all integers shrink the same. If the
%% integer was generated to produce only even numbers for
%% instance, then that knowledge needs to be kept with the
%% value.
%%
%% @end
%%--------------------------------------
-type box(T) :: #?BOX{ dom:: domain(T), value :: T}.
%% @type domain(T). Domain of values of type T.
%%
-type domain(T) :: domrec(T) | T.
%% @type uchar(). Valid unicode code point.
-type uchar() :: 0..16#D7FF | 16#E000..16#10FFFF.
-type uchars() :: unicode:unicode_characters().
-record(?DOM,
{kind :: atom() | tuple(),
pick =fun error_pick/2 :: pick_fun(T),
shrink =fun error_shrink/2 :: shrink_fun(T),
empty_ok = true :: boolean()
}).
-record(list, {elem}).
-record(tuple, {elem}).
-record(vector,{size, elem}).
-record(binary,{size}).
-record(atom, {size}).
-record(oneof, {size, elems=[]}).
-record(resize,{size, dom}).
-record(bind, {dom, body}).
-record(sized, {body}).
-record(suchthat,{dom,pred}).
-record(bound_domain,{dom1,val1,dom2,fun2,size}).
-record(choose,{min,max}).
-record(elements,{elems,size,picked=none}).
-record(seal,{dom,seed}).
-record(unicode_binary, {size, encoding = utf8}).
%% generators
-export([list/1, tuple/1, int/0, int/1, int/2, byte/0, real/0, sized/1, elements/1, any/0, atom/0, atom/1, choose/2,
oneof/1, frequency/1, bool/0, char/0, return/1, vector/2, binary/1, binary/0, non_empty/1, resize/2]).
-export([unicode_char/0,
unicode_string/0,
unicode_string/1,
unicode_binary/0,
unicode_binary/1,
unicode_binary/2,
unicode_characters/0,
unicode_characters/1]).
%% using a generator
-export([bind/2, bindshrink/2, suchthat/2, pick/2, shrink/2, sample/1, sampleshrink/1,
seal/1, open/1, peek/1,
domain/3, shrink_without_duplicates/1]).
%%
%% Default values for pic/shrink in ?DOM records
%%
error_pick(#?DOM{kind=Kind},_) -> erlang:error({pick,Kind}).
error_shrink(#?DOM{kind=Kind},_) -> erlang:error({shrink,Kind}).
-spec pick(domain(T), pos_integer()) -> {domain(T), T}.
%%
%% @doc The heart of the random structure generator; pick a value from the domain.
%% Returns a pair of `{domain(T), T}' where the first component describes
%% the structure of the picked value.
%% @spec pick(domain(T), pos_integer()) -> {domain(T), T}
%%
pick(Dom=#?DOM{pick=PickFun}, SampleSize)
when SampleSize > 0, is_integer(SampleSize) ->
PickFun(Dom,SampleSize);
%%
%% A tuple is generated by generating each element
%%
pick({}=Empty, _) -> {Empty,Empty};
pick(T,SampleSize) when is_tuple(T), SampleSize > 0, is_integer(SampleSize) ->
{DomList,List} = pick(tuple_to_list(T), SampleSize),
{list_to_tuple(DomList), list_to_tuple(List)};
%%
%% for Lists, we traverse down the list and generate
%% each head
%%
pick([], _) -> {[],[]};
pick([H|T], SampleSize)
when SampleSize > 0, is_integer(SampleSize) ->
{HDom,HVal} = pick(H,SampleSize),
{TDom,TVal} = pick(T,SampleSize),
{[HDom|TDom], [HVal|TVal]};
%%
%% Lazy elements...
%%
pick(F,SampleSize) when erlang:is_function(F,0) ->
pick(F(),SampleSize);
%%
%% simple values that generate themselves
%%
pick(V,_) when is_atom(V);
is_number(V);
is_binary(V);
is_function(V);
is_bitstring(V)
->
{V,V}.
pick_test() ->
case pick(int(), 10) of
{Dom, Val} when Val >= -5, Val =< 5 ->
Dom = int()
end.
pick_tuple_test() ->
case pick({int(),int()}, 10) of
{Dom, {Val1,Val2}} when is_integer(Val1), is_integer(Val2) ->
Dom = {int(), int()}
end.
pick_lazy_test() ->
case pick(?DELAY(int()), 10) of
{_, Val} when Val >= -5, Val =< 5 ->
ok
end.
pick_list_test() ->
case pick([int(),int()], 10) of
{Dom, [Val1,Val2]} when is_integer(Val1), is_integer(Val2) ->
Dom = [int(), int()]
end.
pick_pair_test() ->
repeat( fun() ->
case pick([choose(0,10) | {choose(0,10)}], 10) of
{Dom, [Int1| {Int2}]=Val} when is_integer(Int1),
is_integer(Int2) ->
case shrink(Dom, Val) of
{_, [SInt1 | {SInt2}]} when SInt1<Int1; SInt2<Int2 -> ok;
{_, [_ | {_}]} when Int1==0;Int2==0 -> ok
end
end
end,
20).
shrink({Domain,Value}) ->
shrink(Domain,Value).
%% @doc The shrinking step function used internally in Triq.
%%
%% Performs one single step of shrinking. If unsuccessful,
%% i.e. value cound not be shrunk, the output is equal to the input.
%%
%% Takes a `Domain' and a `Value' from said domain, and shrinks
%% the value within the constraints of the domain. The result is
%% a tuple of a (possibly smaller) output domain, and the
%% shrunken value.
%%
%% @spec shrink(Domain::domain(T),Value::T) -> {domain(T), T}
-spec shrink(domain(T),T) -> {domain(T), T}.
shrink(Domain=#?DOM{shrink=SFun}, Value) ->
SFun(Domain,Value);
shrink(TupDom,Tup) when is_tuple(TupDom),
is_tuple(Tup),
tuple_size(TupDom) =:= tuple_size(Tup) ->
shrink_tuple_samesize(TupDom, Tup, 10);
%
% well-formed lists are shrunk using this case.
% the "length(X)>=0 tests if it is well-formed list"
%
shrink(ListDom, List) when is_list(ListDom), is_list(List), length(List) >= 0 ->
?assert(length(ListDom) == length(List)),
shrink_list_samesize(ListDom, List, length(List), 10);
%
% other non-well-formed lists [cons pairs] use this clause
%
shrink([_|_]=ListDom, [_|_]=List) ->
shrink_pair(ListDom,List, 10);
%% finally, if the generator is the value itself, it simplifies to itself
shrink(Any,Any) -> {Any,Any}.
%% @doc
%% support functions for the generic shrinking
%% @private
%% @end
-spec shrink_pair([domain(H)|domain(T)], [H|T], non_neg_integer()) ->
{[domain(H)|domain(T)],[H|T]}.
shrink_pair(ListDom,List,0) ->
{ListDom,List};
shrink_pair([HDom|TDom]=ListDom, [H|T]=List, NAttempts) ->
% choose if we shrink the head or the tail
ShrinkHead = (random:uniform(2) =:= 1),
ShrinkTail = (random:uniform(2) =:= 1),
%% then do it
%
case
%% shrink head and/or tail
{
case ShrinkHead of
true -> shrink(HDom,H);
false -> {HDom,H}
end
,
case ShrinkTail of
true -> shrink(TDom,T);
false -> {TDom,T}
end
}
of
%% it did not shrink
{{_,H}, {_,T}} ->
shrink_pair(ListDom,List,NAttempts-1);
%% either H or T changed.
{{HSDom,HS}, {TSDom,TS}} ->
{[HSDom|TSDom], [HS|TS]}
end.
%%
%% We shrink tuples by turning it into a list and shrinking that...
%%
shrink_tuple_samesize(TupDom, Tup, NAttempts) ->
?assert(tuple_size(TupDom) =:= tuple_size(Tup)),
ListDom = tuple_to_list(TupDom),
List = tuple_to_list(Tup),
{SDom,SList} = shrink_list_samesize(ListDom, List, tuple_size(Tup), NAttempts),
{ list_to_tuple(SDom), list_to_tuple(SList) }.
%%
%% Shrink a list by simplifying one or more of the elements.
%%
-spec shrink_list_samesize([domain(T)],[T],non_neg_integer(),non_neg_integer()) ->
{[domain(T)],[T]}.
shrink_list_samesize([],[],_,_) ->
{[],[]};
shrink_list_samesize(ListDom,List,_,0) ->
{ListDom,List};
shrink_list_samesize(ListDom,List,Length,NAttempts) when is_list(List) ->
?assert(length(ListDom) == length(List)),
HowManyToShrink = shrink_members(Length),
case shrink_list_members(ListDom, List, Length, HowManyToShrink) of
% it did not shrink, try again
{_,List} ->
shrink_list_samesize(ListDom, List, Length, NAttempts-1);
% else, we got a simpler list
{_,_}=Result ->
Result
end.
%%
%% Given a list, shrink HowMany of it's elements,
%% but don't reduce the list length
%%
-spec shrink_list_members([domain(T)],[T],non_neg_integer(),non_neg_integer()) ->
{[domain(T)],[T]}.
shrink_list_members(ListDom, List, _, 0) -> {ListDom,List};
shrink_list_members(ListDom, List, Len, HowMany) when is_list(List), is_list(ListDom) ->
?assert(Len == length(List)),
%%
%% replace element at RemIdx with simplified one
%%
RemIdx = random:uniform(Len),
Elm = lists:nth(RemIdx, List),
ElmDom = lists:nth(RemIdx, ListDom),
{NextDom,NextList} =
case shrink(ElmDom,Elm) of
{_,Elm} -> {ListDom,List};
{SElmDom,SElm} ->
Dom2 = lists:sublist(ListDom,RemIdx-1) ++ [SElmDom] ++ lists:sublist(ListDom,RemIdx+1,Len),
List2 = lists:sublist(List,RemIdx-1) ++ [SElm] ++ lists:sublist(List,RemIdx+1,Len),
{Dom2, List2}
end,
shrink_list_members(NextDom, NextList, Len, HowMany-1).
%%-------------------------------------------------------------------
%%
%% Now, the specifc domains
%%
%%-------------------------------------------------------------------
%%--------------------------------------------------------------------
%% @doc
%% Returns the domain of lists of the argument.
%% For example, `list(int())' yields the domain of lists of integers.
%%
%% @spec list( domain(T) ) -> domain([T])
%% @end
%%--------------------------------------------------------------------
-spec list(domain(T)) -> domrec([T]).
list(ElemDom) ->
#?DOM{kind=#list{elem=ElemDom}, pick=fun list_pick/2 }.
list_pick(#?DOM{kind=#list{elem=ElemDom},empty_ok=EmptyOK},
SampleSize) ->
OutLen = if EmptyOK =:= false ->
random:uniform(SampleSize);
EmptyOK =:= true ->
random:uniform(SampleSize)-1
end,
%%
%% TODO: if ElemDom is "simple" no need to build template
%%
%% generate template Domain and corresponding List
{ListDom,List} =
foldn( fun({Dom,T}) ->
{EDom,E} = pick(ElemDom,SampleSize),
{[EDom|Dom], [E|T]}
end,
{[],[]},
OutLen),
shrinkable_list(ListDom, List, OutLen, EmptyOK).
%% oops, if length==1 and EmptyOK=false; just return the fixed list
shrinkable_list(ListDom, List, 1, false) ->
{ListDom, List};
shrinkable_list(_, [], 0, _) ->
{[], []};
shrinkable_list(ListDom, List, Len, EmptyOK) ->
?assert(length(List) == length(ListDom)),
?assert(length(List) == Len),
SDom = #?DOM{kind={shrinkable_list, ListDom, Len}, shrink=fun list_shrink/2, empty_ok=EmptyOK},
{SDom,List}.
list_shrink(#?DOM{kind={shrinkable_list, ListDom, Len}, empty_ok=EmptyOK}, List) ->
?assert(length(List) == Len),
SmallerOK = ((EmptyOK and (Len>0)) or (Len>1)),
case SmallerOK and (random:uniform(5) == 1) of
true ->
shorter_list(ListDom,List,Len,EmptyOK);
false ->
case shrink(ListDom,List) of
{_, List} when SmallerOK ->
shorter_list(ListDom,List,Len,EmptyOK);
{ShrunkenListDom,ShrunkenList} ->
shrinkable_list(ShrunkenListDom, ShrunkenList, Len, EmptyOK)
end
end.
shorter_list(ListDom,List,Len,EmptyOK) ->
case random:uniform(3) of
1 -> %% Remove one element.
RemIdx = random:uniform(Len),
shrinkable_list( without(RemIdx, ListDom), without(RemIdx, List), Len-1, EmptyOK);
2 -> %% Remove or keep a random sublist.
Idx1 = random:uniform(Len),
Idx2 = random:uniform(Len),
if Idx1 < Idx2 -> % Remove the sublist [Idx1;Idx2]
shrinkable_list( without(Idx1,Idx2, ListDom),
without(Idx1,Idx2, List),
Len-(Idx2-Idx1), EmptyOK);
true -> % Remove all but the sublist [Idx2;Idx1]
NewLen = Idx1-Idx2+1,
shrinkable_list( lists:sublist(ListDom, Idx2, NewLen),
lists:sublist(List , Idx2, NewLen),
NewLen, EmptyOK)
end;
3 -> %% Remove a random sublist.
Zipped = lists:zip(ListDom, List),
TrueTreshold = random:uniform(),
FalseTreshold = random:uniform(),
%% This may happen to be the original list again.
Pruned = markov_prune_list(Zipped, TrueTreshold, FalseTreshold, false),
NewLen = length(Pruned),
{ListDom2,List2} = lists:unzip(Pruned),
shrinkable_list( ListDom2, List2, NewLen, EmptyOK)
end.
markov_prune_list([], _,_,_) -> [];
markov_prune_list([H|T], TrueTreshold, FalseTreshold, Prev) ->
Rnd = random:uniform(),
Threshold = if Prev -> TrueTreshold;
true -> FalseTreshold
end,
Include = Rnd > Threshold,
NewTail = markov_prune_list(T, TrueTreshold, FalseTreshold, Include),
if Include -> [H|NewTail];
true -> NewTail
end.
%%
%% Generator for tuples
%%
%% @spec tuple(domain(ElemType::any())) -> domain(tuple(ElemType))
-spec tuple(domain(any())) -> domrec(tuple()).
tuple(ElemDom) ->
#?DOM{kind=#tuple{elem=ElemDom}, pick=fun tuple_pick/2 }.
tuple_pick(#?DOM{kind=#tuple{elem=ElemDom},empty_ok=EmptyOK},
SampleSize) ->
OutLen = if EmptyOK =:= false ->
random:uniform(SampleSize);
EmptyOK =:= true ->
random:uniform(SampleSize)-1
end,
%%
%% TODO: if ElemDom is "simple" no need to build template
%%
%% generate template Domain and corresponding Tuple
{ListDom,List} =
foldn( fun({Dom,T}) ->
{EDom,E} = pick(ElemDom,SampleSize),
{[EDom|Dom], [E|T]}
end,
{[],[]},
OutLen),
shrinkable_tuple(list_to_tuple(ListDom), list_to_tuple(List), EmptyOK).
%% If length==1 and EmptyOK=false; just return the fixed tuple
shrinkable_tuple(TupleDom, Tuple, false) when tuple_size(Tuple) =:= 1 ->
{TupleDom, Tuple};
shrinkable_tuple(TupleDom, Tuple, EmptyOK) ->
?assert(tuple_size(Tuple) == tuple_size(TupleDom)),
SDom = #?DOM{kind={shrinkable_tuple, TupleDom}, shrink=fun tuple_shrink/2, empty_ok=EmptyOK},
{SDom,Tuple}.
tuple_shrink(#?DOM{kind={shrinkable_tuple, TupleDom}, empty_ok=EmptyOK}, Tuple) ->
AllowSmaller = allow_smaller(tuple_size(Tuple), any, EmptyOK),
case shrink(TupleDom,Tuple) of
{_, Tuple} when AllowSmaller ->
RemIdx = random:uniform(tuple_size(Tuple)),
shrinkable_tuple( without(RemIdx, TupleDom), without(RemIdx, Tuple), EmptyOK);
Result -> Result
end.
%% @doc The domain of integers.
%% @spec int() -> domain(integer())
-spec int() -> domrec(integer()).
int() ->
#?DOM{kind=int,
shrink=fun(Dom,Val) when Val>0 -> {Dom,Val-1};
(Dom,Val) when Val<0 -> {Dom,Val+1};
(Dom,0) -> {Dom,0}
end,
pick=fun(Dom,SampleSize) ->
{Dom, random:uniform(SampleSize) - (SampleSize div 2)}
end
}.
int(Max) ->
int(0, Max).
int(Min, Max) ->
Diff = Max - Min,
#?DOM{kind=int,
shrink=fun(Dom,Val) when Val>0 -> {Dom,Val-1};
(Dom,Val) when Val<0 -> {Dom,Val+1};
(Dom,0) -> {Dom,0}
end,
pick=fun(Dom,SampleSize) ->
{Dom, random:uniform(max(SampleSize, Diff)) + Min}
end
}.
-spec byte() -> domrec(integer()).
byte() ->
int(0, 255).
%% @doc The domain of floats.
%% @spec real() -> domain(float())
-spec real() -> domrec(float()).
real() ->
#?DOM{
kind=real,
pick=fun(Dom,SampleSize) -> {Dom, (random:uniform()*SampleSize) - (SampleSize / 2)} end,
shrink=fun(Dom,Val) -> {Dom, Val/2.0} end
}.
%% @doc The domain of booleans. Shrinks to false.
%% @spec bool() -> domain( true | false )
bool() ->
#?DOM{
kind=boolean,
pick=fun(Dom,_) -> {Dom, random:uniform(2)==1} end,
shrink=fun(_,_) -> {false, false} end
}.
-spec char() -> domrec(32..126).
char() ->
#?DOM{
kind=char,
pick=fun(Dom,_) ->
{Dom, $a + random:uniform($z - $a + 1)-1}
end,
shrink=fun(Dom,V) when V =< $c ->
{Dom,V};
(Dom,N) when N > $c, N =< $z ->
{Dom,N - random:uniform(3)}
end
}.
-spec binary() -> domrec(binary()).
binary() ->
#?DOM{kind=#binary{size=any},
pick=fun binary_pick/2,
shrink=fun binary_shrink/2}.
-spec binary(Size::non_neg_integer()) -> domrec(binary()).
binary(Size) ->
#?DOM{kind=#binary{size=Size},
pick=fun binary_pick/2,
shrink=fun binary_shrink/2}.
binary_pick(#?DOM{kind=#binary{size=Size}, empty_ok=EmptyOK}=BinDom, SampleSize) ->
Sz = case Size of
any ->
case EmptyOK of
true ->
random:uniform(SampleSize)-1;
false ->
random:uniform(SampleSize)
end;
Size ->
Size
end,
BinValue = list_to_binary(foldn(fun(T) -> [random:uniform(256)-1 | T] end,
[],
Sz)),
{BinDom, BinValue}.
allow_smaller(Len,any,true) when Len>0 ->
true;
allow_smaller(Len,any,false) when Len>1 ->
true;
allow_smaller(_,_,_) ->
false.
binary_shrink(#?DOM{kind=#binary{size=Size}, empty_ok=EmptyOK}=BinDom, BinValue) ->
List = binary_to_list(BinValue),
Length = byte_size(BinValue),
AllowSmaller = allow_smaller(Length,Size,EmptyOK) ,
case shrink_list_with_elemdom(int(), List, Length, AllowSmaller) of
List -> {BinDom, BinValue};
NewList -> {BinDom, list_to_binary(NewList)}
end.
-spec atom() -> domrec(atom()).
atom() ->
#?DOM{kind=#atom{size=any},
pick=fun atom_pick/2,
shrink=fun atom_shrink/2}.
-spec atom(non_neg_integer()) -> domrec(atom()).
atom(Size) ->
#?DOM{kind=#atom{size=Size},
pick=fun atom_pick/2,
shrink=fun atom_shrink/2}.
atom_pick(#?DOM{kind=#atom{size=Size}, empty_ok=EmptyOK}=AtomDom, SampleSize) ->
Sz = case Size of
any ->
case EmptyOK of
true ->
random:uniform(xmin(SampleSize,256))-1;
false ->
random:uniform(xmin(SampleSize,256))
end;
Size ->
Size
end,
CharDom = char(),
Fun=fun(T) -> {_,Char} = pick(CharDom,SampleSize), [Char | T] end,
AtomValue = list_to_atom(foldn(Fun, [], Sz)),
{AtomDom, AtomValue}.
xmin(A,B) when A<B -> A;
xmin(A,B) when B<A -> B;
xmin(A,B) when A==B -> A.
atom_shrink(#?DOM{kind=#atom{size=Size}, empty_ok=EmptyOK}=AtomDom, AtomValue) ->
List = atom_to_list(AtomValue),
Length = length(List),
AllowSmaller = allow_smaller(Length,Size,EmptyOK) ,
case shrink_list_with_elemdom(char(), List, Length, AllowSmaller) of
List -> {AtomDom, AtomValue};
NewList -> {AtomDom, list_to_atom(NewList)}
end.
vector(Size,ElemDom) ->
#?DOM{kind=#vector{size=Size,elem=ElemDom},
pick=fun vector_pick/2}.
vector_pick(#?DOM{kind=#vector{size=Size,elem=ElemDom}}, SampleSize) ->
foldn(fun({TDom,T}) ->
{HDom,H} = pick(ElemDom, SampleSize),
{[HDom|TDom], [H|T]}
end,
{[], []},
Size).
%%
%% @doc Shrink `List' where all elements have the same domain `ElemDom'.
%% If parameter `AllowSmaller' is true, then we may also make the list
%% shorter.
%% @end
shrink_list_with_elemdom(_,List,0,_) -> List;
shrink_list_with_elemdom(ElemDom,List,Length,AllowSmaller) ->
%% 1/5 of the time, try shrinking by removing an elemet
case AllowSmaller andalso shrink_smaller(Length) of
true ->
RemoveIdx = random:uniform(Length),
without(RemoveIdx, List);
false ->
HowManyToShrink = shrink_members(Length),
case shrink_list_members_generic(ElemDom, List, Length, HowManyToShrink) of
%% can we remove an element?
List when AllowSmaller ->
RemIdx = random:uniform(Length),
without(RemIdx, List);
%% it changed!
ShrunkenList ->
ShrunkenList
end
end.
%% decide if something of size `Length' should be shrunk by removing an element
shrink_smaller(0) -> false;
shrink_smaller(_Length) ->
random:uniform(5)==1.
%% decide how many of
shrink_members(0) -> 0;
shrink_members(Length) when Length>0 ->
case random:uniform(5) of
1 -> random:uniform(5);
_ -> 1
end.
%%
%% Same, but when component element is fixed (also returns List, not {Dom,List})!
%%
-spec shrink_list_members_generic(domain(T), [T], non_neg_integer(), integer()) -> [T].
shrink_list_members_generic(_, List, _, 0) -> List;
shrink_list_members_generic(#?DOM{}=ElemDom, List, Len, HowMany) ->
NextList = shrink_list_N(ElemDom,List,Len, ?SHRINK_LOOPS),
shrink_list_members_generic(ElemDom, NextList, Len, HowMany-1).
shrink_list_N(_, List, _, 0) -> List;
shrink_list_N(#?DOM{}=ElemDom, List, Len, N) ->
?assert(Len == length(List)),
%%
%% replace element at RemIdx with simplified one
%%
RemIdx = random:uniform(Len),
Elm = lists:nth(RemIdx, List),
%% io:format("shrinking elem ~p (~p) of ~p~n", [RemIdx,Elm,List]),
case shrink(ElemDom,Elm) of
{_,Elm} ->
shrink_list_N(ElemDom, List, Len, N-1);
{_,SElm} ->
lists:sublist(List,RemIdx-1) ++ [SElm] ++ lists:sublist(List,RemIdx+1,Len)
end.
%%
%% simple loop to try N shrinks until value is shrunken.
%%
try_shrink(Dom,Val,0) -> { Dom,Val };
try_shrink(Dom,Val,N) ->
case shrink(Dom,Val) of
{_,Val} ->
io:format("shrink {~p,~p} failed~n", [Dom,Val]),
try_shrink(Dom,Val,N-1);
Shrunk -> Shrunk
end.
non_empty(#?DOM{}=Dom) ->
Dom#?DOM{empty_ok=false}.
%% @doc Support function for the `?LET(Vars,Dom1,Dom2)' macro.
%% @private
%% @spec bind(domain(T), fun( (T) -> domain(D) )) -> domain(D)
-spec bind(domain(T::any()),
fun( (T::any()) -> domain(D) )) -> domain(D).
bind(Gen1,FG2) ->
#?DOM{kind=#bind{dom=Gen1,body=FG2},
pick = fun bind_pick/2
}.
-spec bind_pick(domain(T),pos_integer()) -> T.
bind_pick(#?DOM{kind=#bind{dom=Dom,body=Fun}}, SampleSize) ->
{Dom1,Val1} = pick(Dom, SampleSize),
{Dom2,Val2} = pick( Fun(Val1), SampleSize),
{ bound_domain(Dom1,Val1,Dom2,Fun, SampleSize), Val2 }.
bound_domain(Dom1,Val1,Dom2,Fun,SampleSize) ->
#?DOM{kind=#bound_domain{dom1=Dom1,val1=Val1,dom2=Dom2,fun2=Fun,size=SampleSize},
shrink= fun bound_shrink/2
}.
bound_shrink(#?DOM{kind=#bound_domain{dom1=Dom1,val1=Val1,dom2=Dom2,fun2=Fun,size=SampleSize}}, Val2) ->
case shrink(Dom1,Val1) of
% it did not shrink val1
{_,Val1} ->
% try to shrink the secondary domain
shrink(Dom2,Val2);
% Val1 did shrink!
{SDom1,SVal1} ->
% pick a new value from the secondary domain
{SDom2,SVal2} = pick( Fun(SVal1), SampleSize),
% and return the new bound domain
{ bound_domain(SDom1,SVal1,SDom2,Fun, SampleSize), SVal2 }
end.
%% @doc support function for `?LETSHRINK([X,...],[domain(),...],domain())'
%% @private
bindshrink(Dom,_Fun) when not is_list(Dom) ->
error(argument_to_LETSHRINK_macro_must_be_lists);
bindshrink(Dom,Fun) when is_function(Fun,1) ->
domain(letshrink,
fun(_,SampleSize) ->
Box1 = {_,List1} = pick(Dom, SampleSize),
?assert(is_list(List1) and (length(List1)>0) ),
Box2 = {_,List2} = pick(Fun(List1), SampleSize),
{ bindshrink2(Box1,Box1,Box2,Fun,SampleSize), List2 }
end,
undefined).
bindshrink2(OrigBox1,Box1,Box2,Fun,SampleSize) ->
domain(letshrink2,
undefined,
fun(_,_) ->
{Dom2,Val2}=Box2,
case shrink(Dom2,Val2) of
{_,Val2} ->
case shrink({_,List1}=Box1) of
{_, List1} ->
{OrigDom1,OrigList1}=OrigBox1,
Index = random:uniform(length(OrigList1)),
{ lists:nth(Index,OrigDom1),
lists:nth(Index,OrigList1) };
{_,NewList1}=NewBox1 ->
{_,NewVal2} = NewBox2 = pick(Fun(NewList1), SampleSize),
{ bindshrink2(OrigBox1,
NewBox1,
NewBox2,
Fun,
SampleSize),
NewVal2 }
end;
{_, NewVal2}=NewBox2 ->
{ bindshrink2(OrigBox1,
Box1,
NewBox2,
Fun,
SampleSize),
NewVal2 }
end
end).
%% @doc Support function for the ?SUCHTHAT macro.
%% @private
%% @spec suchthat(domain(T),fun((T) -> boolean())) -> domain(T)
-spec suchthat(domain(T),fun((T) -> boolean())) -> domain(T).
suchthat(Dom,Predicate) ->
#?DOM{kind=#suchthat{dom=Dom,pred=Predicate},
pick=fun(#?DOM{kind=#suchthat{dom=Dom1,pred=Fun1}},SampleSize) ->
suchthat_loop(?SUCHTHAT_LOOPS,Dom1,Fun1,SampleSize)
end
}.
suchthat_loop(0,_,_,_) ->
erlang:exit(suchthat_failed);
suchthat_loop(N,Dom,Fun,SampleSize) ->
{ValDom,Val} = pick(Dom,SampleSize),
case Fun(Val) of
true -> {ValDom,Val};
_ -> suchthat_loop(N-1, Dom, Fun, SampleSize)
end.
smaller(Domain) ->
?SIZED(SZ, resize(random:uniform((SZ div 2)+1), Domain)).
-spec any() -> domain(any()).
any() ->
oneof([int(), real(), bool(), atom(),
[smaller(?DELAY(any())) | smaller(?DELAY(any()))],
%% list(any()), but with a size in the range 1..GenSize
list(smaller(?DELAY(any()))),
tuple(smaller(?DELAY(any())))
]).
-spec oneof([domain(T)]) -> domain(T).
oneof(DomList) when is_list(DomList) ->
#?DOM{kind=#oneof{elems=DomList, size=length(DomList)},
pick=fun oneof_pick/2
}.
oneof_pick(#?DOM{kind=#oneof{elems=DomList, size=Length}}, SampleSize) ->
Dom = lists:nth(random:uniform(Length), DomList),
pick(Dom, SampleSize).
%% --------------------------------------------------------------
%% @doc Choose domain from list [{Weight, Domain}, ...]
%% @end
%% --------------------------------------------------------------
frequency(GenList) when is_list(GenList) ->
Sum = lists:foldl(fun({Freq, _}, Acc) ->
Freq + Acc
end,
0,
GenList),
domain(frequency,
fun(_,SampleSize) ->
Limit = random:uniform(Sum),
{ok,Gen} = lists:foldl(
fun (_, {ok, _}=Acc) ->
Acc;
({Freq,Generator}, {AccSum, none}) ->
NextAcc = AccSum+Freq,
if NextAcc >= Limit ->
{ok, Generator};
true ->
{NextAcc, none}
end
end,
{0, none},
GenList),
pick(Gen, SampleSize)
end,
undefined).
%% @doc Returns the domain containing exactly `Value'.