From 61332fc4f7ebe12300088234e49612ee568e04e8 Mon Sep 17 00:00:00 2001 From: Ulf Wiger Date: Thu, 27 Nov 2025 23:04:35 +0100 Subject: [PATCH] Initial commit. Working dep resource --- .gitignore | 20 ++++ LICENSE.md | 186 +++++++++++++++++++++++++++++++++++ README.md | 48 +++++++++ rebar.config | 2 + src/zx_rebar_plugin.app.src | 13 +++ src/zx_rebar_plugin.erl | 11 +++ src/zx_rebar_rsrc.erl | 190 ++++++++++++++++++++++++++++++++++++ 7 files changed, 470 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 rebar.config create mode 100644 src/zx_rebar_plugin.app.src create mode 100644 src/zx_rebar_plugin.erl create mode 100644 src/zx_rebar_rsrc.erl diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df53f7d --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +.rebar3 +_build +_checkouts +_vendor +.eunit +*.o +*.beam +*.plt +*.swp +*.swo +.erlang.cookie +ebin +log +erl_crash.dump +.rebar +logs +.idea +*.iml +rebar3.crashdump +*~ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..fd1d4c6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,186 @@ +# Apache License +Version 2.0, January 2004 + +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +## 1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +"submitted" means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +## 2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +## 3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +## 4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +1. You must give any other recipients of the Work or Derivative Works a copy of + this License; and + +2. You must cause any modified files to carry prominent notices stating that + You changed the files; and + +3. You must retain, in the Source form of any Derivative Works that You + distribute, all copyright, patent, trademark, and attribution notices from + the Source form of the Work, excluding those notices that do not pertain to + any part of the Derivative Works; and + +4. If the Work includes a "NOTICE" text file as part of its distribution, then + any Derivative Works that You distribute must include a readable copy of the + attribution notices contained within such NOTICE file, excluding those + notices that do not pertain to any part of the Derivative Works, in at least + one of the following places: within a NOTICE text file distributed as part + of the Derivative Works; within the Source form or documentation, if + provided along with the Derivative Works; or, within a display generated by + the Derivative Works, if and wherever such third-party notices normally + appear. The contents of the NOTICE file are for informational purposes only + and do not modify the License. You may add Your own attribution notices + within Derivative Works that You distribute, alongside or as an addendum to + the NOTICE text from the Work, provided that such additional attribution + notices cannot be construed as modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +## 5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +## 6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +## 7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, NON- +INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +## 8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +## 9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +Copyright 2025, Ulf Wiger . + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f124670 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +zx_rebar_plugin +===== +**Copyright** (c) 2025 QPQ AG + +A rebar plugin for assisting `rebar3`-enabled applications that also support `zx`. + +Build +----- + + $ rebar3 compile + +Use +--- + +Add the plugin to your rebar config: + + {plugins, [ + {zx_rebar_plugin, {git, "https://git.qpq.swiss/QPQ-AG/zx_rebar_plugin.git", {tag, "0.1.0"}}} + ]}. + +In order to add `zx` as a dependency: + + {deps, [ + ..., + {zx, {zx, "https://gitlab.com/zxq9/zx", {ref, "2a0437f4"}, "0.14.0"}} + ]}. + +The third element (e.g. `"0.14.0"`) is the application version of `zx`. +Note that the given version must be reachable through the specified commit reference. + +Currently, this plugin only registers a resource callback that fetches and organizes +the `zx` application as a `rebar3` dependency. + +In the future, we may add utility commands to simplify creation of `zx` packages from +within `rebar3`. + +Technicalities +-------------- + +The `zx` git repository has an organization that isn't directly rebar3 compatible, +and the source is found under e.g. `zomp/lib/otpr/zx/0.14.0`. While `rebar3` +supports a `git_subdir` fetch method, it makes assumptions about the path that won't +work with `zx`. The resource plugin also ensures that there is a `rebar.config` file +(generating one if necessary). + +While `zx` relies on `make all` for the compilation, `rebar3` lacks support for this, +and instead uses the `erlc` compiler. At the moment, this isn't a problem, and if it +should become one later, this plugin can be extended to adapt. diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..f618f3e --- /dev/null +++ b/rebar.config @@ -0,0 +1,2 @@ +{erl_opts, [debug_info]}. +{deps, []}. \ No newline at end of file diff --git a/src/zx_rebar_plugin.app.src b/src/zx_rebar_plugin.app.src new file mode 100644 index 0000000..10770e0 --- /dev/null +++ b/src/zx_rebar_plugin.app.src @@ -0,0 +1,13 @@ +{application, zx_rebar_plugin, [ + {description, "A rebar plugin"}, + {vsn, "0.1.0"}, + {registered, []}, + {applications, [ + kernel, + stdlib + ]}, + {env, []}, + {modules, []}, + {licenses, ["Apache-2.0"]}, + {links, []} + ]}. diff --git a/src/zx_rebar_plugin.erl b/src/zx_rebar_plugin.erl new file mode 100644 index 0000000..3f5258c --- /dev/null +++ b/src/zx_rebar_plugin.erl @@ -0,0 +1,11 @@ +-module(zx_rebar_plugin). + +-author("Ulf Wiger "). +-copyright("QPQ AG "). +-license("GPL-3.0-or-later"). + +-export([init/1]). + +-spec init(rebar_state:t()) -> {ok, rebar_state:t()}. +init(State) -> + {ok, rebar_state:add_resource(State, {zx, zx_rebar_rsrc})}. diff --git a/src/zx_rebar_rsrc.erl b/src/zx_rebar_rsrc.erl new file mode 100644 index 0000000..c2b4d66 --- /dev/null +++ b/src/zx_rebar_rsrc.erl @@ -0,0 +1,190 @@ +-module(zx_rebar_rsrc). + +-author("Ulf Wiger "). +-copyright("QPQ AG "). +-license("GPL-3.0-or-later"). + +-behaviour(rebar_resource_v2). + +-export([init/2, + lock/2, + download/4, + needs_update/2, + make_vsn/2, + format_error/1]). + +%% -include_lib("rebar/src/rebar.hrl"). +%% This is copied from rebar.hrl +-define(FMT(Str, Args), lists:flatten(io_lib:format(Str, Args))). + +%% -include_lib("providers/include/providers.hrl"). +%% This is copied from the providers.hrl file: +-define(PRV_ERROR(Reason), + {error, {?MODULE, Reason}}). + +-define(DEBUG(Fmt, Args), rebar_api:debug(Fmt, Args)). + +-spec init(atom(), rebar_state:t()) -> {ok, rebar_resource_v2:resource()}. +init(Type, _State) -> + Resource = rebar_resource_v2:new(Type, ?MODULE, #{}), + {ok, Resource}. + + +lock(AppInfo, _) -> + {zx, Url, Checkout, Vsn} = rebar_app_info:source(AppInfo), + {git, Url1, {ref, Ref}} = + rebar_git_resource:lock_(rebar_app_info:dir(AppInfo), {git, Url, Checkout}), + {zx, Url1, {ref, Ref}, Vsn}. + +download(TmpDir, AppInfo, State, _) -> + Name = rebar_app_info:name(AppInfo), + Source = rebar_app_info:source(AppInfo), + ?DEBUG("Source = ~p", [Source]), + {zx, Url, Checkout, Vsn} = Source, + Ref = to_ref(Checkout), + GitVsn = rebar_git_resource:git_vsn(), + Res = + case rebar_git_resource:download_(TmpDir, {git, Url, Checkout}, State) of + ok -> + sparse_checkout(Name, GitVsn, TmpDir, Ref, Vsn); + {ok, _} -> + sparse_checkout(Name, GitVsn, TmpDir, Ref, Vsn); + {error, Reason} -> + {error, Reason}; + Error -> + {error, Error} + end, + case Res of + ok -> + ZxDir = rebar_app_info:dir(AppInfo), + os:putenv("ZX_DIR", ZxDir), + ensure_rebar_config(TmpDir), + trace_erlc(), + ok; + Other -> + Other + end. + +trace_erlc() -> + dbg:tracer(), + dbg:tpl(rebar_erlc_compiler,x), + dbg:p(all,[c]). + +%% Return true if either the git url or tag/branch/ref is not the same as the currently +%% checked out git repo for the dep +needs_update(AppInfo, _) -> + try + {zx, Url, Ref, _Vsn} = rebar_app_info:source(AppInfo), + ZxDir = rebar_app_info:dir(AppInfo), + rebar_git_resource:needs_update_(ZxDir, {git, Url, Ref}) + catch + error:E:ST -> + ?DEBUG("CAUGHT error:~p / ~p", [E, ST]), + error(E) + end. + + +make_vsn(AppInfo, _) -> + Dir = rebar_app_info:dir(AppInfo), + rebar_git_resource:make_vsn_(Dir). + +to_ref({branch, Branch}) -> + Branch; +to_ref({tag, Tag}) -> + Tag; +to_ref({ref, Ref}) -> + Ref; +to_ref(Rev) -> + Rev. + +sparse_checkout(Name, GitVsn, Dir, Ref, Vsn) when GitVsn >= {1,7,4}; + GitVsn =:= undefined -> + ?DEBUG("doing sparse checkout for ~p in ~s of vsn ~s", [Name, Dir, Vsn]), + SparseDir = filename:join(["zomp/lib/otpr/zx/", Vsn]), + ?DEBUG("SparseDir = ~s", [SparseDir]), + check_directory(Name, Dir, SparseDir), + rebar_utils:sh(?FMT("git --git-dir=.git config core.sparsecheckout true", []), + [{cd, Dir}]), + filelib:ensure_dir(filename:join(Dir, ".git/info/sparse-checkout")), + file:write_file(filename:join(Dir, ".git/info/sparse-checkout"), SparseDir), + Res = rebar_utils:sh(?FMT("git checkout -q ~ts", [rebar_utils:escape_chars(Ref)]), [{cd, Dir}]), + ?DEBUG("Checkout Res = ~p", [Res]), + CpRes = ec_file:copy(filename:join(Dir, SparseDir), Dir, [{recursive, true}]), + ?DEBUG("CpRes = ~p", [CpRes]), + ToRemove1 = filename:join(Dir, SparseDir), + EmptyRes = file:del_dir_r(ToRemove1), + ?DEBUG("EmptyRes = ~p", [EmptyRes]), + DelRes = (catch in_dir(Dir, fun() -> del_sparse_dir(SparseDir) end)), + ?DEBUG("DelRes = ~p", [DelRes]), + FinalRes = filelib:wildcard(filename:join(Dir, "**")), + ok = fix_app(Dir), + ?DEBUG("FinalRes = ~p", [FinalRes]), + ok; +sparse_checkout(Name, _, Dir, _, SparseDir) -> + %% sparse checkout not supported but we can still use the subdirectory + %% so no need to fail, just don't do the sparse checkout + ?DEBUG("too old a git version to do a sparse checkout for a subdir dep", []), + check_directory(Name, Dir, SparseDir), + ok. + +%% verify that subdirectory exists +check_directory(Name, Dir, SparseDir) -> + case filelib:is_dir(filename:join(Dir, SparseDir)) of + true -> + ok; + false -> + erlang:error(?PRV_ERROR({bad_subdir, Name, SparseDir})) + end. + +format_error({bad_subdir, Name, SubDir}) -> + io_lib:format("Failed to fetch git_subdir dependency ~ts:" + " directory ~ts does not exist.", [Name, SubDir]). + +in_dir(D, F) -> + {ok, CWD} = file:get_cwd(), + ok = file:set_cwd(D), + ?DEBUG("CWD now ~p", [D]), + ?DEBUG("ls: ~p", [filelib:wildcard("**")]), + try F() + after + file:set_cwd(CWD) + end. + +del_sparse_dir(".") -> ok; +del_sparse_dir(D) -> + ?DEBUG("del_sparse_dir(~p)", [D]), + case file:del_dir(D) of + {error, enoent} -> ok; + ok -> ok + end, + del_sparse_dir(filename:dirname(D)). + +ensure_rebar_config(Dir) -> + FName = filename:join(Dir, "rebar.config"), + case filelib:is_regular(FName) of + true -> + ok; + false -> + ok = file:write_file(FName, default_rebar_config()) + end. + +default_rebar_config() -> + ~""" + {erlc_compiler, [{recursive, false}]}. + {erl_opts, [debug_info]}. + """. + +fix_app(Dir) -> + ErlFiles = filelib:wildcard(filename:join(Dir, "src/*.erl")), + ModStrs = [filename:basename(F, ".erl") || F <- ErlFiles], + AppF = filename:join(Dir, "ebin/zx.app"), + {ok, [{application, zx, Opts}]} = file:consult(AppF), + Opts1 = lists:keyreplace(modules, 1, Opts, {modules, [list_to_atom(M) || M <- ModStrs]}), + write_term(AppF, {application, zx, Opts1}). + +write_term(F, Term) -> + {ok, Fd} = file:open(F, [write]), + try io:fwrite(Fd, "~p.~n", [Term]) + after + file:close(Fd) + end.