Split skylark flag tests into multiple test cases

This is cleaner and will help when we eventually add tests for flags controlling the global environment. RELNOTES: None PiperOrigin-RevId: 173388860
fulldecent · Oct 25, 2017 · 60fc02b · 60fc02b
1 parent 81fc541
commit 60fc02b
Show file tree

Hide file tree

Showing 3 changed files with 137 additions and 53 deletions.
diff --git a/src/test/shell/bazel/skylark_repository_test.sh b/src/test/shell/bazel/skylark_repository_test.sh
@@ -24,8 +24,6 @@ source "${CURRENT_DIR}/../integration_test_setup.sh" \
 source "${CURRENT_DIR}/remote_helpers.sh" \
   || { echo "remote_helpers.sh not found!" >&2; exit 1; }
 
-SKYLARK_FLAG_MARKER="<== skylark flag test ==>"
-
 # Basic test.
 function test_macro_local_repository() {
   create_new_workspace
@@ -348,12 +346,22 @@ def _impl(repository_ctx):
 repo = repository_rule(implementation=_impl, local=True)
 EOF
 
+  MARKER="<== skylark flag test ==>"
+
+  bazel build @foo//:bar >& $TEST_log \
+    || fail "Expected build to succeed"
+  expect_log "In repo rule: " "Did not find repository rule print output"
+  expect_not_log "$MARKER" \
+      "Marker string '$MARKER' was seen even though \
+      --internal_skylark_flag_test_canary wasn't passed"
+
   # Build with the special testing flag that appends a marker string to all
   # print() calls.
   bazel build @foo//:bar --internal_skylark_flag_test_canary >& $TEST_log \
     || fail "Expected build to succeed"
-  expect_log "In repo rule: $SKYLARK_FLAG_MARKER" \
-      "Skylark flags are not propagating to repository rules"
+  expect_log "In repo rule: $MARKER" \
+      "Skylark flags are not propagating to repository rule implementation \
+      function evaluation"
 }
 
 function test_skylark_repository_which_and_execute() {

diff --git a/src/test/shell/bazel/workspace_test.sh b/src/test/shell/bazel/workspace_test.sh
@@ -21,8 +21,6 @@ source "${CURRENT_DIR}/../integration_test_setup.sh" \
 
 export JAVA_RUNFILES=$BAZEL_RUNFILES
 
-SKYLARK_FLAG_MARKER="<== skylark flag test ==>"
-
 function setup_repo() {
   mkdir -p $1
   touch $1/WORKSPACE
@@ -189,13 +187,24 @@ EOF
 genrule(name = "x", cmd = "echo hi > $@", outs = ["x.out"], srcs = [])
 EOF
 
+  MARKER="<== skylark flag test ==>"
+
+  # Sanity check.
+  bazel build //:x &>"$TEST_log" \
+    || fail "Expected build to succeed"
+  expect_log "In workspace: " "Did not find workspace print output"
+  expect_log "In workspace macro: " "Did not find workspace macro print output"
+  expect_not_log "$MARKER" \
+    "Marker string '$MARKER' was seen even though \
+    --internal_skylark_flag_test_canary wasn't passed"
+
   # Build with the special testing flag that appends a marker string to all
   # print() calls.
   bazel build //:x --internal_skylark_flag_test_canary &>"$TEST_log" \
     || fail "Expected build to succeed"
-  expect_log "In workspace: $SKYLARK_FLAG_MARKER" \
+  expect_log "In workspace: $MARKER" \
     "Skylark flags are not propagating to workspace evaluation"
-  expect_log "In workspace macro: $SKYLARK_FLAG_MARKER" \
+  expect_log "In workspace macro: $MARKER" \
     "Skylark flags are not propagating to workspace macro evaluation"
 }
 

diff --git a/src/test/shell/integration/skylark_flag_test.sh b/src/test/shell/integration/skylark_flag_test.sh
@@ -25,23 +25,122 @@ CURRENT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "${CURRENT_DIR}/../integration_test_setup.sh" \
   || { echo "integration_test_setup.sh not found!" >&2; exit 1; }
 
+# Text that will be appended to every print() output when the flag is enabled.
 MARKER="<== skylark flag test ==>"
 
-function setup_package() {
-  mkdir -p test
-  cat > test/BUILD <<'EOF'
-load(":test.bzl", "macro")
+sanity_fail_msg="Marker string '$MARKER' was seen even though "
+sanity_fail_msg+="--internal_skylark_flag_test_canary wasn't passed"
 
+
+function test_build_file() {
+  mkdir -p test
+  cat > test/BUILD <<'EOF' || fail "couldn't create file"
 print("In BUILD: ")
 
+genrule(
+    name = "dummy",
+    cmd = "echo 'dummy' >$@",
+    outs = ["dummy.txt"],
+)
+EOF
+
+  # Sanity check.
+  bazel build //test:dummy \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In BUILD: " "Did not find BUILD print output"
+  expect_not_log "$MARKER" "$sanity_fail_msg"
+
+  bazel build //test:dummy \
+      --internal_skylark_flag_test_canary \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In BUILD: $MARKER" \
+      "Skylark flags are not propagating to BUILD file evaluation"
+}
+
+function test_bzl_file_and_macro() {
+  mkdir -p test
+  cat > test/BUILD <<'EOF' || fail "couldn't create file"
+load(":test.bzl", "macro")
+
 macro()
 EOF
-  cat >test/test.bzl <<'EOF'
+  cat >test/test.bzl <<'EOF' || fail "couldn't create file"
 print("In bzl: ")
 
+def macro():
+  print("In macro: ")
+  native.genrule(
+      name = "dummy",
+      cmd = "echo 'dummy' >$@",
+      outs = ["dummy.txt"],
+  )
+EOF
+
+  # Sanity check.
+  bazel build //test:dummy \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In bzl: " "Did not find .bzl print output"
+  expect_log "In macro: " "Did not find macro print output"
+  expect_not_log "$MARKER" "$sanity_fail_msg"
+
+  bazel build //test:dummy \
+      --internal_skylark_flag_test_canary \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In bzl: $MARKER" \
+      "Skylark flags are not propagating to .bzl file evaluation"
+  expect_log "In macro: $MARKER" \
+      "Skylark flags are not propagating to macro evaluation"
+}
+
+function test_rule() {
+  mkdir -p test
+  cat > test/BUILD <<'EOF' || fail "couldn't create file"
+load(":test.bzl", "some_rule")
+
+some_rule(
+    name = "dummy",
+)
+EOF
+  cat >test/test.bzl <<'EOF' || fail "couldn't create file"
 def _rule_impl(ctx):
   print("In rule: ")
 
+some_rule = rule(
+    implementation = _rule_impl,
+)
+EOF
+
+  # Sanity check.
+  bazel build //test:dummy \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In rule: " "Did not find rule print output"
+  expect_not_log "$MARKER" "$sanity_fail_msg"
+
+  bazel build //test:dummy \
+      --internal_skylark_flag_test_canary \
+      &>"$TEST_log" || fail "bazel build failed";
+  expect_log "In rule: $MARKER" \
+      "Skylark flags are not propagating to rule implementation function evaluation"
+}
+
+# TODO(brandjon): Once we're no long dropping print() output in computed default
+# functions, also test that we're propagating flags there. Alternatively, this
+# could be tested by having conditional code that crashes while evaluating the
+# Skylark function iff the flag is set.
+
+function test_aspect() {
+  mkdir -p test
+  cat > test/BUILD <<'EOF' || fail "couldn't create file"
+load(":test.bzl", "some_rule")
+
+some_rule(
+    name = "dummy",
+)
+EOF
+  cat >test/test.bzl <<'EOF' || fail "couldn't create file"
+def _rule_impl(ctx):
+  pass
+
 some_rule = rule(
     implementation = _rule_impl,
 )
@@ -53,51 +152,19 @@ def _aspect_impl(target, ctx):
 some_aspect = aspect(
     implementation = _aspect_impl,
 )
-
-def macro():
-  print("In macro: ")
-  some_rule(name="some_target")
 EOF
-}
 
-function test_sanity() {
-  # Control test: Make sure the print strings appear, and the marker string
-  # doesn't appear, when we don't pass the flag.
-  setup_package
-  bazel build //test:some_target  --aspects test/test.bzl%some_aspect \
-    &>"$TEST_log" || fail "bazel build failed";
-  fail_msg="Marker string '$MARKER' was seen even though "
-  fail_msg+="--internal_skylark_flag_test_canary wasn't passed"
-  expect_not_log "$MARKER" "$fail_msg"
-  expect_log "In BUILD: " "Did not find BUILD print output"
-  expect_log "In bzl: " "Did not find .bzl print output"
-  expect_log "In macro: " "Did not find macro print output"
-  expect_log "In rule: " "Did not find rule print output"
-  # TODO(brandjon): If we add computed default functions as per below, add a
-  # sanity check for it here too.
+  # Sanity check.
+  bazel build //test:dummy --aspects test/test.bzl%some_aspect \
+      &>"$TEST_log" || fail "bazel build failed";
   expect_log "In aspect: " "Did not find aspect print output"
-}
+  expect_not_log "$MARKER" "$sanity_fail_msg"
 
-function test_skylark_flags() {
-  # Check that the marker string appears when we pass the flag.
-  setup_package
-  bazel build //test:some_target --aspects test/test.bzl%some_aspect \
-    --internal_skylark_flag_test_canary \
-    &>"$TEST_log" || fail "bazel build failed";
-  expect_log "In BUILD: $MARKER" \
-    "Skylark flags are not propagating to BUILD file evaluation"
-  expect_log "In bzl: $MARKER" \
-    "Skylark flags are not propagating to .bzl file evaluation"
-  expect_log "In macro: $MARKER" \
-    "Skylark flags are not propagating to macro evaluation"
-  expect_log "In rule: $MARKER" \
-    "Skylark flags are not propagating to rule implementation function evaluation"
-  # TODO(brandjon): Once we're no long dropping print() output in computed
-  # default functions, also test that we're propagating flags there.
-  # Alternatively, this could be tested by having conditional code that crashes
-  # while evaluating the Skylark function iff the flag is set.
+  bazel build //test:dummy --aspects test/test.bzl%some_aspect \
+      --internal_skylark_flag_test_canary \
+      &>"$TEST_log" || fail "bazel build failed";
   expect_log "In aspect: $MARKER" \
-    "Skylark flags are not propagating to aspect implementation function evaluation"
+      "Skylark flags are not propagating to aspect implementation function evaluation"
 }