Makefile

# Copyright (C) 2010-2012  The Async HBase Authors.  All rights reserved.
# This file is part of Async HBase.
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#   - Redistributions of source code must retain the above copyright notice,
#     this list of conditions and the following disclaimer.
#   - Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions and the following disclaimer in the documentation
#     and/or other materials provided with the distribution.
#   - Neither the name of the StumbleUpon nor the names of its contributors
#     may be used to endorse or promote products derived from this software
#     without specific prior written permission.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

all: jar $(UNITTESTS)
# TODO(tsuna): Use automake to avoid relying on GNU make extensions.

include third_party/include.mk

JAVA := java
PACKAGE_BUGREPORT := opentsdb@googlegroups.com

top_builddir := build
package := org.hbase.async
proto_package := $(package).protobuf.generated
proto_generated_builddir := $(top_builddir)/src
proto_builddir := $(top_builddir)/protobuf
spec_title := Asynchronous HBase Client
spec_vendor := The Async HBase Authors
# Semantic Versioning (see http://semver.org/).
spec_version := 1.5.0
jar := $(top_builddir)/asynchbase-$(spec_version).jar

asynchbase_PROTOS := \
	protobuf/Cell.proto	\
	protobuf/Client.proto	\
	protobuf/Comparator.proto	\
	protobuf/ErrorHandling.proto	\
	protobuf/Filter.proto	\
	protobuf/MultiRowMutation.proto	\
	protobuf/RPC.proto	\
	protobuf/Tracing.proto	\
	protobuf/ZooKeeper.proto	\
	protobuf/HBase.proto	\

PROTOBUF_GEN_DIR = $(top_builddir)/src/org/hbase/async/generated

BUILT_SOURCES := $(asynchbase_PROTOS:protobuf/%.proto=$(PROTOBUF_GEN_DIR)/%PB.java)

asynchbase_SOURCES := \
	src/AtomicIncrementRequest.java	\
	src/BatchableRpc.java	\
	src/BrokenMetaException.java	\
	src/BufferedIncrement.java	\
	src/Bytes.java	\
	src/ClientStats.java	\
	src/ColumnPrefixFilter.java	\
	src/ColumnRangeFilter.java	\
	src/CompareAndSetRequest.java	\
	src/ConnectionResetException.java	\
	src/Counter.java	\
	src/DeleteRequest.java	\
	src/FilterList.java		\
	src/GetRequest.java	\
	src/HBaseClient.java	\
	src/HBaseException.java	\
	src/HBaseRpc.java	\
	src/HasFailedRpcException.java	\
	src/InvalidResponseException.java	\
	src/KeyRegexpFilter.java	\
	src/KeyValue.java	\
	src/MultiAction.java	\
	src/NoSuchColumnFamilyException.java	\
	src/NonRecoverableException.java	\
	src/NotServingRegionException.java	\
	src/PleaseThrottleException.java	\
	src/PutRequest.java	\
	src/RecoverableException.java	\
	src/RegionClient.java	\
	src/RegionInfo.java	\
	src/RegionOfflineException.java	\
	src/RemoteException.java	\
	src/RowLock.java	\
	src/RowLockRequest.java	\
	src/ScanFilter.java	\
	src/Scanner.java	\
	src/SingletonList.java	\
	src/TableNotFoundException.java	\
	src/UnknownRowLockException.java	\
	src/UnknownScannerException.java	\
	src/VersionMismatchException.java	\
	src/jsr166e/LongAdder.java	\
	src/jsr166e/Striped64.java	\

protobuf_SOURCES := src/protobuf/ZeroCopyLiteralByteString.java

asynchbase_LIBADD := \
	$(NETTY)	\
	$(SLF4J_API)	\
	$(ZOOKEEPER)	\
	$(SUASYNC)	\
	$(GUAVA)	\
	$(PROTOBUF)	\

test_SOURCES := \
	test/Common.java	\
	test/Test.java	\
	test/TestIncrementCoalescing.java	\
	test/TestIntegration.java	\

unittest_SRC := \
	test/TestMETALookup.java	\
	test/TestNSREs.java

test_LIBADD := \
	$(asynchbase_LIBADD)	\
	$(LOG4J_OVER_SLF4J)	\
	$(LOGBACK_CLASSIC)	\
	$(LOGBACK_CORE)	\
	$(JAVASSIST)	\
	$(JUNIT)	\
	$(HAMCREST)	\
	$(MOCKITO)	\
	$(OBJENESIS)	\
	$(POWERMOCK_MOCKITO)	\
        $(jar)

package_dir := $(subst .,/,$(package))
AM_JAVACFLAGS := -Xlint -source 6 -target 6
JAVAC := javac
JVM_ARGS :=
PROTOC := protoc
classes := $(asynchbase_SOURCES:src/%.java=$(top_builddir)/$(package_dir)/%.class) \
 $(protobuf_SOURCES:src/%.java=$(top_builddir)/com/google/%.class) \
 $(asynchbase_PROTOS:protobuf/%.proto=$(top_builddir)/$(package_dir)/generated/%PB.class)
test_classes := $(test_SOURCES:test/%.java=$(top_builddir)/$(package_dir)/test/%.class)
UNITTESTS := $(unittest_SRC:test/%.java=$(top_builddir)/$(package_dir)/%.class)

jar: $(jar)

get_dep_classpath = `echo $(asynchbase_LIBADD) | tr ' ' ':'`
$(top_builddir)/.javac-protobuf-stamp: $(PROTOBUF) $(protobuf_SOURCES) $(BUILT_SOURCES)
	@mkdir -p $(top_builddir)
	$(JAVAC) $(AM_JAVACFLAGS) -cp $(PROTOBUF) \
	  -d $(top_builddir) $(protobuf_SOURCES) $(BUILT_SOURCES)
	@touch "$@"

$(top_builddir)/.javac-stamp: $(top_builddir)/.javac-protobuf-stamp $(asynchbase_SOURCES) $(asynchbase_LIBADD)
	$(JAVAC) $(AM_JAVACFLAGS) -cp $(get_dep_classpath):build \
	  -d $(top_builddir) $(asynchbase_SOURCES)
	@touch "$@"

$(PROTOBUF_GEN_DIR)/%PB.java: protobuf/%.proto
	@mkdir -p $(proto_generated_builddir)
	@case `$(PROTOC) --version` in \
	  (*2.5*) :;; \
	  (*) echo You need the protobuf compiler v2.5 2>&1; exit 1;; \
	esac
	$(PROTOC) -Iprotobuf --java_out=$(proto_generated_builddir) $<

get_runtime_dep_classpath = `echo $(test_LIBADD) | tr ' ' ':'`
$(test_classes): $(jar) $(test_SOURCES) $(test_LIBADD)
	$(JAVAC) $(AM_JAVACFLAGS) -cp $(get_runtime_dep_classpath) \
	  -d $(top_builddir) $(test_SOURCES)
$(top_builddir)/.javac-test-stamp: $(jar) $(unittest_SRC) $(test_LIBADD)
	$(JAVAC) $(AM_JAVACFLAGS) -cp $(get_runtime_dep_classpath) \
	  -d $(top_builddir) $(unittest_SRC)

classes_with_nested_classes := $(classes:$(top_builddir)/%.class=%*.class)
unittest_classes_with_nested_classes := $(UNITTESTS:$(top_builddir)/%.class=%*.class)
test_classes_with_nested_classes := $(test_classes:$(top_builddir)/%.class=%*.class)

run: jar $(test_classes)
	@test -n "$(CLASS)" || { echo 'usage: $(MAKE) run CLASS=<name>'; exit 1; }
	$(JAVA) -ea -esa $(JVM_ARGS) -cp "$(get_runtime_dep_classpath):$(top_builddir)" $(package).test.$(CLASS) $(ARGS)

cli:
	$(MAKE) run CLASS=Test

integration:
	$(MAKE) run CLASS=TestIntegration


# Little sed script to make a pretty-ish banner.
BANNER := sed 's/^.*/  &  /;h;s/./=/g;p;x;p;x'
check: $(top_builddir)/.javac-test-stamp $(UNITTESTS)
	classes=`cd $(top_builddir) && echo $(unittest_classes_with_nested_classes)` \
        && tests=0 && failures=0 \
        && cp="$(get_runtime_dep_classpath):$(top_builddir)" && \
        for i in $$classes; do \
          case $$i in (*[$$]*) continue;; (*/Test*) :;; (*) continue;; esac; \
	  case $$i in (*$(TESTS)*) :;; (*) continue;; esac; \
          tests=$$((tests + 1)); \
          echo "Running tests for `basename $$i .class`" | $(BANNER); \
          $(JAVA) -ea -esa $(JVM_ARGS) -cp "$$cp" org.junit.runner.JUnitCore `echo $${i%.class} | tr / .` $(ARGS) \
          || failures=$$((failures + 1)); \
        done; \
        if test "$$failures" -eq 0; then \
          echo "All $$tests tests passed" | $(BANNER); \
        else \
          echo "$$failures out of $$tests failed, please send a report to $(PACKAGE_BUGREPORT)" | $(BANNER); \
        fi
	@touch $(top_builddir)/.javac-test-stamp

pkg_version = \
  `git rev-list --pretty=format:%h HEAD --max-count=1 | sed 1d || echo unknown`
$(top_builddir)/manifest: $(top_builddir)/.javac-stamp .git/HEAD
	{ echo "Specification-Title: $(spec_title)"; \
          echo "Specification-Version: $(spec_version)"; \
          echo "Specification-Vendor: $(spec_vendor)"; \
          echo "Implementation-Title: $(package)"; \
          echo "Implementation-Version: $(pkg_version)"; \
          echo "Implementation-Vendor: $(spec_vendor)"; } >"$@"

$(jar): $(top_builddir)/manifest $(top_builddir)/.javac-stamp $(classes)
	cd $(top_builddir) && jar cfm `basename $(jar)` manifest $(classes_with_nested_classes) \
         || { rv=$$? && rm -f `basename $(jar)` && exit $$rv; }
#                       ^^^^^^^^^^^^^^^^^^^^^^^
# I've seen cases where `jar' exits with an error but leaves a partially built .jar file!

doc: $(top_builddir)/api/index.html

JDK_JAVADOC := http://download.oracle.com/javase/6/docs/api
NETTY_JAVADOC := http://docs.jboss.org/netty/3.2/api
SUASYNC_JAVADOC := http://tsunanet.net/~tsuna/async/api
GUAVA_JAVADOC := http://docs.guava-libraries.googlecode.com/git/javadoc
JAVADOCS = $(JDK_JAVADOC) $(NETTY_JAVADOC) $(SUASYNC_JAVADOC) $(GUAVA_JAVADOC)
$(top_builddir)/api/index.html: $(asynchbase_SOURCES) $(jar)
	javadoc -d $(top_builddir)/api -classpath $(get_dep_classpath):$(jar) \
          `echo $(JAVADOCS) | sed 's/\([^ ]*\)/-link \1/g'` $(asynchbase_SOURCES) \
	  `find src -name package-info.java`

clean:
	@rm -f $(top_builddir)/.javac*-stamp
	rm -f $(top_builddir)/manifest pom.xml
	rm -rf $(proto_generated_builddir)
	cd $(top_builddir) || exit 0 \
	  && rm -f $(classes_with_nested_classes) \
	           $(unittest_classes_with_nested_classes) \
	           $(test_classes_with_nested_classes) \
		   *.class
	for dir in $(top_builddir)/com/google/protobuf \
	           $(top_builddir)/com/google \
		   $(top_builddir)/com; do \
	  test -d $$dir && rmdir $$dir; \
	done; :
	cd $(top_builddir) || exit 0 \
	  && test -d $(package_dir) || exit 0 \
	  && dir=$(package_dir) \
	  && rmdir $(package_dir)/*/ \
	  && while test x"$$dir" != x"$${dir%/*}"; do \
	       rmdir "$$dir" && dir=$${dir%/*} || break; \
	     done \
	  && rmdir "$$dir"

distclean: clean
	rm -f $(jar)
	rm -rf $(top_builddir)/api target
	test ! -d $(top_builddir) || rmdir $(top_builddir)

pom.xml: pom.xml.in Makefile
	{ \
	  echo '<!-- Generated by Makefile on '`date`' -->'; \
	  sed <$< \
	    -e 's/@GUAVA_VERSION@/$(GUAVA_VERSION)/' \
	    -e 's/@HAMCREST_VERSION@/$(HAMCREST_VERSION)/' \
	    -e 's/@JAVASSIST_VERSION@/$(JAVASSIST_VERSION)/' \
	    -e 's/@JCL_OVER_SLF4J_VERSION@/$(JCL_OVER_SLF4J_VERSION)/' \
	    -e 's/@JUNIT_VERSION@/$(JUNIT_VERSION)/' \
	    -e 's/@LOG4J_OVER_SLF4J_VERSION@/$(LOG4J_OVER_SLF4J_VERSION)/' \
	    -e 's/@MOCKITO_VERSION@/$(MOCKITO_VERSION)/' \
	    -e 's/@NETTY_VERSION@/$(NETTY_VERSION)/' \
	    -e 's/@OBJENESIS_VERSION@/$(OBJENESIS_VERSION)/' \
	    -e 's/@POWERMOCK_MOCKITO_VERSION@/$(POWERMOCK_MOCKITO_VERSION)/' \
	    -e 's/@PROTOBUF_VERSION@/$(PROTOBUF_VERSION)/' \
	    -e 's/@SLF4J_API_VERSION@/$(SLF4J_API_VERSION)/' \
	    -e 's/@SUASYNC_VERSION@/$(SUASYNC_VERSION)/' \
	    -e 's/@ZOOKEEPER_VERSION@/$(ZOOKEEPER_VERSION)/' \
	    -e 's/@spec_title@/$(spec_title)/' \
	    -e 's/@spec_vendor@/$(spec_vendor)/' \
	    -e 's/@spec_version@/$(spec_version)/' \
	    ; \
	} >$@-t
	mv $@-t $@

.PHONY: all jar clean cli distclean doc check run