Build with Buck
Implement a new build system using Buck[1], Facebook's
open source clone of Google's internal build system.
Pros:
- Concise build language
- Test and build output is concise
- Test failures and stack traces show on terminal
- Reliable incrementals; clean is unnecessary
- Extensible with simple blocks of Python
- Fast
buck: clean: 0.452s, full 1m21.083s [*], no-op: 7.145s,
mvn: clean: 4.596s, full 2m53.776s, no-op: 59.108s,
[*] full build includes downloading all dependencies,
time can vary due to remote server performance.
Cons:
- No Windows support
- No native Maven Central support (added by macros)
- No native GWT, Prolog, or WAR support (added by macros)
- Bootstrap of buck requires Ant
Getting started:
git clone https://gerrit.googlesource.com/buck
cd buck
ant
Mac OS X:
PATH="`pwd`/bin:/System/Library/Frameworks/JavaVM.framework/Versions/Current/Commands:$PATH"
Linux:
PATH="`pwd`/bin:$PATH"
Importing into Eclipse:
$ time buck build :eclipse
0m48.949s
Import existing project from `pwd`
Import 'gerrit' (do not import other Maven based projects)
Expand 'gerrit'
Right click 'buck-out' > Properties
Under Attributes check 'Derived'
If the code doesn't currently compile but an updated classpath
is needed, refresh the configs and obtain missing JARs:
$ buck build :eclipse_project :download
Running JUnit tests:
$ time buck test --all -e slow # skip slow tests
0m19.320s
$ time buck test --all # includes acceptance tests
5m17.517s
Building WAR:
$ buck build :gerrit
$ java -jar buck-out/gen/gerrit.war
Building release:
$ buck test --all && buck build :api :release
$ java -jar buck-out/gen/release.war
$ ls -lh buck-out/gen/{extension,plugin}-api.jar
Downloading dependencies:
Dependencies are normally downloaded automatically, but Buck can
inspect its graph and download missing dependencies so future
compiles can run without the network:
$ buck build :download
[1] http://facebook.github.io/buck/
Change-Id: I40853b108bd8e153cefa0896a5280a9a5ff81655
diff --git a/lib/DEFS b/lib/DEFS
new file mode 100644
index 0000000..c7f975c
--- /dev/null
+++ b/lib/DEFS
@@ -0,0 +1,158 @@
+# Copyright (C) 2013 The Android Open Source Project
+#
+# 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.
+
+def genantlr(
+ name,
+ srcs,
+ outs):
+ genrule(
+ name = name,
+ srcs = srcs,
+ cmd = '${//lib/antlr:antlr-tool} -o $(dirname $OUT) $SRCS',
+ deps = ['//lib/antlr:antlr-tool'],
+ out = outs[0],
+ )
+
+def gwt_module(
+ name,
+ srcs,
+ gwtxml = None,
+ resources = [],
+ deps = [],
+ visibility = []):
+ if gwtxml:
+ resources = resources + [gwtxml]
+ resources = resources + srcs
+ java_library(
+ name = name,
+ srcs = srcs,
+ deps = deps,
+ resources = resources,
+ visibility = visibility,
+ )
+
+def gwt_application(
+ name,
+ module_target,
+ compiler_opts = [],
+ compiler_jvm_flags = [],
+ deps = [],
+ visibility = []):
+ cmd = ['${//lib/gwt:compiler}', module_target, '$OUT']
+ cmd += compiler_opts + ['--', '$DEPS']
+ genrule(
+ name = name,
+ srcs = [],
+ cmd = ' '.join(cmd),
+ deps = [
+ '//lib/gwt:compiler',
+ '//lib/gwt:dev',
+ ] + deps,
+ out = '%s.zip' % name,
+ visibility = visibility,
+ )
+
+# Compiles a Java library with additional compile-time dependencies
+# that do not show up as transitive dependencies to java_library()
+# or java_binary() rule that depends on this library.
+def java_library2(
+ name,
+ srcs = [],
+ resources = [],
+ deps = [],
+ compile_deps = [],
+ visibility = []):
+ c = name + '__compile'
+ t = name + '__link'
+ j = 'lib__%s__output/%s.jar' % (c, c)
+ o = 'lib__%s__output/%s.jar' % (name, name)
+ java_library(
+ name = c,
+ srcs = srcs,
+ resources = resources,
+ deps = deps + compile_deps,
+ visibility = ['//:eclipse_classpath'],
+ )
+ # Break the dependency chain by passing the newly built
+ # JAR to consumers through a prebuilt_jar().
+ genrule(
+ name = t,
+ cmd = 'mkdir -p $(dirname $OUT);ln -s $SRCS $OUT',
+ srcs = [genfile(j)],
+ deps = [':' + c],
+ out = o,
+ )
+ prebuilt_jar(
+ name = name,
+ binary_jar = genfile(o),
+ deps = deps + [':' + t],
+ visibility = visibility,
+ )
+
+def gerrit_extension(
+ name,
+ deps = [],
+ srcs = [],
+ resources = [],
+ manifest_file = None,
+ visibility = ['PUBLIC']):
+ gerrit_plugin(
+ name = name,
+ deps = deps,
+ srcs = srcs,
+ resources = resources,
+ manifest_file = manifest_file,
+ type = 'extension',
+ visibility = visibility,
+ )
+
+def gerrit_plugin(
+ name,
+ deps = [],
+ srcs = [],
+ resources = [],
+ manifest_file = None,
+ type = 'plugin',
+ visibility = ['PUBLIC']):
+ mf_cmd = 'v=$(git describe HEAD);'
+ if manifest_file:
+ mf_src = [manifest_file]
+ mf_cmd += 'sed "s:@VERSION@:$v:g" $SRCS >$OUT'
+ else:
+ mf_src = []
+ mf_cmd += 'echo "Manifest-Version: 1.0" >$OUT;'
+ mf_cmd += 'echo "Gerrit-ApiType: %s" >>$OUT;' % type
+ mf_cmd += 'echo "Implementation-Version: $v" >>$OUT'
+ genrule(
+ name = name + '__manifest',
+ cmd = mf_cmd,
+ srcs = mf_src,
+ out = 'MANIFEST.MF',
+ )
+ java_library2(
+ name = name + '__plugin',
+ srcs = srcs,
+ resources = resources,
+ deps = deps,
+ compile_deps = ['//:%s-lib' % type],
+ )
+ java_binary(
+ name = name,
+ manifest_file = genfile('MANIFEST.MF'),
+ deps = [
+ ':%s__plugin' % name,
+ ':%s__manifest' % name,
+ ],
+ visibility = visibility,
+ )
