summaryrefslogtreecommitdiff
path: root/test/rebar_alias_SUITE.erl
blob: d6e27d95cb93d0d308dd80e2bcf69f6a397cd8cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
-module(rebar_alias_SUITE).
-compile([export_all]).

-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").

init_per_suite(Config) -> Config.
end_per_suite(_Config) -> ok.

init_per_testcase(_, Config) ->
    rebar_test_utils:init_rebar_state(Config, "alias_").

end_per_testcase(_, _Config) ->
    ok.

all() -> [command, args, many, override_default, no_circular, release,
          check_namespaces, create_lib].

command() ->
    [{doc, "Runs multiple regular commands as one alias"}].
command(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_command_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [compile, unlock]}]}],

    %% compile job ran
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["test"], {ok, [{app, Name}]}),
    %% unlock job also ran
    Lockfile = filename:join(?config(apps, Config), "rebar.lock"),
    ?assertNot(filelib:is_file(Lockfile)),
    ok.

args() ->
    [{doc, "Runs multiple regular commands as one alias, some of "
           "which have default arguments"}].
args(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_args_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [{eunit,"-c"}, cover]}]}],

    %% test job ran (compiled and succeeded)
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["test"], {ok, [{app, Name}]}),
    %% cover job also ran, meaning eunit had coverage on, otherwise
    %% the index file is not generated.
    CoverFile = filename:join([?config(apps, Config),
                               "_build", "test", "cover", "index.html"]),
    ?assert(filelib:is_file(CoverFile)),
    ok.

many() ->
    [{doc, "Multiple aliases may be registered"}].
many(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_args_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [{eunit,"-c"}, cover]},
                            {nolock, [compile, unlock]}]}],

    %% test job ran (compiled and succeeded)
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["test"], {ok, [{app, Name}]}),
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["nolock"], {ok, [{app, Name}]}),
    %% both jobs ran (see args/1 and command/1)
    CoverFile = filename:join([?config(apps, Config),
                               "_build", "test", "cover", "index.html"]),
    ?assert(filelib:is_file(CoverFile)),
    Lockfile = filename:join(?config(apps, Config), "rebar.lock"),
    ?assertNot(filelib:is_file(Lockfile)),
    ok.

override_default() ->
    [{doc, "An alias cannot take over a default provider"}].
override_default(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_override_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{compile, [help]}]}],

    %% App compiles anyway
    rebar_test_utils:run_and_check(Config, RebarConfig, ["compile"],
                                   {ok, [{app, Name}]}),
    ok.

no_circular() ->
    [{doc, "An alias cannot define itself as itself"},
     {timetrap, 2000}].
no_circular(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_circular_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [help, {test,"-a"}, compile]}]}],

    %% Code does not deadlock forever and errors by not knowing
    %% the command
    rebar_test_utils:run_and_check(Config, RebarConfig, ["test"],
                {error, [$C,$o,$m,$m,$a,$n,$d,$ ,"test",$ ,$n,$o,$t,$ ,
                         $f,$o,$u,$n,$d]}),
    ok.

release() ->
    [{doc, "An alias for a release command"}].
release(Config) ->
    AppDir = ?config(apps, Config),

    Name = rebar_test_utils:create_random_name("alias_release_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{relx,
                    [{release, {skipped_release, Vsn}, []},
                     {release, {the_release, Vsn}, [list_to_atom(Name)]},
                     {lib_dirs, [AppDir]}]},
                   {alias,
                    [{the_rel1, [clean, {release, "-n the_release"}]},
                     {the_rel2, [clean, {release, "--relname=the_release"}]}]}],
    rebar_test_utils:run_and_check(
      Config, RebarConfig,
      ["the_rel1"],
      {ok, [{release, the_release, Vsn, false}]}),
    rebar_test_utils:run_and_check(
      Config, RebarConfig,
      ["the_rel2"],
      {ok, [{release, the_release, Vsn, false}]}),
    ok.

check_namespaces() ->
    [{doc, "Test calling commands with namespaces from rebar3"}].
check_namespaces(Config) ->
    AppDir = ?config(apps, Config),
    Name = rebar_test_utils:create_random_name("alias_args_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [{eunit,"-c"}, {plugins, list}]}]}],
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["test"], {ok, [{app, Name}]}),
    ok.

create_lib() ->
    [{doc, "Test calling commands with namespaces from rebar3"}].
create_lib(Config) ->
    AppDir = ?config(apps, Config),
    Name = rebar_test_utils:create_random_name("create_lib_"),
    Vsn = rebar_test_utils:create_random_vsn(),
    rebar_test_utils:create_app(AppDir, Name, Vsn, [kernel, stdlib]),
    RebarConfig = [{alias, [{test, [compile, {do, "new lib shouldexist"}]}]}],
    rebar_test_utils:run_and_check(Config, RebarConfig,
                                   ["test"], {ok, [{app, Name}]}),
    AppFile = filename:join(?config(apps, Config),
                            "../../../../shouldexist/src/shouldexist.app.src"),
    ?assert(filelib:is_file(AppFile)),
    ok.