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

114 lines
3.3 KiB
Makefile
Raw Normal View History

Erlang.mk in-umbrella integration
2016-10-27 21:51:02 +08:00
PROJECT = rabbitmq_cli
Make amqp_client a test dependency, to avoid a circular dependency amqp_client -> rabbitmq_cli -> amqp_client rabbitmq_cli is an indirect test dependency of amqp_client Signed-off-by: Jean-Sébastien Pedron <jean-sebastien@rabbitmq.com>
2016-12-15 01:27:25 +08:00
BUILD_DEPS = rabbit_common
TEST_DEPS = amqp_client
Erlang.mk in-umbrella integration
2016-10-27 21:51:02 +08:00
Makefile: Load the new `rabbitmq-early-plugin.mk` early-stage plugin See the corresponding commit in rabbitmq-common for an explanation. [#144697185]
2017-05-17 00:02:10 +08:00
DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk
Erlang.mk in-umbrella integration
2016-10-27 21:51:02 +08:00
DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk
VERBOSE_TEST makefile variable to toggle test output format
2016-12-08 00:08:29 +08:00
VERBOSE_TEST ?= true
ifeq ($(VERBOSE_TEST),true)
MIX_TEST = mix test --trace
else
MIX_TEST = mix test --max-cases=1
endif
Erlang.mk in-umbrella integration
2016-10-27 21:51:02 +08:00
include rabbitmq-components.mk
include erlang.mk
# FIXME: Use erlang.mk patched for RabbitMQ, while waiting for PRs to be
# reviewed and merged.
ERLANG_MK_REPO = https://github.com/rabbitmq/erlang.mk.git
ERLANG_MK_COMMIT = rabbitmq-tmp
Makefile: New `install` target to copy escripts ... to the directory specified with `$(PREFIX)`. Handling of escripts in the `escript` is modified at the same time so the result in this directory and in `$(PREFIX)` is the same. The behavior is: we use hardlinks by default because they work everywhere, including Windows. If `USE_SYMLINKS_IN_ESCRIPTS_DIR` is specified, we use symlinks instead. However this is not the default behavior because symlinks require privileges on Windows. In the Makefile, I took this occasion to generalize a bit how we distinguish actual escripts (rabbitmqctl) from linked escripts (rabbitmq-plugins, rabbitmq-diagnostics). If we need to add more, it should be easier now by editing the top of the Makefile. Management of the `escript` directory and the install `$(PREFIX)` won't need modifications. [#138925175]
2017-02-09 18:47:14 +08:00
ACTUAL_ESCRIPTS = escript/rabbitmqctl
LINKED_ESCRIPTS = escript/rabbitmq-plugins \
escript/rabbitmq-diagnostics
ESCRIPTS = $(ACTUAL_ESCRIPTS) $(LINKED_ESCRIPTS)
# Record the build and link dependency: the target files are linked to
# their first dependency.
rabbitmq-plugins = escript/rabbitmqctl
rabbitmq-diagnostics = escript/rabbitmqctl
escript/rabbitmq-plugins escript/rabbitmq-diagnostics: escript/rabbitmqctl
# We use hardlinks or symlinks in the `escript` directory and
# install's PREFIX when a single escript can have several names (eg.
# rabbitmq-plugins, rabbitmq-plugins and rabbitmq-diagnostics).
#
# Hardlinks and symlinks work on Windows. However, symlinks require
# privileges unlike hardlinks. That's why we default to hardlinks,
# unless USE_SYMLINKS_IN_ESCRIPTS_DIR is set.
#
# The link_escript function is called as:
# $(call link_escript,source,target)
#
# The function assumes all escripts live in the same directory and that
# the source was previously copied in that directory.
ifdef USE_SYMLINKS_IN_ESCRIPTS_DIR
link_escript = ln -s "$(notdir $(1))" "$(2)"
else
link_escript = ln "$(dir $(2))$(notdir $(1))" "$(2)"
endif
Makefile: Do not rebuild escripts if no source file has changed While here, remove escripts during `make clean` because `mix clean` doesn't cover that. [#131353583]
2016-11-04 17:31:14 +08:00
app:: $(ESCRIPTS)
@:
rabbitmqctl_srcs := mix.exs \
$(shell find config lib -name "*.ex" -o -name "*.exs")
Makefile, mix.exs: Reduce build time First, run mix(1) once from the Makefile. We use an mix alias to call all actual mix commands in a single run. Now `make app` takes care of calling the equivalent of `deps.get`, `deps.compile`, `compile` and `escript.build`. It doesn't match the expected Erlang.mk behavior but it saves us from starting mix(1) multiple times. Second, only build Erlang dependencies (rabbit_common and amqp_client) once from the Makefile (through Erlang.mk dependency mechanism). In `mix.exs`, their compile command is set to `true` because they are already up-to-date. This saves two no-op builds of those dependencies. On my laptop, this reduces the no-op build from 10 seconds to 5 seconds.
2017-01-10 22:45:15 +08:00
# Elixir dependencies are fetched and compiled as part of the alias
# `mix make_all`. We do not fetch and build them in `make deps` because
# mix(1) startup time is quite high. Thus we prefer to run it once, even
# though it kind of breaks the Erlang.mk model.
Makefile: Use `echo y | mix` instead of `mix local.hex --force` The problem with `mix local.hex --force` is it always reinstalls Hex, even if it's to download the exact same version. There is no way to tell it "Install Hex only when needed". Also, calling `local.hex --force` from an alias doesn't work either: mix insists on having Hex available before looking at the command. Even `mix help` wants to download Hex first... Another problem, with the Makefile this time, is that different filename chracter encodings are used on Windows, between Windows itself, GNU Make and/or Elixir, leading to the wildcard not working. This causes `mix local.hex` to be always called and `rabbitmqctl` to always be recompiled. Just automatically answering the interactive question to install Hex solves all issues at once: Hex is installed only when needed and we get rid of the wildcard on Windows.
2017-01-16 20:50:02 +08:00
#
# We write `y` on mix stdin because it asks approval to install Hex if
# it's missing. Another way to do it is to use `mix local.hex` but it
# can't be integrated in an alias and doing it from the Makefile isn't
# practical.
Makefile: New `install` target to copy escripts ... to the directory specified with `$(PREFIX)`. Handling of escripts in the `escript` is modified at the same time so the result in this directory and in `$(PREFIX)` is the same. The behavior is: we use hardlinks by default because they work everywhere, including Windows. If `USE_SYMLINKS_IN_ESCRIPTS_DIR` is specified, we use symlinks instead. However this is not the default behavior because symlinks require privileges on Windows. In the Makefile, I took this occasion to generalize a bit how we distinguish actual escripts (rabbitmqctl) from linked escripts (rabbitmq-plugins, rabbitmq-diagnostics). If we need to add more, it should be easier now by editing the top of the Makefile. Management of the `escript` directory and the install `$(PREFIX)` won't need modifications. [#138925175]
2017-02-09 18:47:14 +08:00
$(ACTUAL_ESCRIPTS): $(rabbitmqctl_srcs) deps
Makefile: Use `echo y | mix` instead of `mix local.hex --force` The problem with `mix local.hex --force` is it always reinstalls Hex, even if it's to download the exact same version. There is no way to tell it "Install Hex only when needed". Also, calling `local.hex --force` from an alias doesn't work either: mix insists on having Hex available before looking at the command. Even `mix help` wants to download Hex first... Another problem, with the Makefile this time, is that different filename chracter encodings are used on Windows, between Windows itself, GNU Make and/or Elixir, leading to the wildcard not working. This causes `mix local.hex` to be always called and `rabbitmqctl` to always be recompiled. Just automatically answering the interactive question to install Hex solves all issues at once: Hex is installed only when needed and we get rid of the wildcard on Windows.
2017-01-16 20:50:02 +08:00
$(gen_verbose) echo y | mix make_all
Erlang.mk in-umbrella integration
2016-10-27 21:51:02 +08:00
Makefile: New `install` target to copy escripts ... to the directory specified with `$(PREFIX)`. Handling of escripts in the `escript` is modified at the same time so the result in this directory and in `$(PREFIX)` is the same. The behavior is: we use hardlinks by default because they work everywhere, including Windows. If `USE_SYMLINKS_IN_ESCRIPTS_DIR` is specified, we use symlinks instead. However this is not the default behavior because symlinks require privileges on Windows. In the Makefile, I took this occasion to generalize a bit how we distinguish actual escripts (rabbitmqctl) from linked escripts (rabbitmq-plugins, rabbitmq-diagnostics). If we need to add more, it should be easier now by editing the top of the Makefile. Management of the `escript` directory and the install `$(PREFIX)` won't need modifications. [#138925175]
2017-02-09 18:47:14 +08:00
$(LINKED_ESCRIPTS):
$(gen_verbose) $(call link_escript,$<,$@)
Makefile: Do not rebuild escripts if no source file has changed While here, remove escripts during `make clean` because `mix clean` doesn't cover that. [#131353583]
2016-11-04 17:31:14 +08:00
rel:: $(ESCRIPTS)
@:
Support start from common_test tests
2016-12-23 20:12:33 +08:00
tests:: $(ESCRIPTS)
Reintroduce make test It requires TEST_FILE to be set and thus is only suitable for running a single test case. The same can be done with make tests, which also can run the entire suite.
2017-03-09 21:13:20 +08:00
$(gen_verbose) $(MIX_TEST) $(TEST_FILE)
Revert "Remove test make target" This reverts commit 21fb931e7ac30dbbc27be8fddbf32da4e7e0a643. We decided to keep the test target around but also make the tests one support running a single case.
2017-03-09 20:57:59 +08:00
test:: $(ESCRIPTS)
Reintroduce make test It requires TEST_FILE to be set and thus is only suitable for running a single test case. The same can be done with make tests, which also can run the entire suite.
2017-03-09 21:13:20 +08:00
ifdef TEST_FILE
Makefile: Use $(verbose) Erlang.mk macros
2016-12-30 00:49:58 +08:00
$(gen_verbose) $(MIX_TEST) $(TEST_FILE)
Reintroduce make test It requires TEST_FILE to be set and thus is only suitable for running a single test case. The same can be done with make tests, which also can run the entire suite.
2017-03-09 21:13:20 +08:00
else
$(verbose) echo "TEST_FILE must be set, e.g. TEST_FILE=./test/close_all_connections_command_test.exs" 1>&2; false
endif
script name is overridable via argument
2016-10-31 19:21:10 +08:00
Makefile: New `install` target to copy escripts ... to the directory specified with `$(PREFIX)`. Handling of escripts in the `escript` is modified at the same time so the result in this directory and in `$(PREFIX)` is the same. The behavior is: we use hardlinks by default because they work everywhere, including Windows. If `USE_SYMLINKS_IN_ESCRIPTS_DIR` is specified, we use symlinks instead. However this is not the default behavior because symlinks require privileges on Windows. In the Makefile, I took this occasion to generalize a bit how we distinguish actual escripts (rabbitmqctl) from linked escripts (rabbitmq-plugins, rabbitmq-diagnostics). If we need to add more, it should be easier now by editing the top of the Makefile. Management of the `escript` directory and the install `$(PREFIX)` won't need modifications. [#138925175]
2017-02-09 18:47:14 +08:00
.PHONY: install
install: $(ESCRIPTS)
ifdef PREFIX
$(gen_verbose) mkdir -p "$(DESTDIR)$(PREFIX)"
$(verbose) $(foreach script,$(ESCRIPTS), \
rm -f "$(DESTDIR)$(PREFIX)/$(notdir $(script))";)
$(verbose) $(foreach script,$(ACTUAL_ESCRIPTS), \
cp "$(script)" "$(DESTDIR)$(PREFIX)";)
$(verbose) $(foreach script,$(LINKED_ESCRIPTS), \
$(call link_escript,$($(notdir $(script))),$(DESTDIR)$(PREFIX)/$(notdir $(script)));)
else
$(verbose) echo "You must specify a PREFIX" 1>&2; false
endif
Makefile: Use $(verbose) Erlang.mk macros
2016-12-30 00:49:58 +08:00
clean:: clean-mix
Makefile: Use `echo y | mix` instead of `mix local.hex --force` The problem with `mix local.hex --force` is it always reinstalls Hex, even if it's to download the exact same version. There is no way to tell it "Install Hex only when needed". Also, calling `local.hex --force` from an alias doesn't work either: mix insists on having Hex available before looking at the command. Even `mix help` wants to download Hex first... Another problem, with the Makefile this time, is that different filename chracter encodings are used on Windows, between Windows itself, GNU Make and/or Elixir, leading to the wildcard not working. This causes `mix local.hex` to be always called and `rabbitmqctl` to always be recompiled. Just automatically answering the interactive question to install Hex solves all issues at once: Hex is installed only when needed and we get rid of the wildcard on Windows.
2017-01-16 20:50:02 +08:00
clean-mix:
Makefile: Use $(verbose) Erlang.mk macros
2016-12-30 00:49:58 +08:00
$(gen_verbose) rm -f $(ESCRIPTS)
Makefile: Use `echo y | mix` instead of `mix local.hex --force` The problem with `mix local.hex --force` is it always reinstalls Hex, even if it's to download the exact same version. There is no way to tell it "Install Hex only when needed". Also, calling `local.hex --force` from an alias doesn't work either: mix insists on having Hex available before looking at the command. Even `mix help` wants to download Hex first... Another problem, with the Makefile this time, is that different filename chracter encodings are used on Windows, between Windows itself, GNU Make and/or Elixir, leading to the wildcard not working. This causes `mix local.hex` to be always called and `rabbitmqctl` to always be recompiled. Just automatically answering the interactive question to install Hex solves all issues at once: Hex is installed only when needed and we get rid of the wildcard on Windows.
2017-01-16 20:50:02 +08:00
$(verbose) echo y | mix clean
script name is overridable via argument
2016-10-31 19:21:10 +08:00
repl:
Makefile: Use $(verbose) Erlang.mk macros
2016-12-30 00:49:58 +08:00
$(verbose) iex -S mix