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
|
%%%-------------------------------------------------------------------
%%% File: stub.erl
%%% @author Cliff Moon <> []
%%% @copyright 2009 Cliff Moon
%%% @doc
%%%
%%% @end
%%%
%%% @since 2009-05-10 by Cliff Moon
%%%-------------------------------------------------------------------
-module(stub).
-author('cliff@powerset.com').
-behaviour(gen_server).
%% API
-export([stub/3, stub/4, proxy_call/3]).
%% gen_server callbacks
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
terminate/2, code_change/3]).
-include_lib("eunit/include/eunit.hrl").
-include("../include/common.hrl").
-record(state, {old_code, module, stub, times}).
%%====================================================================
%% API
%%====================================================================
stub(Module, Function, Fun) ->
stub(Module, Function, Fun, 1).
stub(Module, Function, Fun, Times) when is_function(Fun) ->
gen_server:start({local, name(Module, Function)}, ?MODULE, [Module, Function, Fun, Times], []).
proxy_call(_, Name, Args) ->
{Times, Reply} = gen_server:call(Name, {proxy_call, Args}),
if
Times =< 0 -> gen_server:cast(Name, stop);
true -> ok
end,
Reply.
%%====================================================================
%% gen_server callbacks
%%====================================================================
%%--------------------------------------------------------------------
%% @spec init(Args) -> {ok, State} |
%% {ok, State, Timeout} |
%% ignore |
%% {stop, Reason}
%% @doc Initiates the server
%% @end
%%--------------------------------------------------------------------
init([Module, Function, Fun, Times]) ->
case code:get_object_code(Module) of
{Module, Bin, Filename} ->
?debugMsg("stubbing"),
stub_function(Module, Function, arity(Fun)),
{ok, #state{module=Module,old_code={Module,Bin,Filename},times=Times,stub=Fun}};
error -> {stop, ?fmt("Could not get object code for module ~p", [Module])}
end.
%%--------------------------------------------------------------------
%% @spec
%% handle_call(Request, From, State) -> {reply, Reply, State} |
%% {reply, Reply, State, Timeout} |
%% {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, Reply, State} |
%% {stop, Reason, State}
%% @doc Handling call messages
%% @end
%%--------------------------------------------------------------------
handle_call({proxy_call, Args}, _From, State = #state{stub=Fun, times=Times}) ->
Reply = apply(Fun, tuple_to_list(Args)),
{reply, {Times-1, Reply}, State#state{times=Times-1}}.
%%--------------------------------------------------------------------
%% @spec handle_cast(Msg, State) -> {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, State}
%% @doc Handling cast messages
%% @end
%%--------------------------------------------------------------------
handle_cast(stop, State) ->
sleep:timer(10),
{stop, normal, State}.
%%--------------------------------------------------------------------
%% @spec handle_info(Info, State) -> {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, State}
%% @doc Handling all non call/cast messages
%% @end
%%--------------------------------------------------------------------
handle_info(_Info, State) ->
{noreply, State}.
%%--------------------------------------------------------------------
%% @spec terminate(Reason, State) -> void()
%% @doc This function is called by a gen_server when it is about to
%% terminate. It should be the opposite of Module:init/1 and do any necessary
%% cleaning up. When it returns, the gen_server terminates with Reason.
%% The return value is ignored.
%% @end
%%--------------------------------------------------------------------
terminate(_Reason, #state{old_code={_Module,_Bin,_Filename}}) ->
ok.
%%--------------------------------------------------------------------
%% @spec code_change(OldVsn, State, Extra) -> {ok, NewState}
%% @doc Convert process state when code is changed
%% @end
%%--------------------------------------------------------------------
code_change(_OldVsn, State, _Extra) ->
{ok, State}.
%%--------------------------------------------------------------------
%%% Internal functions
%%--------------------------------------------------------------------
name(Module, Function) ->
list_to_atom(lists:concat([Module, Function, "stub"])).
stub_function(Module, Function, Arity) ->
{_, Bin, _} = code:get_object_code(Module),
{ok, {Module,[{abstract_code,{raw_abstract_v1,Forms}}]}} = beam_lib:chunks(Bin, [abstract_code]),
?debugMsg("replacing function"),
StubbedForms = replace_function(Module, Function, Arity, Forms),
case compile:forms(StubbedForms, [binary]) of
{ok, Module, Binary} -> code:load_binary(Module, atom_to_list(Module) ++ ".erl", Binary);
Other -> Other
end.
arity(Fun) when is_function(Fun) ->
Props = erlang:fun_info(Fun),
proplists:get_value(arity, Props).
replace_function(Module, Function, Arity, Forms) ->
replace_function(Module, Function, Arity, Forms, []).
replace_function(_Module, _Function, _Arity, [], Acc) ->
lists:reverse(Acc);
replace_function(Module, Function, Arity, [{function, Line, Function, Arity, _Clauses}|Forms], Acc) ->
lists:reverse(Acc) ++ [{function, Line, Function, Arity, [
{clause,
Line,
generate_variables(Arity),
[],
generate_expression(stub,proxy_call,Module,name(Module,Function),Arity)}]}] ++ Forms;
replace_function(Module, Function, Arity, [Form|Forms], Acc) ->
replace_function(Module, Function, Arity, Forms, [Form|Acc]).
generate_variables(0) -> [];
generate_variables(Arity) ->
lists:map(fun(N) ->
{var, 1, list_to_atom(lists:concat(['Arg', N]))}
end, lists:seq(1, Arity)).
generate_expression(M, F, Module, Name, 0) ->
[{call,1,{remote,1,{atom,1,M},{atom,1,F}}, [{atom,1,Module}, {atom,1,Name}]}];
generate_expression(M, F, Module, Name, Arity) ->
[{call,1,{remote,1,{atom,1,M},{atom,1,F}}, [{atom,1,Module}, {atom,1,Name}, {tuple,1,lists:map(fun(N) ->
{var, 1, list_to_atom(lists:concat(['Arg', N]))}
end, lists:seq(1, Arity))}]}].
|
