Skip to content

Update test scripts for Bzlmod compatibility #1622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2024
Merged

Update test scripts for Bzlmod compatibility #1622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cc2de7
Update test scripts for Bzlmod compatibility
mbland Oct 15, 2024
c4b5a9a
Add SCALA_VERSION comment to test_coverage_*.sh
mbland Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion test/shell/test_coverage_equals_in_target.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
. "${dir}"/test_helper.sh
runner=$(get_test_runner "${1:-local}")

# Default to 2.12.19 for `diff` tests because other versions change the output.
SCALA_VERSION="${SCALA_VERSION:-2.12.19}"

test_coverage_target_name_contains_equals_sign() {
bazel coverage //test/coverage_filename_encoding:name-with-equals
bazel coverage \
--repo_env="SCALA_VERSION=${SCALA_VERSION}" \
//test/coverage_filename_encoding:name-with-equals
diff test/coverage_filename_encoding/expected-coverage.dat $(bazel info bazel-testlogs)/test/coverage_filename_encoding/name-with-equals/coverage.dat
}

Expand Down
11 changes: 8 additions & 3 deletions test/shell/test_coverage_scalatest.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@ dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
. "${dir}"/test_helper.sh
runner=$(get_test_runner "${1:-local}")

# Default to 2.12.19 for `diff` tests because other versions change the output.
SCALA_VERSION="${SCALA_VERSION:-2.12.19}"

test_coverage_on() {
bazel coverage //test/coverage_scalatest:test-scalatest
bazel coverage \
--repo_env="SCALA_VERSION=${SCALA_VERSION}" \
//test/coverage_scalatest:test-scalatest
diff test/coverage_scalatest/expected-coverage.dat $(bazel info bazel-testlogs)/test/coverage_scalatest/test-scalatest/coverage.dat
}

test_coverage_includes_test_targets() {
bazel coverage \
--instrument_test_targets=True \
//test/coverage_scalatest:test-scalatest
--instrument_test_targets=True \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't --repo_env="SCALA_VERSION=${SCALA_VERSION}" be passed here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! But I actually went the other way—the tests missing --repo_env="SCALA_VERSION=${SCALA_VERSION}" are only grepping for the expected filename, not diffing against an expected coverage file. So I've added comments in each file to explain the SCALA_VERSION setting.

I think the actual solution might be to generate coverage files for each Scala version, and use $SCALA_VERSION to select between them instead of setting --repo_env. I can take that on as a side quest, perhaps.

//test/coverage_scalatest:test-scalatest
grep -q "SF:test/coverage_scalatest/TestWithScalaTest.scala" $(bazel info bazel-testlogs)/test/coverage_scalatest/test-scalatest/coverage.dat
}

Expand Down
12 changes: 8 additions & 4 deletions test/shell/test_coverage_scalatest_resources.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@ dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
. "${dir}"/test_helper.sh
runner=$(get_test_runner "${1:-local}")

# Default to 2.12.19 for `diff` tests because other versions change the output.
SCALA_VERSION="${SCALA_VERSION:-2.12.19}"

test_coverage_succeeds_resource_call() {
bazel coverage \
--instrumentation_filter=^//test/coverage_scalatest_resources[:/] \
//test/coverage_scalatest_resources/consumer:tests
--repo_env="SCALA_VERSION=${SCALA_VERSION}" \
--instrumentation_filter=^//test/coverage_scalatest_resources[:/] \
//test/coverage_scalatest_resources/consumer:tests
diff test/coverage_scalatest_resources/expected-coverage.dat $(bazel info bazel-testlogs)/test/coverage_scalatest_resources/consumer/tests/coverage.dat
}

test_coverage_includes_resource_test_targets() {
bazel coverage \
--instrument_test_targets=True \
//test/coverage_scalatest_resources/consumer:tests
--instrument_test_targets=True \
//test/coverage_scalatest_resources/consumer:tests
grep -q "SF:test/coverage_scalatest_resources/consumer/src/test/scala/com/example/consumer/ConsumerSpec.scala" $(bazel info bazel-testlogs)/test/coverage_scalatest_resources/consumer/tests/coverage.dat
}

Expand Down
11 changes: 8 additions & 3 deletions test/shell/test_coverage_specs2_with_junit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@ dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
. "${dir}"/test_helper.sh
runner=$(get_test_runner "${1:-local}")

# Default to 2.12.19 for `diff` tests because other versions change the output.
SCALA_VERSION="${SCALA_VERSION:-2.12.19}"

test_coverage_on() {
bazel coverage //test/coverage_specs2_with_junit:test-specs2-with-junit
bazel coverage \
--repo_env="SCALA_VERSION=${SCALA_VERSION}" \
//test/coverage_specs2_with_junit:test-specs2-with-junit
diff test/coverage_specs2_with_junit/expected-coverage.dat $(bazel info bazel-testlogs)/test/coverage_specs2_with_junit/test-specs2-with-junit/coverage.dat
}

test_coverage_includes_test_targets() {
bazel coverage \
--instrument_test_targets=True \
//test/coverage_specs2_with_junit:test-specs2-with-junit
--instrument_test_targets=True \
//test/coverage_specs2_with_junit:test-specs2-with-junit
grep -q "SF:test/coverage_specs2_with_junit/TestWithSpecs2WithJUnit.scala" $(bazel info bazel-testlogs)/test/coverage_specs2_with_junit/test-specs2-with-junit/coverage.dat
}

Expand Down
59 changes: 23 additions & 36 deletions test/shell/test_helper.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,23 @@ action_should_fail() {
fi
}

_expect_failure_with_messages() {
local bazel_cmd="$1"
shift
local expected_message=""

while [[ "$#" -ne 0 ]]; do
expected_message="$1"
shift

if [[ -n "$expected_message" && ! "$output" =~ $expected_message ]]; then
echo ${output}
echo "'${bazel_cmd}' should have logged \"${expected_message}\"."
exit 1
fi
done
}

test_expect_failure_with_message() {
set +e

Expand All @@ -34,21 +51,8 @@ test_expect_failure_with_message() {
command="bazel test --nocache_test_results --test_output=streamed ${test_filter} ${test_command}"
output=$(${command} 2>&1)

echo ${output} | grep "$expected_message"
if [ $? -ne 0 ]; then
echo ${output}
echo "'bazel test ${test_command}' should have logged \"${expected_message}\"."
exit 1
fi
if [ "${additional_expected_message}" != "" ]; then
echo ${output} | grep "$additional_expected_message"
if [ $? -ne 0 ]; then
echo ${output}
echo "'bazel test ${test_command}' should have logged \"${additional_expected_message}\"."
exit 1
fi
fi

_expect_failure_with_messages "bazel test ${test_command}" \
"$expected_message" "$additional_expected_message"
set -e
}

Expand All @@ -58,13 +62,11 @@ action_should_fail_with_message() {
TEST_ARG=${@:2}
RES=$(bazel $TEST_ARG 2>&1)
RESPONSE_CODE=$?
echo $RES | grep -- "$MSG"
GREP_RES=$?
if [ $RESPONSE_CODE -eq 0 ]; then
echo $RES
echo -e "${RED} \"bazel $TEST_ARG\" should have failed but passed. $NC"
exit 1
elif [ $GREP_RES -ne 0 ]; then
elif [[ ! "$RES" =~ $MSG ]]; then
echo $RES
echo -e "${RED} \"bazel $TEST_ARG\" should have failed with message \"$MSG\" but did not. $NC"
exit 1
Expand All @@ -79,13 +81,11 @@ action_should_fail_without_message() {
TEST_ARG=${@:2}
RES=$(bazel $TEST_ARG 2>&1)
RESPONSE_CODE=$?
echo $RES | grep -- "$MSG"
GREP_RES=$?
if [ $RESPONSE_CODE -eq 0 ]; then
echo $RES
echo -e "${RED} \"bazel $TEST_ARG\" should have failed but passed. $NC"
exit 1
elif [ $GREP_RES -eq 0 ]; then
elif [[ "$RES" =~ $MSG ]]; then
echo $RES
echo -e "${RED} \"bazel $TEST_ARG\" should have failed with message not containing \"$MSG\" but it did. $NC"
exit 1
Expand Down Expand Up @@ -120,21 +120,8 @@ test_expect_failure_or_warning_on_missing_direct_deps_with_expected_message() {
exit 1
fi

echo ${output} | grep "$expected_message"
if [ $? -ne 0 ]; then
echo ${output}
echo "'bazel build ${test_target}' should have logged \"${expected_message}\"."
exit 1
fi
if [ "${additional_expected_message}" != "" ]; then
echo ${output} | grep "$additional_expected_message"
if [ $? -ne 0 ]; then
echo ${output}
echo "'bazel build ${test_target}' should have logged \"${additional_expected_message}\"."
exit 1
fi
fi

_expect_failure_with_messages "bazel build ${test_target}" \
"$expected_message" "$additional_expected_message"
set -e
}

Expand Down
3 changes: 2 additions & 1 deletion test/shell/test_scala_config.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ test_classpath_contains_2_13() {

test_scala_config_content() {
bazel build --repo_env=SCALA_VERSION=0.0.0 @io_bazel_rules_scala_config//:all 2> /dev/null
grep "SCALA_MAJOR_VERSION='0.0'" $(bazel info output_base)/external/io_bazel_rules_scala_config/config.bzl
grep "SCALA_MAJOR_VERSION='0.0'" \
"$(bazel info output_base)"/external/*io_bazel_rules_scala_config/config.bzl
}

$runner test_classpath_contains_2_12
Expand Down
2 changes: 1 addition & 1 deletion test/shell/test_scala_library.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ test_scala_library_expect_better_failure_with_target_label_from_stamped_jar_on_m

test_scala_library_expect_better_failure_message_on_missing_transitive_dependency_labels_from_other_jvm_rules() {
transitive_target='.*transitive_dependency_without_manifest.jar'
direct_target='@//test_expect_failure/missing_direct_deps/internal_deps:unstamped_direct_java_provider_dependency'
direct_target='@@?//test_expect_failure/missing_direct_deps/internal_deps:unstamped_direct_java_provider_dependency'
test_target='//test_expect_failure/missing_direct_deps/internal_deps:unstamped_jar_dependent_on_some_java_provider'

expected_message="Unknown label of file $transitive_target which came from $direct_target"
Expand Down
40 changes: 20 additions & 20 deletions test/shell/test_semanticdb.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ test_produces_semanticdb(){


if [ $is_bundle -eq 1 ]; then
local toolchain="--extra_toolchains=//test/semanticdb:semanticdb_bundle_toolchain"
local toolchain="--extra_toolchains=//test/semanticdb:semanticdb_bundle_toolchain"
else
local toolchain="--extra_toolchains=//test/semanticdb:semanticdb_nobundle_toolchain"
fi
Expand All @@ -36,7 +36,7 @@ test_produces_semanticdb(){

bazel build //test/semanticdb:semantic_provider_vars_all ${toolchain} ${version_opt}

#semantic_provider_vars.sh contains the SemanticdbInfo data
#semantic_provider_vars.sh contains the SemanticdbInfo data
. $(bazel info bazel-bin)/test/semanticdb/semantic_provider_vars_all.sh

#Check the Provider variables
Expand All @@ -61,7 +61,7 @@ test_produces_semanticdb(){
echo "Error: SemanticdbInfo.target_root expected to be empty string"
exit 1
fi
fi
fi

if [[ $scala_majver == 3 ]] && [[ $semanticdb_pluginjarpath != "" ]]; then
echo "Error: SemanticdbInfo.pluginjarpath expected to be empty for scala 3"
Expand All @@ -73,7 +73,7 @@ test_produces_semanticdb(){
fi

if [ $is_bundle -eq 0 ]; then

semanticdb_path="$(bazel info execution_root)/${semanticdb_target_root}/META-INF/semanticdb/test/semanticdb/"

for arg in $FILES
Expand All @@ -85,8 +85,8 @@ test_produces_semanticdb(){
fi
done
fi
local JAR="$(bazel info bazel-bin)/test/semanticdb/all_lib.jar"

local JAR="$(bazel info bazel-bin)/test/semanticdb/all_lib.jar"

if [ $is_bundle -eq 0 ]; then
if jar_contains_files $JAR $FILES; then
Expand All @@ -110,11 +110,11 @@ test_empty_semanticdb(){
}

test_no_semanticdb() {
#verify no semanticdb files have been generated in the bin dir or bundled in the jar
#verify no semanticdb files have been generated in the bin dir or bundled in the jar

set -e

local jar="$(bazel info bazel-bin)/test/semanticdb/all_lib.jar"
local jar="$(bazel info bazel-bin)/test/semanticdb/all_lib.jar"
local targetout_path="$(bazel info bazel-bin)/test/semanticdb"

rm -rf $targetout_path #clean out the output dir for clean slate
Expand All @@ -137,7 +137,7 @@ test_no_semanticdb() {

test_semanticdb_handles_removed_sourcefiles() {
#Ensure absense of bug where bazel failed with 'access denied' on Windows when a source file was removed.

#First add the new scala file, build it, then remove the new scala file, and ensure it builds.
set -e

Expand All @@ -151,7 +151,7 @@ test_semanticdb_handles_removed_sourcefiles() {
mkdir -p $newfile_dir && echo "class D{ val a = 1; }" > $newfilepath


#make sure D.scala was added to the target (sanity check)
#make sure D.scala was added to the target (sanity check)
local query_result1=$(bazel query "labels(srcs, $rule_label)")
if [[ $query_result1 != *"$newfilename"* ]] ; then
echo "$newfilename was not properly added as src for target $rule_label"
Expand All @@ -162,30 +162,30 @@ test_semanticdb_handles_removed_sourcefiles() {

#remove the new source file and build it
rm $newfilepath

#make sure D.scala was properly removed from the target(sanity check)
local query_result2=$(bazel query "labels(srcs, $rule_label)")
if [[ $query_result2 == *"$newfilename"* ]] ; then
if [[ $query_result2 == *"$newfilename"* ]] ; then
echo "$newfilename was not properly removed as src for target $rule_label"
exit 1
fi

bazel build $rule_label $toolchainArg


}

run_semanticdb_tests() {
local bundle=1; local nobundle=0
local scala3=3; local scala2=2
$runner test_produces_semanticdb $scala2 $bundle
$runner test_produces_semanticdb $scala2 $nobundle

$runner test_produces_semanticdb $scala2 $bundle
$runner test_produces_semanticdb $scala2 $nobundle

$runner test_empty_semanticdb

$runner test_produces_semanticdb $scala3 $bundle
$runner test_produces_semanticdb $scala3 $nobundle
$runner test_produces_semanticdb $scala3 $bundle
$runner test_produces_semanticdb $scala3 $nobundle

$runner test_no_semanticdb
$runner test_semanticdb_handles_removed_sourcefiles
Expand Down
9 changes: 5 additions & 4 deletions test/shell/test_strict_dependency.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ test_plus_one_ast_analyzer_strict_deps() {

test_stamped_target_label_loading() {
local test_target="//test_expect_failure/missing_direct_deps/external_deps:java_lib_with_a_transitive_external_dep"
local expected_message="buildozer 'add deps @io_bazel_rules_scala_guava//:io_bazel_rules_scala_guava' ${test_target}"
local missing_dep="@@?[a-z_.~+-]*io_bazel_rules_scala_guava[_0-9]*//:io_bazel_rules_scala_guava[_0-9]*"
local expected_message="buildozer 'add deps ${missing_dep}' ${test_target}"

test_expect_failure_or_warning_on_missing_direct_deps_with_expected_message \
"${expected_message}" ${test_target} \
Expand All @@ -69,7 +70,7 @@ test_strict_deps_filter_included_target() {

test_demonstrate_INCORRECT_scala_proto_library_stamp() {
local test_target="//test_expect_failure/missing_direct_deps/scala_proto_deps:uses_transitive_scala_proto"
local incorrectly_stamped_expected_message="buildozer 'add deps @//test_expect_failure/missing_direct_deps/scala_proto_deps:some_proto' ${test_target}"
local incorrectly_stamped_expected_message="buildozer 'add deps @@?//test_expect_failure/missing_direct_deps/scala_proto_deps:some_proto' ${test_target}"

# When stamping is fixed, expected stamp is:
# local correctly_stamped_expected_message="buildozer 'add deps //test_expect_failure/missing_direct_deps/scala_proto_deps:some_scala_proto' ${test_target}"
Expand All @@ -82,7 +83,7 @@ test_demonstrate_INCORRECT_scala_proto_library_stamp() {

test_scala_proto_library_stamp_by_convention() {
local test_target="//test_expect_failure/missing_direct_deps/scala_proto_deps:uses_transitive_scala_proto"
local expected_message="buildozer 'add deps @//test_expect_failure/missing_direct_deps/scala_proto_deps:some_scala_proto' ${test_target}"
local expected_message="buildozer 'add deps @@?//test_expect_failure/missing_direct_deps/scala_proto_deps:some_scala_proto' ${test_target}"

test_expect_failure_or_warning_on_missing_direct_deps_with_expected_message \
"${expected_message}" ${test_target} \
Expand All @@ -92,7 +93,7 @@ test_scala_proto_library_stamp_by_convention() {

test_scala_proto_library_custom_phase_stamping() {
local test_target="//test_expect_failure/missing_direct_deps/scala_proto_deps:uses_transitive_some_proto_custom_suffix"
local expected_message="buildozer 'add deps @//test_expect_failure/missing_direct_deps/scala_proto_deps:some_proto_custom_suffix' ${test_target}"
local expected_message="buildozer 'add deps @@?//test_expect_failure/missing_direct_deps/scala_proto_deps:some_proto_custom_suffix' ${test_target}"

test_expect_failure_or_warning_on_missing_direct_deps_with_expected_message \
"${expected_message}" ${test_target} \
Expand Down
Loading