ypconstante

ypconstante

How to enable the native code coverage from OTP 27?

I’m trying to enable the native coverage from OTP 27, but so far nothing has worked.

I’ve added erlc_options: [:debug_info, :line_coverage, {:line_coverage, true}] to the project config and set the environment variable ERL_AFLAGS="+JPcover true", but it didn’t do anything.

I added these lines to a test to see what is happening:

      dbg :code.coverage_support() # true
      dbg :code.get_coverage_mode() # :line_counters
      dbg :code.get_coverage_mode(mod) # :none

All project modules have :none as the coverage mode, only if I run with :cover that it changes to :line_counters.

Is there a way to have coverage without :cover compiling the modules? Locally :cover compile takes 7 seconds, so I’m trying to find a way to speed it up, or to have coverage without using it.

Most Liked

bjorng

bjorng

Erlang Core Team

No, that’s correct. That will tell the Erlang compiler to instrument the code. However, it seems that the way the Elixir compiler invokes the Erlang compiler, line_coverage instrumentation will not work for Elixir code.

To confirm, I changed your setup to:

export ERL_COMPILER_OPTIONS=[line_coverage,force_line_counters,time]

That will instruct the Erlang compiler to print the name of each pass it executes.

If I then compile an Erlang module, the first few passes will be shown as follows:

Eshell V15.2.4 (press Ctrl+G to abort, type help(). for help)
1> c(t).
Compiling t.erl
 remove_file                   :      0.000 s       0.9 kB
 parse_module                  :      0.006 s       2.5 kB
 transform_module              :      0.000 s       2.5 kB
 lint_module                   :      0.005 s       2.5 kB
 beam_docs                     :      0.002 s       2.5 kB
 remove_doc_attributes         :      0.000 s       2.5 kB
 compile_directives            :      0.000 s       2.5 kB
 sys_coverage                  :      0.001 s       2.8 kB
 expand_records                :      0.002 s       2.8 kB
 core                          :      0.007 s      20.9 kB
 sys_core_fold                 :      0.003 s      14.7 kB
 sys_core_alias                :      0.001 s      14.7 kB

The sys_coverage pass is the pass that adds the executable_line instructions.

If I compile using the Elixir compiler, the sys_coverage pass is not run:

ex(1)> c "test.ex"
Compiling /Users/bjorng/git/otp/test.ex
 get_module_name_from_core     :      0.000 s      25.5 kB
 core_lint_module              :      0.000 s      25.8 kB
 sys_core_fold                 :      0.000 s      20.9 kB
 sys_core_alias                :      0.000 s      20.9 kB
 core_transforms               :      0.000 s      20.9 kB

That’s why there are no executable_line instructions in the generated BEAM code.

josevalim

josevalim

Creator of Elixir

I believe cover will use native coverage by default. The native coverage speeds up the time for running tests, it may not necessarily speed up the time for compiling nor building the reports.

ypconstante

ypconstante

It doesn’t, after running time mix test some_test_file.exs --cover multiple times,

Test output:

Finished in 0.1 seconds (0.1s async, 0.00s sync)
22 tests, 0 failures

Time output:

mix test some_test_file.exs --cover  58.22s user 12.81s system 449% cpu 15.812 total

:cover compiling takes 7 seconds, and then the rest of the time is spent on creating the summary and HTML generation. On CI --cover adds a whole minute, which is the main reason I wanted to enable this native coverage.

ypconstante

ypconstante

I did make some progress, but still didn’t manage to make it work

Environment variables

export ERL_COMPILER_OPTIONS="[line_coverage,force_line_counters]"
export ELIXIR_ERL_OPTIONS="+JPcover line_counters"
    dbg :code.coverage_support() # true
    dbg :code.get_coverage_mode() # :line_counters
    dbg :code.get_coverage_mode(mod) # :line_counters
    dbg mod.module_info()[:compile][:options] # [:no_spawn_compiler_process, :from_core, :no_core_prepare, :no_auto_import, :line_coverage, :force_line_counters]
    dbg :code.get_coverage(:line, mod)  # []

:code.get_coverage is returning an empty list, but if I init :cover it returns the expected data.

bjorng

bjorng

Erlang Core Team

Do you see any executable_line instructions if you disassemble the compiled module?

This should be the way to do it from Elixir:

:beam_disasm.file(mod)

Here is an extract from a disassembly of one of my Erlang modules:

     [{function,t,1,2,
                      [{label,1},
                       {line,1},
                       {func_info,{atom,t},{atom,t},1},
                       {label,2},
                       {executable_line,2,1},
                       {executable_line,3,4},
                       {call_only,1,{t,'-t/1-lc$^0/1-0-',1}}]},

Yes, cover uses native coverage on systems that support it.

Where Next?

Popular in Questions Top

srinivasu
How to handle excepions in elixir? Suppose i have A, B, C ,D, E modules. and each module has get() function. A.get() method will call th...
New
Werner
Hi, I’m using Ubuntu 18.04 and after updating to OTP-24.0 yesterday i have this warning when I run “mix local.hex”: 14:57:30.512 [warn] ...
New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
Kagamiiiii
Student & New to elixir. Nice language. I want to convert a english character, e.g. “a”, which is stored in a variable, to it’s asci...
New
lk-geimfari
What is most correct way to open, read and parse JSON file with poison? For example if we have example.json file in root of some projec...
New
Fl4m3Ph03n1x
Background Let’s assume I have a typical GenServer that receives messages as requests, does some operation in a DB and returns responses....
New
gonzofish
I’m currently trying to understand how to join three tables using Ecto. All the examples I’ve seen use 2, so maybe I’m just missing somet...
New
chewm
Hi guys, nice to meet you to the whole forum, I’m new here, I’m trying to configure visual studio code for elixir, right now the intellis...
New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
wernerlaude
In AR this is so simple @articles = current_user.articles How to do in Ecto? def index(conn, _params) do current_user = conn.assig...
New

Other popular topics Top

senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 35421 110
New
New
mcarvalho
What is the difference between System.get_env and Application.get_env? For example, what are best practices to use one versus another.
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
belgoros
I’m not a pro in using Regex and can’t figure out why the following behaviour happens, especially if we take into account the difference ...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers' Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New

We're in Beta

About us Mission Statement