Skip to content

Commit

Permalink
Merge pull request rebar#420 from tomas-abrahamsson/mock-gpb-and-prot…
Browse files Browse the repository at this point in the history
…obuffs-in-inttest

Mock gpb and protobuffs, in inttest, replacing external dependencies
  • Loading branch information
ferd committed Jan 7, 2015
2 parents b8e0018 + 2af51af commit d242472
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 12 deletions.
9 changes: 9 additions & 0 deletions inttest/proto_gpb/mock/gpb/src/gpb.app.src
Original file line number Diff line number Diff line change
@@ -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, []}]}.
4 changes: 4 additions & 0 deletions inttest/proto_gpb/mock/gpb/src/gpb.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et

-module(gpb).
73 changes: 73 additions & 0 deletions inttest/proto_gpb/mock/gpb/src/gpb_compile.erl
Original file line number Diff line number Diff line change
@@ -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]).
4 changes: 1 addition & 3 deletions inttest/proto_gpb/rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
5 changes: 0 additions & 5 deletions inttest/proto_gpb/retest.config

This file was deleted.

10 changes: 10 additions & 0 deletions inttest/proto_protobuffs/mock/protobuffs/src/protobuffs.app.src
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et

{application, protobuffs,
[{description,
"Simple mock of erlang_protobuffs, with enough to generate dummy files"},
{vsn, "1"},
{registered, []},
{applications, [kernel, stdlib]},
{env, []}]}.
4 changes: 4 additions & 0 deletions inttest/proto_protobuffs/mock/protobuffs/src/protobuffs.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et

-module(protobuffs).
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
%% -*- 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(protobuffs_compile).
-export([scan_file/2]).

%% Simulate protobuffs compiling some proto files,
%% but generate only enough of what's needed for testing -- dummy stuff only.
scan_file(Proto, _Opts) ->
ProtoBase = filename:basename(Proto, ".proto"),
ModBase = ProtoBase ++ "_pb",
BeamDest = filename:join(get_beam_outdir(), ModBase ++ ".beam"),
HrlDest = filename:join(get_hrl_outdir(), ModBase ++ ".hrl"),
ok = file:write_file(BeamDest, beam_text(ModBase)),
ok = file:write_file(HrlDest, hrl_text(ModBase)).

beam_text(ModBase) ->
Mod = list_to_atom(ModBase),
Forms = [mk_attr(module, Mod)], % just a -module(...). line
{ok, Mod, Bin} = compile:forms(Forms),
Bin.

mk_attr(AttrName, AttrValue) ->
erl_syntax:revert(
erl_syntax:attribute(erl_syntax:atom(AttrName),
[erl_syntax:abstract(AttrValue)])).

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_beam_outdir() ->
".".

get_hrl_outdir() ->
".".

lines(Lines) ->
lists:flatten([[L, $\n] || L <- Lines]).
6 changes: 2 additions & 4 deletions inttest/proto_protobuffs/rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@

{erl_opts,
[
{i, "deps/protobuffs/include"},
{platform_define, "R13|R14", 'NO_CALLBACK_ATTRIBUTE'}
]}.

{deps,
[
{protobuffs, [], {git, "git://github.com/basho/erlang_protobuffs",
{branch, "master"}}}
{protobuffs, [], {rsync, "../../../inttest/proto_protobuffs/mock/protobuffs"}}
]}.

%% The default proto compiler is protobuffs
%% so don't need to specify this
%% {proto_compiler, gpb}.
%% {proto_compiler, protobuffs}.

0 comments on commit d242472

Please sign in to comment.