test(e2e): add Behave step definitions for context merging (#593)

balgaly · jonathannorris · gruebel · web-flow · commit 79bb01b96e9c · 2026-06-07T09:03:41.000+02:00
* test(e2e): add Behave step definitions for context merging Add the missing E2E step definitions so the contextMerging.feature scenarios from the OpenFeature spec run against python-sdk. Fixes #500 Changes: - Bump spec submodule to 130df3eb so contextMerging.feature is copied in during the `poe e2e` task. - Add tests/features/environment.py with a before_scenario hook that resets provider/hook/API-context/transaction-context state, so scenarios cannot leak state between features. - Add tests/features/steps/context_merging_steps.py: - RetrievableContextProvider captures the merged EvaluationContext it receives, so assertions can inspect what the SDK merged. - Step definitions for all scenarios in contextMerging.feature: single-level insert, multi-level insert, and per-key overwrite precedence across API / Transaction / Client / Invocation / Before Hooks. - Client-level context is set via direct attribute assignment on OpenFeatureClient.context (no new setter), since merging already honors client.context (openfeature/client.py:422-429). Runs clean: 4 features / 50 scenarios / 233 steps. Signed-off-by: gruebel <anton.gruebel@gmail.com> * docs: fix inaccuracies in README code examples (#592) Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * fix: correctly reset api state on shutdown (#589) correctly reset api state on shutdown Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(main): release 0.9.0 (#555) Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update pre-commit hook tox-dev/pyproject-fmt to v2.21.2 (#601) * chore(deps): update pre-commit hook tox-dev/pyproject-fmt to v2.21.2 * upper bound toml-fmt-common till fixed Signed-off-by: gruebel <anton.gruebel@gmail.com> --------- Signed-off-by: gruebel <anton.gruebel@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: gruebel <anton.gruebel@gmail.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update astral-sh/setup-uv action to v8 (#603) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update codecov/codecov-action action to v6 (#604) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update googleapis/release-please-action action to v5 (#605) * chore(deps): update googleapis/release-please-action action to v5 * fix config Signed-off-by: gruebel <anton.gruebel@gmail.com> --------- Signed-off-by: gruebel <anton.gruebel@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: gruebel <anton.gruebel@gmail.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v2 (#606) * chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v2 * update config Signed-off-by: gruebel <anton.gruebel@gmail.com> --------- Signed-off-by: gruebel <anton.gruebel@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: gruebel <anton.gruebel@gmail.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update dependency prek to >=0.4.3,<0.5.0 (#607) * chore(deps): update dependency prek to >=0.4.3,<0.5.0 * adjust CI Signed-off-by: gruebel <anton.gruebel@gmail.com> --------- Signed-off-by: gruebel <anton.gruebel@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: gruebel <anton.gruebel@gmail.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * feat!: make set_provider non-blocking, add set_provider_and_wait (#595) * feat!: make set_provider non-blocking, add set_provider_and_wait Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> * fix: ruff format signature collapse in api.py Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> * fix: use threading.Event in error event test to avoid flaky busy-wait Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> * fixup: pr feedback and additional checks Signed-off-by: Todd Baert <todd.baert@dynatrace.com> * fix: check active registration in stale-init guard, not _provider_status Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> * fixup: edge shutdown race Signed-off-by: Todd Baert <todd.baert@dynatrace.com> --------- Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * fix: isolate provider event handler dispatch (#599) * Isolate provider event handlers Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> * Address event handler review feedback Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> * test: cover event dispatch noop path Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> * fixup: drain executor at exit and relax non-blocking test timing margin Signed-off-by: Todd Baert <todd.baert@dynatrace.com> --------- Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Co-authored-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * test: fix flaky event handler test (#609) fix flaky event handler test Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.15.15 (#608) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * chore(main): release 0.10.0 (#602) * chore(main): release 0.10.0 Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> * docs: clarify non-blocking set_provider behavior in changelog Signed-off-by: Todd Baert <todd.baert@dynatrace.com> --------- Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: gruebel <anton.gruebel@gmail.com> * fix CR comments Signed-off-by: gruebel <anton.gruebel@gmail.com> * cleanup Signed-off-by: gruebel <anton.gruebel@gmail.com> --------- Signed-off-by: gruebel <anton.gruebel@gmail.com> Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com> Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com> Co-authored-by: Jonathan Norris <jonathan.norris@dynatrace.com> Co-authored-by: Anton Grübel <anton.gruebel@gmail.com> Co-authored-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Co-authored-by: Nguyen Cat Luong <pkiphone.anhluong@gmail.com> Co-authored-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
diff --git a/spec b/spec
@@ -1 +1 @@
-Subproject commit 0cd553d85f03b0b7ab983a988ce1720a3190bc88
+Subproject commit 130df3eb61f1b8d1a121d54f33563ce0ec27c1b6
diff --git a/tests/features/environment.py b/tests/features/environment.py
@@ -0,0 +1,15 @@
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from openfeature.transaction_context import (
+    ContextVarsTransactionContextPropagator,
+    set_transaction_context,
+    set_transaction_context_propagator,
+)
+
+
+def before_scenario(context, scenario):
+    api.clear_providers()
+    api.clear_hooks()
+    api.set_evaluation_context(EvaluationContext())
+    set_transaction_context_propagator(ContextVarsTransactionContextPropagator())
+    set_transaction_context(EvaluationContext())
diff --git a/tests/features/steps/context_merging_steps.py b/tests/features/steps/context_merging_steps.py
@@ -0,0 +1,186 @@
+from __future__ import annotations
+
+import typing
+from collections.abc import Mapping, Sequence
+
+from behave import given, then, when
+
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from openfeature.flag_evaluation import FlagResolutionDetails, FlagValueType, Reason
+from openfeature.hook import Hook, HookContext, HookHints
+from openfeature.provider import AbstractProvider, Metadata
+from openfeature.transaction_context import (
+    set_transaction_context,
+)
+
+
+class RetrievableContextProvider(AbstractProvider):
+    """Stores the last merged evaluation context it was asked to resolve."""
+
+    def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+        super().__init__(*args, **kwargs)
+
+        self.last_context: EvaluationContext | None = None
+
+    def get_metadata(self) -> Metadata:
+        return Metadata(name="retrievable-context-provider")
+
+    def get_provider_hooks(self) -> list[Hook]:
+        return []
+
+    def _capture(
+        self, default_value: FlagValueType, context: EvaluationContext | None
+    ) -> FlagResolutionDetails[typing.Any]:
+        self.last_context = context
+        return FlagResolutionDetails(value=default_value, reason=Reason.STATIC)
+
+    def resolve_boolean_details(
+        self,
+        flag_key: str,
+        default_value: bool,
+        evaluation_context: EvaluationContext | None = None,
+    ) -> FlagResolutionDetails[bool]:
+        return self._capture(default_value, evaluation_context)
+
+    def resolve_string_details(
+        self,
+        flag_key: str,
+        default_value: str,
+        evaluation_context: EvaluationContext | None = None,
+    ) -> FlagResolutionDetails[str]:
+        return self._capture(default_value, evaluation_context)
+
+    def resolve_integer_details(
+        self,
+        flag_key: str,
+        default_value: int,
+        evaluation_context: EvaluationContext | None = None,
+    ) -> FlagResolutionDetails[int]:
+        return self._capture(default_value, evaluation_context)
+
+    def resolve_float_details(
+        self,
+        flag_key: str,
+        default_value: float,
+        evaluation_context: EvaluationContext | None = None,
+    ) -> FlagResolutionDetails[float]:
+        return self._capture(default_value, evaluation_context)
+
+    def resolve_object_details(
+        self,
+        flag_key: str,
+        default_value: Sequence[FlagValueType] | Mapping[str, FlagValueType],
+        evaluation_context: EvaluationContext | None = None,
+    ) -> FlagResolutionDetails[Sequence[FlagValueType] | Mapping[str, FlagValueType]]:
+        return self._capture(default_value, evaluation_context)
+
+
+class _BeforeHookContextInjector(Hook):
+    def __init__(self, context: EvaluationContext) -> None:
+        self._context = context
+
+    def before(
+        self, hook_context: HookContext, hints: HookHints
+    ) -> EvaluationContext | None:
+        return self._context
+
+
+_LEVELS = {"API", "Transaction", "Client", "Invocation", "Before Hooks"}
+
+
+def _ensure_state(context: typing.Any) -> None:
+    if getattr(context, "_merging_initialized", False):
+        return
+
+    provider = RetrievableContextProvider()
+    api.set_provider(provider)
+    context.provider = provider
+    context.client = api.get_client()
+    context.invocation_context = EvaluationContext()
+    context.before_hook_context = EvaluationContext()
+    context._merging_initialized = True
+
+
+@given("a stable provider with retrievable context is registered")
+def step_impl_retrievable_provider(context: typing.Any) -> None:
+    context._merging_initialized = False
+    _ensure_state(context)
+
+
+def _add_entry_at_level(
+    context: typing.Any, level: str, key: str, value: typing.Any
+) -> None:
+    if level not in _LEVELS:
+        raise ValueError(f"Unknown level: {level!r}")
+
+    new_entry = (
+        EvaluationContext(targeting_key=value)
+        if key == "targeting_key"
+        else EvaluationContext(attributes={key: value})
+    )
+    if level == "API":
+        api.set_evaluation_context(api.get_evaluation_context().merge(new_entry))
+    elif level == "Transaction":
+        set_transaction_context(api.get_transaction_context().merge(new_entry))
+    elif level == "Client":
+        context.client.context = context.client.context.merge(new_entry)
+    elif level == "Invocation":
+        context.invocation_context = context.invocation_context.merge(new_entry)
+    elif level == "Before Hooks":
+        context.before_hook_context = context.before_hook_context.merge(new_entry)
+
+
+@given(
+    'A context entry with key "{key}" and value "{value}" is added to the '
+    '"{level}" level'
+)
+def step_impl_add_entry(context: typing.Any, key: str, value: str, level: str) -> None:
+    _add_entry_at_level(context, level, key, value)
+
+
+@given("A table with levels of increasing precedence")
+def step_impl_levels_table(context: typing.Any) -> None:
+    # The feature table is a single-column list of levels. Behave treats the
+    # first row as the heading, so recombine heading + body rows.
+    levels = [context.table.headings[0]]
+    levels.extend(row[0] for row in context.table.rows)
+    context.precedence_levels = levels
+
+
+@given(
+    'Context entries for each level from API level down to the "{level}" level, '
+    'with key "{key}" and value "{value}"'
+)
+def step_impl_entries_down_to(
+    context: typing.Any, level: str, key: str, value: str
+) -> None:
+    levels = context.precedence_levels
+    if level not in levels:
+        raise ValueError(f"Level {level!r} not in precedence table {levels!r}")
+    for current_level in levels:
+        _add_entry_at_level(context, current_level, key, value)
+        if current_level == level:
+            break
+
+
+@when("Some flag was evaluated")
+def step_impl_evaluate(context: typing.Any) -> None:
+    context.client.add_hooks(
+        [(_BeforeHookContextInjector(context.before_hook_context))]
+    )
+    context.client.get_boolean_details("some-flag", False, context.invocation_context)
+
+
+@then('The merged context contains an entry with key "{key}" and value "{value}"')
+def step_impl_merged_contains(context: typing.Any, key: str, value: str) -> None:
+    assert context.provider.last_context is not None, (
+        "provider did not receive an evaluation context"
+    )
+    last_context = context.provider.last_context
+    actual_value = (
+        last_context.targeting_key
+        if key == "targeting_key"
+        else last_context.attributes.get(key)
+    )
+    assert actual_value == value, f"expected {key!r}={value!r}, got {actual_value!r}"
