| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656 |
- #!/usr/bin/env -S escript -c
- %% -*- erlang-indent-level:4 -*-
- usage() ->
- "A script that fills in boilerplate for appup files.
- Algorithm: this script compares md5s of beam files of each
- application, and creates a `{load_module, Module, brutal_purge,
- soft_purge, []}` action for the changed and new modules. For deleted
- modules it creates `{delete_module, M}` action. These entries are
- added to each patch release preceding the current release. If an entry
- for a module already exists, this module is ignored. The existing
- actions are kept.
- Please note that it only compares the current release with its
- predecessor, assuming that the upgrade actions for the older releases
- are correct.
- Note: The defaults are set up for emqx, but they can be tuned to
- support other repos too.
- Usage:
- update_appup.escript [--check] [--repo URL] [--remote NAME] [--skip-build] [--make-commad SCRIPT] [--release-dir DIR] <previous_release_tag>
- Options:
- --check Don't update the appfile, just check that they are complete
- --repo Upstream git repo URL
- --remote Get upstream repo URL from the specified git remote
- --skip-build Don't rebuild the releases. May produce wrong results
- --make-command A command used to assemble the release
- --release-dir Release directory
- --src-dirs Directories where source code is found. Defaults to '{src,apps,lib-*}/**/'
- --binary-rel-url Binary release URL pattern. %VSN% variable is substituted with the version in release tag.
- E.g. \"https://github.com/emqx/emqx/releases/download/v%VSN%/emqx-%VSN%-otp-24.2.1-1-el7-amd64.tar.gz\"
- ".
- -record(app,
- { modules :: #{module() => binary()}
- , version :: string()
- }).
- default_options() ->
- #{ clone_url => find_upstream_repo("origin")
- , make_command => "make emqx-rel"
- , beams_dir => "_build/emqx/rel/emqx/lib/"
- , check => false
- , prev_tag => undefined
- , src_dirs => "{src,apps,lib-*}/**/"
- , binary_rel_url => undefined
- }.
- %% App-specific actions that should be added unconditionally to any update/downgrade:
- app_specific_actions(_) ->
- [].
- ignored_apps() ->
- [emqx_dashboard, emqx_management] ++ otp_standard_apps().
- main(Args) ->
- #{prev_tag := Baseline} = Options = parse_args(Args, default_options()),
- init_globals(Options),
- main(Options, Baseline).
- parse_args([PrevTag = [A|_]], State) when A =/= $- ->
- State#{prev_tag => PrevTag};
- parse_args(["--check"|Rest], State) ->
- parse_args(Rest, State#{check => true});
- parse_args(["--skip-build"|Rest], State) ->
- parse_args(Rest, State#{make_command => "true"});
- parse_args(["--repo", Repo|Rest], State) ->
- parse_args(Rest, State#{clone_url => Repo});
- parse_args(["--remote", Remote|Rest], State) ->
- parse_args(Rest, State#{clone_url => find_upstream_repo(Remote)});
- parse_args(["--make-command", Command|Rest], State) ->
- parse_args(Rest, State#{make_command => Command});
- parse_args(["--release-dir", Dir|Rest], State) ->
- parse_args(Rest, State#{beams_dir => Dir});
- parse_args(["--src-dirs", Pattern|Rest], State) ->
- parse_args(Rest, State#{src_dirs => Pattern});
- parse_args(["--binary-rel-url", URL|Rest], State) ->
- parse_args(Rest, State#{binary_rel_url => {ok, URL}});
- parse_args(_, _) ->
- fail(usage()).
- main(Options, Baseline) ->
- {CurrRelDir, PrevRelDir} = prepare(Baseline, Options),
- log("~n===================================~n"
- "Processing changes..."
- "~n===================================~n"),
- CurrAppsIdx = index_apps(CurrRelDir),
- PrevAppsIdx = index_apps(PrevRelDir),
- %% log("Curr: ~p~nPrev: ~p~n", [CurrAppsIdx, PrevAppsIdx]),
- AppupChanges = find_appup_actions(CurrAppsIdx, PrevAppsIdx),
- case getopt(check) of
- true ->
- case AppupChanges of
- [] ->
- ok;
- _ ->
- Diffs =
- lists:filtermap(
- fun({App, {Upgrade, Downgrade, OldUpgrade, OldDowngrade}}) ->
- case parse_appup_diffs(Upgrade, OldUpgrade,
- Downgrade, OldDowngrade) of
- ok ->
- false;
- {diffs, Diffs} ->
- {true, {App, Diffs}}
- end
- end,
- AppupChanges),
- case Diffs =:= [] of
- true ->
- ok;
- false ->
- set_invalid(),
- log("ERROR: The appup files are incomplete. Missing changes:~n ~p",
- [Diffs])
- end
- end;
- false ->
- update_appups(AppupChanges)
- end,
- check_appup_files(),
- warn_and_exit(is_valid()).
- warn_and_exit(true) ->
- log("
- NOTE: Please review the changes manually. This script does not know about NIF
- changes, supervisor changes, process restarts and so on. Also the load order of
- the beam files might need updating.~n"),
- halt(0);
- warn_and_exit(false) ->
- log("~nERROR: Incomplete appups found. Please inspect the output for more details.~n"),
- halt(1).
- prepare(Baseline, Options = #{make_command := MakeCommand, beams_dir := BeamDir, binary_rel_url := BinRel}) ->
- log("~n===================================~n"
- "Baseline: ~s"
- "~n===================================~n", [Baseline]),
- log("Building the current version...~n"),
- bash(MakeCommand),
- log("Downloading and building the previous release...~n"),
- PrevRelDir =
- case BinRel of
- undefined ->
- {ok, PrevRootDir} = build_prev_release(Baseline, Options),
- filename:join(PrevRootDir, BeamDir);
- {ok, _URL} ->
- {ok, PrevRootDir} = download_prev_release(Baseline, Options),
- PrevRootDir
- end,
- {BeamDir, PrevRelDir}.
- build_prev_release(Baseline, #{clone_url := Repo, make_command := MakeCommand}) ->
- BaseDir = "/tmp/emqx-baseline/",
- Dir = filename:basename(Repo, ".git") ++ [$-|Baseline],
- %% TODO: shallow clone
- Script = "mkdir -p ${BASEDIR} &&
- cd ${BASEDIR} &&
- { [ -d ${DIR} ] || git clone --branch ${TAG} ${REPO} ${DIR}; } &&
- cd ${DIR} &&" ++ MakeCommand,
- Env = [{"REPO", Repo}, {"TAG", Baseline}, {"BASEDIR", BaseDir}, {"DIR", Dir}],
- bash(Script, Env),
- {ok, filename:join(BaseDir, Dir)}.
- download_prev_release(Tag, #{binary_rel_url := {ok, URL0}, clone_url := Repo}) ->
- URL = string:replace(URL0, "%TAG%", Tag, all),
- BaseDir = "/tmp/emqx-baseline-bin/",
- Dir = filename:basename(Repo, ".git") ++ [$-|Tag],
- Filename = filename:join(BaseDir, Dir),
- Script = "mkdir -p ${OUTFILE} &&
- wget -c -O ${OUTFILE}.tar.gz ${URL} &&
- tar -zxf ${OUTFILE} ${OUTFILE}.tar.gz",
- Env = [{"TAG", Tag}, {"OUTFILE", Filename}, {"URL", URL}],
- bash(Script, Env),
- {ok, Filename}.
- find_upstream_repo(Remote) ->
- string:trim(os:cmd("git remote get-url " ++ Remote)).
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% Appup action creation and updating
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- find_appup_actions(CurrApps, PrevApps) ->
- maps:fold(
- fun(App, CurrAppIdx, Acc) ->
- case PrevApps of
- #{App := PrevAppIdx} ->
- find_appup_actions(App, CurrAppIdx, PrevAppIdx) ++ Acc;
- _ ->
- %% New app, nothing to upgrade here.
- Acc
- end
- end,
- [],
- CurrApps).
- find_appup_actions(_App, AppIdx, AppIdx) ->
- %% No changes to the app, ignore:
- [];
- find_appup_actions(App,
- CurrAppIdx = #app{version = CurrVersion},
- PrevAppIdx = #app{version = PrevVersion}) ->
- {OldUpgrade0, OldDowngrade0} = find_old_appup_actions(App, PrevVersion),
- OldUpgrade = ensure_all_patch_versions(App, CurrVersion, OldUpgrade0),
- OldDowngrade = ensure_all_patch_versions(App, CurrVersion, OldDowngrade0),
- Upgrade = merge_update_actions(App, diff_app(App, CurrAppIdx, PrevAppIdx), OldUpgrade),
- Downgrade = merge_update_actions(App, diff_app(App, PrevAppIdx, CurrAppIdx), OldDowngrade),
- if OldUpgrade =:= Upgrade andalso OldDowngrade =:= Downgrade ->
- %% The appup file has been already updated:
- [];
- true ->
- [{App, {Upgrade, Downgrade, OldUpgrade, OldDowngrade}}]
- end.
- %% To avoid missing one patch version when upgrading, we try to
- %% optimistically generate the list of expected versions that should
- %% be covered by the upgrade.
- ensure_all_patch_versions(App, CurrVsn, OldActions) ->
- case is_app_external(App) of
- true ->
- %% we do not attempt to predict the version list for
- %% external dependencies, as those may not follow our
- %% conventions.
- OldActions;
- false ->
- do_ensure_all_patch_versions(App, CurrVsn, OldActions)
- end.
- do_ensure_all_patch_versions(App, CurrVsn, OldActions) ->
- case enumerate_past_versions(CurrVsn) of
- {ok, ExpectedVsns} ->
- CoveredVsns = [V || {V, _} <- OldActions, V =/= <<".*">>],
- ExpectedVsnStrs = [vsn_number_to_string(V) || V <- ExpectedVsns],
- MissingActions = [{V, []} || V <- ExpectedVsnStrs, not contains_version(V, CoveredVsns)],
- MissingActions ++ OldActions;
- {error, bad_version} ->
- log("WARN: Could not infer expected versions to upgrade from for ~p~n", [App]),
- OldActions
- end.
- %% For external dependencies, show only the changes that are missing
- %% in their current appup.
- diff_appup_instructions(ComputedChanges, PresentChanges) ->
- lists:foldr(
- fun({VsnOrRegex, ComputedActions}, Acc) ->
- case find_matching_version(VsnOrRegex, PresentChanges) of
- undefined ->
- [{VsnOrRegex, ComputedActions} | Acc];
- PresentActions ->
- DiffActions = ComputedActions -- PresentActions,
- case DiffActions of
- [] ->
- %% no diff
- Acc;
- _ ->
- [{VsnOrRegex, DiffActions} | Acc]
- end
- end
- end,
- [],
- ComputedChanges).
- %% For external dependencies, checks if any missing diffs are present
- %% and groups them by `up' and `down' types.
- parse_appup_diffs(Upgrade, OldUpgrade, Downgrade, OldDowngrade) ->
- DiffUp = diff_appup_instructions(Upgrade, OldUpgrade),
- DiffDown = diff_appup_instructions(Downgrade, OldDowngrade),
- case {DiffUp, DiffDown} of
- {[], []} ->
- %% no diff for external dependency; ignore
- ok;
- _ ->
- set_invalid(),
- Diffs = #{ up => DiffUp
- , down => DiffDown
- },
- {diffs, Diffs}
- end.
- find_matching_version(VsnOrRegex, PresentChanges) ->
- proplists:get_value(VsnOrRegex, PresentChanges).
- find_old_appup_actions(App, PrevVersion) ->
- {Upgrade0, Downgrade0} =
- case locate(ebin_current, App, ".appup") of
- {ok, AppupFile} ->
- log("Found the previous appup file: ~s~n", [AppupFile]),
- {_, U, D} = read_appup(AppupFile),
- {U, D};
- undefined ->
- %% Fallback to the app.src file, in case the
- %% application doesn't have a release (useful for the
- %% apps that live outside the EMQX monorepo):
- case locate(src, App, ".appup.src") of
- {ok, AppupSrcFile} ->
- log("Using ~s as a source of previous update actions~n", [AppupSrcFile]),
- {_, U, D} = read_appup(AppupSrcFile),
- {U, D};
- undefined ->
- {[], []}
- end
- end,
- {ensure_version(PrevVersion, Upgrade0), ensure_version(PrevVersion, Downgrade0)}.
- merge_update_actions(App, Changes, Vsns) ->
- lists:map(fun(Ret = {<<".*">>, _}) ->
- Ret;
- ({Vsn, Actions}) ->
- {Vsn, do_merge_update_actions(App, Changes, Actions)}
- end,
- Vsns).
- do_merge_update_actions(App, {New0, Changed0, Deleted0}, OldActions) ->
- AppSpecific = app_specific_actions(App) -- OldActions,
- AlreadyHandled = lists:flatten(lists:map(fun process_old_action/1, OldActions)),
- New = New0 -- AlreadyHandled,
- Changed = Changed0 -- AlreadyHandled,
- Deleted = Deleted0 -- AlreadyHandled,
- Reloads = [{load_module, M, brutal_purge, soft_purge, []}
- || not contains_restart_application(App, OldActions),
- M <- Changed ++ New],
- {OldActionsWithStop, OldActionsAfterStop} =
- find_application_stop_instruction(App, OldActions),
- OldActionsWithStop ++
- Reloads ++
- OldActionsAfterStop ++
- [{delete_module, M} || M <- Deleted] ++
- AppSpecific.
- %% If an entry restarts an application, there's no need to use
- %% `load_module' instructions.
- contains_restart_application(Application, Actions) ->
- lists:member({restart_application, Application}, Actions).
- %% If there is an `application:stop(Application)' call in the
- %% instructions, we insert `load_module' instructions after it.
- find_application_stop_instruction(Application, Actions) ->
- {Before, After0} =
- lists:splitwith(
- fun({apply, {application, stop, [App]}}) when App =:= Application ->
- false;
- (_) ->
- true
- end, Actions),
- case After0 of
- [StopInst | After] ->
- {Before ++ [StopInst], After};
- [] ->
- {[], Before}
- end.
- %% @doc Process the existing actions to exclude modules that are
- %% already handled
- process_old_action({purge, Modules}) ->
- Modules;
- process_old_action({delete_module, Module}) ->
- [Module];
- process_old_action(LoadModule) when is_tuple(LoadModule) andalso
- element(1, LoadModule) =:= load_module ->
- element(2, LoadModule);
- process_old_action(_) ->
- [].
- ensure_version(Version, OldInstructions) ->
- OldVersions = [element(1, I) || I <- OldInstructions],
- case contains_version(Version, OldVersions) of
- false ->
- [{Version, []} | OldInstructions];
- true ->
- OldInstructions
- end.
- contains_version(Needle, Haystack) when is_list(Needle) ->
- lists:any(
- fun(Regex) when is_binary(Regex) ->
- case re:run(Needle, Regex) of
- {match, _} ->
- true;
- nomatch ->
- false
- end;
- (Vsn) ->
- Vsn =:= Needle
- end,
- Haystack).
- %% As a best effort approach, we assume that we only bump patch
- %% version numbers between release upgrades for our dependencies and
- %% that we deal only with 3-part version schemas
- %% (`Major.Minor.Patch'). Using those assumptions, we enumerate the
- %% past versions that should be covered by regexes in .appup file
- %% instructions.
- enumerate_past_versions(Vsn) when is_list(Vsn) ->
- case parse_version_number(Vsn) of
- {ok, ParsedVsn} ->
- {ok, enumerate_past_versions(ParsedVsn)};
- Error ->
- Error
- end;
- enumerate_past_versions({Major, Minor, Patch}) ->
- [{Major, Minor, P} || P <- lists:seq(Patch - 1, 0, -1)].
- parse_version_number(Vsn) when is_list(Vsn) ->
- Nums = string:split(Vsn, ".", all),
- Results = lists:map(fun string:to_integer/1, Nums),
- case Results of
- [{Major, []}, {Minor, []}, {Patch, []}] ->
- {ok, {Major, Minor, Patch}};
- _ ->
- {error, bad_version}
- end.
- vsn_number_to_string({Major, Minor, Patch}) ->
- io_lib:format("~b.~b.~b", [Major, Minor, Patch]).
- read_appup(File) ->
- %% NOTE: appup file is a script, it may contain variables or functions.
- case file:script(File, [{'VSN', "VSN"}]) of
- {ok, Terms} ->
- Terms;
- Error ->
- fail("Failed to parse appup file ~s: ~p", [File, Error])
- end.
- check_appup_files() ->
- AppupFiles = filelib:wildcard(getopt(src_dirs) ++ "/*.appup.src"),
- lists:foreach(fun read_appup/1, AppupFiles).
- update_appups(Changes) ->
- lists:foreach(
- fun({App, {Upgrade, Downgrade, OldUpgrade, OldDowngrade}}) ->
- do_update_appup(App, Upgrade, Downgrade, OldUpgrade, OldDowngrade)
- end,
- Changes).
- do_update_appup(App, Upgrade, Downgrade, OldUpgrade, OldDowngrade) ->
- case locate(src, App, ".appup.src") of
- {ok, AppupFile} ->
- case contains_contents(AppupFile, Upgrade, Downgrade) of
- true ->
- ok;
- false ->
- render_appfile(AppupFile, Upgrade, Downgrade)
- end;
- undefined ->
- case create_stub(App) of
- {ok, AppupFile} ->
- render_appfile(AppupFile, Upgrade, Downgrade);
- false ->
- case parse_appup_diffs(Upgrade, OldUpgrade,
- Downgrade, OldDowngrade) of
- ok ->
- %% no diff for external dependency; ignore
- ok;
- {diffs, Diffs} ->
- set_invalid(),
- log("ERROR: Appup file for the external dependency '~p' is not complete.~n Missing changes: ~100p~n", [App, Diffs]),
- log("NOTE: Some changes above might be already covered by regexes.~n")
- end
- end
- end.
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% Appup file creation
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- render_appfile(File, Upgrade, Downgrade) ->
- IOList = io_lib:format("%% -*- mode: erlang -*-\n{VSN,~n ~p,~n ~p}.~n", [Upgrade, Downgrade]),
- ok = file:write_file(File, IOList).
- create_stub(App) ->
- Ext = ".app.src",
- case locate(src, App, Ext) of
- {ok, AppSrc} ->
- DirName = filename:dirname(AppSrc),
- AppupFile = filename:basename(AppSrc, Ext) ++ ".appup.src",
- Default = {<<".*">>, []},
- AppupFileFullpath = filename:join(DirName, AppupFile),
- render_appfile(AppupFileFullpath, [Default], [Default]),
- {ok, AppupFileFullpath};
- undefined ->
- false
- end.
- %% we check whether the destination file already has the contents we
- %% want to write to avoid writing and losing indentation and comments.
- contains_contents(File, Upgrade, Downgrade) ->
- %% the file may contain the VSN variable, so it's a script
- case file:script(File, [{'VSN', 'VSN'}]) of
- {ok, {_, Upgrade, Downgrade}} ->
- true;
- _ ->
- false
- end.
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% application and release indexing
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- index_apps(ReleaseDir) ->
- Apps0 = maps:from_list([index_app(filename:join(ReleaseDir, AppFile)) ||
- AppFile <- filelib:wildcard("**/ebin/*.app", ReleaseDir)]),
- maps:without(ignored_apps(), Apps0).
- index_app(AppFile) ->
- {ok, [{application, App, Properties}]} = file:consult(AppFile),
- Vsn = proplists:get_value(vsn, Properties),
- %% Note: assuming that beams are always located in the same directory where app file is:
- EbinDir = filename:dirname(AppFile),
- Modules = hashsums(EbinDir),
- {App, #app{ version = Vsn
- , modules = Modules
- }}.
- diff_app(App,
- #app{version = NewVersion, modules = NewModules},
- #app{version = OldVersion, modules = OldModules}) ->
- {New, Changed} =
- maps:fold( fun(Mod, MD5, {New, Changed}) ->
- case OldModules of
- #{Mod := OldMD5} when MD5 =:= OldMD5 ->
- {New, Changed};
- #{Mod := _} ->
- {New, [Mod | Changed]};
- _ ->
- {[Mod | New], Changed}
- end
- end
- , {[], []}
- , NewModules
- ),
- Deleted = maps:keys(maps:without(maps:keys(NewModules), OldModules)),
- NChanges = length(New) + length(Changed) + length(Deleted),
- if NewVersion =:= OldVersion andalso NChanges > 0 ->
- set_invalid(),
- log("ERROR: Application '~p' contains changes, but its version is not updated~n", [App]);
- NewVersion > OldVersion ->
- log("INFO: Application '~p' has been updated: ~p -> ~p~n", [App, OldVersion, NewVersion]),
- ok;
- true ->
- ok
- end,
- {New, Changed, Deleted}.
- -spec hashsums(file:filename()) -> #{module() => binary()}.
- hashsums(EbinDir) ->
- maps:from_list(lists:map(
- fun(Beam) ->
- File = filename:join(EbinDir, Beam),
- {ok, Ret = {_Module, _MD5}} = beam_lib:md5(File),
- Ret
- end,
- filelib:wildcard("*.beam", EbinDir)
- )).
- is_app_external(App) ->
- Ext = ".app.src",
- case locate(src, App, Ext) of
- {ok, _} ->
- false;
- undefined ->
- true
- end.
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% Global state
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- init_globals(Options) ->
- ets:new(globals, [named_table, set, public]),
- ets:insert(globals, {valid, true}),
- ets:insert(globals, {options, Options}).
- getopt(Option) ->
- maps:get(Option, ets:lookup_element(globals, options, 2)).
- %% Set a global flag that something about the appfiles is invalid
- set_invalid() ->
- ets:insert(globals, {valid, false}).
- is_valid() ->
- ets:lookup_element(globals, valid, 2).
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% Utility functions
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %% Locate a file in a specified application
- locate(ebin_current, App, Suffix) ->
- ReleaseDir = getopt(beams_dir),
- AppStr = atom_to_list(App),
- case filelib:wildcard(ReleaseDir ++ "/**/ebin/" ++ AppStr ++ Suffix) of
- [File] ->
- {ok, File};
- [] ->
- undefined
- end;
- locate(src, App, Suffix) ->
- AppStr = atom_to_list(App),
- SrcDirs = getopt(src_dirs),
- case filelib:wildcard(SrcDirs ++ AppStr ++ Suffix) of
- [File] ->
- {ok, File};
- [] ->
- undefined
- end.
- bash(Script) ->
- bash(Script, []).
- bash(Script, Env) ->
- log("+ ~s~n+ Env: ~p~n", [Script, Env]),
- case cmd("bash", #{args => ["-c", Script], env => Env}) of
- 0 -> true;
- _ -> fail("Failed to run command: ~s", [Script])
- end.
- %% Spawn an executable and return the exit status
- cmd(Exec, Params) ->
- case os:find_executable(Exec) of
- false ->
- fail("Executable not found in $PATH: ~s", [Exec]);
- Path ->
- Params1 = maps:to_list(maps:with([env, args, cd], Params)),
- Port = erlang:open_port( {spawn_executable, Path}
- , [ exit_status
- , nouse_stdio
- | Params1
- ]
- ),
- receive
- {Port, {exit_status, Status}} ->
- Status
- end
- end.
- fail(Str) ->
- fail(Str, []).
- fail(Str, Args) ->
- log(Str ++ "~n", Args),
- halt(1).
- log(Msg) ->
- log(Msg, []).
- log(Msg, Args) ->
- io:format(standard_error, Msg, Args).
- otp_standard_apps() ->
- [ssl, mnesia, kernel, asn1, stdlib].
|