Regression test for #249

inttest/erlc/erlc_rt.erl

@@ -1,3 +1,5 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
 -module(erlc_rt).
 -export([files/0,
          run/1]).
@@ -7,6 +9,7 @@
 -define(MODULES,
         [first_xrl,
          first_yrl,
+         first_erl,
          foo,
          foo_app,
          foo_sup,
@@ -17,6 +20,7 @@
 -define(BEAM_FILES,
         ["first_xrl.beam",
          "first_yrl.beam",
+         "first_erl.beam",
          "foo.beam",
          "foo_app.beam",
          "foo_sup.beam",
@@ -35,7 +39,10 @@ files() ->
      {copy, "extra-src", "extra-src"},
      {copy, "mibs", "mibs"},
      {copy, "asn1", "asn1"},
-     {create, "ebin/foo.app", app(foo, ?MODULES)}
+     {create, "ebin/foo.app", app(foo, ?MODULES)},
+     %% deps
+     {create, "deps/foobar/ebin/foobar.app", app(foobar, [foobar])},
+     {copy, "foobar.erl", "deps/foobar/src/foobar.erl"}
     ].
 
 run(_Dir) ->
@@ -53,6 +60,38 @@ run(_Dir) ->
     ok = check_beams(true),
     ok = check_debug_info(false),
     ?assertMatch(true, filelib:is_regular(MibResult)),
+    %% Regression test for https://github.com/rebar/rebar/issues/249
+    %%
+    %% Root cause: We didn't have per-project .rebar/erlcinfo but just one in
+    %% <base_dir>/.rebar/erlcinfo.
+    %%
+    %% Solution: Ensure every project has its own .rebar/erlcinfo
+    %%
+    %% For the bug to happen, the following conditions must be met:
+    %%
+    %% 1. <base_dir>/rebar.config has erl_first_files
+    %% 2. one of the 'first' files depends on another file (in this
+    %%    case via -include_lib())
+    %% 3. a sub project's rebar.config, if any, has no erl_first_files entry
+    %%
+    %% Now because erl_first_files is retrieved via rebar_config:get_list/3,
+    %% base_dir/rebar.config's erl_first_files is inherited, and because we had
+    %% a shared <base_dir>/.rebar/erlcinfo instead of one per project, the
+    %% cached entry was reused. Next, while compiling the sub project
+    %% rebar_erlc_compiler:needs_compile/3 gets a last modification time of
+    %% zero for the 'first' file which does not exist inside the sub project.
+    %% This, and the fact that it has at least one dependency, makes
+    %% needs_compile/3 return 'true'. The root cause is that we didn't have per
+    %% project .rebar/erlcinfo. For <base_dir>/.rebar/erlcinfo to be populated,
+    %% base_dir has to be compiled at least once. Therefore, after the first
+    %% compile any compile processing the sub project will fail because
+    %% needs_compile/3 will always return true for the non-existent 'first'
+    %% file.
+    ?assertMatch({ok, _}, retest_sh:run("./rebar clean", [])),
+    ?assertMatch({ok, _}, retest_sh:run("./rebar compile", [])),
+    ok = check_beams(true),
+    ?assertMatch({ok, _}, retest_sh:run("./rebar compile", [])),
+    ok = check_beams(true),
     ok.
 
 check_beams(Exist) ->

inttest/erlc/extra-include/foo_extra.hrl

@@ -1 +1,3 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
 -define(FOO_EXTRA, foo_extra).

inttest/erlc/extra-src/foo_sup.erl

@@ -1,3 +1,5 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
 -module(foo_sup).
 
 -behavior(supervisor).

inttest/erlc/foobar.erl

@@ -0,0 +1,8 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
+-module(foobar).
+
+-export([test/0]).
+
+test() ->
+    true.

inttest/erlc/include/foo_core.hrl

@@ -1 +1,3 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
 -define(FOO_CORE, foo_core).

inttest/erlc/rebar.config

@@ -1,6 +1,8 @@
 %% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
 %% ex: ts=4 sw=4 ft=erlang et
-{erl_first_files, ["first_xrl.erl", "first_yrl.erl"]}.
+{erl_first_files, ["first_xrl.erl", "first_yrl.erl", "src/first_erl.erl"]}.
+
+{deps, [foobar]}.
 
 {erl_opts,
  [

inttest/erlc/src/first_erl.erl

@@ -0,0 +1,10 @@
+%% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
+-module(first_erl).
+
+-include_lib("eunit/include/eunit.hrl").
+
+-export([test/0]).
+
+test() ->
+    ?debugHere.