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

Allow sandboxing for copy_* and fix copy_directory tests #392

Merged
merged 1 commit into from
Sep 2, 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
9 changes: 0 additions & 9 deletions rules/private/copy_common.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ COPY_EXECUTION_REQUIREMENTS = {
# ----------------+-----------------------------------------------------------------------------
# no-cache | Results in the action or test never being cached (remotely or locally)
# ----------------+-----------------------------------------------------------------------------
# local | Precludes the action or test from being remotely cached, remotely executed,
# | or run inside the sandbox. For genrules and tests, marking the rule with the
# | local = True attribute has the same effect.
# ----------------+-----------------------------------------------------------------------------
# See https://bazel.build/reference/be/common-definitions#common-attributes
#
# Copying file & directories is entirely IO-bound and there is no point doing this work
Expand All @@ -44,11 +40,6 @@ COPY_EXECUTION_REQUIREMENTS = {
# disk cache stores the directory artifact as a single entry, but the slight performance bump
# comes at the cost of heavy disk cache usage, which is an unmanaged directory that grow beyond
# the bounds of the physical disk.
#
# Sandboxing for this action is wasteful as well since there is a 1:1 mapping of input
# file/directory to output file/directory and no room for non-hermetic inputs to sneak in to the
# input.
"no-remote": "1",
"no-cache": "1",
"local": "1",
}
7 changes: 3 additions & 4 deletions tests/copy_directory/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# This package aids testing the 'copy_directory' rule.

load("//rules:copy_directory.bzl", "copy_directory")
load(":empty_directory.bzl", "empty_directory")

licenses(["notice"])

Expand All @@ -13,10 +14,8 @@ copy_directory(
out = "dir_copy",
)

genrule(
name = "empty_directory",
outs = ["empty_dir"],
cmd = "mkdir $@",
empty_directory(
name = "empty_dir",
)

copy_directory(
Expand Down
34 changes: 34 additions & 0 deletions tests/copy_directory/empty_directory.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 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.

"""Creates an empty directory."""

def _empty_directory_impl(ctx):
out = ctx.actions.declare_directory(ctx.attr.name)
ctx.actions.run_shell(
outputs = [out],
command = "mkdir -p $@",
tetromino marked this conversation as resolved.
Show resolved Hide resolved
arguments = [out.path],
mnemonic = "EmptyDirectory",
progress_message = "Creating empty directory %s" % out.path,
use_default_shell_env = True,
execution_requirements = {"no-remote": "1"}, # see rules/private/copy_directory_private.bzl
)
return [DefaultInfo(files = depset(direct = [out]))]

empty_directory = rule(
implementation = _empty_directory_impl,
provides = [DefaultInfo],
doc = "Creates an empty directory with the same name as the target",
)