From 7e78c133c7a373384411d9fd0e1366b14e4c31d8 Mon Sep 17 00:00:00 2001 From: Fred Hebert Date: Wed, 1 Nov 2017 15:40:09 -0400 Subject: Support OTP-20 Unicode functions Use either optional compilation or version-safe variants of the string functions. Prevents warnings when the switch to OTP-21 will happen. --- src/rlx_app_discovery.erl | 2 +- src/rlx_prv_app_discover.erl | 2 +- src/rlx_prv_assembler.erl | 30 +++++++++++++++--------------- src/rlx_prv_release.erl | 2 +- src/rlx_rel_discovery.erl | 2 +- src/rlx_string.erl | 23 +++++++++++++++++++++++ 6 files changed, 42 insertions(+), 19 deletions(-) create mode 100644 src/rlx_string.erl (limited to 'src') diff --git a/src/rlx_app_discovery.erl b/src/rlx_app_discovery.erl index 0414a0a..642b887 100644 --- a/src/rlx_app_discovery.erl +++ b/src/rlx_app_discovery.erl @@ -40,7 +40,7 @@ do(State, LibDirs) -> ec_cmd_log:info(rlx_state:log(State), fun() -> ["Resolving OTP Applications from directories:\n", - string:join([[rlx_util:indent(2), LibDir] || LibDir <- LibDirs], "\n")] + rlx_string:join([[rlx_util:indent(2), LibDir] || LibDir <- LibDirs], "\n")] end), resolve_app_metadata(State, LibDirs). diff --git a/src/rlx_prv_app_discover.erl b/src/rlx_prv_app_discover.erl index a8a40ae..d58cf71 100644 --- a/src/rlx_prv_app_discover.erl +++ b/src/rlx_prv_app_discover.erl @@ -132,7 +132,7 @@ add_system_lib_dir(State) -> add_environment_lib_dir(_State) -> case os:getenv("ERL_LIBS") of false -> []; - Libs -> [erlang:iolist_to_binary(L) || L <- string:tokens(Libs, ":")] + Libs -> [erlang:iolist_to_binary(L) || L <- rlx_string:lexemes(Libs, ":")] end. %% Order matters so this slow dedup needs to be used diff --git a/src/rlx_prv_assembler.erl b/src/rlx_prv_assembler.erl index a6bf5f8..5efa8b5 100644 --- a/src/rlx_prv_assembler.erl +++ b/src/rlx_prv_assembler.erl @@ -416,13 +416,13 @@ write_bin_file(State, Release, OutputDir, RelDir) -> _ -> VsnRelStartFile = case OsFamily of unix -> VsnRel; - win32 -> string:concat(VsnRel, ".cmd") + win32 -> rlx_string:concat(VsnRel, ".cmd") end, ok = file:write_file(VsnRelStartFile, StartFile), ok = file:change_mode(VsnRelStartFile, 8#777), BareRelStartFile = case OsFamily of unix -> BareRel; - win32 -> string:concat(BareRel, ".cmd") + win32 -> rlx_string:concat(BareRel, ".cmd") end, ok = file:write_file(BareRelStartFile, StartFile), ok = file:change_mode(BareRelStartFile, 8#777) @@ -494,15 +494,15 @@ hook_filename(builtin_status) -> "hooks/builtin/status". hook_invocation({custom, CustomScript}) -> CustomScript; %% the pid builtin hook with no arguments writes to pid file %% at /var/run/{{ rel_name }}.pid -hook_invocation(pid) -> string:join(["hooks/builtin/pid", +hook_invocation(pid) -> rlx_string:join(["hooks/builtin/pid", "/var/run/$REL_NAME.pid"], "|"); -hook_invocation({pid, PidFile}) -> string:join(["hooks/builtin/pid", +hook_invocation({pid, PidFile}) -> rlx_string:join(["hooks/builtin/pid", PidFile], "|"); hook_invocation(wait_for_vm_start) -> "hooks/builtin/wait_for_vm_start"; hook_invocation({wait_for_process, Name}) -> %% wait_for_process takes an atom as argument %% which is the process name to wait for - string:join(["hooks/builtin/wait_for_process", + rlx_string:join(["hooks/builtin/wait_for_process", atom_to_list(Name)], "|"); hook_invocation(builtin_status) -> "hooks/builtin/status". @@ -796,15 +796,15 @@ extended_bin_file_contents(OsFamily, RelName, RelVsn, ErtsVsn, ErlOpts, Hooks, E win32 -> extended_bin_windows end, %% turn all the hook lists into space separated strings - PreStartHooks = string:join(proplists:get_value(pre_start, Hooks, []), " "), - PostStartHooks = string:join(proplists:get_value(post_start, Hooks, []), " "), - PreStopHooks = string:join(proplists:get_value(pre_stop, Hooks, []), " "), - PostStopHooks = string:join(proplists:get_value(post_stop, Hooks, []), " "), - PreInstallUpgradeHooks = string:join(proplists:get_value(pre_install_upgrade, + PreStartHooks = rlx_string:join(proplists:get_value(pre_start, Hooks, []), " "), + PostStartHooks = rlx_string:join(proplists:get_value(post_start, Hooks, []), " "), + PreStopHooks = rlx_string:join(proplists:get_value(pre_stop, Hooks, []), " "), + PostStopHooks = rlx_string:join(proplists:get_value(post_stop, Hooks, []), " "), + PreInstallUpgradeHooks = rlx_string:join(proplists:get_value(pre_install_upgrade, Hooks, []), " "), - PostInstallUpgradeHooks = string:join(proplists:get_value(post_install_upgrade, + PostInstallUpgradeHooks = rlx_string:join(proplists:get_value(post_install_upgrade, Hooks, []), " "), - StatusHook = string:join(proplists:get_value(status, Hooks, []), " "), + StatusHook = rlx_string:join(proplists:get_value(status, Hooks, []), " "), {ExtensionsList1, ExtensionDeclarations1} = lists:foldl(fun({Name, Script}, {ExtensionsList0, ExtensionDeclarations0}) -> @@ -816,10 +816,10 @@ extended_bin_file_contents(OsFamily, RelName, RelVsn, ErtsVsn, ErlOpts, Hooks, E end, {[], []}, Extensions), % pipe separated string of extensions, to show on the start script usage % (eg. foo|bar) - ExtensionsList = string:join(ExtensionsList1 ++ ["undefined"], "|"), + ExtensionsList = rlx_string:join(ExtensionsList1 ++ ["undefined"], "|"), % command separated string of extension script declarations % (eg. foo_extension="path/to/foo_script") - ExtensionDeclarations = string:join(ExtensionDeclarations1, ";"), + ExtensionDeclarations = rlx_string:join(ExtensionDeclarations1, ";"), render(Template, [{rel_name, RelName}, {rel_vsn, RelVsn}, {erts_vsn, ErtsVsn}, {erl_opts, ErlOpts}, {pre_start_hooks, PreStartHooks}, @@ -833,7 +833,7 @@ extended_bin_file_contents(OsFamily, RelName, RelVsn, ErtsVsn, ErlOpts, Hooks, E {extension_declarations, ExtensionDeclarations}]). erl_ini(OutputDir, ErtsVsn) -> - ErtsDirName = string:concat("erts-", ErtsVsn), + ErtsDirName = rlx_string:concat("erts-", ErtsVsn), BinDir = filename:join([OutputDir, ErtsDirName, bin]), render(erl_ini, [{bin_dir, BinDir}, {output_dir, OutputDir}]). diff --git a/src/rlx_prv_release.erl b/src/rlx_prv_release.erl index 2af8acd..8de1a51 100644 --- a/src/rlx_prv_release.erl +++ b/src/rlx_prv_release.erl @@ -202,7 +202,7 @@ set_resolved(State, Release0, Pkgs) -> ErtsDir -> try [Erts | _] = filelib:wildcard(filename:join(ErtsDir, "erts-*")), - [_, ErtsVsn] = string:tokens(filename:basename(Erts), "-"), + [_, ErtsVsn] = rlx_string:lexemes(filename:basename(Erts), "-"), {ok, rlx_state:add_realized_release(State, rlx_release:erts(Release1, ErtsVsn))} catch _:_ -> diff --git a/src/rlx_rel_discovery.erl b/src/rlx_rel_discovery.erl index fca416f..767ceac 100644 --- a/src/rlx_rel_discovery.erl +++ b/src/rlx_rel_discovery.erl @@ -42,7 +42,7 @@ do(State, LibDirs, AppMeta) -> ec_cmd_log:info(rlx_state:log(State), fun() -> ["Resolving available OTP Releases from directories:\n", - string:join([[rlx_util:indent(2), LibDir] || LibDir <- LibDirs], "\n")] + rlx_string:join([[rlx_util:indent(2), LibDir] || LibDir <- LibDirs], "\n")] end), resolve_rel_metadata(State, LibDirs, AppMeta) end. diff --git a/src/rlx_string.erl b/src/rlx_string.erl new file mode 100644 index 0000000..1f9cc0c --- /dev/null +++ b/src/rlx_string.erl @@ -0,0 +1,23 @@ +%% Compatibility module for the string API changes between +%% OTP-19 and OTP-21, where Unicode support means the deprecation +%% of a lot of string functions. +-module(rlx_string). +-export([concat/2, lexemes/2, join/2]). + +-ifdef(unicode_str). +concat(Str1, Str2) -> unicode:characters_to_list([Str1,Str2]). +lexemes(Str, Separators) -> string:lexemes(Str, Separators). +-else. +concat(Str1, Str2) -> string:concat(Str1, Str2). +lexemes(Str, Separators) -> string:tokens(Str, Separators). +-endif. + +%% string:join/2 copy; string:join/2 is getting obsoleted +%% and replaced by lists:join/2, but lists:join/2 is too new +%% for version support (only appeared in 19.0) so it cannot be +%% used. Instead we just adopt join/2 locally and hope it works +%% for most unicode use cases anyway. +join([], Sep) when is_list(Sep) -> + []; +join([H|T], Sep) -> + H ++ lists:append([Sep ++ X || X <- T]). -- cgit v1.2.3 From 78561dc7a812466aa1e8c9f36a6b48c7f7cc4195 Mon Sep 17 00:00:00 2001 From: Fred Hebert Date: Wed, 1 Nov 2017 15:42:25 -0400 Subject: Maintain no_dot_erlang.boot file in releases Had a problem in OTP-21 (master) where escript calls in nodetool would fail since the file is not around and is being used by default there. The patch works by copying its equivalent file, which I belive to be just the start_clean file (their .rel.src are identical), into the same directories as we do for start_clean. Internal errors are renamed to be made neutral. --- src/rlx_prv_assembler.erl | 49 ++++++++++++++++++++++++++++++----------------- src/rlx_release.erl | 7 +++++++ 2 files changed, 38 insertions(+), 18 deletions(-) (limited to 'src') diff --git a/src/rlx_prv_assembler.erl b/src/rlx_prv_assembler.erl index 5efa8b5..65975e5 100644 --- a/src/rlx_prv_assembler.erl +++ b/src/rlx_prv_assembler.erl @@ -111,12 +111,12 @@ format_error({unable_to_make_symlink, AppDir, TargetDir, Reason}) -> io_lib:format("Unable to symlink directory ~s to ~s because \n~s~s", [AppDir, TargetDir, rlx_util:indent(2), file:format_error(Reason)]); -format_error(start_clean_script_generation_error) -> +format_error(boot_script_generation_error) -> "Unknown internal release error generating start_clean.boot"; -format_error({start_clean_script_generation_warning, Module, Warnings}) -> +format_error({boot_script_generation_warning, Module, Warnings}) -> ["Warnings generating start_clean.boot \s", rlx_util:indent(2), Module:format_warning(Warnings)]; -format_error({start_clean_script_generation_error, Module, Errors}) -> +format_error({boot_script_generation_error, Module, Errors}) -> ["Errors generating start_clean.boot \n", rlx_util:indent(2), Module:format_error(Errors)]; format_error({strip_release, Reason}) -> @@ -354,17 +354,22 @@ create_release_info(State0, Release0, OutputDir) -> ReleaseDir = rlx_util:release_output_dir(State0, Release0), ReleaseFile = filename:join([ReleaseDir, RelName ++ ".rel"]), StartCleanFile = filename:join([ReleaseDir, "start_clean.rel"]), + NoDotErlFile = filename:join([ReleaseDir, "no_dot_erlang.rel"]), ok = ec_file:mkdir_p(ReleaseDir), Release1 = rlx_release:relfile(Release0, ReleaseFile), State1 = rlx_state:update_realized_release(State0, Release1), case rlx_release:metadata(Release1) of {ok, Meta} -> - case rlx_release:start_clean_metadata(Release1) of - {ok, StartCleanMeta} -> + case {rlx_release:start_clean_metadata(Release1), + rlx_release:no_dot_erlang_metadata(Release1)} of + {{ok, StartCleanMeta}, {ok, NoDotErlMeta}} -> ok = ec_file:write_term(ReleaseFile, Meta), ok = ec_file:write_term(StartCleanFile, StartCleanMeta), + ok = ec_file:write_term(NoDotErlFile, NoDotErlMeta), write_bin_file(State1, Release1, OutputDir, ReleaseDir); - E -> + {{ok, _}, E} -> + E; + {_, E} -> E end; E -> @@ -692,6 +697,7 @@ make_boot_script(State, Release, OutputDir, RelDir) -> ec_cmd_log:info(rlx_state:log(State), "release successfully created!"), create_RELEASES(OutputDir, ReleaseFile), + create_no_dot_erlang(RelDir, OutputDir, Options, State), create_start_clean(RelDir, OutputDir, Options, State); error -> ?RLX_ERROR({release_script_generation_error, ReleaseFile}); @@ -699,6 +705,7 @@ make_boot_script(State, Release, OutputDir, RelDir) -> ec_cmd_log:info(rlx_state:log(State), "release successfully created!"), create_RELEASES(OutputDir, ReleaseFile), + create_no_dot_erlang(RelDir, OutputDir, Options, State), create_start_clean(RelDir, OutputDir, Options, State); {ok,Module,Warnings} -> ?RLX_ERROR({release_script_generation_warn, Module, Warnings}); @@ -728,29 +735,35 @@ make_boot_script_variables(State) -> [{"ERTS_LIB_DIR", code:lib_dir()}] end. +create_no_dot_erlang(RelDir, OutputDir, Options, State) -> + create_boot_file(RelDir, OutputDir, Options, State, "no_dot_erlang"). + create_start_clean(RelDir, OutputDir, Options, State) -> + create_boot_file(RelDir, OutputDir, Options, State, "start_clean"). + +create_boot_file(RelDir, OutputDir, Options, State, Name) -> case rlx_util:make_script(Options, fun(CorrectedOptions) -> - systools:make_script("start_clean", CorrectedOptions) + systools:make_script(Name, CorrectedOptions) end) of ok -> - ok = ec_file:copy(filename:join([RelDir, "start_clean.boot"]), - filename:join([OutputDir, "bin", "start_clean.boot"])), - ec_file:remove(filename:join([RelDir, "start_clean.rel"])), - ec_file:remove(filename:join([RelDir, "start_clean.script"])), + ok = ec_file:copy(filename:join([RelDir, Name++".boot"]), + filename:join([OutputDir, "bin", Name++".boot"])), + ec_file:remove(filename:join([RelDir, Name++".rel"])), + ec_file:remove(filename:join([RelDir, Name++".script"])), {ok, State}; error -> - ?RLX_ERROR(start_clean_script_generation_error); + ?RLX_ERROR(boot_script_generation_error); {ok, _, []} -> - ok = ec_file:copy(filename:join([RelDir, "start_clean.boot"]), - filename:join([OutputDir, "bin", "start_clean.boot"])), - ec_file:remove(filename:join([RelDir, "start_clean.rel"])), - ec_file:remove(filename:join([RelDir, "start_clean.script"])), + ok = ec_file:copy(filename:join([RelDir, Name++".boot"]), + filename:join([OutputDir, "bin", Name++".boot"])), + ec_file:remove(filename:join([RelDir, Name++".rel"])), + ec_file:remove(filename:join([RelDir, Name++".script"])), {ok, State}; {ok,Module,Warnings} -> - ?RLX_ERROR({start_clean_script_generation_warn, Module, Warnings}); + ?RLX_ERROR({boot_script_generation_warn, Module, Warnings}); {error,Module,Error} -> - ?RLX_ERROR({start_clean_script_generation_error, Module, Error}) + ?RLX_ERROR({boot_script_generation_error, Module, Error}) end. create_RELEASES(OutputDir, ReleaseFile) -> diff --git a/src/rlx_release.erl b/src/rlx_release.erl index 5765079..f2a1c35 100644 --- a/src/rlx_release.erl +++ b/src/rlx_release.erl @@ -39,6 +39,7 @@ realized/1, metadata/1, start_clean_metadata/1, + no_dot_erlang_metadata/1, canonical_name/1, config/1, config/2, @@ -198,6 +199,12 @@ start_clean_metadata(#release_t{name=Name, vsn=Vsn, erts=ErtsVsn, applications=A ?RLX_ERROR({not_realized, Name, Vsn}) end. +%% The no_dot_erlang.rel.src file is a literal copy of start_clean.rel.src +%% in Erlang/OTP itself. +-spec no_dot_erlang_metadata(t()) -> term(). +no_dot_erlang_metadata(T) -> + start_clean_metadata(T). + %% @doc produce the canonical name (-) for this release -spec canonical_name(t()) -> string(). canonical_name(#release_t{name=Name, vsn=Vsn}) -> -- cgit v1.2.3