Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[skip ci] Basic IQ Handler tutorial automates Common Test. #2307

Merged
merged 2 commits into from
May 24, 2019
Merged

[skip ci] Basic IQ Handler tutorial automates Common Test. #2307

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a72bc0
[skip ci] Basic IQ Handler tutorial automates Common Test.
NelsonVides May 16, 2019
ca7a8f6
Fix typo: pararell -> parallel
erszcz May 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 10 additions & 23 deletions doc/developers-guide/Basic-iq-handler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,14 @@ The server may use one of the following strategies to handle incoming stanzas:
be handled
* `{queues, N}` spawns **N** processes. Every incoming stanza will be then
handled by one of those processes
* `pararell` registers the handler without spawning a new process, a new process will be spawned
for each incoming stanza
* `parallel` registers the handler without spawning a new process, a new process
will be spawned for each incoming stanza


## Test your handler

Go to `big_tests/tests` and create a test suite for your handler.
Implement the test case for success and failure.
Our IQ handler is enabled only for one domain, which is `localhost`.
We will register two users, which are predefined in `$REPO/big_tests/test.config`:

```erlang
Expand All @@ -96,8 +95,9 @@ We will register two users, which are predefined in `$REPO/big_tests/test.config
{password, <<"matygrysa">>}]},
```

After sending an IQ stanza to `alice` we should get a result, but our IQ
handler is not enabled for `localhost.bis` domain, so we should get an error.
Our IQ handler will be enabled only for one domain, `localhost`.
After sending an IQ stanza to `alice` we should get a result, but as our IQ
handler is not enabled for `localhost.bis` domain, we should get an error.

```erlang
-module(mod_iq_example_SUITE).
Expand Down Expand Up @@ -145,9 +145,13 @@ suite() ->
%%--------------------------------------------------------------------

init_per_suite(Config) ->
Domain = ct:get_config({hosts, mim, domain}),
dynamic_modules:start(Domain, mod_iq_example, [no_opts]),
escalus:init_per_suite(Config).

end_per_suite(Config) ->
Domain = ct:get_config({hosts, mim, domain}),
dynamic_modules:stop(Domain, mod_iq_example),
escalus:end_per_suite(Config).

init_per_group(_, Config) ->
Expand Down Expand Up @@ -181,7 +185,7 @@ should_return_result(Config) ->

should_return_error(Config) ->
%% given
escalus:story(Config, [{alice_invalid_domain, 1}], fun(Alice) ->
escalus:story(Config, [{alice_bis, 1}], fun(Alice) ->
%% when sending a request with unregistered server
Req = escalus_stanza:iq_get(?EXAMPLE_NS, [#xmlel{name = <<"example">>}]),
ct:pal("req: ~p", [Req]),
Expand All @@ -204,23 +208,6 @@ Go to `$REPO/_build/mim1/rel/mongooseim` and start one MongooseIM node.
```bash
$ bin/mongooseim live
```

The module has to be compiled and then started in order to test it.

```erlang
(mongooseim@localhost)> c(mod_iq_example).
Recompiling /Users/zofiapolkowska/MongooseIM/_build/mim1/lib/mongooseim/src/mod_iq_example.erl
{ok,mod_iq_example}
(mongooseim@localhost)1> gen_mod:is_loaded(<<"localhost">>, mod_iq_example).
false
(mongooseim@localhost)> gen_mod:start_module(<<"localhost">>, mod_iq_example, [no_opts]).
{ok,{register_iq_handler,<<"localhost">>,
<<"erlang-solutions.com:example">>,mod_iq_example,
process_iq,no_queue}}
(mongooseim@localhost)1> gen_mod:is_loaded(<<"localhost">>, mod_iq_example).
true
```

Open up a new terminal window, go to `$REPO` and use the [test runner](Testing-MongooseIM).
Run single suite with the already started `mim1` node.

Expand Down