Module escalus_story

Function Index

make_all_clients_friends/1
make_everyone_friends/1
make_everyone_friends/2
send_initial_presence/1
start_ready_clients/2
story/3Run an test story using the standard format:.
story_with_client_list/3Run a story, but pass all the connected clients as a list.

Function Details

make_all_clients_friends/1

make_all_clients_friends(Clients::[escalus:client()]) -> ok

make_everyone_friends/1

make_everyone_friends(Config::escalus:config()) -> escalus:config()

make_everyone_friends/2

make_everyone_friends(Config0::escalus:config(), Users::[{term(), term()}]) -> escalus:config()

send_initial_presence/1

send_initial_presence(Client::escalus:client()) -> ok

start_ready_clients/2

start_ready_clients(Config::escalus:config(), FlatCDs::[term()]) -> [escalus:client()]

story/3

story(ConfigIn::escalus:config(), ResourceCounts::term(), Story::function()) -> term()

Run an test story using the standard format:

    story(Config, [{alice, 2}, {bob, 1}], fun (Alice1, Alice2, Bob) ->
              ...
          end).

story_with_client_list/3

story_with_client_list(ConfigIn::escalus:config(), ResourceCounts::term(), Story::function()) -> term()

Run a story, but pass all the connected clients as a list. This is needed when the number of resources is variable (pseudo-Erlang!):

    story(Config, [{alice, 2}, {bob, N}], fun (Alice1, Alice2, Bob1, Bob2, ..., BobN) ->
              ...
          end).

The closest we can get is:

    story(Config, [{alice, 2}, {bob, N}], fun (Clients) ->
              [Alice1, Alice2, Bob1 | BobsUpToN] = Clients,
              ...
          end).
See carboncopy_SUITE test properties for an example: https://github.com/esl/MongooseIM/blob/f0ed90a93e17f7f3d5baf4d51bbb3f8b19826dd8/test.disabled/ejabberd_tests/tests/carboncopy_SUITE.erl#L183-L185


Generated by EDoc