Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Let go_binary's executable bit depend on linkmode #3143

Merged
merged 1 commit into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions go/private/mode.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ LINKMODE_C_ARCHIVE = "c-archive"

LINKMODES = [LINKMODE_NORMAL, LINKMODE_PLUGIN, LINKMODE_C_SHARED, LINKMODE_C_ARCHIVE, LINKMODE_PIE]

# All link modes that produce executables to be run with bazel run.
fmeum marked this conversation as resolved.
Show resolved Hide resolved
LINKMODES_EXECUTABLE = [LINKMODE_NORMAL, LINKMODE_PIE]

def mode_string(mode):
result = [mode.goos, mode.goarch]
if mode.static:
Expand Down
6 changes: 3 additions & 3 deletions go/private/rules/binary.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,6 @@ _go_binary_kwargs = {
),
"_go_context_data": attr.label(default = "//:go_context_data"),
},
"executable": True,
"toolchains": ["@io_bazel_rules_go//go:toolchain"],
"doc": """This builds an executable from a set of source files,
which must all be in the `main` package. You can run the binary with
Expand All @@ -387,8 +386,9 @@ _go_binary_kwargs = {
""",
}

go_binary = rule(**_go_binary_kwargs)
go_transition_binary = go_transition_rule(**_go_binary_kwargs)
go_binary = rule(executable = True, **_go_binary_kwargs)
go_transition_binary = go_transition_rule(executable = True, **_go_binary_kwargs)
go_non_executable_transition_binary = go_transition_rule(executable = False, **_go_binary_kwargs)

def _go_tool_binary_impl(ctx):
sdk = ctx.attr.sdk[GoSDK]
Expand Down
10 changes: 9 additions & 1 deletion go/private/rules/wrappers.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@

load(
"//go/private:mode.bzl",
"LINKMODES_EXECUTABLE",
"LINKMODE_C_ARCHIVE",
"LINKMODE_C_SHARED",
"LINKMODE_NORMAL",
)
load(
"//go/private/rules:library.bzl",
Expand All @@ -24,6 +26,7 @@ load(
load(
"//go/private/rules:binary.bzl",
"go_binary",
"go_non_executable_transition_binary",
"go_transition_binary",
)
load(
Expand All @@ -48,7 +51,12 @@ def go_library_macro(name, **kwargs):
def go_binary_macro(name, **kwargs):
"""See docs/go/core/rules.md#go_binary for full documentation."""
_cgo(name, kwargs)
go_transition_wrapper(go_binary, go_transition_binary, name = name, **kwargs)
if kwargs.get("linkmode", default = LINKMODE_NORMAL) in LINKMODES_EXECUTABLE:
go_transition_wrapper(go_binary, go_transition_binary, name = name, **kwargs)
else:
# A non-normal link mode implies the use of transitions, so we don't have to define a
# non-executable version of the untransitioned go_binary.
go_transition_wrapper(None, go_non_executable_transition_binary, name = name, **kwargs)
if kwargs.get("linkmode") in (LINKMODE_C_ARCHIVE, LINKMODE_C_SHARED):
# Create an alias to tell users of the `.cc` rule that it is deprecated.
native.alias(
Expand Down
5 changes: 5 additions & 0 deletions tests/core/go_binary/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,8 @@ go_binary(
name = "prefix",
embed = ["//tests/core/go_binary/prefix"],
)

go_bazel_test(
name = "non_executable_test",
srcs = ["non_executable_test.go"],
)
51 changes: 51 additions & 0 deletions tests/core/go_binary/non_executable_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright 2022 The Bazel Authors. All rights reserved.
//
// 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.

package non_executable_test

import (
"strings"
"testing"

"github.com/bazelbuild/rules_go/go/tools/bazel_testing"
)

func TestMain(m *testing.M) {
bazel_testing.TestMain(m, bazel_testing.Args{
Main: `
-- src/BUILD.bazel --
load("@io_bazel_rules_go//go:def.bzl", "go_binary")

go_binary(
name = "archive",
srcs = ["archive.go"],
linkmode = "c-archive",
)
-- src/archive.go --
package main

func main() {}
`,
})
}

func TestNonExecutableGoBinary(t *testing.T) {
if err := bazel_testing.RunBazel("build", "//src:archive"); err != nil {
t.Fatal(err)
}
err := bazel_testing.RunBazel("run", "//src:archive")
if err == nil || !strings.Contains(err.Error(), "ERROR: Cannot run target //src:archive: Not executable") {
t.Errorf("Expected bazel run to fail due to //src:archive not being executable")
}
}