Skip to content

Commit

Permalink
test(core): Add analysis tests for base Python rules.
Browse files Browse the repository at this point in the history
This is to provide some regression tests for the Starlark rewrite.

These tests are approximately the same as Bazel's Java-implemented
tests.

Work towards #1069
  • Loading branch information
rickeylev committed Feb 27, 2023
1 parent f97e008 commit cfc038d
Show file tree
Hide file tree
Showing 14 changed files with 940 additions and 0 deletions.
7 changes: 7 additions & 0 deletions internal_deps.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ def rules_python_internal_deps():
],
sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
)
maybe(
http_archive,
name = "rules_testing",
url = "https://github.com/bazelbuild/rules_testing/releases/download/v0.0.1/rules_testing-v0.0.1.tar.gz",
sha256 = "47db8fc9c3c1837491333cdcedebf267285479bd709a1ff0a47b19a324817def",
strip_prefix = "rules_testing-0.0.1",
)

maybe(
http_archive,
Expand Down
13 changes: 13 additions & 0 deletions tools/build_defs/python/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright 2023 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.
78 changes: 78 additions & 0 deletions tools/build_defs/python/tests/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Copyright 2023 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.

load("@rules_cc//cc:defs.bzl", "cc_toolchain", "cc_toolchain_suite")
load(":fake_cc_toolchain_config.bzl", "fake_cc_toolchain_config")

platform(
name = "mac",
constraint_values = [
"@platforms//os:macos",
],
)

platform(
name = "linux",
constraint_values = [
"@platforms//os:linux",
],
)

cc_toolchain_suite(
name = "cc_toolchain_suite",
toolchains = {
"darwin_x86_64": ":mac_toolchain",
"k8": ":linux_toolchain",
},
)

filegroup(name = "empty")

cc_toolchain(
name = "mac_toolchain",
all_files = ":empty",
compiler_files = ":empty",
dwp_files = ":empty",
linker_files = ":empty",
objcopy_files = ":empty",
strip_files = ":empty",
supports_param_files = 0,
toolchain_config = ":mac_toolchain_config",
toolchain_identifier = "mac-toolchain",
)

fake_cc_toolchain_config(
name = "mac_toolchain_config",
target_cpu = "darwin_x86_64",
toolchain_identifier = "mac-toolchain",
)

cc_toolchain(
name = "linux_toolchain",
all_files = ":empty",
compiler_files = ":empty",
dwp_files = ":empty",
linker_files = ":empty",
objcopy_files = ":empty",
strip_files = ":empty",
supports_param_files = 0,
toolchain_config = ":linux_toolchain_config",
toolchain_identifier = "mac-toolchain",
)

fake_cc_toolchain_config(
name = "linux_toolchain_config",
target_cpu = "darwin_x86_64",
toolchain_identifier = "linux_toolchain",
)
103 changes: 103 additions & 0 deletions tools/build_defs/python/tests/base_tests.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Copyright 2023 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 common to py_test, py_binary, and py_library rules."""

load("@rules_testing//lib:analysis_test.bzl", "analysis_test")
load("@rules_testing//lib:truth.bzl", "matching")
load("@rules_testing//lib:util.bzl", rt_util = "util")
load("//python:defs.bzl", "PyInfo")
load("//tools/build_defs/python/tests:py_info_subject.bzl", "py_info_subject")
load("//tools/build_defs/python/tests:util.bzl", pt_util = "util")

_tests = []

def _produces_py_info_impl(ctx):
return [PyInfo(transitive_sources = depset(ctx.files.srcs))]

_produces_py_info = rule(
implementation = _produces_py_info_impl,
attrs = {"srcs": attr.label_list(allow_files = True)},
)

def _test_consumes_provider(name, config):
rt_util.helper_target(
config.base_test_rule,
name = name + "_subject",
deps = [name + "_produces_py_info"],
)
rt_util.helper_target(
_produces_py_info,
name = name + "_produces_py_info",
srcs = [rt_util.empty_file(name + "_produce.py")],
)
analysis_test(
name = name,
target = name + "_subject",
impl = _test_consumes_provider_impl,
)

def _test_consumes_provider_impl(env, target):
env.expect.that_target(target).provider(
PyInfo,
factory = py_info_subject,
).transitive_sources().contains("{package}/{test_name}_produce.py")

_tests.append(_test_consumes_provider)

def _test_requires_provider(name, config):
rt_util.helper_target(
config.base_test_rule,
name = name + "_subject",
deps = [name + "_nopyinfo"],
)
rt_util.helper_target(
native.filegroup,
name = name + "_nopyinfo",
)
analysis_test(
name = name,
target = name + "_subject",
impl = _test_requires_provider_impl,
expect_failure = True,
)

def _test_requires_provider_impl(env, target):
env.expect.that_target(target).failures().contains_predicate(
matching.str_matches("mandatory*PyInfo"),
)

_tests.append(_test_requires_provider)

def _test_data_sets_uses_shared_library(name, config):
rt_util.helper_target(
config.base_test_rule,
name = name + "_subject",
data = [rt_util.empty_file(name + "_dso.so")],
)
analysis_test(
name = name,
target = name + "_subject",
impl = _test_data_sets_uses_shared_library_impl,
)

def _test_data_sets_uses_shared_library_impl(env, target):
env.expect.that_target(target).provider(
PyInfo,
factory = py_info_subject,
).uses_shared_libraries().equals(True)

_tests.append(_test_data_sets_uses_shared_library)

def create_base_tests(config):
return pt_util.create_tests(_tests, config = config)
37 changes: 37 additions & 0 deletions tools/build_defs/python/tests/fake_cc_toolchain_config.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2023 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.

"""Fake for providing CcToolchainConfigInfo."""

def _impl(ctx):
return cc_common.create_cc_toolchain_config_info(
ctx = ctx,
toolchain_identifier = ctx.attr.toolchain_identifier,
host_system_name = "local",
target_system_name = "local",
target_cpu = ctx.attr.target_cpu,
target_libc = "unknown",
compiler = "clang",
abi_version = "unknown",
abi_libc_version = "unknown",
)

fake_cc_toolchain_config = rule(
implementation = _impl,
attrs = {
"target_cpu": attr.string(),
"toolchain_identifier": attr.string(),
},
provides = [CcToolchainConfigInfo],
)
17 changes: 17 additions & 0 deletions tools/build_defs/python/tests/py_binary/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2023 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.

load(":py_binary_tests.bzl", "py_binary_test_suite")

py_binary_test_suite(name = "py_binary_tests")
28 changes: 28 additions & 0 deletions tools/build_defs/python/tests/py_binary/py_binary_tests.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copyright 2023 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 for py_binary."""

load("//python:defs.bzl", "py_binary")
load(
"//tools/build_defs/python/tests:py_executable_base_tests.bzl",
"create_executable_tests",
)

def py_binary_test_suite(name):
config = struct(rule = py_binary)

native.test_suite(
name = name,
tests = create_executable_tests(config),
)
Loading

0 comments on commit cfc038d

Please sign in to comment.