Skip to content
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

Jump to bottom

Add support for testing rules_cc's new toolchains with rules_testing. #84

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for testing rules_cc's new toolchains with rules_testing. #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions lib/private/analysis_test.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ load("@bazel_skylib//lib:dicts.bzl", "dicts")
load("@bazel_skylib//lib:types.bzl", "types")
load("//lib:truth.bzl", "truth")
load("//lib:util.bzl", "recursive_testing_aspect", "testing_aspect")
load("//lib/private:target_subject.bzl", "PROVIDER_SUBJECT_FACTORIES")
load("//lib/private:util.bzl", "get_test_name_from_function")

def _fail(env, msg):
Expand All @@ -37,7 +38,7 @@ def _fail(env, msg):
print(full_msg)
env.failures.append(full_msg)

def _begin_analysis_test(ctx):
def _begin_analysis_test(ctx, provider_factories):
"""Begins a unit test.

This should be the first function called in a unit test implementation
Expand All @@ -48,6 +49,10 @@ def _begin_analysis_test(ctx):
Args:
ctx: The Starlark context. Pass the implementation function's `ctx` argument
in verbatim.
provider_factories: List[struct(type, name, factory)] Additional provider
factories that should be available to `target.provider(...)`.
Eg. `[struct(type=FooInfo, name="FooInfo", factory=FooInfoFactory)]`.


Returns:
An analysis_test "environment" struct. The following fields are public:
Expand Down Expand Up @@ -86,6 +91,7 @@ def _begin_analysis_test(ctx):
truth_env = struct(
ctx = ctx,
fail = lambda msg: _fail(failures_env, msg),
providers = PROVIDER_SUBJECT_FACTORIES + provider_factories,
)
analysis_test_env = struct(
ctx = ctx,
Expand Down Expand Up @@ -126,7 +132,8 @@ def analysis_test(
fragments = [],
config_settings = {},
extra_target_under_test_aspects = [],
collect_actions_recursively = False):
collect_actions_recursively = False,
provider_factories = []):
"""Creates an analysis test from its implementation function.

An analysis test verifies the behavior of a "real" rule target by examining
Expand Down Expand Up @@ -189,6 +196,7 @@ def analysis_test(
analysis test target itself (e.g. common attributes like `tags`,
`target_compatible_with`, or attributes from `attrs`). Note that these
are for the analysis test target itself, not the target under test.

fragments: An optional list of fragment names that can be used to give rules access to
language-specific parts of configuration.
config_settings: A dictionary of configuration settings to change for the target under
Expand All @@ -202,6 +210,10 @@ def analysis_test(
in addition to those set up by default for the test harness itself.
collect_actions_recursively: If true, runs testing_aspect over all attributes, otherwise
it is only applied to the target under test.
provider_factories: Optional[List[struct(type, name, factory)]]
Additional provider factories that should be available to
`target.provider(...)`.
Eg. `[struct(type=FooInfo, name="FooInfo", factory=FooInfoFactory)]`.

Returns:
(None)
Expand Down Expand Up @@ -290,7 +302,7 @@ def analysis_test(
)

def wrapped_impl(ctx):
env, target = _begin_analysis_test(ctx)
env, target = _begin_analysis_test(ctx, provider_factories)
impl(env, target)
return _end_analysis_test(env)

Expand Down
32 changes: 23 additions & 9 deletions lib/private/target_subject.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,12 @@ def _target_subject_provider(self, provider_key, factory = None):
Returns:
A subject wrapper of the provider value.
"""
provider_name = str(factory)
if not factory:
for key, value in _PROVIDER_SUBJECT_FACTORIES:
if key == provider_key:
factory = value
for provider in self.meta.env.providers:
if provider.type == provider_key:
factory = provider.factory
provider_name = provider.name
break

if not factory:
Expand All @@ -249,7 +251,7 @@ def _target_subject_provider(self, provider_key, factory = None):

return factory(
info,
meta = self.meta.derive("provider({})".format(provider_key)),
meta = self.meta.derive("provider({})".format(provider_name)),
)

def _target_subject_action_generating(self, short_path):
Expand Down Expand Up @@ -385,11 +387,23 @@ def _target_subject_attr(self, name, *, factory = None):
meta = self.meta.derive("attr({})".format(name)),
)

# Providers aren't hashable, so we have to use a list of (key, value)
_PROVIDER_SUBJECT_FACTORIES = [
(InstrumentedFilesInfo, InstrumentedFilesInfoSubject.new),
(RunEnvironmentInfo, RunEnvironmentInfoSubject.new),
(testing.ExecutionInfo, ExecutionInfoSubject.new),
# Providers aren't hashable, so we have to use a list of structs.
PROVIDER_SUBJECT_FACTORIES = [
struct(
type = InstrumentedFilesInfo,
name = str(InstrumentedFilesInfo),
factory = InstrumentedFilesInfoSubject.new,
),
struct(
type = RunEnvironmentInfo,
name = str(RunEnvironmentInfo),
factory = RunEnvironmentInfoSubject,
),
struct(
type = testing.ExecutionInfo,
name = str(testing.ExecutionInfo),
factory = ExecutionInfoSubject.new,
),
]

def _provider_name(provider):
Expand Down