Fix edoc generation for MIM #3333

gustawlippa · 2021-10-12T14:43:33Z

This PR makes it possible to compile edoc for MIM (rebar3 edoc). It also fixes some warnings and deprecations - there are some left concerning header files.
It also adds Edoc to CI so it keeps on compiling in the future.

mongoose-im · 2021-10-12T14:54:25Z

small_tests_24 / small_tests / fdcaf98
Reports root / small

internal_mnesia_24 / internal_mnesia / fdcaf98
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 297 / Auto-skipped: 0

small_tests_23 / small_tests / fdcaf98
Reports root / small

dynamic_domains_pgsql_mnesia_23 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 2701 / Failed: 1 / User-skipped: 184 / Auto-skipped: 0

service_domain_db_SUITE:db:db_keeps_syncing_after_cluster_join

{error,{test_case_failed,{[<<"example1.com">>,<<"example2.com">>,
               <<"example3.com">>],
              [<<"example1.com">>,<<"example2.com">>,
               <<"example3.com">>,<<"example4.com">>]}}}

Report log

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 2727 / Failed: 1 / User-skipped: 184 / Auto-skipped: 0

rest_client_SUITE:muc:messages_can_be_paginated_in_room

{error,
  {{assertion_failed,assert,is_chat_message,
     [<<"026643bc">>],
     {xmlel,<<"message">>,
       [{<<"to">>,<<"1634-51405-716@muclight2.domain.example.com">>},
        {<<"type">>,<<"chat">>}],
       [{xmlel,<<"body">>,[],[{xmlcdata,<<"cac17253">>}]}]},
     "<message to='1634-51405-716@muclight2.domain.example.com' type='chat'><body>cac17253</body></message>"},
   [{escalus_new_assert,assert_true,2,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
       {line,84}]},
    {rest_client_SUITE,assert_room_messages,2,
      [{file,"/home/circleci/app/big_tests/tests/rest_client_SUITE.erl"},
       {line,772}]},
    {escalus_story,story,4,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
       {line,72}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1292}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1224}]}]}}

Report log

ldap_mnesia_23 / ldap_mnesia / fdcaf98
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 400 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / fdcaf98
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 400 / Auto-skipped: 0

pgsql_mnesia_23 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 3071 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

dynamic_domains_mysql_redis_24 / mysql_redis / fdcaf98
Reports root/ big
OK: 2685 / Failed: 0 / User-skipped: 201 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_24 / odbc_mssql_mnesia / fdcaf98
Reports root/ big
OK: 2702 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 3096 / Failed: 1 / User-skipped: 211 / Auto-skipped: 0

rest_client_SUITE:muc:messages_can_be_paginated_in_room

{error,
  {{assertion_failed,assert,is_chat_message,
     [<<"95434bb6">>],
     {xmlel,<<"message">>,
       [{<<"to">>,<<"1634-51684-350024@muclight.localhost">>},
        {<<"type">>,<<"chat">>}],
       [{xmlel,<<"body">>,[],[{xmlcdata,<<"3e790c5d">>}]}]},
     "<message to='1634-51684-350024@muclight.localhost' type='chat'><body>3e790c5d</body></message>"},
   [{escalus_new_assert,assert_true,2,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
       {line,84}]},
    {rest_client_SUITE,assert_room_messages,2,
      [{file,"/home/circleci/app/big_tests/tests/rest_client_SUITE.erl"},
       {line,772}]},
    {escalus_story,story,4,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
       {line,72}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1292}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1224}]}]}}

Report log

elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / fdcaf98
Reports root/ big
OK: 1862 / Failed: 0 / User-skipped: 323 / Auto-skipped: 0

mysql_redis_24 / mysql_redis / fdcaf98
Reports root/ big
OK: 3054 / Failed: 0 / User-skipped: 228 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / fdcaf98
Reports root/ big
OK: 1709 / Failed: 0 / User-skipped: 326 / Auto-skipped: 0

mssql_mnesia_24 / odbc_mssql_mnesia / fdcaf98
Reports root/ big
OK: 3071 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_23 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 2727 / Failed: 1 / User-skipped: 184 / Auto-skipped: 0

rest_client_SUITE:muc:messages_can_be_paginated_in_room

{error,
  {{assertion_failed,assert,is_chat_message,
     [<<"5d97c914">>],
     {xmlel,<<"message">>,
       [{<<"to">>,<<"1634-113627-889154@muclight2.domain.example.com">>},
        {<<"type">>,<<"chat">>}],
       [{xmlel,<<"body">>,[],[{xmlcdata,<<"5c544005">>}]}]},
     "<message to='1634-113627-889154@muclight2.domain.example.com' type='chat'><body>5c544005</body></message>"},
   [{escalus_new_assert,assert_true,2,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
       {line,84}]},
    {rest_client_SUITE,assert_room_messages,2,
      [{file,"/home/circleci/app/big_tests/tests/rest_client_SUITE.erl"},
       {line,772}]},
    {escalus_story,story,4,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
       {line,72}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1784}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1293}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1225}]}]}}

Report log

dynamic_domains_pgsql_mnesia_23 / pgsql_mnesia / fdcaf98
Reports root/ big
OK: 2702 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

codecov · 2021-10-12T14:54:32Z

Codecov Report

Merging #3333 (007f85a) into master (02b7e96) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3333      +/-   ##
==========================================
- Coverage   80.67%   80.67%   -0.01%     
==========================================
  Files         397      397              
  Lines       32440    32440              
==========================================
- Hits        26172    26170       -2     
- Misses       6268     6270       +2

Impacted Files	Coverage Δ
src/admin_extra/service_admin_extra_roster.erl	`87.41% <ø> (ø)`
src/auth/ejabberd_auth_dummy.erl	`68.18% <ø> (ø)`
src/ejabberd_cowboy.erl	`88.78% <ø> (ø)`
src/ejabberd_ctl.erl	`16.93% <ø> (ø)`
src/ejabberd_sm_backend_sup.erl	`100.00% <ø> (ø)`
src/event_pusher/mod_event_pusher_push_plugin.erl	`100.00% <ø> (ø)`
src/mod_roster.erl	`79.09% <ø> (ø)`
src/pubsub/mod_pubsub.erl	`73.17% <ø> (ø)`
src/event_pusher/mod_event_pusher.erl	`65.00% <0.00%> (-22.50%)`	⬇️
src/elasticsearch/mongoose_elasticsearch.erl	`76.92% <0.00%> (-7.70%)`	⬇️
... and 12 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 02b7e96...007f85a. Read the comment docs.

erszcz · 2021-10-12T15:11:51Z

The next step could be to add edoc compilation to the CI.

👍

Even if we don't actively use these docs yet, I think it would be worth just making sure rebar3 edoc doesn't start failing spuriously due to some future changes.

mongoose-im · 2021-10-13T09:04:58Z

small_tests_24 / small_tests / 4425218
Reports root / small

internal_mnesia_24 / internal_mnesia / 4425218
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 297 / Auto-skipped: 0

mongoose-im · 2021-10-13T09:06:19Z

small_tests_24 / small_tests / 007f85a
Reports root / small

internal_mnesia_24 / internal_mnesia / 007f85a
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 297 / Auto-skipped: 0

small_tests_23 / small_tests / 007f85a
Reports root / small

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 007f85a
Reports root/ big
OK: 2702 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / 007f85a
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 400 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_23 / pgsql_mnesia / 007f85a
Reports root/ big
OK: 2702 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

dynamic_domains_mysql_redis_24 / mysql_redis / 007f85a
Reports root/ big
OK: 2685 / Failed: 0 / User-skipped: 201 / Auto-skipped: 0

ldap_mnesia_23 / ldap_mnesia / 007f85a
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 400 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_24 / odbc_mssql_mnesia / 007f85a
Reports root/ big
OK: 2702 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / 007f85a
Reports root/ big
OK: 3071 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

pgsql_mnesia_23 / pgsql_mnesia / 007f85a
Reports root/ big
OK: 3070 / Failed: 1 / User-skipped: 211 / Auto-skipped: 0

service_domain_db_SUITE:db:db_keeps_syncing_after_cluster_join

{error,{test_case_failed,{[<<"example1.com">>,<<"example2.com">>,
               <<"example3.com">>],
              [<<"example1.com">>,<<"example2.com">>,
               <<"example3.com">>,<<"example4.com">>]}}}

Report log

mysql_redis_24 / mysql_redis / 007f85a
Reports root/ big
OK: 3054 / Failed: 0 / User-skipped: 228 / Auto-skipped: 0

elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / 007f85a
Reports root/ big
OK: 1862 / Failed: 0 / User-skipped: 323 / Auto-skipped: 0

mssql_mnesia_24 / odbc_mssql_mnesia / 007f85a
Reports root/ big
OK: 3071 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / 007f85a
Reports root/ big
OK: 1734 / Failed: 1 / User-skipped: 326 / Auto-skipped: 0

rest_client_SUITE:muc:messages_can_be_paginated_in_room

{error,
  {{assertion_failed,assert,is_chat_message,
     [<<"0f5300ad">>],
     {xmlel,<<"message">>,
       [{<<"to">>,<<"1634-117284-21378@muclight.localhost">>},
        {<<"type">>,<<"chat">>}],
       [{xmlel,<<"body">>,[],[{xmlcdata,<<"4b8cc1e4">>}]}]},
     "<message to='1634-117284-21378@muclight.localhost' type='chat'><body>4b8cc1e4</body></message>"},
   [{escalus_new_assert,assert_true,2,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
       {line,84}]},
    {rest_client_SUITE,assert_room_messages,2,
      [{file,"/home/circleci/app/big_tests/tests/rest_client_SUITE.erl"},
       {line,772}]},
    {escalus_story,story,4,
      [{file,
         "/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
       {line,72}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1292}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1224}]}]}}

Report log

pgsql_mnesia_23 / pgsql_mnesia / 007f85a
Reports root/ big
OK: 3071 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

mongoose-im · 2021-10-13T09:08:28Z

internal_mnesia_24 / internal_mnesia / 16e8210
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 297 / Auto-skipped: 0

chrzaszcz

Nice! There are a few warnings left that I can see in the edoc job on CI, but we could fix them later.

gustawlippa added 2 commits October 12, 2021 16:42

Fix edoc so it compiles

ee5cf3c

Remove deprecated specs

fdcaf98

gustawlippa force-pushed the fix-edoc branch from 16e8210 to 4425218 Compare October 13, 2021 08:54

Add Edoc to CI

007f85a

gustawlippa force-pushed the fix-edoc branch from 4425218 to 007f85a Compare October 13, 2021 08:55

esl deleted a comment from mongoose-im Oct 13, 2021

chrzaszcz approved these changes Oct 14, 2021

View reviewed changes

chrzaszcz merged commit b1b95ec into master Oct 14, 2021

chrzaszcz deleted the fix-edoc branch October 14, 2021 08:04

gustawlippa mentioned this pull request Mar 3, 2022

Add edoc generation to CI so that it fails if doc have syntax errors #2695

Closed

Premwoik added this to the 5.1.0 milestone May 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix edoc generation for MIM #3333

Fix edoc generation for MIM #3333

gustawlippa commented Oct 12, 2021 •

edited

mongoose-im commented Oct 12, 2021 •

edited

codecov bot commented Oct 12, 2021 •

edited

erszcz commented Oct 12, 2021

mongoose-im commented Oct 13, 2021 •

edited

mongoose-im commented Oct 13, 2021 •

edited

mongoose-im commented Oct 13, 2021

chrzaszcz left a comment •

edited

Fix edoc generation for MIM #3333

Fix edoc generation for MIM #3333

Conversation

gustawlippa commented Oct 12, 2021 • edited

mongoose-im commented Oct 12, 2021 • edited

codecov bot commented Oct 12, 2021 • edited

Codecov Report

erszcz commented Oct 12, 2021

mongoose-im commented Oct 13, 2021 • edited

mongoose-im commented Oct 13, 2021 • edited

mongoose-im commented Oct 13, 2021

chrzaszcz left a comment • edited

Choose a reason for hiding this comment

gustawlippa commented Oct 12, 2021 •

edited

mongoose-im commented Oct 12, 2021 •

edited

codecov bot commented Oct 12, 2021 •

edited

mongoose-im commented Oct 13, 2021 •

edited

mongoose-im commented Oct 13, 2021 •

edited

chrzaszcz left a comment •

edited