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.

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

feat: Add metadata to providers #26

Merged
merged 4 commits into from
Oct 18, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
Empty file.
6 changes: 6 additions & 0 deletions open_feature/provider/metadata.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from dataclasses import dataclass


@dataclass
class Metadata:
name: str
9 changes: 9 additions & 0 deletions open_feature/provider/no_op_metadata.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from dataclasses import dataclass

from open_feature.provider.metadata import Metadata


@dataclass
class NoOpMetadata(Metadata):
name: str = "No-op Provider"
is_test_class: bool = True
6 changes: 4 additions & 2 deletions open_feature/provider/no_op_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@
from open_feature.evaluation_context.evaluation_context import EvaluationContext
from open_feature.flag_evaluation.flag_evaluation_details import FlagEvaluationDetails
from open_feature.flag_evaluation.reason import Reason
from open_feature.provider.metadata import Metadata
from open_feature.provider.no_op_metadata import NoOpMetadata
from open_feature.provider.provider import AbstractProvider

PASSED_IN_DEFAULT = "Passed in default"


class NoOpProvider(AbstractProvider):
def get_name(self) -> str:
return "No-op Provider"
def get_metadata(self) -> Metadata:
return NoOpMetadata()

def get_boolean_details(
self,
Expand Down
3 changes: 2 additions & 1 deletion open_feature/provider/provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
from numbers import Number

from open_feature.evaluation_context.evaluation_context import EvaluationContext
from open_feature.provider.metadata import Metadata


class AbstractProvider:
@abstractmethod
def get_name(self) -> str:
def get_metadata(self) -> Metadata:
pass

@abstractmethod
Expand Down
10 changes: 10 additions & 0 deletions tests/provider/test_no_op_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ def setup():
assert isinstance(provider, NoOpProvider)


def test_should_return_no_op_provider_metadata(no_op_provider_client):
# Given
# When
metadata = NoOpProvider().get_metadata()
# Then
assert metadata is not None
assert metadata.name == "No-op Provider"
assert metadata.is_test_class


def test_should_get_boolean_flag_from_no_op(no_op_provider_client):
# Given
# When
Expand Down