root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Rework plt/dialyze for rabbitmqctl and plugins that depend on it 

This allows us to stop ignorning undefined callback warnings

When mix compiles rabbitmqctl, it produces a 'consolidated' directory
alongside the 'ebin' dir. Some of the modules in consolidated are
intended to be used instead of those provided by elixir. We now handle
the conflicts properly in the bazel build.
This commit is contained in:
Rin Kuryloski 2023-01-16 21:33:50 +01:00
parent 8bbe87ec9e
commit b84e746ee9
14 changed files with 227 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bazel/elixir/elixir_as_app.bzl
View File

@ -31,6 +31,8 @@ cp -r "{elixir_home}"/lib/elixir/ebin/* {ebin}
include = [],
beam = [ebin],
priv = [],
license_files = [],
srcs = [],
deps = [],
),
]

12
deps/rabbitmq_amqp1_0/BUILD.bazel vendored
View File

@ -23,7 +23,7 @@ APP_NAME = "rabbitmq_amqp1_0"
APP_DESCRIPTION = "AMQP 1.0 support for RabbitMQ"
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -58,17 +58,13 @@ plt(
"stdlib",
"ssl",
],
# this ought to include BUILD_DEPS, but not sure how to
# get dialyze of elixir code working yet
deps = without(
"//deps/rabbitmq_cli:rabbitmqctl",
BUILD_DEPS + DEPS + RUNTIME_DEPS,
),
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
size = "medium",
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

14
deps/rabbitmq_auth_backend_oauth2/BUILD.bazel vendored
View File

@ -23,7 +23,7 @@ EXTRA_APPS = [
BUILD_DEPS = [
"//deps/rabbit_common:erlang_app",
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -40,29 +40,27 @@ rabbitmq_app(
app_description = APP_DESCRIPTION,
app_name = APP_NAME,
build_deps = BUILD_DEPS,
extra_apps = EXTRA_APPS,
runtime_deps = RUNTIME_DEPS,
deps = DEPS,
extra_apps = EXTRA_APPS,
)
xref(
additional_libs = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
],
)
plt(
name = "base_plt",
apps = EXTRA_APPS,
libs = ["//deps/rabbitmq_cli:elixir"],
plt = "//:base_plt",
deps = without(
"//deps/rabbitmq_cli:rabbitmqctl",
BUILD_DEPS + DEPS + RUNTIME_DEPS,
),
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

174
deps/rabbitmq_cli/rabbitmqctl.bzl vendored
View File

@ -18,11 +18,27 @@ load(
"maybe_install_erlang",
)
ElixirAppInfo = provider(
doc = "Compiled Erlang Application",
fields = {
"app_name": "Name of the erlang application",
"extra_apps": "Extra applications in the applications key of the .app file",
"include": "Public header files",
"beam": "ebin directory produced by mix",
"consolidated": "consolidated directory produced by mix",
"priv": "Additional files",
"license_files": "License files",
"srcs": "Source files",
"deps": "Runtime dependencies of the compiled sources",
},
)
def deps_dir_contents(ctx, deps, dir):
files = []
for dep in deps:
lib_info = dep[ErlangAppInfo]
for src in lib_info.include + lib_info.beam + lib_info.srcs:
if not src.is_directory:
rp = additional_file_dest_relative_path(dep.label, src)
f = ctx.actions.declare_file(path_join(
dir,
@ -42,6 +58,7 @@ def _impl(ctx):
escript = ctx.actions.declare_file(path_join("escript", "rabbitmqctl"))
ebin = ctx.actions.declare_directory("ebin")
consolidated = ctx.actions.declare_directory("consolidated")
mix_invocation_dir = ctx.actions.declare_directory("{}_mix".format(ctx.label.name))
fetched_srcs = ctx.actions.declare_file("deps.tar")
@ -66,6 +83,7 @@ else
ABS_ELIXIR_HOME=$PWD/{elixir_home}
fi
ABS_EBIN_DIR=$PWD/{ebin_dir}
ABS_CONSOLIDATED_DIR=$PWD/{consolidated_dir}
ABS_ESCRIPT_PATH=$PWD/{escript_path}
ABS_FETCHED_SRCS=$PWD/{fetched_srcs}
@ -99,7 +117,7 @@ fi
cp escript/rabbitmqctl ${{ABS_ESCRIPT_PATH}}
cp _build/${{MIX_ENV}}/lib/rabbitmqctl/ebin/* ${{ABS_EBIN_DIR}}
cp _build/${{MIX_ENV}}/lib/rabbitmqctl/consolidated/* ${{ABS_EBIN_DIR}}
cp _build/${{MIX_ENV}}/lib/rabbitmqctl/consolidated/* ${{ABS_CONSOLIDATED_DIR}}
tar --file ${{ABS_FETCHED_SRCS}} \\
--create deps
@ -116,6 +134,7 @@ find . -type l -delete
deps_dir = deps_dir,
escript_path = escript.path,
ebin_dir = ebin.path,
consolidated_dir = consolidated.path,
fetched_srcs = fetched_srcs.path,
)
@ -130,12 +149,18 @@ find . -type l -delete
ctx.actions.run_shell(
inputs = inputs,
outputs = [escript, ebin, mix_invocation_dir, fetched_srcs],
outputs = [
escript,
ebin,
consolidated,
mix_invocation_dir,
fetched_srcs,
],
command = script,
mnemonic = "MIX",
)
runfiles = ctx.runfiles([ebin]).merge_all([
runfiles = ctx.runfiles([ebin, consolidated]).merge_all([
erlang_runfiles,
elixir_runfiles,
] + [
@ -146,13 +171,15 @@ find . -type l -delete
return [
DefaultInfo(
executable = escript,
files = depset([ebin, fetched_srcs]),
files = depset([ebin, consolidated, fetched_srcs]),
runfiles = runfiles,
),
ErlangAppInfo(
app_name = "rabbitmq_cli",
ElixirAppInfo(
app_name = "rabbitmqctl", # mix generates 'rabbitmqctl.app'
extra_apps = ["elixir", "logger"],
include = [],
beam = [ebin],
beam = ebin,
consolidated = consolidated,
priv = [],
license_files = ctx.files.license_files,
srcs = ctx.files.srcs,
@ -180,15 +207,144 @@ rabbitmqctl_private = rule(
toolchains = [
"//bazel/elixir:toolchain_type",
],
provides = [ErlangAppInfo],
provides = [ElixirAppInfo],
executable = True,
)
def rabbitmqctl(**kwargs):
def _elixir_app_to_erlang_app(ctx):
app_consolidated = ctx.attr.elixir_app[ElixirAppInfo].consolidated
app_ebin = ctx.attr.elixir_app[ElixirAppInfo].beam
elixir_ebin = ctx.attr.elixir_as_app[ErlangAppInfo].beam[0].path
ebin = ctx.actions.declare_directory(path_join(ctx.label.name, "ebin"))
if ctx.attr.mode == "elixir":
ctx.actions.run_shell(
inputs = ctx.files.elixir_as_app + ctx.files.elixir_app,
outputs = [ebin],
command = """\
set -euo pipefail
cp {elixir_ebin}/* {ebin}
for beam in {app_consolidated}/*; do
find {ebin} -name "$(basename $beam)" -exec cp -f $beam {ebin} \\;
done
""".format(
elixir_ebin = elixir_ebin,
app_consolidated = app_consolidated.path,
ebin = ebin.path,
),
)
lib_info = ctx.attr.elixir_as_app[ErlangAppInfo]
return [
DefaultInfo(files = depset([ebin])),
ErlangAppInfo(
app_name = "elixir",
include = lib_info.include,
beam = [ebin],
priv = lib_info.priv,
deps = lib_info.deps,
),
]
elif ctx.attr.mode == "app":
ctx.actions.run_shell(
inputs = ctx.files.elixir_as_app + ctx.files.elixir_app,
outputs = [ebin],
command = """\
set -euo pipefail
cp {app_ebin}/* {ebin}
cp -f {app_consolidated}/* {ebin}
for beam in {elixir_ebin}/*; do
find {ebin} -name "$(basename $beam)" -delete
done
""".format(
elixir_ebin = elixir_ebin,
app_ebin = app_ebin.path,
app_consolidated = app_consolidated.path,
ebin = ebin.path,
),
)
lib_info = ctx.attr.elixir_app[ElixirAppInfo]
return [
DefaultInfo(files = depset([ebin])),
ErlangAppInfo(
app_name = lib_info.app_name,
extra_apps = lib_info.extra_apps,
include = lib_info.include,
beam = [ebin],
priv = lib_info.priv,
license_files = lib_info.license_files,
srcs = lib_info.srcs,
deps = lib_info.deps,
),
]
return []
elixir_app_to_erlang_app = rule(
implementation = _elixir_app_to_erlang_app,
attrs = {
"elixir_as_app": attr.label(
providers = [ErlangAppInfo],
),
"elixir_app": attr.label(
providers = [ElixirAppInfo],
),
"mode": attr.string(
values = [
"elixir",
"app",
],
),
},
provides = [ErlangAppInfo],
)
def rabbitmqctl(
name = None,
visibility = None,
**kwargs):
# mix produces a consolidated directory alongside the ebin
# directory, which contains .beam files for modules that
# are extended by protocols
# When used with dialyzer, this results in module conflicts
# between the original versions in elixir, and the
# consolidated ones
# So, this macro compiles the cli, then derives a copy of
# elixir that can be loaded alongside it without conflict
# (but assumes that the two are used together)
# These each have to be separate rules, as a single rule
# cannot provide multiple erlang_app (ErlangAppInfo
# provider instances)
rabbitmqctl_private(
name = name,
is_windows = select({
"@bazel_tools//src/conditions:host_windows": True,
"//conditions:default": False,
}),
visibility = visibility,
**kwargs
)
elixir_app_to_erlang_app(
name = "elixir",
elixir_as_app = Label("//bazel/elixir:erlang_app"),
elixir_app = ":" + name,
mode = "elixir",
visibility = visibility,
)
elixir_app_to_erlang_app(
name = "erlang_app",
elixir_as_app = Label("//bazel/elixir:erlang_app"),
elixir_app = ":" + name,
mode = "app",
visibility = visibility,
)

7
deps/rabbitmq_consistent_hash_exchange/BUILD.bazel vendored
View File

@ -15,7 +15,7 @@ APP_NAME = "rabbitmq_consistent_hash_exchange"
APP_DESCRIPTION = "Consistent Hash Exchange Type"
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -41,11 +41,12 @@ xref(
plt(
name = "base_plt",
deps = DEPS,
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

7
deps/rabbitmq_federation/BUILD.bazel vendored
View File

@ -24,7 +24,7 @@ APP_ENV = """[
]"""
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -49,11 +49,12 @@ xref(
plt(
name = "base_plt",
deps = DEPS,
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

6
deps/rabbitmq_management/BUILD.bazel vendored
View File

@ -77,8 +77,12 @@ xref()
plt(
name = "base_plt",
apps = [
"erts",
"kernel",
"stdlib",
] + EXTRA_APPS,
deps = DEPS + RUNTIME_DEPS,
apps = ["erts", "kernel", "stdlib"] + EXTRA_APPS,
)
dialyze(

7
deps/rabbitmq_management_agent/BUILD.bazel vendored
View File

@ -36,7 +36,7 @@ EXTRA_APPS = [
]
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -66,12 +66,13 @@ plt_apps.remove("ranch")
plt(
name = "base_plt",
apps = plt_apps,
libs = ["//deps/rabbitmq_cli:elixir"],
plt = "//:base_plt",
deps = DEPS,
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
warnings_as_errors = False,
)

7
deps/rabbitmq_mqtt/BUILD.bazel vendored
View File

@ -42,7 +42,7 @@ APP_ENV = """[
]"""
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -73,11 +73,12 @@ xref(
plt(
name = "base_plt",
deps = DEPS,
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
warnings_as_errors = False,
)

7
deps/rabbitmq_shovel/BUILD.bazel vendored
View File

@ -34,7 +34,7 @@ EXTRA_APPS = [
]
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -65,11 +65,12 @@ xref(
plt(
name = "base_plt",
deps = DEPS,
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

7
deps/rabbitmq_stomp/BUILD.bazel vendored
View File

@ -41,7 +41,7 @@ APP_ENV = """[
]"""
BUILD_DEPS = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -71,11 +71,12 @@ xref(
plt(
name = "base_plt",
deps = DEPS,
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS + RUNTIME_DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
warnings_as_errors = False,
)

12
deps/rabbitmq_stream/BUILD.bazel vendored
View File

@ -34,7 +34,7 @@ APP_ENV = """[
BUILD_DEPS = [
"//deps/rabbit_common:erlang_app",
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
]
DEPS = [
@ -55,7 +55,7 @@ rabbitmq_app(
xref(
additional_libs = [
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:erlang_app",
],
)
@ -67,14 +67,12 @@ plt(
"stdlib",
"ssl",
],
deps = without(
"//deps/rabbitmq_cli:rabbitmqctl",
BUILD_DEPS + DEPS,
),
libs = ["//deps/rabbitmq_cli:elixir"],
deps = ["//deps/rabbitmq_cli:elixir"] + BUILD_DEPS + DEPS,
)
dialyze(
dialyzer_opts = RABBITMQ_DIALYZER_OPTS + ["-Wno_undefined_callbacks"],
dialyzer_opts = RABBITMQ_DIALYZER_OPTS,
plt = ":base_plt",
)

2
dist.bzl
View File

@ -309,7 +309,7 @@ def source_archive(
source_tree(
name = "source-tree",
deps = plugins + [
Label(rabbitmq_workspace + "//deps/rabbitmq_cli:rabbitmqctl"),
Label(rabbitmq_workspace + "//deps/rabbitmq_cli:erlang_app"),
],
)

8
rabbitmq.bzl
View File

@ -247,8 +247,8 @@ def rabbitmq_integration_suite(
":rabbitmq-for-tests-run",
] + tools,
runtime_deps = [
"//bazel/elixir:erlang_app",
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:elixir",
"//deps/rabbitmq_cli:erlang_app",
"//deps/rabbitmq_ct_client_helpers:erlang_app",
] + runtime_deps,
deps = extra_deps + deps,
@ -288,8 +288,8 @@ def rabbitmq_integration_suite(
"@rabbitmq-server-generic-unix-3.11//:rabbitmq-run",
] + tools,
runtime_deps = [
"//bazel/elixir:erlang_app",
"//deps/rabbitmq_cli:rabbitmqctl",
"//deps/rabbitmq_cli:elixir",
"//deps/rabbitmq_cli:erlang_app",
"//deps/rabbitmq_ct_client_helpers:erlang_app",
] + runtime_deps,
deps = extra_deps + deps,