Replace inttest external dependency to gpb with a mock

In inttest/proto_gpb, replace the external dependency to gpb, a
protocol buffer compiler, with a simple mock.

The mock provides enough of what is needed for inttest only,
which is to generate some dummy content, but with proper file names.

As a result, the increased timeout for the proto_gpb inttest should no
longer be needed (inttest/proto_gpb/retest.config), both since the
mock is now much faster to compile, and since any network bandwidth or
connectivity issues have now been eliminated.
This commit is contained in:
Tomas Abrahamsson 2015-01-02 01:07:01 +01:00
parent b8e0018782
commit c82bf703ae
5 changed files with 87 additions and 8 deletions

View file

@ -0,0 +1,9 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
{application, gpb,
[{description, "Simple mock of gpb, with enough to generate dummy files"},
{vsn, "1"},
{registered, []},
{applications, [kernel, stdlib]},
{env, []}]}.

View file

@ -0,0 +1,4 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
-module(gpb).

View file

@ -0,0 +1,73 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2015 Tomas Abrahamsson (tomas.abrahamsson@gmail.com)
%%
%% 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(gpb_compile).
-export([file/2]).
%% Simulate gpb compiling some proto files,
%% but generate only enough of what's needed for testing -- dummy stuff only.
file(Proto, Opts) ->
Prefix = proplists:get_value(module_name_prefix, Opts, ""),
Suffix = proplists:get_value(module_name_suffix, Opts, ""),
ProtoBase = filename:basename(Proto, ".proto"),
ModBase = Prefix ++ ProtoBase ++ Suffix,
ErlDest = filename:join(get_erl_outdir(Opts), ModBase ++ ".erl"),
HrlDest = filename:join(get_hrl_outdir(Opts), ModBase ++ ".hrl"),
ok = file:write_file(ErlDest, erl_text(ModBase)),
ok = file:write_file(HrlDest, hrl_text(ModBase)).
erl_text(ModBase) ->
io_lib:format(
lines(["-module(~p).",
"-export([encode_msg/1]).",
"-export([decode_msg/2]).",
"",
"encode_msg(some_dummy_msg) -> <<1,2,3>>.",
"",
"decode_msg(<<1,2,3>>, _) -> some_dummy_msg."]),
[list_to_atom(ModBase)]).
hrl_text(ModBase) ->
io_lib:format(
lines(["-ifndef(~s_hrl).",
"-define(~s_hrl, true).",
"",
"%% some record definitions would normally go here...",
""
"-endif. %% ~s_hrl"]),
[ModBase, ModBase, ModBase]).
get_erl_outdir(Opts) ->
proplists:get_value(o_erl, Opts, get_outdir(Opts)).
get_hrl_outdir(Opts) ->
proplists:get_value(o_hrl, Opts, get_outdir(Opts)).
get_outdir(Opts) ->
proplists:get_value(o, Opts, ".").
lines(Lines) ->
lists:flatten([[L, $\n] || L <- Lines]).

View file

@ -3,14 +3,12 @@
{erl_opts,
[
{i, "deps/gpb/include"},
{platform_define, "R13|R14", 'NO_CALLBACK_ATTRIBUTE'}
]}.
{deps,
[
{gpb, [], {git, "git://github.com/tomas-abrahamsson/gpb",
{branch, "master"}}}
{gpb, [], {rsync, "../../../inttest/proto_gpb/mock/gpb"}}
]}.
{proto_compiler, gpb}.

View file

@ -1,5 +0,0 @@
%% On my slow old netbook with a 1.6GHz CPU, this inttest
%% takes about 40 seconds to run, of which network activity
%% is about 3s. Double that to make avoid unnecessary timeouts
%% on e.g. loaded shared hosts, or with slow network connections.
{timeout, 90000}.