vereis / erlpkg Goto Github PK

Pkgutils is implemented in such a way that the exposed functions change based on whether or not it is currently being run from inside of an Erlpkg.

This is because originally I believed this to be the best way of allowing IO dependent unit testing to be tested but this isn't the case.

Instead I suggest that all calls to pkgutil functions which reflect upon the calling Erlpkg instead are implemented as follows:

%% EXISTING CODE:
-spec pkg_extract_file(file:filename_all()) -> file:filename_all().
-spec pkg_extract_file(file:filename_all(), file:name_all()) -> file:filename_all().

%% PROPOSED CHANGE:
-spec pkg_extract_file(zip:handle(), file:filename_all()) -> file:filename_all().
-spec pkg_extract_file(zip:handle(), file:filename_all(), file:name_all()) -> file:filename_all().

%% and implement a new pkg_extract/1 and pkg_extract/2 which looks like
pkg_extract_file(FileName) ->
    pkg_extract(pkg_open(), FileName, pkg_tmp_dir()).
pkg_extract_file(FileName, ExtractDir) ->
    pkg_extract(pkg_open(), FileName, ExtractDir).
-endif.

This will allow us to unit test pkgutils as it will be able to operate on external erlpkgs instead of being limited to reflecting upon the running erlpkg.

These changes will only be changes to internal functions since the exposed interface will stay the same unless for some reason this seems like something pkgutils should be able to do?

Proposed function changes:

[pkg_extract/0,
pkg_extract/1,
pkg_extract_file/1,
pkg_extract_file/2,
pkg_extract_dir/1,
pkg_extract_dir/2,
pkg_reflect/0,
pkg_reflect/1].