Skip to content

Commit

Permalink
Add --experimental_repository_disable_download to allow users disable…
Browse files Browse the repository at this point in the history
… download for external repos

This PR adds a flag `--experimental_repository_disable_download` which when set will prevent Bazel from downloading external repositories.  However, `local_repository`, `new_local_repository` and external repositories already downloaded in the repository cache  would still work.

Closes #12940.

PiperOrigin-RevId: 355332927
  • Loading branch information
coeuvre authored and copybara-github committed Feb 3, 2021
1 parent 5bf5c30 commit 9804ba5
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,8 @@ public void beforeCommand(CommandEnvironment env) {

RepositoryOptions repoOptions = env.getOptions().getOptions(RepositoryOptions.class);
if (repoOptions != null) {
downloadManager.setDisableDownload(repoOptions.disableDownload);

repositoryCache.setHardlink(repoOptions.useHardlinks);
if (repoOptions.experimentalScaleTimeouts > 0.0) {
starlarkRepositoryFunction.setTimeoutScaling(repoOptions.experimentalScaleTimeouts);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ public class RepositoryOptions extends OptionsBase {
+ " cache hit, rather than copying. This is intended to save disk space.")
public boolean useHardlinks;

@Option(
name = "experimental_repository_disable_download",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.BAZEL_CLIENT_OPTIONS,
effectTags = {OptionEffectTag.UNKNOWN},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help = "If set, downloading external repositories is not allowed.")
public boolean disableDownload;

@Option(
name = "distdir",
oldName = "experimental_distdir",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public class DownloadManager {
private List<Path> distdir = ImmutableList.of();
private UrlRewriter rewriter;
private final Downloader downloader;
private boolean disableDownload = false;

public DownloadManager(RepositoryCache repositoryCache, Downloader downloader) {
this.repositoryCache = repositoryCache;
Expand All @@ -60,6 +61,10 @@ public void setUrlRewriter(UrlRewriter rewriter) {
this.rewriter = rewriter;
}

public void setDisableDownload(boolean disableDownload) {
this.disableDownload = disableDownload;
}

/**
* Downloads file to disk and returns path.
*
Expand Down Expand Up @@ -194,6 +199,11 @@ public Path download(
}
}

if (disableDownload) {
throw new IOException(
String.format("Failed to download repo %s: download is disabled.", repo));
}

try {
downloader.download(
urls, authHeaders, checksum, canonicalId, destination, eventHandler, clientEnv, type);
Expand Down
88 changes: 88 additions & 0 deletions src/test/shell/bazel/starlark_repository_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2061,4 +2061,92 @@ EOF
|| fail "Expected success despite needing a file behind basic auth"
}

function test_disable_download_should_prevent_downloading() {
mkdir x
echo 'exports_files(["file.txt"])' > x/BUILD
echo 'Hello World' > x/file.txt
tar cvf x.tar x
sha256=$(sha256sum x.tar | head -c 64)
serve_file x.tar

mkdir main
cd main
cat > WORKSPACE <<EOF
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="ext",
url = "http://127.0.0.1:$nc_port/x.tar",
sha256="$sha256",
)
EOF
cat > BUILD <<'EOF'
genrule(
name = "it",
srcs = ["@ext//x:file.txt"],
outs = ["it.txt"],
cmd = "cp $< $@",
)
EOF

bazel build --experimental_repository_disable_download //:it > "${TEST_log}" 2>&1 \
&& fail "Expected failure" || :
expect_log "Failed to download repo ext: download is disabled"
}

function test_disable_download_should_allow_distdir() {
mkdir x
echo 'exports_files(["file.txt"])' > x/BUILD
echo 'Hello World' > x/file.txt
tar cvf x.tar x
sha256=$(sha256sum x.tar | head -c 64)

mkdir main
cp x.tar main
cd main
cat > WORKSPACE <<EOF
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="ext",
url = "http://127.0.0.1/x.tar",
sha256="$sha256",
)
EOF
cat > BUILD <<'EOF'
genrule(
name = "it",
srcs = ["@ext//x:file.txt"],
outs = ["it.txt"],
cmd = "cp $< $@",
)
EOF

bazel build --distdir="." --experimental_repository_disable_download //:it || fail "Failed to build"
}

function test_disable_download_should_allow_local_repository() {
mkdir x
echo 'exports_files(["file.txt"])' > x/BUILD
echo 'Hello World' > x/file.txt
touch x/WORKSPACE

mkdir main
cd main
cat > WORKSPACE <<EOF
local_repository(
name="ext",
path="../x",
)
EOF
cat > BUILD <<'EOF'
genrule(
name = "it",
srcs = ["@ext//:file.txt"],
outs = ["it.txt"],
cmd = "cp $< $@",
)
EOF

bazel build --experimental_repository_disable_download //:it || fail "Failed to build"
}

run_suite "local repository tests"

0 comments on commit 9804ba5

Please sign in to comment.