src/test/shell/bazel/platforms_test.sh - bazel - Git at Google

 #!/bin/bash
 #
 # Copyright 2019 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.
 #
 # Test related to @platforms embedded repository
 #

 # --- begin runfiles.bash initialization ---
 set -euo pipefail
 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; }

 # `uname` returns the current platform, e.g "MSYS_NT-10.0" or "Linux".
 # `tr` converts all upper case letters to lower case.
 # `case` matches the result if the `uname | tr` expression to string prefixes
 # that use the same wildcards as names do in Bash, i.e. "msys*" matches strings
 # starting with "msys", and "*" matches everything (it's the default case).
 case "$(uname -s | tr [:upper:] [:lower:])" in
 msys*)
   # As of 2019-01-15, Bazel on Windows only supports MSYS Bash.
   declare -r is_windows=true
   ;;
 *)
   declare -r is_windows=false
   ;;
 esac

 function test_platforms_repository_builds_itself() {
   # We test that a built-in @platforms repository is buildable.
   bazel build @platforms//:all &> $TEST_log \
       || fail "Build failed unexpectedly"
 }

 function test_platforms_can_be_overridden() {
   # We test that a custom repository can override @platforms in their
   # WORKSPACE file.
   mkdir -p platforms_can_be_overridden || fail "couldn't create directory"
   touch platforms_can_be_overridden/BUILD || \ fail "couldn't touch BUILD file"
   cat > platforms_can_be_overridden/WORKSPACE <<EOF
 local_repository(
   name = 'platforms',
   path = '../override',
 )
 EOF

   mkdir -p override || fail "couldn't create override directory"
   touch override/WORKSPACE || fail "couldn't touch override/WORKSPACE"
   cat > override/BUILD <<EOF
 filegroup(name = 'yolo')
 EOF

   cd platforms_can_be_overridden || fail "couldn't cd into workspace"
   bazel build @platforms//:yolo &> $TEST_log || \
     fail "Bazel failed to build @platforms"
 }

 function test_incompatible_use_platforms_repo_for_constraints() {
   # We test that a built-in @platforms repository is buildable.
   bazel build --incompatible_use_platforms_repo_for_constraints @bazel_tools//platforms:all &> \
     $TEST_log && fail "Build passed when we expected an error."
   expect_log "Constraints from @bazel_tools//platforms have been removed."
 }


 function test_platform_accessor() {
   cat > rules.bzl <<'EOF'
 def _impl(ctx):
   platform = ctx.attr.platform[platform_common.PlatformInfo]
   properties = platform.exec_properties
   print("The properties are:", properties)
   return []

 print_props = rule(
   implementation = _impl,
   attrs = {
       'platform': attr.label(providers = [platform_common.PlatformInfo]),
   }
 )
 EOF
   cat > BUILD << 'EOF'
 load("//:rules.bzl", "print_props")

 print_props(
     name = "a",
     platform = ":my_platform",
 )

 platform(
     name = "my_platform",
     exec_properties = {
         "key": "value",
         "key2": "value2",
         }
 )
 EOF

   bazel build --experimental_platforms_api=true :a &> $TEST_log || fail "Build failed"
   grep 'The properties are: {"key2": "value2", "key": "value"}' $TEST_log || fail "Did not find expected properties"
 }

 function test_target_exec_properties_starlark() {
 cat > rules.bzl << 'EOF'
 def _impl(ctx):
   out_file = ctx.outputs.output
   ctx.actions.run_shell(inputs = [], outputs = [out_file], arguments=[out_file.path], progress_message = "Saying hello", command = "echo hello > \"$1\"")

 my_rule = rule(
   implementation = _impl,
   attrs = {
     "output": attr.output(),
   }
 )
 EOF
   cat > BUILD << 'EOF'
 load("//:rules.bzl", "my_rule")

 my_rule(
     name = "a",
     output = "out.txt",
     exec_properties = {"key3": "value3", "overridden": "child_value"}
 )

 platform(
     name = "my_platform",
     exec_properties = {
         "key2": "value2",
         "overridden": "parent_value",
         }
 )
 EOF

   bazel build --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log || fail "Build failed"
   grep "key2" out.txt || fail "Did not find the platform key"
   grep "key3" out.txt || fail "Did not find the target attribute key"
   grep "child_value" out.txt || fail "Did not find the overriding value"
 }


 function test_target_exec_properties_starlark_test() {
 if "$is_windows"; then
   script_name="test_script.bat"
   script_content="@echo off\necho hello\n"
 else
   script_name="test_script.sh"
   script_content="#!/bin/bash\necho hello\n"
 fi
 cat > rules.bzl <<EOF
 def _impl(ctx):
   out_file = ctx.actions.declare_file("$script_name")
   ctx.actions.write(out_file, "$script_content", is_executable=True)
   return [DefaultInfo(executable = out_file)]

 my_rule_test = rule(
   implementation = _impl,
   test = True,
 )
 EOF
   cat > BUILD << 'EOF'
 load("//:rules.bzl", "my_rule_test")

 my_rule_test(
     name = "a",
     exec_properties = {"key3": "value3", "overridden": "child_value"}
 )

 platform(
     name = "my_platform",
     exec_properties = {
         "key2": "value2",
         "overridden": "parent_value",
         }
 )
 EOF

   bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log || fail "Build failed"
   grep "key2" out.txt || fail "Did not find the platform key"
   grep "key3" out.txt || fail "Did not find the target attribute key"
   grep "child_value" out.txt || fail "Did not find the overriding value"
 }

 function test_target_exec_properties_cc() {
   cat > a.cc <<'EOF'
 #include <stdio.h>
 int main() {
   printf("Hello\n");
 }
 EOF
   cat > BUILD <<'EOF'
 cc_binary(
   name = "a",
   srcs = ["a.cc"],
   exec_properties = {"key3": "value3", "overridden": "child_value"}
 )

 platform(
     name = "my_platform",
     parents = ["@local_config_platform//:host"],
     exec_properties = {
         "key2": "value2",
         "overridden": "parent_value",
         }
 )
 EOF
   bazel build --extra_execution_platforms=":my_platform" --toolchain_resolution_debug :a --execution_log_json_file out.txt &> $TEST_log || fail "Build failed"
   grep "key3" out.txt || fail "Did not find the target attribute key"
   grep "child_value" out.txt || fail "Did not find the overriding value"
   grep "key2" out.txt || fail "Did not find the platform key"
 }

 function test_target_exec_properties_cc_test() {
   cat > a.cc <<'EOF'
 #include <stdio.h>
 int main() {
   printf("Hello\n");
 }
 EOF
   cat > BUILD <<'EOF'

 cc_test(
   name = "a",
   srcs = ["a.cc"],
   exec_properties = {"key3": "value3", "overridden": "child_value"}
 )

 platform(
     name = "my_platform",
     parents = ["@local_config_platform//:host"],
     exec_properties = {
         "key2": "value2",
         "overridden": "parent_value",
         }
 )
 EOF
   bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log || fail "Build failed"
   grep "key2" out.txt || fail "Did not find the platform key"
   grep "key3" out.txt || fail "Did not find the target attribute key"
   grep "child_value" out.txt || fail "Did not find the overriding value"
 }

 function test_target_test_properties_sh_test() {
   cat > a.sh <<'EOF'
 #!/bin/bash
 echo hello
 EOF
   chmod u+x a.sh
   cat > BUILD <<'EOF'
 sh_test(
   name = "a",
   srcs = ["a.sh"],
   exec_properties = {"key3": "value3", "overridden": "child_value"}
 )

 platform(
     name = "my_platform",
     parents = ["@local_config_platform//:host"],
     exec_properties = {
         "key2": "value2",
         "overridden": "parent_value",
         }
 )
 EOF
   bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log || fail "Build failed"
   grep "key2" out.txt || fail "Did not find the platform key"
   grep "key3" out.txt || fail "Did not find the target attribute key"
   grep "child_value" out.txt || fail "Did not find the overriding value"
 }

 run_suite "platform mapping test"
	#!/bin/bash
	#
	# Copyright 2019 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.
	#
	# Test related to @platforms embedded repository
	#

	# --- begin runfiles.bash initialization ---
	set -euo pipefail
	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; }

	# `uname` returns the current platform, e.g "MSYS_NT-10.0" or "Linux".
	# `tr` converts all upper case letters to lower case.
	# `case` matches the result if the `uname \| tr` expression to string prefixes
	# that use the same wildcards as names do in Bash, i.e. "msys*" matches strings
	# starting with "msys", and "*" matches everything (it's the default case).
	case "$(uname -s \| tr [:upper:] [:lower:])" in
	msys*)
	# As of 2019-01-15, Bazel on Windows only supports MSYS Bash.
	declare -r is_windows=true
	;;
	*)
	declare -r is_windows=false
	;;
	esac

	function test_platforms_repository_builds_itself() {
	# We test that a built-in @platforms repository is buildable.
	bazel build @platforms//:all &> $TEST_log \
	\|\| fail "Build failed unexpectedly"
	}

	function test_platforms_can_be_overridden() {
	# We test that a custom repository can override @platforms in their
	# WORKSPACE file.
	mkdir -p platforms_can_be_overridden \|\| fail "couldn't create directory"
	touch platforms_can_be_overridden/BUILD \|\| \ fail "couldn't touch BUILD file"
	cat > platforms_can_be_overridden/WORKSPACE <<EOF
	local_repository(
	name = 'platforms',
	path = '../override',
	)
	EOF

	mkdir -p override \|\| fail "couldn't create override directory"
	touch override/WORKSPACE \|\| fail "couldn't touch override/WORKSPACE"
	cat > override/BUILD <<EOF
	filegroup(name = 'yolo')
	EOF

	cd platforms_can_be_overridden \|\| fail "couldn't cd into workspace"
	bazel build @platforms//:yolo &> $TEST_log \|\| \
	fail "Bazel failed to build @platforms"
	}

	function test_incompatible_use_platforms_repo_for_constraints() {
	# We test that a built-in @platforms repository is buildable.
	bazel build --incompatible_use_platforms_repo_for_constraints @bazel_tools//platforms:all &> \
	$TEST_log && fail "Build passed when we expected an error."
	expect_log "Constraints from @bazel_tools//platforms have been removed."
	}


	function test_platform_accessor() {
	cat > rules.bzl <<'EOF'
	def _impl(ctx):
	platform = ctx.attr.platform[platform_common.PlatformInfo]
	properties = platform.exec_properties
	print("The properties are:", properties)
	return []

	print_props = rule(
	implementation = _impl,
	attrs = {
	'platform': attr.label(providers = [platform_common.PlatformInfo]),
	}
	)
	EOF
	cat > BUILD << 'EOF'
	load("//:rules.bzl", "print_props")

	print_props(
	name = "a",
	platform = ":my_platform",
	)

	platform(
	name = "my_platform",
	exec_properties = {
	"key": "value",
	"key2": "value2",
	}
	)
	EOF

	bazel build --experimental_platforms_api=true :a &> $TEST_log \|\| fail "Build failed"
	grep 'The properties are: {"key2": "value2", "key": "value"}' $TEST_log \|\| fail "Did not find expected properties"
	}

	function test_target_exec_properties_starlark() {
	cat > rules.bzl << 'EOF'
	def _impl(ctx):
	out_file = ctx.outputs.output
	ctx.actions.run_shell(inputs = [], outputs = [out_file], arguments=[out_file.path], progress_message = "Saying hello", command = "echo hello > \"$1\"")

	my_rule = rule(
	implementation = _impl,
	attrs = {
	"output": attr.output(),
	}
	)
	EOF
	cat > BUILD << 'EOF'
	load("//:rules.bzl", "my_rule")

	my_rule(
	name = "a",
	output = "out.txt",
	exec_properties = {"key3": "value3", "overridden": "child_value"}
	)

	platform(
	name = "my_platform",
	exec_properties = {
	"key2": "value2",
	"overridden": "parent_value",
	}
	)
	EOF

	bazel build --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log \|\| fail "Build failed"
	grep "key2" out.txt \|\| fail "Did not find the platform key"
	grep "key3" out.txt \|\| fail "Did not find the target attribute key"
	grep "child_value" out.txt \|\| fail "Did not find the overriding value"
	}


	function test_target_exec_properties_starlark_test() {
	if "$is_windows"; then
	script_name="test_script.bat"
	script_content="@echo off\necho hello\n"
	else
	script_name="test_script.sh"
	script_content="#!/bin/bash\necho hello\n"
	fi
	cat > rules.bzl <<EOF
	def _impl(ctx):
	out_file = ctx.actions.declare_file("$script_name")
	ctx.actions.write(out_file, "$script_content", is_executable=True)
	return [DefaultInfo(executable = out_file)]

	my_rule_test = rule(
	implementation = _impl,
	test = True,
	)
	EOF
	cat > BUILD << 'EOF'
	load("//:rules.bzl", "my_rule_test")

	my_rule_test(
	name = "a",
	exec_properties = {"key3": "value3", "overridden": "child_value"}
	)

	platform(
	name = "my_platform",
	exec_properties = {
	"key2": "value2",
	"overridden": "parent_value",
	}
	)
	EOF

	bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log \|\| fail "Build failed"
	grep "key2" out.txt \|\| fail "Did not find the platform key"
	grep "key3" out.txt \|\| fail "Did not find the target attribute key"
	grep "child_value" out.txt \|\| fail "Did not find the overriding value"
	}

	function test_target_exec_properties_cc() {
	cat > a.cc <<'EOF'
	#include <stdio.h>
	int main() {
	printf("Hello\n");
	}
	EOF
	cat > BUILD <<'EOF'
	cc_binary(
	name = "a",
	srcs = ["a.cc"],
	exec_properties = {"key3": "value3", "overridden": "child_value"}
	)

	platform(
	name = "my_platform",
	parents = ["@local_config_platform//:host"],
	exec_properties = {
	"key2": "value2",
	"overridden": "parent_value",
	}
	)
	EOF
	bazel build --extra_execution_platforms=":my_platform" --toolchain_resolution_debug :a --execution_log_json_file out.txt &> $TEST_log \|\| fail "Build failed"
	grep "key3" out.txt \|\| fail "Did not find the target attribute key"
	grep "child_value" out.txt \|\| fail "Did not find the overriding value"
	grep "key2" out.txt \|\| fail "Did not find the platform key"
	}

	function test_target_exec_properties_cc_test() {
	cat > a.cc <<'EOF'
	#include <stdio.h>
	int main() {
	printf("Hello\n");
	}
	EOF
	cat > BUILD <<'EOF'

	cc_test(
	name = "a",
	srcs = ["a.cc"],
	exec_properties = {"key3": "value3", "overridden": "child_value"}
	)

	platform(
	name = "my_platform",
	parents = ["@local_config_platform//:host"],
	exec_properties = {
	"key2": "value2",
	"overridden": "parent_value",
	}
	)
	EOF
	bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log \|\| fail "Build failed"
	grep "key2" out.txt \|\| fail "Did not find the platform key"
	grep "key3" out.txt \|\| fail "Did not find the target attribute key"
	grep "child_value" out.txt \|\| fail "Did not find the overriding value"
	}

	function test_target_test_properties_sh_test() {
	cat > a.sh <<'EOF'
	#!/bin/bash
	echo hello
	EOF
	chmod u+x a.sh
	cat > BUILD <<'EOF'
	sh_test(
	name = "a",
	srcs = ["a.sh"],
	exec_properties = {"key3": "value3", "overridden": "child_value"}
	)

	platform(
	name = "my_platform",
	parents = ["@local_config_platform//:host"],
	exec_properties = {
	"key2": "value2",
	"overridden": "parent_value",
	}
	)
	EOF
	bazel test --extra_execution_platforms=":my_platform" :a --execution_log_json_file out.txt &> $TEST_log \|\| fail "Build failed"
	grep "key2" out.txt \|\| fail "Did not find the platform key"
	grep "key3" out.txt \|\| fail "Did not find the target attribute key"
	grep "child_value" out.txt \|\| fail "Did not find the overriding value"
	}

	run_suite "platform mapping test"