Skip to content

Commit

Permalink
Make Go tool location configurable
Browse files Browse the repository at this point in the history
  • Loading branch information
@peterebden
peterebden committed Oct 5, 2017
1 parent 21971c6 commit c2637ea
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 24 deletions.
2 changes: 2 additions & 0 deletions src/core/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ func DefaultConfiguration() *Configuration {
config.Docker.Timeout = cli.Duration(20 * time.Minute)
config.Docker.ResultsTimeout = cli.Duration(20 * time.Second)
config.Docker.RemoveTimeout = cli.Duration(20 * time.Second)
config.Go.GoTool = "go"
config.Go.CgoCCTool = "gcc"
config.Go.GoVersion = "1.6"
config.Go.GoPath = "$TMP_DIR:$TMP_DIR/src:$TMP_DIR/$PKG:$TMP_DIR/third_party/go:$TMP_DIR/third_party/"
Expand Down Expand Up @@ -254,6 +255,7 @@ type Configuration struct {
KeepLabel []string `help:"Defines a target label to be kept; for example, if you set this to go, no Go targets would ever be considered for deletion." example:"go"`
} `help:"Please supports a form of 'garbage collection', by which it means identifying targets that are not used for anything. By default binary targets and all their transitive dependencies are always considered non-garbage, as are any tests directly on those. The config options here allow tweaking this behaviour to retain more things.\n\nNote that it's a very good idea that your BUILD files are in the standard format when running this."`
Go struct {
GoTool string `help:"The binary to use to invoke Go & its subtools with." var:"GO_TOOL"`
GoVersion string `help:"String identifying the version of the Go compiler.\nThis is only now really important for anyone targeting versions of Go earlier than 1.5 since some of the tool names have changed (6g and 6l became compile and link in Go 1.5).\nWe're pretty sure that targeting Go 1.4 works; we're not sure about 1.3 (never tried) but 1.2 certainly doesn't since some of the flags to go tool pack are different. We assume nobody is terribly bothered about this..." var:"GO_VERSION"`
GoRoot string `help:"If set, will set the GOROOT environment variable appropriately during build actions."`
TestTool string `help:"Sets the location of the please_go_test tool that is used to template the test main for go_test rules." var:"GO_TEST_TOOL"`
Expand Down
1 change: 1 addition & 0 deletions src/parse/interpreter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ func initializeInterpreter(state *core.BuildState) {
setConfigValue("PLZ_VERSION", config.Please.Version.String())
setConfigValue("BUILD_SANDBOX", pythonBool(config.Build.Sandbox))
setConfigValue("TEST_SANDBOX", pythonBool(config.Test.Sandbox))
setConfigValue("GO_TOOL", config.Go.GoTool)
setConfigValue("GO_VERSION", config.Go.GoVersion)
setConfigValue("GO_TEST_TOOL", config.Go.TestTool)
setConfigValue("GOPATH", config.Go.GoPath)
Expand Down
40 changes: 16 additions & 24 deletions src/parse/rules/go_rules.build_defs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ _LINK_PKGS_CMD = ' '.join([
'ln -s $TMP_DIR/$FN ${DN%/*}; fi; done'
])

# Applied to various rules to treat 'go' as a tool.
_GO_TOOL = ['go']


def go_library(name, srcs, out=None, deps=None, visibility=None, test_only=False,
go_tools=None, complete=True, _needs_transitive_deps=False,_all_srcs=False):
Expand Down Expand Up @@ -65,7 +62,7 @@ def go_library(name, srcs, out=None, deps=None, visibility=None, test_only=False
requires=['go', 'go_src'] if _all_srcs else ['go'],
provides={'go': ':' + name, 'go_src': ':_%s#srcs' % name},
test_only=test_only,
tools=_GO_TOOL,
tools=[CONFIG.GO_TOOL],
needs_transitive_deps=_needs_transitive_deps,
)

Expand All @@ -88,7 +85,7 @@ def go_generate(name, srcs, tools, deps=None, visibility=None, test_only=False):
add_out(rule_name, out)

# All the tools must be in the $PATH.
path = ':'.join('$(dirname $(location %s))' % tool for tool in tools)

gopath = ' | '.join([
'find . -type d -name src',
'grep -v "^\.$"',
Expand All @@ -104,15 +101,19 @@ def go_generate(name, srcs, tools, deps=None, visibility=None, test_only=False):
# It's also essential that the compiled .a files are under this prefix, otherwise gcimporter won't find them.
'mkdir pkg',
'ln -s $TMP_DIR pkg/%s_%s' % (CONFIG.OS, CONFIG.ARCH),
'PATH="$PATH:%s" GOPATH="$TMP_DIR$(echo ":$(%s)" | sed "s/:$//g")" go generate $SRCS' % (path, gopath),
'export PATH="$(echo "$TOOLS_GEN " | sed -re \'s|/[^/]+[ ]|:|g\')$PATH"',
'GOPATH="$TMP_DIR$(echo ":$(%s)" | sed "s/:$//g")" $TOOLS_GO generate $SRCS' % gopath,
'mv $PKG_DIR/*.go .',
'ls *.go'
])
build_rule(
name=name,
srcs=srcs,
deps=deps,
tools=_go_tool(tools),
tools={
'go': [CONFIG.GO_TOOL],
'gen': tools,
},
cmd=cmd,
visibility=visibility,
test_only=test_only,
Expand Down Expand Up @@ -177,7 +178,7 @@ def cgo_library(name, srcs, go_srcs=None, c_srcs=None, hdrs=None, out=None, comp
'ls *.c *.go',
]),
deps = [h for h in hdrs if h.startswith('/') or h.startswith(':')],
tools = _GO_TOOL,
tools = [CONFIG.GO_TOOL],
post_build = post_build if file_srcs != srcs else None,
requires = ['go', 'cc_hdrs'],
)
Expand Down Expand Up @@ -245,7 +246,7 @@ def _merge_cgo_obj(name, a_rule, o_rule=None, visibility=None, test_only=False,
},
outs = [out or name + '.a'],
cmd = 'cp $SRCS_A $OUT && chmod +w $OUT && $TOOL tool pack r $OUT $PKG_DIR/*_cgo.o',
tools = _GO_TOOL,
tools = [CONFIG.GO_TOOL],
visibility = visibility,
test_only = test_only,
labels = ['cc:ld:' + flag for flag in (linker_flags or [])],
Expand Down Expand Up @@ -328,7 +329,7 @@ def go_test(name, srcs, data=None, deps=None, visibility=None, flags='', contain
deps = deps or []
timeout, labels = _test_size_and_timeout(size, timeout, labels)
# Unfortunately we have to recompile this to build the test together with its library.
go_library(
lib_rule = go_library(
name = '_%s#lib' % name,
srcs = srcs,
out = name + ('_lib.a' if cgo else '.a'),
Expand All @@ -337,7 +338,6 @@ def go_test(name, srcs, data=None, deps=None, visibility=None, flags='', contain
_all_srcs = not external,
complete = False,
)
lib_rule = ':_%s#lib' % name
if cgo:
lib_rule = _merge_cgo_obj(
name = name,
Expand All @@ -361,7 +361,7 @@ def go_test(name, srcs, data=None, deps=None, visibility=None, flags='', contain
requires=['go'],
test_only=True,
tools={
'go': ['go'],
'go': [CONFIG.GO_TOOL],
'test': [CONFIG.GO_TEST_TOOL],
},
post_build=lambda name, output: _replace_test_package(name, output, static),
Expand Down Expand Up @@ -493,15 +493,15 @@ def go_get(name, get=None, outs=None, deps=None, exported_deps=None, visibility=
'export GOPATH="$INSTALL_DIR:$GOPATH"',

'cd $INSTALL_DIR',
'go get -d ' + get,
'$TOOL get -d ' + get,
]
subdir = 'src/' + (get[:-4] if get.endswith('/...') else get)
if revision:
# Annoyingly -C does not work on git checkout :(
cmd.append('(cd %s && git checkout -q %s)' % (subdir, revision))
if patch:
cmd.append('patch -s -d %s -p1 < ${TMP_DIR}/$(location %s)' % (subdir, patch))
cmd.append('go install -gcflags "-trimpath $INSTALL_DIR" ' + ' '.join([get] + (install or [])))
cmd.append('$TOOL install -gcflags "-trimpath $INSTALL_DIR" ' + ' '.join([get] + (install or [])))
# Remove anything that was there already.
cmd.extend([
# go_get built dependencies could be in different dirs so we strip the prefix
Expand All @@ -527,7 +527,7 @@ def go_get(name, get=None, outs=None, deps=None, exported_deps=None, visibility=
outs=outs,
deps=deps,
exported_deps=exported_deps,
tools=_GO_TOOL,
tools=[CONFIG.GO_TOOL],
visibility=visibility,
building_description='Fetching...',
cmd=' && '.join(cmd),
Expand Down Expand Up @@ -582,20 +582,12 @@ def _replace_test_package(name, output, static):
set_command(lib, k, 'mv -f ${PKG_DIR}/%s.a ${PKG_DIR}/%s.a && %s' % (new_name, pkg_name, v))


def _go_tool(tools):
"""Returns the given list annotated with the 'go' tool.
Currently the tool invoked for 'go' is not configurable.
"""
return (tools or []) + ['go']


def _go_library_cmds(complete=True, all_srcs=False):
"""Returns the commands to run for building a Go library."""
go_compile_tool = 'compile' if CONFIG.GO_VERSION >= "1.5" else '6g'
# Invokes the Go compiler.
complete_flag = '-complete ' if complete else ''
compile_cmd = 'go tool %s -trimpath $TMP_DIR %s%s -pack -o $OUT ' % (go_compile_tool, complete_flag, _GOPATH)
compile_cmd = '$TOOL tool %s -trimpath $TMP_DIR %s%s -pack -o $OUT ' % (go_compile_tool, complete_flag, _GOPATH)
# Annotates files for coverage
cover_cmd = 'for SRC in $SRCS; do mv -f $SRC _tmp.go; BN=$(basename $SRC); go tool cover -mode=set -var=GoCover_${BN//./_} _tmp.go > $SRC; done'
srcs = 'export SRCS="$PKG_DIR/*.go"; ' if all_srcs else ''
Expand Down

0 comments on commit c2637ea

Please sign in to comment.