File 6591-Property-based-tests-for-the-gb_sets-modul... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 6591-Property-based-tests-for-the-gb_sets-module.patch of Package erlang (Revision ef76582d9ec8723017fd1825f278d2c9)

Currently displaying revision ef76582d9ec8723017fd1825f278d2c9 , Show latest

From 1dfebf36fb81ef798c67ae775c05597d8cfd2d20 Mon Sep 17 00:00:00 2001
From: Maria Scott <maria-12648430@hnc-agency.org>
Date: Fri, 18 Aug 2023 12:30:25 +0200
Subject: [PATCH] Property-based tests for the gb_sets module

---
 lib/stdlib/test/Makefile                      |   1 +
 .../test/gb_sets_property_test_SUITE.erl      |  97 ++++++
 .../test/property_test/gb_sets_prop.erl       | 303 ++++++++++++++++++
 3 files changed, 401 insertions(+)
 create mode 100644 lib/stdlib/test/gb_sets_property_test_SUITE.erl
 create mode 100644 lib/stdlib/test/property_test/gb_sets_prop.erl

diff --git a/lib/stdlib/test/Makefile b/lib/stdlib/test/Makefile
index bdac775256..80037703c9 100644
--- a/lib/stdlib/test/Makefile
+++ b/lib/stdlib/test/Makefile
@@ -44,6 +44,7 @@ MODULES= \
 	filename_SUITE \
 	fixtable_SUITE \
 	format_SUITE \
+	gb_sets_property_test_SUITE \
 	gen_event_SUITE \
 	gen_fsm_SUITE \
 	gen_server_SUITE \
diff --git a/lib/stdlib/test/gb_sets_property_test_SUITE.erl b/lib/stdlib/test/gb_sets_property_test_SUITE.erl
new file mode 100644
index 0000000000..4ba8809506
--- /dev/null
+++ b/lib/stdlib/test/gb_sets_property_test_SUITE.erl
@@ -0,0 +1,97 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2021-2022. All Rights Reserved.
+%%
+%% 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.
+%%
+%% %CopyrightEnd%
+%%
+-module(gb_sets_property_test_SUITE).
+
+-include_lib("common_test/include/ct.hrl").
+
+-compile(export_all).
+-compile(nowarn_export_all).
+
+all() -> [
+          add_case,
+          balance_case,
+          delete_case, delete_any_case,
+          difference_case,
+          from_ordset_case,
+          insert_case,
+          is_member_case,
+          iterator_case, iterator_from_case,
+          largest_case,
+          singleton_case,
+          smallest_case,
+          take_largest_case,
+          take_smallest_case
+    ].
+
+init_per_suite(Config) ->
+    ct_property_test:init_per_suite(Config).
+
+end_per_suite(Config) ->
+    Config.
+
+add_case(Config) ->
+    do_proptest(prop_add, Config).
+
+balance_case(Config) ->
+    do_proptest(prop_balance, Config).
+
+delete_case(Config) ->
+    do_proptest(prop_delete, Config).
+
+delete_any_case(Config) ->
+    do_proptest(prop_delete_any, Config).
+
+difference_case(Config) ->
+    do_proptest(prop_difference, Config).
+
+from_ordset_case(Config) ->
+    do_proptest(prop_from_ordset, Config).
+
+insert_case(Config) ->
+    do_proptest(prop_insert, Config).
+
+is_member_case(Config) ->
+    do_proptest(prop_is_member, Config).
+
+iterator_case(Config) ->
+    do_proptest(prop_iterator, Config).
+
+iterator_from_case(Config) ->
+    do_proptest(prop_iterator_from, Config).
+
+largest_case(Config) ->
+    do_proptest(prop_largest, Config).
+
+singleton_case(Config) ->
+    do_proptest(prop_singleton, Config).
+
+smallest_case(Config) ->
+    do_proptest(prop_smallest, Config).
+
+take_largest_case(Config) ->
+    do_proptest(prop_take_largest, Config).
+
+take_smallest_case(Config) ->
+    do_proptest(prop_take_smallest, Config).
+
+do_proptest(Prop, Config) ->
+    ct_property_test:quickcheck(
+        gb_sets_prop:Prop(),
+        Config).
diff --git a/lib/stdlib/test/property_test/gb_sets_prop.erl b/lib/stdlib/test/property_test/gb_sets_prop.erl
new file mode 100644
index 0000000000..a4097904d9
--- /dev/null
+++ b/lib/stdlib/test/property_test/gb_sets_prop.erl
@@ -0,0 +1,303 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2021-2022. All Rights Reserved.
+%%
+%% 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.
+%%
+%% %CopyrightEnd%
+%%
+-module(gb_sets_prop).
+
+-include_lib("common_test/include/ct_property_test.hrl").
+
+%%%%%%%%%%%%%%%%%%
+%%% Properties %%%
+%%%%%%%%%%%%%%%%%%
+
+%% --- add/2 ----------------------------------------------------------
+%%
+%% add_element/2 is an alias for add/2
+%% Since add_element/2 is tested in sets_prop, this property only tests if
+%% the result of add/2 is the same as the result of add_element/2.
+prop_add() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             non_empty(ct_proper_ext:safe_list())},
+            {gb_sets:from_list(L1), L1 ++ L2}
+        ),
+        lists:all(fun(E) -> gb_sets:add(E, S) =:= gb_sets:add_element(E, S) end, L)
+    ).
+
+%% --- balance/1 ------------------------------------------------------
+prop_balance() ->
+    ?FORALL(
+        S,
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             ct_proper_ext:safe_list()},
+            lists:foldl(
+                fun gb_sets:del_element/2,
+                gb_sets:from_list(L1 ++ L2),
+                L1
+            )
+        ),
+        gb_sets:is_equal(S, gb_sets:balance(S))
+    ).
+
+%% --- delete/2 -------------------------------------------------------
+prop_delete() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             non_empty(ct_proper_ext:safe_list())},
+            {gb_sets:from_list(L1), L1 ++ L2}
+        ),
+        lists:all(
+            fun(E) ->
+                try
+                    gb_sets:delete(E, S) =:= gb_sets:del_element(E, S)
+                of
+                    _ -> gb_sets:is_element(E, S)
+                catch
+                    error:_ -> not gb_sets:is_element(E, S)
+                end
+            end,
+            L
+         )
+    ).
+
+%% --- delete_any/2 ---------------------------------------------------
+%%
+%% del_element/2 is an alias for delete_any/2
+%% Since del_element/2 is tested in sets_prop, this property only tests if
+%% the result of delete_any/2 is the same as the result of del_element/2.
+prop_delete_any() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             non_empty(ct_proper_ext:safe_list())},
+            {gb_sets:from_list(L1), L1 ++ L2}
+        ),
+        lists:all(fun(E) -> gb_sets:delete_any(E, S) =:= gb_sets:del_element(E, S) end, L)
+    ).
+
+%% --- difference/2 ---------------------------------------------------
+%%
+%% subtract/2 is an alias for difference/2
+%% Since subtract/2 is tested in sets_prop, this property only tests if
+%% the result of difference/2 is the same as the result of subtract/2.
+prop_difference() ->
+    ?FORALL(
+        {S1, S2},
+        ?LET(
+            {L1, L2, Both},
+            {ct_proper_ext:safe_list(),
+             ct_proper_ext:safe_list(),
+             ct_proper_ext:safe_list()},
+            {gb_sets:from_list(L1 ++ Both), gb_sets:from_list(L2 ++ Both)}
+        ),
+        gb_sets:difference(S1, S2) =:= gb_sets:subtract(S1, S2)
+    ).
+
+%% --- from_ordset/1 --------------------------------------------------
+prop_from_ordset() ->
+    ?FORALL(
+        L,
+        ct_proper_ext:safe_list(),
+        gb_sets:is_equal(gb_sets:from_list(L),
+                         gb_sets:from_ordset(ordsets:from_list(L)))
+    ).
+
+%% --- insert/2 -------------------------------------------------------
+prop_insert() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             non_empty(ct_proper_ext:safe_list())},
+            {gb_sets:from_list(L1), L1 ++ L2}
+        ),
+        lists:all(
+            fun(E) ->
+                try
+                    gb_sets:insert(E, S) =:= gb_sets:add_element(E, S)
+                of
+                    _ -> not gb_sets:is_element(E, S)
+                catch
+                    error:_ -> gb_sets:is_element(E, S)
+                end
+            end,
+            L
+         )
+    ).
+
+%% --- is_member/2 ----------------------------------------------------
+%%
+%% is_element/2 is an alias for is_member/2
+%% Since is_element/2 is tested in sets_prop, this property only tests if
+%% the result of is_member/2 is the same as the result of is_element/2.
+prop_is_member() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            {L1, L2},
+            {ct_proper_ext:safe_list(),
+             non_empty(ct_proper_ext:safe_list())},
+            {gb_sets:from_list(L1), L1 ++ L2}
+        ),
+        lists:all(fun(E) -> gb_sets:is_member(E, S) =:= gb_sets:is_element(E, S) end, L)
+    ).
+
+%% --- iterator/1 -----------------------------------------------------
+%%
+%% This property implicitly tests next/1
+prop_iterator() ->
+    ?FORALL(
+        {S, L},
+        ?LET(
+            L,
+            ct_proper_ext:safe_list(),
+            begin
+                L1 = lists:usort(L),
+                {gb_sets:from_list(L1), L1}
+            end
+        ),
+        do_iterate(gb_sets:iterator(S), L)
+    ).
+
+do_iterate(none, L) ->
+    L =:= [];
+do_iterate(I, []) ->
+    none =:= gb_sets:next(I);
+do_iterate(I0, L0) ->
+    {E, I1} = gb_sets:next(I0),
+    lists:member(E, L0) andalso
+    do_iterate_from(E, I1, lists:delete(E, L0)).
+
+%% --- iterator_from/2 ------------------------------------------------
+%%
+%% This property implicitly tests next/1
+prop_iterator_from() ->
+    ?FORALL(
+        {S, L, From},
+        ?LET(
+            {L, E},
+            {ct_proper_ext:safe_list(), ct_proper_ext:safe_any()},
+            begin
+                L1 = lists:usort(L),
+                L2 = lists:dropwhile(fun(X) -> X < E end, L1),
+                F = case L2 of
+                        [] -> E;
+                        _ -> oneof([E, hd(L2)])
+                    end,
+                {gb_sets:from_list(L1), L2, F}
+            end
+        ),
+        do_iterate_from(From, gb_sets:iterator_from(From, S), L)
+    ).
+
+do_iterate_from(_Min, none, L) ->
+    L =:= [];
+do_iterate_from(_Min, I, []) ->
+    none =:= gb_sets:next(I);
+do_iterate_from(Min, I0, L0) ->
+    {E, I1} = gb_sets:next(I0),
+    lists:member(E, L0) andalso
+    Min =< E andalso
+    do_iterate_from(E, I1, lists:delete(E, L0)).
+
+%% --- largest/1 ------------------------------------------------------
+prop_largest() ->
+    ?FORALL(
+        {Set, Largest},
+        ?LET(
+            L,
+            non_empty(ct_proper_ext:safe_list()),
+            begin
+                L1 = lists:usort(L),
+                {gb_sets:from_list(L1), lists:last(L1)}
+            end
+        ),
+        Largest =:= gb_sets:largest(Set)
+    ).
+
+%% --- singleton/1 ----------------------------------------------------
+prop_singleton() ->
+    ?FORALL(
+        E,
+        ct_proper_ext:safe_any(),
+        [E] =:= gb_sets:to_list(gb_sets:singleton(E))
+    ).
+
+%% --- smallest/1 -----------------------------------------------------
+prop_smallest() ->
+    ?FORALL(
+        {Set, Smallest},
+        ?LET(
+            L,
+            non_empty(ct_proper_ext:safe_list()),
+            begin
+                L1 = lists:usort(L),
+                {gb_sets:from_list(L1), hd(L1)}
+            end
+        ),
+        Smallest =:= gb_sets:smallest(Set)
+    ).
+
+%% --- take_largest/1 -------------------------------------------------
+prop_take_largest() ->
+    ?FORALL(
+        {S, Largest},
+        ?LET(
+            L,
+            non_empty(ct_proper_ext:safe_list()),
+            begin
+                L1 = lists:usort(L),
+                {gb_sets:from_list(L1), lists:last(L1)}
+            end
+        ),
+        begin
+            {Largest1, S1} = gb_sets:take_largest(S),
+            Largest1 =:= Largest andalso
+            gb_sets:is_equal(S1, gb_sets:del_element(Largest, S))
+        end
+    ).
+
+%% --- take_smallest/1 ------------------------------------------------
+prop_take_smallest() ->
+    ?FORALL(
+        {S, Smallest},
+        ?LET(
+            L,
+            non_empty(ct_proper_ext:safe_list()),
+            begin
+                L1 = lists:usort(L),
+                {gb_sets:from_list(L1), hd(L1)}
+            end
+        ),
+        begin
+            {Smallest1, S1} = gb_sets:take_smallest(S),
+            Smallest1 =:= Smallest andalso
+            gb_sets:is_equal(S1, gb_sets:del_element(Smallest, S))
+        end
+    ).
-- 
2.35.3

Places

File 6591-Property-based-tests-for-the-gb_sets-module.patch of Package erlang (Revision ef76582d9ec8723017fd1825f278d2c9)

Places