|
%% Test suite for the rebar pkg index caching and decompression
|
|
%% mechanisms.
|
|
-module(rebar_pkg_SUITE).
|
|
-compile(export_all).
|
|
-include_lib("common_test/include/ct.hrl").
|
|
-include_lib("eunit/include/eunit.hrl").
|
|
|
|
-define(bad_etag, "abcdef").
|
|
-define(good_etag, "22e1d7387c9085a462340088a2a8ba67").
|
|
-define(bad_checksum, <<"D576B442A68C7B92BACDE1EFE9C6E54D8D6C74BDB71D8175B9D3C6EC8C7B62A7">>).
|
|
-define(good_checksum, <<"1C6CE379D191FBAB41B7905075E0BF87CBBE23C77CECE775C5A0B786B2244C35">>).
|
|
|
|
all() -> [good_uncached, good_cached, badindexchk, badpkg,
|
|
badhash_nocache, badhash_cache,
|
|
bad_to_good, good_disconnect, bad_disconnect, pkgs_provider,
|
|
find_highest_matching].
|
|
|
|
init_per_suite(Config) ->
|
|
application:start(meck),
|
|
Config.
|
|
|
|
end_per_suite(_Config) ->
|
|
application:stop(meck).
|
|
|
|
init_per_testcase(pkgs_provider=Name, Config) ->
|
|
%% Need to mock out a registry for this test now because it will try to update it automatically
|
|
Priv = ?config(priv_dir, Config),
|
|
Tid = ets:new(registry_table, [public]),
|
|
ets:insert_new(Tid, []),
|
|
CacheRoot = filename:join([Priv, "cache", atom_to_list(Name)]),
|
|
CacheDir = filename:join([CacheRoot, "hex", "com", "test", "packages"]),
|
|
filelib:ensure_dir(filename:join([CacheDir, "registry"])),
|
|
ok = ets:tab2file(Tid, filename:join([CacheDir, "registry"])),
|
|
meck:new(rebar_packages, [passthrough]),
|
|
meck:expect(rebar_packages, registry_dir, fun(_) -> {ok, CacheDir} end),
|
|
meck:expect(rebar_packages, package_dir, fun(_) -> {ok, CacheDir} end),
|
|
rebar_prv_update:hex_to_index(rebar_state:new()),
|
|
Config;
|
|
init_per_testcase(good_uncached=Name, Config0) ->
|
|
Config = [{good_cache, false},
|
|
{pkg, {<<"goodpkg">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
mock_config(Name, Config);
|
|
init_per_testcase(good_cached=Name, Config0) ->
|
|
Pkg = {<<"goodpkg">>, <<"1.0.0">>},
|
|
Config1 = [{good_cache, true},
|
|
{pkg, Pkg}
|
|
| Config0],
|
|
Config = mock_config(Name, Config1),
|
|
copy_to_cache(Pkg, Config),
|
|
Config;
|
|
init_per_testcase(badindexchk=Name, Config0) ->
|
|
Config = [{good_cache, false},
|
|
{pkg, {<<"badindexchk">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
mock_config(Name, Config);
|
|
init_per_testcase(badpkg=Name, Config0) ->
|
|
Config = [{good_cache, false},
|
|
{pkg, {<<"badpkg">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
mock_config(Name, Config);
|
|
init_per_testcase(badhash_nocache=Name, Config0) ->
|
|
Config = [{good_cache, false},
|
|
{pkg, {<<"goodpkg">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
mock_config(Name, Config);
|
|
init_per_testcase(badhash_cache=Name, Config0) ->
|
|
Pkg = {<<"goodpkg">>, <<"1.0.0">>},
|
|
Config1 = [{good_cache, true},
|
|
{pkg, Pkg}
|
|
| Config0],
|
|
Config = mock_config(Name, Config1),
|
|
copy_to_cache(Pkg, Config),
|
|
Config;
|
|
init_per_testcase(bad_to_good=Name, Config0) ->
|
|
Config1 = [{good_cache, false},
|
|
{pkg, {<<"goodpkg">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
Config = mock_config(Name, Config1),
|
|
Source = filename:join(?config(data_dir, Config), <<"badpkg-1.0.0.tar">>),
|
|
Dest = filename:join(?config(cache_dir, Config), <<"goodpkg-1.0.0.tar">>),
|
|
ec_file:copy(Source, Dest),
|
|
Config;
|
|
init_per_testcase(good_disconnect=Name, Config0) ->
|
|
Pkg = {<<"goodpkg">>, <<"1.0.0">>},
|
|
Config1 = [{good_cache, true},
|
|
{pkg, Pkg}
|
|
| Config0],
|
|
Config = mock_config(Name, Config1),
|
|
copy_to_cache(Pkg, Config),
|
|
meck:unload(httpc),
|
|
meck:new(httpc, [passthrough, unsticky]),
|
|
meck:expect(httpc, request, fun(_, _, _, _, _) -> {error, econnrefused} end),
|
|
Config;
|
|
init_per_testcase(bad_disconnect=Name, Config0) ->
|
|
Pkg = {<<"goodpkg">>, <<"1.0.0">>},
|
|
Config1 = [{good_cache, false},
|
|
{pkg, Pkg}
|
|
| Config0],
|
|
Config = mock_config(Name, Config1),
|
|
meck:unload(httpc),
|
|
meck:new(httpc, [passthrough, unsticky]),
|
|
meck:expect(httpc, request, fun(_, _, _, _, _) -> {error, econnrefused} end),
|
|
Config;
|
|
init_per_testcase(Name, Config0) ->
|
|
Config = [{good_cache, false},
|
|
{pkg, {<<"goodpkg">>, <<"1.0.0">>}}
|
|
| Config0],
|
|
mock_config(Name, Config).
|
|
|
|
end_per_testcase(_, Config) ->
|
|
unmock_config(Config),
|
|
Config.
|
|
|
|
good_uncached(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
?assertEqual({ok, true},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
Cache = ?config(cache_dir, Config),
|
|
?assert(filelib:is_regular(filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>))).
|
|
|
|
good_cached(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
Cache = ?config(cache_dir, Config),
|
|
CachedFile = filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>),
|
|
?assert(filelib:is_regular(CachedFile)),
|
|
{ok, Content} = file:read_file(CachedFile),
|
|
?assertEqual({ok, true},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
{ok, Content} = file:read_file(CachedFile).
|
|
|
|
badindexchk(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
?assertMatch({bad_registry_checksum, _Path},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
%% The cached file is there for forensic purposes
|
|
Cache = ?config(cache_dir, Config),
|
|
?assert(filelib:is_regular(filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>))).
|
|
|
|
badpkg(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
?assertMatch({bad_download, _Path},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
%% The cached file is there for forensic purposes
|
|
Cache = ?config(cache_dir, Config),
|
|
?assert(filelib:is_regular(filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>))).
|
|
|
|
badhash_nocache(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
?assertMatch({unexpected_hash, _Path, ?bad_checksum, ?good_checksum},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?bad_checksum}, State)),
|
|
%% The cached file is there for forensic purposes
|
|
Cache = ?config(cache_dir, Config),
|
|
?assert(filelib:is_regular(filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>))).
|
|
|
|
badhash_cache(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
Cache = ?config(cache_dir, Config),
|
|
State = ?config(state, Config),
|
|
CachedFile = filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>),
|
|
?assert(filelib:is_regular(CachedFile)),
|
|
{ok, Content} = file:read_file(CachedFile),
|
|
?assertMatch({unexpected_hash, _Path, ?bad_checksum, ?good_checksum},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?bad_checksum}, State)),
|
|
%% The cached file is there still, unchanged.
|
|
?assert(filelib:is_regular(CachedFile)),
|
|
?assertEqual({ok, Content}, file:read_file(CachedFile)).
|
|
|
|
bad_to_good(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
Cache = ?config(cache_dir, Config),
|
|
CachedFile = filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>),
|
|
?assert(filelib:is_regular(CachedFile)),
|
|
{ok, Contents} = file:read_file(CachedFile),
|
|
?assertEqual({ok, true},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
%% Cache has refreshed
|
|
?assert({ok, Contents} =/= file:read_file(CachedFile)).
|
|
|
|
good_disconnect(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
Cache = ?config(cache_dir, Config),
|
|
CachedFile = filename:join(Cache, <<Pkg/binary, "-", Vsn/binary, ".tar">>),
|
|
?assert(filelib:is_regular(CachedFile)),
|
|
{ok, Content} = file:read_file(CachedFile),
|
|
?assertEqual({ok, true},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)),
|
|
{ok, Content} = file:read_file(CachedFile).
|
|
|
|
bad_disconnect(Config) ->
|
|
Tmp = ?config(tmp_dir, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
State = ?config(state, Config),
|
|
?assertEqual({fetch_fail, Pkg, Vsn},
|
|
rebar_pkg_resource:download(Tmp, {pkg, Pkg, Vsn, ?good_checksum}, State)).
|
|
|
|
pkgs_provider(Config) ->
|
|
Config1 = rebar_test_utils:init_rebar_state(Config),
|
|
rebar_test_utils:run_and_check(
|
|
Config1, [], ["pkgs"],
|
|
{ok, []}
|
|
).
|
|
|
|
find_highest_matching(_Config) ->
|
|
State = rebar_state:new(),
|
|
{ok, Vsn} = rebar_packages:find_highest_matching(
|
|
<<"test">>, <<"1.0.0">>, <<"goodpkg">>, <<"1.0.0">>, package_index, State),
|
|
?assertEqual(<<"1.0.1">>, Vsn),
|
|
{ok, Vsn1} = rebar_packages:find_highest_matching(
|
|
<<"test">>, <<"1.0.0">>, <<"goodpkg">>, <<"1.0">>, package_index, State),
|
|
?assertEqual(<<"1.1.1">>, Vsn1),
|
|
{ok, Vsn2} = rebar_packages:find_highest_matching(
|
|
<<"test">>, <<"1.0.0">>, <<"goodpkg">>, <<"2.0">>, package_index, State),
|
|
?assertEqual(<<"2.0.0">>, Vsn2).
|
|
|
|
|
|
%%%%%%%%%%%%%%%
|
|
%%% Helpers %%%
|
|
%%%%%%%%%%%%%%%
|
|
mock_config(Name, Config) ->
|
|
Priv = ?config(priv_dir, Config),
|
|
CacheRoot = filename:join([Priv, "cache", atom_to_list(Name)]),
|
|
TmpDir = filename:join([Priv, "tmp", atom_to_list(Name)]),
|
|
Tid = ets:new(registry_table, [public]),
|
|
ets:insert_new(Tid, [
|
|
{<<"badindexchk">>,[[<<"1.0.0">>]]},
|
|
{<<"goodpkg">>,[[<<"1.0.0">>, <<"1.0.1">>, <<"1.1.1">>, <<"2.0.0">>]]},
|
|
{<<"badpkg">>,[[<<"1.0.0">>]]},
|
|
{{<<"badindexchk">>,<<"1.0.0">>}, [[], ?bad_checksum, [<<"rebar3">>]]},
|
|
{{<<"goodpkg">>,<<"1.0.0">>}, [[], ?good_checksum, [<<"rebar3">>]]},
|
|
{{<<"goodpkg">>,<<"1.0.1">>}, [[], ?good_checksum, [<<"rebar3">>]]},
|
|
{{<<"goodpkg">>,<<"1.1.1">>}, [[], ?good_checksum, [<<"rebar3">>]]},
|
|
{{<<"goodpkg">>,<<"2.0.0">>}, [[], ?good_checksum, [<<"rebar3">>]]},
|
|
{{<<"badpkg">>,<<"1.0.0">>}, [[], ?good_checksum, [<<"rebar3">>]]}
|
|
]),
|
|
CacheDir = filename:join([CacheRoot, "hex", "com", "test", "packages"]),
|
|
filelib:ensure_dir(filename:join([CacheDir, "registry"])),
|
|
ok = ets:tab2file(Tid, filename:join([CacheDir, "registry"])),
|
|
|
|
%% The state returns us a fake registry
|
|
meck:new(rebar_state, [passthrough]),
|
|
meck:expect(rebar_state, get,
|
|
fun(_State, rebar_packages_cdn, _Default) ->
|
|
"http://test.com/"
|
|
end),
|
|
|
|
meck:new(rebar_dir, [passthrough]),
|
|
meck:expect(rebar_dir, global_cache_dir, fun(_) -> CacheRoot end),
|
|
|
|
meck:new(rebar_packages, [passthrough]),
|
|
meck:expect(rebar_packages, registry_dir, fun(_) -> {ok, CacheDir} end),
|
|
meck:expect(rebar_packages, package_dir, fun(_) -> {ok, CacheDir} end),
|
|
rebar_prv_update:hex_to_index(rebar_state:new()),
|
|
|
|
%% Cache fetches are mocked -- we assume the server and clients are
|
|
%% correctly used.
|
|
GoodCache = ?config(good_cache, Config),
|
|
{Pkg,Vsn} = ?config(pkg, Config),
|
|
PkgFile = <<Pkg/binary, "-", Vsn/binary, ".tar">>,
|
|
{ok, PkgContents} = file:read_file(filename:join(?config(data_dir, Config), PkgFile)),
|
|
meck:new(httpc, [passthrough, unsticky]),
|
|
meck:expect(httpc, request,
|
|
fun(get, {_Url, _Opts}, _, _, _) when GoodCache ->
|
|
{ok, {{Vsn, 304, <<"Not Modified">>}, [{"etag", ?good_etag}], <<>>}};
|
|
(get, {_Url, _Opts}, _, _, _) ->
|
|
{ok, {{Vsn, 200, <<"OK">>}, [{"etag", ?good_etag}], PkgContents}}
|
|
end),
|
|
[{cache_root, CacheRoot},
|
|
{cache_dir, CacheDir},
|
|
{tmp_dir, TmpDir},
|
|
{mock_table, Tid} | Config].
|
|
|
|
unmock_config(Config) ->
|
|
meck:unload(),
|
|
ets:delete(?config(mock_table, Config)).
|
|
|
|
copy_to_cache({Pkg,Vsn}, Config) ->
|
|
Name = <<Pkg/binary, "-", Vsn/binary, ".tar">>,
|
|
Source = filename:join(?config(data_dir, Config), Name),
|
|
Dest = filename:join(?config(cache_dir, Config), Name),
|
|
ec_file:copy(Source, Dest).
|