| Overview |  |
| clean/0 | |
| create_fresh_user/2 | Creates a fresh user along with XMPP user on a server. |
| create_users/2 | Create fresh users for lower-level testing (NOT escalus:stories) The users are created and the config updated with their fresh usernames. |
| freshen_spec/2 | |
| freshen_specs/2 | freshen_spec/2 and freshen_specs/2 Creates a fresh spec without creating XMPP users on a server. |
| start/1 | |
| stop/1 | |
| story/3 | Run story with fresh users (non-breaking API). |
| story_with_client_list/3 | See escalus_story:story/3 for the difference between story/3 and story_with_client_list/3. |
| story_with_config/3 | Run story with fresh users AND fresh config passed as first argument If within a story there are references to the top-level Config object, discrepancies may arise when querying this config object for user data, as it will differ from the fresh config actually used by the story. |
| work_on_deleting_users/3 |
clean() -> no_return() | ok
create_fresh_user(Config, User) -> R
Config = escalus:config()User = escalus_users:resource_spec() | escalus_users:user_name()R = escalus_users:user_spec()
Creates a fresh user along with XMPP user on a server.
create_users(Config::escalus:config(), UserSpecs::[escalus_users:resource_spec()]) -> escalus:config()
Create fresh users for lower-level testing (NOT escalus:stories) The users are created and the config updated with their fresh usernames. The side effect is the creation of XMPP users on a server.
freshen_spec(Config, User) -> R
Config = escalus:config()User = escalus_users:user_name() | escalus_users:resource_spec()R = escalus_users:user_spec()
freshen_specs(Config::escalus:config(), UserSpecs::[escalus_users:resource_spec()]) -> R
freshen_spec/2 and freshen_specs/2 Creates a fresh spec without creating XMPP users on a server. It is useful when testing some lower level parts of the protocol i.e. some stream features. It is side-effect free.
start(Config::escalus:config()) -> ok
stop(X1::escalus:config()) -> ok | no_return()
story(Config::escalus:config(), UserSpecs::[escalus_users:resource_spec()], StoryFun::function()) -> any()
Run story with fresh users (non-breaking API). The generated fresh usernames will consist of the predefined {username, U} value prepended to a unique, per-story suffix.
{username, <<"alice">>} -> {username, <<"alice32.632506">>}
story_with_client_list(Config::escalus:config(), UserSpecs::[escalus_users:resource_spec()], StoryFun::function()) -> any()
See escalus_story:story/3 for the difference between story/3 and story_with_client_list/3.
story_with_config(Config::escalus:config(), UserSpecs::[escalus_users:resource_spec()], StoryFun::function()) -> any()
Run story with fresh users AND fresh config passed as first argument If within a story there are references to the top-level Config object, discrepancies may arise when querying this config object for user data, as it will differ from the fresh config actually used by the story. The story arguments can be changed from
fresh_story(C,[..],fun(Alice, Bob) ->
to
fresh_story_with_config(C,[..],fun(FreshConfig, Alice, Bob) ->and any queries rewritten to use FreshConfig within this scope
work_on_deleting_users(Ord::term(), Item::{term(), term()}, CollectingPid::pid()) -> ok
Generated by EDoc