summaryrefslogtreecommitdiff
path: root/inttest/profile/profile_rt.erl
blob: b128517655422a4f090477edbc33f333513fdafe (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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2014 Tuncer Ayaz
%%
%% Permission is hereby granted, free of charge, to any person obtaining a copy
%% of this software and associated documentation files (the "Software"), to deal
%% in the Software without restriction, including without limitation the rights
%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
%% copies of the Software, and to permit persons to whom the Software is
%% furnished to do so, subject to the following conditions:
%%
%% The above copyright notice and this permission notice shall be included in
%% all copies or substantial portions of the Software.
%%
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
%% THE SOFTWARE.
%% -------------------------------------------------------------------
-module(profile_rt).
-export([files/0,
         run/1]).

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

files() ->
    [
     {copy, "../../rebar", "rebar"}
    ].

run(_Dir) ->
    Cmd = "./rebar list-deps",
    FprofFiles = fprof_files(),
    EflameFiles = ["eflame.trace", "eflame.svg"],

    %% run a simple command (list-deps) without profiling
    SharedExpected = "==> profile_rt \\(list-deps\\)",
    %% run Cmd without profiling
    retest:log(info, "Check '~s' without profiling~n", [Cmd]),
    ok = check(Cmd, should_succeed, [SharedExpected], ["Profiling!"],
               [], FprofFiles ++ EflameFiles),

    %% run Cmd with fprof profiling
    retest:log(info, "Check '~s' with fprof profiling~n", [Cmd]),
    ok = check(Cmd ++ " -p", should_succeed,
               [SharedExpected, "Profiling!", "See fprof\.analysis"],
               ["See eflame\.svg"],
               FprofFiles, EflameFiles),
    delete_files(FprofFiles),

    %% run Cmd with explicitly selected fprof profiling
    retest:log(info, "Check '~s' with explicitly selected fprof profiling~n",
               [Cmd]),
    ok = check(Cmd ++ " -p profiler=fprof", should_succeed,
               [SharedExpected, "Profiling!", "See fprof\.analysis"],
               ["See eflame\.svg"],
               FprofFiles, EflameFiles),
    delete_files(FprofFiles),

    case code:lib_dir(eflame) of
        {error, bad_name} ->
            retest:log(info,
                       "eflame not found in code path. skip eflame test~n"),
            ok;
        _EflameDir ->
            %% run Cmd with eflame profiling
            retest:log(info, "Check '~s' with eflame profiling~n", [Cmd]),
            ok = check(Cmd ++ " -p profiler=eflame", should_succeed,
                       [SharedExpected, "Profiling!", "See eflame\.svg"],
                       ["See fprof\.analysis"],
                       EflameFiles, FprofFiles),
            delete_files(EflameFiles)
    end,

    ok.

fprof_files() ->
    FprofFiles = ["fprof.trace", "fprof.analysis"],
    CgrindFiles = ["fprof.cgrind"],
    case os:find_executable("erlgrind") of
        false ->
            retest:log(info,
                       "erlgrind escript not found. skip fprof.cgrind check~n"),
            FprofFiles;
        _ErlGrind ->
            FprofFiles ++ CgrindFiles
    end.

check(Cmd, FailureMode, ExpectedOutput, UnexpectedOutput,
      ExpectedFiles, UnexpectedFiles) ->
    case {retest:sh(Cmd), FailureMode} of
        {{error, _}=Error, should_succeed} ->
            retest:log(error, "cmd '~s' failed:~n~p~n", [Cmd, Error]),
            Error;
        {{ok, CapturedOutput}, should_succeed} ->
            JoinedOutput = string:join(CapturedOutput, "\n"),
            check1(Cmd, JoinedOutput, ExpectedOutput, UnexpectedOutput,
                   ExpectedFiles, UnexpectedFiles);
        {{error, {stopped, {_Rc, CapturedOutput}}}, should_fail} ->
            JoinedOutput = string:join(CapturedOutput, "\n"),
            check1(Cmd, JoinedOutput, ExpectedOutput, UnexpectedOutput,
                   ExpectedFiles, UnexpectedFiles)
    end.

check1(Cmd, CapturedOutput, ExpectedOutput, UnexpectedOutput,
       ExpectedFiles, UnexpectedFiles) ->
    ReOpts = [{capture, all, list}],
    ExMatches =
        lists:zf(
          fun(Pattern) ->
                  case re:run(CapturedOutput, Pattern, ReOpts) of
                      nomatch ->
                          retest:log(error,
                                     "Expected pattern '~s' missing "
                                     "in the following output:~n"
                                     "=== BEGIN ===~n~s~n=== END ===~n",
                                     [Pattern, CapturedOutput]),
                          {true, Pattern};
                      {match, _} ->
                          false
                  end
          end, ExpectedOutput),

    UnExMatches =
        lists:zf(
          fun(Pattern) ->
                  case re:run(CapturedOutput, Pattern, ReOpts) of
                      nomatch ->
                          false;
                      {match, [Match]} ->
                          retest:log(
                            console,
                            "Unexpected output when running cmd '~s':~n~s~n",
                            [Cmd, Match]),
                          {true, Match}
                  end
          end, UnexpectedOutput),

    ExFiles =
        lists:zf(
          fun(File) ->
                  case filelib:is_regular(File) of
                      true ->
                          false;
                      false ->
                          retest:log(error,
                                     "Expected file missing: ~s~n", [File]),
                          {true, File}
                  end
          end, ExpectedFiles),

    UnExFiles =
        lists:zf(
          fun(File) ->
                  case filelib:is_regular(File) of
                      true ->
                          retest:log(error,
                                     "Unexpected file found: ~s~n", [File]),
                          {true, File};
                      false ->
                          false
                  end
          end, UnexpectedFiles),

    case {ExMatches, UnExMatches, ExFiles, UnExFiles} of
        {[], [], [], []} ->
            ok;
        _ ->
            error
    end.

delete_files(Files) ->
    lists:foreach(fun(File) -> ok = file:delete(File) end, Files).

%%
%% Generate the contents of a simple .app file
%%
app(Name, Modules) ->
    App = {application, Name,
           [{description, atom_to_list(Name)},
            {vsn, "1"},
            {modules, Modules},
            {registered, []},
            {applications, [kernel, stdlib]}]},
    io_lib:format("~p.\n", [App]).