Merge pull request #4545 from esl/pep-native-bookmarks

XEP-0402 PEP Native Bookmarks

Author: jacekwegr

big_tests/rebar.config

@@ -13,7 +13,7 @@
         {proper, "1.4.0"},
         {gun, "2.1.0"},
         {fusco, "0.1.1"},
-        {escalus, "4.5.1"},
+        {escalus, "4.5.3"},
         {ranch, "2.2.0"},
         {cowboy, "2.13.0"},
         {csv, "3.0.3", {pkg, csve}},

big_tests/rebar.lock

@@ -10,7 +10,7 @@
  {<<"ct_groups_summary_hook">>,
   {pkg,<<"ct_groups_summary_hook">>,<<"0.1.1">>},
   0},
- {<<"escalus">>,{pkg,<<"escalus">>,<<"4.5.1">>},0},
+ {<<"escalus">>,{pkg,<<"escalus">>,<<"4.5.3">>},0},
  {<<"esip">>,{pkg,<<"esip">>,<<"1.0.57">>},0},
  {<<"exml">>,{pkg,<<"hexml">>,<<"4.1.2">>},0},
  {<<"fast_pbkdf2">>,{pkg,<<"fast_pbkdf2">>,<<"2.0.0">>},2},
@@ -42,7 +42,7 @@
  {<<"credentials_obfuscation">>, <<"34E18B126B3AEFD6E8143776FBE1CECEEA6792307C99AC5EE8687911F048CFD7">>},
  {<<"csv">>, <<"69E7D9B3FDC72016644368762C6A3E6CBFEB85BCCADBF1BD99AB6C827E360E04">>},
  {<<"ct_groups_summary_hook">>, <<"21B94902B6CF2D345F4D790D34B49654E71CB8E570DCCC9C1C3616DAE720A7AA">>},
- {<<"escalus">>, <<"A79B93BC013219078C13C004766287CC97045D75A8BF893163B8FF7E5DD521CD">>},
+ {<<"escalus">>, <<"A6BC39DD7648E56FB4514E323FC566C59B8B4F53A40ED6E89811BD4E5325DA53">>},
  {<<"esip">>, <<"4B14E4832D08B9FFC10D855B5D10B3083232B1D53DEB4C046679496CE85569C4">>},
  {<<"exml">>, <<"4EA6B95AF18922F94FD67BBDEAA325A75CCE04487083C786E7417BA862D590E5">>},
  {<<"fast_pbkdf2">>, <<"72CDEE3C10C6B9B40E31194DE946A883CEEF6CF1F37D7FC9FD1A9D87502723F5">>},
@@ -73,7 +73,7 @@
  {<<"credentials_obfuscation">>, <<"738ACE0ED5545D2710D3F7383906FC6F6B582D019036E5269C4DBD85DBCED566">>},
  {<<"csv">>, <<"741D1A55AABADAA3E0FE13051050101A73E90C4570B9F9403A939D9546813521">>},
  {<<"ct_groups_summary_hook">>, <<"997CDE48FEB0C398989E4091A341D4FFF43CFA06CDB8FB2E80CC4A0E0362691C">>},
- {<<"escalus">>, <<"FE4BACC8E6875334341872C188A5C68CD749DB362F189617D3520F6D25C7B145">>},
+ {<<"escalus">>, <<"34559C804CC44F2ADC2B8B466153E023A4C9D76AE97D18CA5F5447C1D4F85D07">>},
  {<<"esip">>, <<"19C357E1817B1E04792EF359BF900400F3E6D0E5ADE929FD72F88EA9B44AF2ED">>},
  {<<"exml">>, <<"03883AE3E27970E9DAC204B27CE330B54A6C2772455E43FE2319349DFF40B1DC">>},
  {<<"fast_pbkdf2">>, <<"74159FD09FB8BF5E97D25137C6C83C28E2CF7E97D7C127D83310DFD0904BD732">>},

big_tests/tests/pep_SUITE.erl

@@ -13,37 +13,7 @@
 -include_lib("exml/include/exml.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
--export([suite/0, all/0, groups/0]).
--export([init_per_suite/1, end_per_suite/1,
-         init_per_group/2, end_per_group/2,
-         init_per_testcase/2, end_per_testcase/2]).
-
--export([
-         disco_test/1,
-         disco_sm_test/1,
-         disco_sm_node_test/1,
-         disco_sm_items_test/1,
-         disco_sm_items_node_test/1,
-         pep_caps_test/1,
-         publish_and_notify_test/1,
-         auto_create_with_publish_options_test/1,
-         publish_options_success_test/1,
-         publish_options_fail_unknown_option_story/1,
-         publish_options_fail_wrong_value_story/1,
-         publish_options_fail_wrong_form/1,
-         send_caps_after_login_test/1,
-         delayed_receive/1,
-         delayed_receive_with_sm/1,
-         h_ok_after_notify_test/1,
-         authorize_access_model/1,
-         unsubscribe_after_presence_unsubscription/1
-        ]).
-
--export([
-         start_caps_clients/2,
-         send_initial_presence_with_caps/2,
-         add_config_to_create_node_request/1
-        ]).
+-compile([export_all, nowarn_export_all]).
 
 -import(distributed_helper, [mim/0,
                              require_rpc_nodes/1,
@@ -85,7 +55,8 @@ groups() ->
            delayed_receive_with_sm,
            h_ok_after_notify_test,
            authorize_access_model,
-           unsubscribe_after_presence_unsubscription
+           unsubscribe_after_presence_unsubscription,
+           native_bookmarks_test
           ]
          },
          {cache_tests, [parallel],
@@ -233,6 +204,42 @@ pep_caps_test(Config) ->
               send_caps_disco_result(Bob, DiscoRequest, NodeNS)
       end).
 
+native_bookmarks_test(Config) ->
+    Config1 = set_caps(Config, ?NS_PEP_BOOKMARKS),
+    escalus:fresh_story_with_config(Config1, [{bob, 1}], fun native_bookmarks_story/2).
+
+%% Minimal test for XEP-0402
+native_bookmarks_story(Config, Bob) ->
+    NodeNS = ?config(node_ns, Config),
+    PublishOptions = [{<<"pubsub#persist_items">>, <<"true">>},
+                      {<<"pubsub#max_items">>, <<"max">>},
+                      {<<"pubsub#send_last_published_item">>, <<"never">>},
+                      {<<"pubsub#access_model">>, <<"whitelist">>}],
+    Options = [{with_payload, {true, bookmark_element()}}],
+    Id = <<"[email protected]">>,
+    BobJid = escalus_utils:get_short_jid(Bob),
+
+    %% Example 6. Client adds a new bookmark
+    pubsub_tools:publish_with_options(Bob, Id, {pep, NodeNS}, Options, PublishOptions),
+
+    %% Example 12. Client receives a new bookmark notification
+    pubsub_tools:receive_item_notification(Bob, Id, {BobJid, NodeNS}, []),
+
+    %% Example 4. Client retrieves all bookmarks
+    pubsub_tools:get_all_items(Bob, {pep, NodeNS}, [{expected_result, [Id]}]),
+
+    %% Example 10. Client removes a bookmark
+    pubsub_tools:retract_item(Bob, {pep, NodeNS}, Id, [{notify, true}]),
+
+    %% Example 14. Client receives a bookmark retraction notification
+    pubsub_tools:receive_retract_notification(Bob, Id, {BobJid, NodeNS}, []),
+
+    pubsub_tools:get_all_items(Bob, {pep, NodeNS}, [{expected_result, []}]).
+
+bookmark_element() ->
+    #xmlel{name = <<"conference">>,
+           attrs = #{<<"xmlns">> => ?NS_PEP_BOOKMARKS}}.
+
 publish_and_notify_test(Config) ->
     Config1 = set_caps(Config),
     escalus:fresh_story_with_config(Config1, [{alice, 1}, {bob, 1}], fun publish_and_notify_story/3).
@@ -591,8 +598,11 @@ verify_publish_options(FullNodeConfig, Options) ->
                            end, Options).
 
 set_caps(Config) ->
+    set_caps(Config, random_node_ns()).
+
+set_caps(Config, NS) ->
     [{escalus_overrides, [{start_ready_clients, {?MODULE, start_caps_clients}}]},
-     {node_ns, random_node_ns()} | Config].
+     {node_ns, NS} | Config].
 
 %% Implemented only for one resource per client, because it is enough
 start_caps_clients(Config, [{UserSpec, Resource}]) ->
@@ -622,7 +632,7 @@ caps(PEPNodeNS) ->
     #xmlel{name = <<"c">>,
            attrs = #{<<"xmlns">> => ?NS_CAPS,
                      <<"hash">> => <<"sha-1">>,
-                     <<"node">> => caps_node_name(),
+                     <<"node">> => random_name(),
                      <<"ver">> => caps_hash(PEPNodeNS)}}.
 
 features(PEPNodeNS) ->
@@ -637,14 +647,14 @@ ns_notify(NS) ->
     <<NS/binary, "+notify">>.
 
 random_node_ns() ->
+    random_name().
+
+random_name() ->
     base64:encode(crypto:strong_rand_bytes(16)).
 
 caps_hash(PEPNodeNS) ->
     rpc(mim(), mod_caps, make_disco_hash, [feature_elems(PEPNodeNS), sha1]).
 
-caps_node_name() ->
-    <<"http://www.chatopus.com">>.
-
 send_presence(From, Type, To) ->
     ToJid = escalus_client:short_jid(To),
     Stanza = escalus_stanza:presence_direct(ToJid, Type),

big_tests/tests/pubsub_SUITE.erl

@@ -483,7 +483,7 @@ publish_with_max_items_test(Config) ->
               %% would always arrive before a retraction notification for an old item
               pubsub_tools:publish(Alice, <<"item2">>, Node, []),
               pubsub_tools:receive_item_notification(Bob, <<"item2">>, Node, []),
-              verify_item_retract(Node, <<"item1">>, escalus:wait_for_stanza(Bob)),
+              pubsub_tools:receive_retract_notification(Bob, <<"item1">>, Node, []),
 
               pubsub_tools:delete_node(Alice, Node, [])
       end).
@@ -604,7 +604,7 @@ retract_test(Config) ->
                                              [{<<"pubsub#notify_retract">>, <<"1">>}], []),
               pubsub_tools:subscribe(Bob, Node, []),
               pubsub_tools:retract_item(Alice, Node, <<"item2">>, []),
-              verify_item_retract(Node, <<"item2">>, escalus:wait_for_stanza(Bob)),
+              pubsub_tools:receive_retract_notification(Bob, <<"item2">>, Node, []),
               pubsub_tools:get_all_items(Bob, Node, [{expected_result, []}]),
 
               pubsub_tools:delete_node(Alice, Node, [])
@@ -1985,18 +1985,6 @@ default_config() ->
      {<<"pubsub#type">>, <<>>},
      {<<"pubsub#collection">>, []}].
 
-verify_item_retract({NodeAddr, NodeName}, ItemId, Stanza) ->
-    escalus:assert(is_message, Stanza),
-    NodeAddr = exml_query:attr(Stanza, <<"from">>),
-
-    [#xmlel{ attrs = #{<<"xmlns">> := ?NS_PUBSUB_EVENT} } = Event]
-        = exml_query:subelements(Stanza, <<"event">>),
-
-    [#xmlel{ attrs = #{<<"node">> := NodeName} } = Items]
-        = exml_query:subelements(Event, <<"items">>),
-
-    [#xmlel{ attrs = #{<<"id">> := ItemId} }] = exml_query:subelements(Items, <<"retract">>).
-
 verify_config_event({NodeAddr, NodeName}, ConfigChange, Stanza) ->
     escalus:assert(is_message, Stanza),
     NodeAddr = exml_query:attr(Stanza, <<"from">>),

big_tests/tests/pubsub_tools.erl

@@ -143,7 +143,11 @@ publish_request(Id, User, ItemId, Node, Options, PublishOptions) ->
 
 retract_item(User, Node, ItemId, Options) ->
     Id = id(User, Node, <<"retract">>),
-    Request = escalus_pubsub_stanza:retract(User, Id, Node, ItemId),
+    Attrs = case proplists:get_value(notify, Options) of
+        Bool when is_boolean(Bool) -> #{<<"notify">> => atom_to_binary(Bool)};
+        undefined -> #{}
+    end,
+    Request = escalus_pubsub_stanza:retract(User, Id, Node, ItemId, Attrs),
     send_request_and_receive_response(User, Request, Id, Options).
 
 get_all_items(User, {_, NodeName} = Node, Options) ->
@@ -257,6 +261,10 @@ receive_item_notification(User, ItemId, {NodeAddr, NodeName}, Options) ->
     Stanza = receive_notification(User, NodeAddr, Options),
     check_item_notification(Stanza, ItemId, {NodeAddr, NodeName}, Options).
 
+receive_retract_notification(User, ItemId, {NodeAddr, NodeName}, Options) ->
+    Stanza = receive_notification(User, NodeAddr, Options),
+    check_retract_notification(Stanza, ItemId, {NodeAddr, NodeName}).
+
 receive_subscription_notification(User, Subscription, {NodeAddr, NodeName}, Options) ->
     Stanza = receive_notification(User, NodeAddr, Options),
     check_subscription_notification(User, Stanza, Subscription, NodeName, Options).
@@ -389,15 +397,6 @@ check_node_creation_notification(Response, NodeName) ->
     Response.
 
 check_item_notification(Response, ItemId, {NodeAddr, NodeName}, Options) ->
-    try
-        do_check_item_notification(Response, ItemId, {NodeAddr, NodeName}, Options)
-    catch Class:Reason:StackTrace ->
-              ct:pal("failed to check response=~p", [Response]),
-              erlang:raise(Class, Reason, StackTrace)
-    end,
-    Response.
-
-do_check_item_notification(Response, ItemId, {NodeAddr, NodeName}, Options) ->
     check_notification(Response, NodeAddr),
     true = escalus_pred:has_type(<<"headline">>, Response),
     Items = exml_query:path(Response, [{element, <<"event">>},
@@ -406,6 +405,17 @@ do_check_item_notification(Response, ItemId, {NodeAddr, NodeName}, Options) ->
     check_items(Items, [ItemId], NodeName),
     ok.
 
+check_retract_notification(Response, ItemId, {NodeAddr, NodeName}) ->
+    check_notification(Response, NodeAddr),
+    true = escalus_pred:has_type(<<"headline">>, Response),
+    [#xmlel{ attrs = #{<<"xmlns">> := ?NS_PUBSUB_EVENT} } = Event] =
+        exml_query:subelements(Response, <<"event">>),
+    [#xmlel{ attrs = #{<<"node">> := NodeName} } = Items] =
+        exml_query:subelements(Event, <<"items">>),
+    [#xmlel{ attrs = #{<<"id">> := ItemId} }] =
+        exml_query:subelements(Items, <<"retract">>),
+    ok.
+
 send_request_and_receive_response(User, Request, Id, Options) ->
     send_request_and_receive_response(User, Request, Id, Options, fun(R) -> R end).