Merge pull request #119 from rabbitmq/rabbitmq-perf-test-118-docker-image

Create Docker image

Author: acogoluegnes

Dockerfile

@@ -0,0 +1,15 @@
+FROM openjdk:8u181-jre-alpine3.8
+
+ARG perf_test_version
+ENV URL=https://github.com/rabbitmq/rabbitmq-perf-test/releases/download/v$perf_test_version/rabbitmq-perf-test-$perf_test_version-bin.tar.gz
+
+RUN apk add --no-cache bash curl ca-certificates
+
+# Fail fast if URL is invalid
+RUN curl --verbose --head --fail $URL 1>/dev/null
+
+# Download into /perf_test & ensure that it works correctly
+RUN mkdir -p /perf_test && cd /perf_test && curl --location --silent --fail --output - $URL | tar x -z -v -f - --strip-components 1 && bin/runjava com.rabbitmq.perf.PerfTest --help
+WORKDIR /perf_test
+
+ENTRYPOINT ["bin/runjava", "com.rabbitmq.perf.PerfTest"]

Makefile

@@ -1,52 +1,71 @@
-.ONESHELL:# single shell invocation for all lines in the recipe
+SHELL := bash# we want bash behaviour in all shell invocations
 
 .DEFAULT_GOAL = help
 
 ### VARIABLES ###
 #
-export PATH 	:=$(CURDIR):$(CURDIR)/scripts:$(PATH)
-OS              := $(shell uname -s | tr '[:upper:]' '[:lower:]')
-HARDWARE        := $(shell uname -m | tr '[:upper:]' '[:lower:]')
-GPG_KEYNAME     := $(shell cat pom.xml | grep -oPm1 "(?<=<gpg.keyname>)[^<]+")
+export PATH := $(CURDIR):$(CURDIR)/scripts:$(PATH)
+
+OS := $$(uname -s | tr '[:upper:]' '[:lower:]')
+HARDWARE := $$(uname -m | tr '[:upper:]' '[:lower:]')
+
+GPG_KEYNAME := $$(awk -F'[<>]' '/<gpg.keyname>/ { print $$3 }' pom.xml)
+
+RELEASE_VERSION ?= 2.3.0
 
 ### TARGETS ###
 #
 
+.PHONY: binary
 binary: clean ## Build the binary distribution
 	@mvnw package -P assemblies -Dgpg.skip=true -Dmaven.test.skip
 
+.PHONY: native-image
 native-image: clean ## Build the native image
 	@mvnw -q package -DskipTests -P native-image -P '!java-packaging'
 	native-image -jar target/perf-test.jar -H:Features="com.rabbitmq.perf.NativeImageFeature"
 
+.PHONY: docker-image
+docker-image: ## Build Docker image
+	@docker build \
+	  --tag pivotalrabbitmq/perf-test:$(RELEASE_VERSION) \
+	  --tag pivotalrabbitmq/perf-test:latest \
+	  --build-arg perf_test_version=$(RELEASE_VERSION) .
 
+.PHONY: package-native-image
 package-native-image: native-image ## Package the native image
 	cp perf-test target/perf-test_$(OS)_$(HARDWARE)
 	@mvnw -q checksum:files -P native-image
 	gpg --armor --local-user $(GPG_KEYNAME) --detach-sign target/perf-test_$(OS)_$(HARDWARE)
 
+.PHONY: help
 help:
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-24s\033[0m %s\n", $$1, $$2}'
 
+.PHONY: clean
 clean: 	## Clean all build artefacts
 	@mvnw clean
 
+.PHONY: compile
 compile: ## Compile the source code
 	@mvnw compile
 
+.PHONY: install
 install: clean ## Create and copy the binaries into the local Maven repository
 	@mvnw install -Dmaven.test.skip
 
+.PHONY: jar
 jar: clean ## Build the JAR file
 	@mvnw package -Dmaven.test.skip
 
+.PHONY: run
 run: compile ## Run PerfTest, pass exec arguments via ARGS, e.g. ARGS="-x 1 -y 1 -r 1"
 	@mvnw exec:java -Dexec.mainClass="com.rabbitmq.perf.PerfTest" -Dexec.args="$(ARGS)"
 
+.PHONY: signed-binary
 signed-binary: clean ## Build a GPG signed binary
 	@mvnw package -P assemblies
 
+.PHONY: doc
 doc: ## Generate PerfTest documentation
 	@mvnw asciidoctor:process-asciidoc
-
-.PHONY: binary help clean compile jar run signed-binary

src/docs/asciidoc/installation.adoc

@@ -1,6 +1,6 @@
 == Installation
 
-=== From binary
+=== From Binary
 
 PerfTest is distributed as a binary build archive
 from https://github.com/rabbitmq/rabbitmq-perf-test/releases[GitHub releases] and
@@ -22,13 +22,35 @@ the `PerfTest` Java class.
 
 To verify a PerfTest installation, use:
 
- $ bin/runjava com.rabbitmq.perf.PerfTest --help
+ bin/runjava com.rabbitmq.perf.PerfTest --help
 
 === From Native Executable
 
 PerfTest is also distributed as a native executable binary. This is an experimental
 feature, see the link:#native-executable[dedicated section] for more information.
 
+=== From Docker Image
+
+PerfTest has a https://hub.docker.com/r/pivotalrabbitmq/perf-test/[Docker image] as well.
+To use it:
+
+ docker run -it --rm pivotalrabbitmq/perf-test:latest --help
+
+Note that the Docker container needs to be able to connect to the host where
+the RabbitMQ broker runs.  Find out more at
+https://docs.docker.com/network/[Docker network documentation].  Once the
+Docker container where PerfTest runs can connect to the RabbitMQ broker,
+PerfTest can be run with the regular options, e.g.:
+
+ docker run -it --rm pivotalrabbitmq/perf-test:latest -x 1 -y 2 -u "throughput-test-1" -a --id "test 1"
+
+To run the RabbitMQ broker within Docker, and run PerfTest against it, run the
+following commands:
+
+ docker network create perf-test
+ docker run -it --rm --network perf-test --name rabbitmq -p 15672:15672 rabbitmq:3.7.8-management
+ docker run -it --rm --network perf-test pivotalrabbitmq/perf-test:latest --uri amqp://rabbitmq
+
 === For Cloud Foundry
 
 There is a https://github.com/rabbitmq/rabbitmq-perf-test-for-cf[template project]