Add errorHints to stdout when read-only file system errors are detected
The source tree will eventually be made ReadOnly, and recipes that write
directly to the source tree will fail. Use a pattern-match approach on
the results of stdout/stderr to provide hints to the user in such a
scenario.
If multiple patterns are found in raw output, print error hint
corresponding to first pattern match. first pattern match is chosen
since the failing function will be at the top of the stack, and hence
will be logged first
Test: Wrote a unit test to assert errorhint is added to output.
Wrote an integration test that writes to a file in the source tree
1. When source_tree is RO, the recipe fails and an error hint is printed
to stdout
2. When source tree is RW, the recipe succeeds and no error hint is
printed
Bug: 174726238
Change-Id: Id67b48f8094cdf8a571c239ae469d60464a1e89c
diff --git a/tests/bootstrap_test.sh b/tests/bootstrap_test.sh
index 8c8dc82..1258684 100755
--- a/tests/bootstrap_test.sh
+++ b/tests/bootstrap_test.sh
@@ -486,6 +486,39 @@
fi
}
+function test_write_to_source_tree {
+ setup
+ mkdir -p a
+ cat > a/Android.bp <<EOF
+genrule {
+ name: "write_to_source_tree",
+ out: ["write_to_source_tree"],
+ cmd: "touch file_in_source_tree && touch \$(out)",
+}
+EOF
+ readonly EXPECTED_OUT=out/soong/.intermediates/a/write_to_source_tree/gen/write_to_source_tree
+ readonly ERROR_LOG=${MOCK_TOP}/out/error.log
+ readonly ERROR_MSG="Read-only file system"
+ readonly ERROR_HINT_PATTERN="BUILD_BROKEN_SRC_DIR"
+ # Test in ReadOnly source tree
+ run_ninja BUILD_BROKEN_SRC_DIR_IS_WRITABLE=false ${EXPECTED_OUT} &> /dev/null && \
+ fail "Write to source tree should not work in a ReadOnly source tree"
+
+ if grep -q "${ERROR_MSG}" ${ERROR_LOG} && grep -q "${ERROR_HINT_PATTERN}" ${ERROR_LOG} ; then
+ echo Error message and error hint found in logs >/dev/null
+ else
+ fail "Did not find Read-only error AND error hint in error.log"
+ fi
+
+ # Test in ReadWrite source tree
+ run_ninja BUILD_BROKEN_SRC_DIR_IS_WRITABLE=true ${EXPECTED_OUT} &> /dev/null || \
+ fail "Write to source tree did not succeed in a ReadWrite source tree"
+
+ if grep -q "${ERROR_MSG}\|${ERROR_HINT_PATTERN}" ${ERROR_LOG} ; then
+ fail "Found read-only error OR error hint in error.log"
+ fi
+}
+
function test_bp2build_smoke {
setup
GENERATE_BAZEL_FILES=1 run_soong
@@ -692,6 +725,7 @@
test_glob_during_bootstrapping
test_soong_build_rerun_iff_environment_changes
test_dump_json_module_graph
+test_write_to_source_tree
test_bp2build_smoke
test_bp2build_generates_fake_ninja_file
test_bp2build_null_build