src/test/shell/bazel/external_remote_file_test.sh

#!/usr/bin/env bash
#
# Copyright 2017 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.
#
# Tests the remote files overlay patching functionality of external repositories.

set -euo pipefail
# --- begin runfiles.bash initialization ---
if [[ ! -d "${RUNFILES_DIR:-/dev/null}" && ! -f "${RUNFILES_MANIFEST_FILE:-/dev/null}" ]]; then
  if [[ -f "$0.runfiles_manifest" ]]; then
    export RUNFILES_MANIFEST_FILE="$0.runfiles_manifest"
  elif [[ -f "$0.runfiles/MANIFEST" ]]; then
    export RUNFILES_MANIFEST_FILE="$0.runfiles/MANIFEST"
  elif [[ -f "$0.runfiles/bazel_tools/tools/bash/runfiles/runfiles.bash" ]]; then
    export RUNFILES_DIR="$0.runfiles"
  fi
fi
if [[ -f "${RUNFILES_DIR:-/dev/null}/bazel_tools/tools/bash/runfiles/runfiles.bash" ]]; then
  source "${RUNFILES_DIR}/bazel_tools/tools/bash/runfiles/runfiles.bash"
elif [[ -f "${RUNFILES_MANIFEST_FILE:-/dev/null}" ]]; then
  source "$(grep -m1 "^bazel_tools/tools/bash/runfiles/runfiles.bash " \
            "$RUNFILES_MANIFEST_FILE" | cut -d ' ' -f 2-)"
else
  echo >&2 "ERROR: cannot find @bazel_tools//tools/bash/runfiles:runfiles.bash"
  exit 1
fi
# --- end runfiles.bash initialization ---

source "$(rlocation "io_bazel/src/test/shell/integration_test_setup.sh")" \
  || { echo "integration_test_setup.sh not found!" >&2; exit 1; }

function set_up() {
  WRKDIR=$(mktemp -d "${TEST_TMPDIR}/testXXXXXX")
  cd "${WRKDIR}"
  setup_module_dot_bazel
  # create an archive file with files interesting for patching
  mkdir hello_world-0.1.2
  cat > hello_world-0.1.2/hello_world.c <<'EOF'
#include <stdio.h>
int main() {
  printf("Hello, world!\n");
  return 0;
}
EOF
  zip hello_world.zip hello_world-0.1.2/*
  rm -rf hello_world-0.1.2
}

function get_extrepourl() {
  if is_windows; then
    echo "file:///$(cygpath -m $1)"
  else
    echo "file://$1"
  fi
}


test_overlay_remote_file_multiple_segments() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  # Generate the remote files to overlay
  mkdir -p child
    cat > child/foo_bar.c <<'EOF'
#include <stdio.h>
int main() {
  printf("Foo, Bar!\n");
  return 0;
}
EOF
  cat > child/BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "foo_bar",
    srcs = ["foo_bar.c"],
)
EOF
  touch BUILD.bazel
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
    "child/foo_bar.c": ["${EXTREPOURL}/child/foo_bar.c"],
    "child/BUILD.bazel": ["${EXTREPOURL}/child/BUILD.bazel"],
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//child:foo_bar
}

test_overlay_remote_file_with_integrity() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
  remote_file_integrity={
    "REPO.bazel": "sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=",
    "BUILD.bazel": "sha256-0bs+dwSOzHTbNAgDS02I3giLAZu2/NLn7BJWwQGN/Pk=",
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world
}

test_overlay_remote_file_fail_with_integrity() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
  remote_file_integrity={
    "REPO.bazel": "sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFZ=",
    "BUILD.bazel": "sha256-0bs+dwSOzHTbNAgDS02I3giLAZu2/NLn7BJWwQGN/Pk=",
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world &> $TEST_log 2>&1 && fail "Expected to fail"
  expect_log "but wanted sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFY="
}

test_overlay_remote_file_without_integrity() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  archive_integrity="sha256-$(cat hello_world.zip | openssl dgst -sha256 -binary | openssl base64 -A)"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  integrity="${archive_integrity}",
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world > "${TEST_log}" 2>&1
  expect_log "canonical reproducible form can be obtained by modifying arguments \
remote_file_integrity = {\"REPO\.bazel\": \"[^\"]*\", \"BUILD\.bazel\": \"[^\"]*\"}\$"

  # Check that repo is not marked as reproducible and cached

  bazel clean --expunge

  # Modify the remote files to overlay
  cat > ../BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "goodbye_world",
    srcs = ["hello_world.c"],
)
EOF

  bazel build @hello_world//:goodbye_world
}

test_overlay_remote_file_with_empty_integrity() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  archive_integrity="sha256-$(cat hello_world.zip | openssl dgst -sha256 -binary | openssl base64 -A)"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  integrity="${archive_integrity}",
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
  remote_file_integrity={
    "REPO.bazel": "sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=",
    "BUILD.bazel": "",
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world > "${TEST_log}" 2>&1
  expect_log "canonical reproducible form can be obtained by modifying arguments \
remote_file_integrity = {\"REPO\.bazel\": \"[^\"]*\", \"BUILD\.bazel\": \"[^\"]*\"}\$"

  # Check that repo is not marked as reproducible and cached

  bazel clean --expunge

  # Modify the remote files to overlay
  cat > ../BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "goodbye_world",
    srcs = ["hello_world.c"],
)
EOF

  bazel build @hello_world//:goodbye_world
}

test_overlay_remote_file_disallow_relative_outside_repo() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  remote_file_urls={
    "../../../REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world &> $TEST_log 2>&1 && fail "Expected to fail"
  expect_log "Error in download: Cannot write outside of the repository directory"
}

test_overlay_remote_file_disallow_absolute_path() {
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  remote_file_urls={
    "/tmp/REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world &> $TEST_log 2>&1 && fail "Expected to fail"
  expect_log "Error in download: Cannot write outside of the repository directory"
}

test_overlay_remote_file_collision() {
  # hello_world.c
  EXTREPODIR=`pwd`
  EXTREPOURL="$(get_extrepourl ${EXTREPODIR})"

  archive_integrity="sha256-$(cat hello_world.zip | openssl dgst -sha256 -binary | openssl base64 -A)"

  # Generate the remote files to overlay
  cat > BUILD.bazel <<'EOF'
load("@rules_cc//cc:defs.bzl", "cc_binary")

cc_binary(
    name = "hello_world",
    srcs = ["hello_world.c"],
)
EOF
  touch REPO.bazel
  cat > hello_world.c <<'EOF'
#include <stdio.h>
int main() {
  printf("Goodbye, world!\n");
  return 0;
}
EOF

  mkdir main
  cd main
  cat >> $(setup_module_dot_bazel) <<EOF
http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
  name="hello_world",
  strip_prefix="hello_world-0.1.2",
  urls=["${EXTREPOURL}/hello_world.zip"],
  integrity="${archive_integrity}",
  remote_file_urls={
    "REPO.bazel": ["${EXTREPOURL}/REPO.bazel"],
    "BUILD.bazel": ["${EXTREPOURL}/BUILD.bazel"],
    "hello_world.c": ["${EXTREPOURL}/hello_world.c"],
  },
)
EOF
  add_rules_cc "MODULE.bazel"

  bazel build @hello_world//:hello_world > "${TEST_log}" 2>&1
  bazel run @hello_world//:hello_world | grep 'Goodbye, world!' \
    || fail "Expected output 'Goodbye, world!'"
}

run_suite "external remote file tests"