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/tools/build.defs b/tools/build.defs
new file mode 100644
index 0000000..42cb630
--- /dev/null
+++ b/tools/build.defs
@@ -0,0 +1,80 @@
+# 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.
+
+DOCS = ['//Documentation:html.zip']
+LIBS = [
+ '//gerrit-common:version',
+ '//gerrit-war:init',
+ '//gerrit-war:log4j-config',
+ '//lib:postgresql',
+ '//lib/log:impl_log4j',
+]
+PGMLIBS = ['//gerrit-pgm:pgm']
+
+def scan_plugins():
+ import os
+ deps = []
+ for n in os.listdir('plugins'):
+ if os.path.exists(os.path.join('plugins', n, 'BUCK')):
+ deps.append('//plugins/%s:%s__plugin__compile' % (n, n))
+ return deps
+
+def war(
+ name,
+ libs = [],
+ pgmlibs = [],
+ context = [],
+ visibility = []
+ ):
+ cmd = ['${//tools:pack_war}', '-o', '$OUT']
+ for l in libs:
+ cmd.extend(['--lib', l])
+ for l in pgmlibs:
+ cmd.extend(['--pgmlib', l])
+
+ src = []
+ dep = []
+ if context:
+ root = get_base_path()
+ if root:
+ root = '/'.join(['..' for _ in root.split('/')]) + '/'
+ for r in context:
+ dep.append(r[:r.rindex('.')])
+ if r.startswith('//'):
+ r = root + r[2:]
+ r = r.replace(':', '/')
+ src.append(genfile(r))
+ cmd.append('$SRCS')
+
+ genrule(
+ name = name,
+ cmd = ' '.join(cmd),
+ srcs = src,
+ deps = libs + pgmlibs + dep + ['//tools:pack_war'],
+ out = name + '.war',
+ visibility = visibility,
+ )
+
+def gerrit_war(name, ui = 'ui_optdbg', context = []):
+ war(
+ name = name,
+ libs = LIBS,
+ pgmlibs = PGMLIBS,
+ context = [
+ '//gerrit-main:main_bin.jar',
+ '//gerrit-war:webapp_assets.zip',
+ '//gerrit-gwtexpui:clippy_swf.zip',
+ '//gerrit-gwtui:' + ui + '.zip',
+ ] + context,
+ )
