Safer CT hook error handling

[arcusfelis]

When I was testing suites, I was generating errors from all/0 and groups/0 callbacks. And CT works really strange and not informative.

Two problems:

• it does not print the error, just "location is unknown"
• it passes that error to CT hooks, and that's why this PR.

Before CTH was crashing when handling SUITE crash during the init:

*** CT 2021-05-24 12:32:43.391 *** Suite Hook
Call to CTH failed: error:{{test_case_failed,
                               {open_file_failed,'test@Mikhails-MacBook-Pro',
                                   "/Users/mikhailuvarov/erlang/esl/MongooseIM/big_tests/ct_report/ct_run.test@Mikhails-MacBook-Pro.2021-05-24_12.32.42/undefined/../../../mongooseim@localhost.log.html",
                                   {error,enoent}}},
                           [{ct_mongoose_log_hook,ensure_initialized,2,
                                [{file,
                                     "/Users/mikhailuvarov/erlang/esl/MongooseIM/big_tests/src/ct_mongoose_log_hook.erl"},
                                 {line,176}]},
                            {ct_mongoose_log_hook,pre_init_per_testcase,3,
                                [{file,
                                     "/Users/mikhailuvarov/erlang/esl/MongooseIM/big_tests/src/ct_mongoose_log_hook.erl"},
                                 {line,81}]},
                            {ct_hooks,catch_apply,3,
                                [{file,"ct_hooks.erl"},{line,491}]},
                            {ct_hooks,do_call_generic,4,
                                [{file,"ct_hooks.erl"},{line,247}]},
                            {ct_hooks,call,4,
                                [{file,"ct_hooks.erl"},{line,301}]},
                            {ct_hooks,call,4,
                                [{file,"ct_hooks.erl"},{line,304}]},
                            {ct_hooks,call,3,
                                [{file,"ct_hooks.erl"},{line,257}]}]}

*** CT 2021-05-24 12:32:43.391 *** Suite Hook
Call to CTH failed: error:{function_clause,
                           [{proplists,get_value,
                             [priv_dir,
                              {fail,
                               "ct_mongoose_log_hook:pre_init_per_testcase/3 CTH call failed"},
                              undefined],
                             [{file,"proplists.erl"},{line,215}]},
                            {ct_mongoose_log_hook,keep_priv_dir,2,
                             [{file,
                               "/Users/mikhailuvarov/erlang/esl/MongooseIM/big_tests/src/ct_mongoose_log_hook.erl"},
                              {line,193}]},
                            {ct_mongoose_log_hook,pre_init_per_testcase,3,
                             [{file,
                               "/Users/mikhailuvarov/erlang/esl/MongooseIM/big_tests/src/ct_mongoose_log_hook.erl"},
                              {line,80}]},
                            {ct_hooks,catch_apply,3,
                             [{file,"ct_hooks.erl"},{line,491}]},
                            {ct_hooks,do_call_generic,4,
                             [{file,"ct_hooks.erl"},{line,247}]},
                            {ct_hooks,call,4,
                             [{file,"ct_hooks.erl"},{line,301}]},
                            {ct_hooks,call,4,
                             [{file,"ct_hooks.erl"},{line,304}]},
                            {ct_hooks,call,3,
                             [{file,"ct_hooks.erl"},{line,257}]}]}

*** CT Error Notification 2021-05-24 12:32:43.391 ***
Error detected: 'mam_SUITE:groups/0 failed'

Full error description and stacktrace

=== Ended at 2021-05-24 12:32:43
=== Location: unknown
=== === Reason: 'mam_SUITE:groups/0 failed'

After it is not crashing in the handler. Theoretically, it allows CT to fail with the origin SUITE error, but CT is broken, so it just eats the original error location anyway. We should go and fix it in otp upstream, probably it got broken during introducing line numbering.

[codecov]

Codecov Report

Merging #3133 (d5ca4d0) into master (5166ab3) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3133   +/-   ##
=======================================
  Coverage   79.46%   79.47%           
=======================================
  Files         395      395           
  Lines       32168    32168           
=======================================
+ Hits        25563    25566    +3     
+ Misses       6605     6602    -3     

Impacted Files	Coverage Δ
src/pubsub/node_hometree.erl	77.77% <0.00%> (-5.56%)	⬇️
...bal_distrib/mod_global_distrib_hosts_refresher.erl	71.69% <0.00%> (-1.89%)	⬇️
src/wpool/mongoose_wpool.erl	84.00% <0.00%> (-1.00%)	⬇️
src/ejabberd_sm.erl	84.17% <0.00%> (-0.34%)	⬇️
src/mam/mod_mam_utils.erl	89.56% <0.00%> (-0.34%)	⬇️
src/mod_muc_room.erl	77.45% <0.00%> (-0.06%)	⬇️
src/mod_muc_log.erl	77.72% <0.00%> (ø)
src/ejabberd_c2s.erl	89.57% <0.00%> (+0.29%)	⬆️
src/pubsub/mod_pubsub_db_mnesia.erl	92.82% <0.00%> (+0.42%)	⬆️
...c/global_distrib/mod_global_distrib_server_mgr.erl	77.40% <0.00%> (+0.56%)	⬆️
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5166ab3...d5ca4d0. Read the comment docs.

[NelsonVides]

LGTM