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

[MAINTENANCE] Add suite_name to ExpectationSuiteValidationResult #9677

Merged
merged 6 commits into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 12 additions & 14 deletions great_expectations/core/expectation_validation_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -503,13 +503,15 @@ class ExpectationSuiteValidationResult(SerializableDictDot):
evaluation_parameters: Dict of Evaluation Parameters used to produce these results, or None.
statistics: Dict of values describing the results.
meta: Instance of ExpectationSuiteValidationResult, a Dict of meta values, or None.

batch_id: A unique identifier for the batch of data that was validated.
result_url: A URL where the results are stored.
""" # noqa: E501

def __init__( # noqa: PLR0913
self,
success: Optional[bool] = None,
results: Optional[list] = None,
success: bool,
results: list[ExpectationValidationResult],
suite_name: str,
Comment on lines +512 to +514
Copy link
Member Author

Choose a reason for hiding this comment

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

These should be guaranteed fields - what is a result if we don't have results, an origin suite, and a success metric?

evaluation_parameters: Optional[dict] = None,
statistics: Optional[dict] = None,
meta: Optional[ExpectationSuiteValidationResult | dict] = None,
Expand All @@ -518,21 +520,16 @@ def __init__( # noqa: PLR0913
id: Optional[str] = None,
) -> None:
self.success = success
if results is None:
results = []
self.results = results
if evaluation_parameters is None:
evaluation_parameters = {}
self.evaluation_parameters = evaluation_parameters
if statistics is None:
statistics = {}
self.statistics = statistics
if meta is None:
meta = {}
self.suite_name = suite_name
self.evaluation_parameters = evaluation_parameters or {}
self.statistics = statistics or {}
meta = meta or {}
ensure_json_serializable(meta) # We require meta information to be serializable.
self.meta = meta
self.batch_id = batch_id
self.result_url = result_url
self.id = id
self._metrics: dict = {}

def __eq__(self, other):
Expand Down Expand Up @@ -632,6 +629,7 @@ def get_failed_validation_results(
return ExpectationSuiteValidationResult(
success=success,
results=validation_results,
suite_name=self.suite_name,
evaluation_parameters=self.evaluation_parameters,
statistics=statistics,
meta=self.meta,
Expand All @@ -654,11 +652,11 @@ def describe(self) -> str:
class ExpectationSuiteValidationResultSchema(Schema):
success = fields.Bool()
results = fields.List(fields.Nested(ExpectationValidationResultSchema))
suite_name = fields.String(required=True, allow_none=False)
evaluation_parameters = fields.Dict()
statistics = fields.Dict()
meta = fields.Dict(allow_none=True)
id = fields.UUID(required=False, allow_none=True)
checkpoint_name = fields.String(required=False, allow_none=True)
Copy link
Member Author

Choose a reason for hiding this comment

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

This was wrong - it might be in meta but shouldn't be at the top level


# noinspection PyUnusedLocal
@pre_dump
Expand Down
1 change: 1 addition & 0 deletions great_expectations/validator/v1_validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ def validate_expectation_suite(
return ExpectationSuiteValidationResult(
results=results,
success=statistics.success,
suite_name=expectation_suite.name,
statistics={
"evaluated_expectations": statistics.evaluated_expectations,
"successful_expectations": statistics.successful_expectations,
Expand Down
1 change: 1 addition & 0 deletions great_expectations/validator/validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -1417,6 +1417,7 @@ def validate( # noqa: C901, PLR0912, PLR0913, PLR0915
result = ExpectationSuiteValidationResult(
results=results,
success=statistics.success,
suite_name=expectation_suite_name,
statistics={
"evaluated_expectations": statistics.evaluated_expectations,
"successful_expectations": statistics.successful_expectations,
Expand Down
2 changes: 2 additions & 0 deletions tests/actions/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ def validation_result_suite():
return ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="empty_suite",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand Down Expand Up @@ -112,6 +113,7 @@ def validation_result_suite_with_ge_cloud_id(validation_result_suite_ge_cloud_id
return ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="empty_suite",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand Down
8 changes: 6 additions & 2 deletions tests/actions/test_core_actions.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ class Object:
run_id=RunIdentifier(run_name="prod_20190801"),
batch_identifier="1234",
),
validation_result_suite=ExpectationSuiteValidationResult(success=False, results=[]),
validation_result_suite=ExpectationSuiteValidationResult(
success=False, results=[], suite_name="empty_suite"
),
data_asset=None,
)

Expand All @@ -118,7 +120,7 @@ class Object:
run_id=expected_run_id,
batch_identifier="1234",
)
) == ExpectationSuiteValidationResult(success=False, results=[])
) == ExpectationSuiteValidationResult(success=False, results=[], suite_name="empty_suite")


@pytest.mark.big
Expand Down Expand Up @@ -217,6 +219,7 @@ def test_SlackNotificationAction(
validation_result_suite=ExpectationSuiteValidationResult(
success=False,
results=[],
suite_name="empty_suite",
statistics={
"successful_expectations": [],
"evaluated_expectations": [],
Expand All @@ -239,6 +242,7 @@ def test_SlackNotificationAction(
validation_result_suite=ExpectationSuiteValidationResult(
success=True,
results=[],
suite_name="empty_suite",
statistics={
"successful_expectations": [],
"evaluated_expectations": [],
Expand Down
1 change: 1 addition & 0 deletions tests/actions/test_sns_action.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ def test_send_sns_notification(sns, aws_credentials):
"missing_count": None,
"missing_percent": None,
},
"suite_name": "empty_suite",
}
result = ExpectationSuiteValidationResult(**results)
topic = "test"
Expand Down
1 change: 1 addition & 0 deletions tests/checkpoint/test_v1_checkpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,7 @@ def validation_definition(
},
),
],
suite_name=self.suite_name,
statistics={
"evaluated_expectations": 1,
"successful_expectations": 1,
Expand Down
1 change: 1 addition & 0 deletions tests/core/test_expectation_validation_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ def test_expectation_suite_validation_result_returns_expected_shape(
"unsuccessful_expectations": 0,
"success_percent": 100.0,
},
suite_name="empty_suite",
results=[
ExpectationValidationResult(
**{
Expand Down
7 changes: 4 additions & 3 deletions tests/core/test_validation_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
from great_expectations.data_context.data_context.ephemeral_data_context import (
EphemeralDataContext,
)
from great_expectations.data_context.store.validations_store import ValidationsStore
from great_expectations.data_context.store.validation_results_store import ValidationResultsStore
from great_expectations.data_context.types.resource_identifiers import (
GXCloudIdentifier,
ValidationResultIdentifier,
Expand Down Expand Up @@ -182,6 +182,7 @@ def test_returns_expected_data(
assert output == ExpectationSuiteValidationResult(
results=graph_validate_results,
success=True,
suite_name="empty_suite",
statistics={
"evaluated_expectations": 1,
"successful_expectations": 1,
Expand All @@ -190,7 +191,7 @@ def test_returns_expected_data(
},
)

@mock.patch.object(ValidationsStore, "set")
@mock.patch.object(ValidationResultsStore, "set")
@pytest.mark.unit
def test_persists_validation_results_for_non_cloud(
self,
Expand Down Expand Up @@ -223,7 +224,7 @@ def test_persists_validation_results_for_non_cloud(
assert key.batch_identifier == BATCH_ID
assert value.success is True

@mock.patch.object(ValidationsStore, "set")
@mock.patch.object(ValidationResultsStore, "set")
@pytest.mark.unit
def test_persists_validation_results_for_cloud(
self,
Expand Down
4 changes: 3 additions & 1 deletion tests/data_context/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,9 @@ def checkpoint_result(checkpoint_config: dict) -> CheckpointResult:
run_id=RunIdentifier(run_time=timestamp),
batch_identifier="default_pandas_datasource-#ephemeral_pandas_asset",
): {
"validation_result": ExpectationSuiteValidationResult(),
"validation_result": ExpectationSuiteValidationResult(
success=True, results=[], suite_name="my_suite"
),
"actions_results": {"my_action": {"class": "StoreValidationResultAction"}},
}
}
Expand Down
2 changes: 2 additions & 0 deletions tests/data_context/migrator/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ def get(self, key):
# Note: Key is unused
return ExpectationSuiteValidationResult(
success=True,
results=[],
suite_name="empty_suite",
)


Expand Down
2 changes: 2 additions & 0 deletions tests/data_context/store/test_evaluation_parameter_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ def test_evaluation_parameter_store_methods(
)
],
success=True,
suite_name="source_patient_data.default",
)

data_context_parameterized_expectation_suite.store_evaluation_parameters(
Expand Down Expand Up @@ -162,6 +163,7 @@ def test_evaluation_parameter_store_methods(
)
],
success=True,
suite_name="source_diabetes_data.default",
)

data_context_parameterized_expectation_suite.store_evaluation_parameters(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ def test_evaluation_parameter_store_methods(
)
],
success=True,
suite_name="empty_suite",
)

data_context_parameterized_expectation_suite_no_checkpoint_store.store_evaluation_parameters(
Expand Down
51 changes: 36 additions & 15 deletions tests/data_context/store/test_validations_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def test_ValidationsStore_with_TupleS3StoreBackend(aws_credentials):
)
my_store.set(ns_1, ExpectationSuiteValidationResult(success=True))
assert my_store.get(ns_1) == ExpectationSuiteValidationResult(
success=True, statistics={}, results=[]
success=True, statistics={}, results=[], suite_name="asset.quarantine"
)

ns_2 = ValidationResultIdentifier(
Expand All @@ -61,9 +61,12 @@ def test_ValidationsStore_with_TupleS3StoreBackend(aws_credentials):
batch_identifier="batch_id",
)

my_store.set(ns_2, ExpectationSuiteValidationResult(success=False))
my_store.set(
ns_2,
ExpectationSuiteValidationResult(success=False, results=[], suite_name="asset.quarantine"),
)
assert my_store.get(ns_2) == ExpectationSuiteValidationResult(
success=False, statistics={}, results=[]
success=False, statistics={}, results=[], suite_name="asset.quarantine"
)

# Verify that internals are working as expected, including the default filepath
Expand Down Expand Up @@ -118,9 +121,12 @@ def test_ValidationsStore_with_InMemoryStoreBackend():
"prod-100",
)
)
my_store.set(ns_1, ExpectationSuiteValidationResult(success=True))
my_store.set(
ns_1,
ExpectationSuiteValidationResult(success=True, results=[], suite_name="a.b.c.quarantine"),
)
assert my_store.get(ns_1) == ExpectationSuiteValidationResult(
success=True, statistics={}, results=[]
success=True, statistics={}, results=[], suite_name="a.b.c.quarantine"
)

ns_2 = ValidationResultIdentifier.from_tuple(
Expand All @@ -133,9 +139,12 @@ def test_ValidationsStore_with_InMemoryStoreBackend():
"prod-200",
)
)
my_store.set(ns_2, ExpectationSuiteValidationResult(success=False))
my_store.set(
ns_2,
ExpectationSuiteValidationResult(success=False, results=[], suite_name="a.b.c.quarantine"),
)
assert my_store.get(ns_2) == ExpectationSuiteValidationResult(
success=False, statistics={}, results=[]
success=False, statistics={}, results=[], suite_name="a.b.c.quarantine"
)
assert set(my_store.list_keys()) == {
ns_1,
Expand Down Expand Up @@ -181,9 +190,12 @@ def test_ValidationsStore_with_TupleFileSystemStoreBackend(tmp_path_factory):
run_id="prod-100",
batch_identifier="batch_id",
)
my_store.set(ns_1, ExpectationSuiteValidationResult(success=True))
my_store.set(
ns_1,
ExpectationSuiteValidationResult(success=True, results=[], suite_name="asset.quarantine"),
)
assert my_store.get(ns_1) == ExpectationSuiteValidationResult(
success=True, statistics={}, results=[]
success=True, statistics={}, results=[], suite_name="asset.quarantine"
)

ns_2 = ValidationResultIdentifier.from_tuple(
Expand All @@ -195,9 +207,12 @@ def test_ValidationsStore_with_TupleFileSystemStoreBackend(tmp_path_factory):
"batch_id",
)
)
my_store.set(ns_2, ExpectationSuiteValidationResult(success=False))
my_store.set(
ns_2,
ExpectationSuiteValidationResult(success=False, results=[], suite_name="asset.quarantine"),
)
assert my_store.get(ns_2) == ExpectationSuiteValidationResult(
success=False, statistics={}, results=[]
success=False, statistics={}, results=[], suite_name="asset.quarantine"
)

assert set(my_store.list_keys()) == {
Expand Down Expand Up @@ -270,9 +285,12 @@ def test_ValidationsStore_with_DatabaseStoreBackend(sa):
run_id="20191007T151224.1234Z_prod_100",
batch_identifier="batch_id",
)
my_store.set(ns_1, ExpectationSuiteValidationResult(success=True))
my_store.set(
ns_1,
ExpectationSuiteValidationResult(success=True, results=[], suite_name="asset.quarantine"),
)
assert my_store.get(ns_1) == ExpectationSuiteValidationResult(
success=True, statistics={}, results=[]
success=True, statistics={}, results=[], suite_name="asset.quarantine"
)

ns_2 = ValidationResultIdentifier(
Expand All @@ -283,9 +301,12 @@ def test_ValidationsStore_with_DatabaseStoreBackend(sa):
batch_identifier="batch_id",
)

my_store.set(ns_2, ExpectationSuiteValidationResult(success=False))
my_store.set(
ns_2,
ExpectationSuiteValidationResult(success=False, results=[], suite_name="asset.quarantine"),
)
assert my_store.get(ns_2) == ExpectationSuiteValidationResult(
success=False, statistics={}, results=[]
success=False, statistics={}, results=[], suite_name="asset.quarantine"
)

assert set(my_store.list_keys()) == {
Expand Down
2 changes: 2 additions & 0 deletions tests/render/test_EmailRenderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ def test_EmailRenderer_validation_results_with_datadocs():
validation_result_suite = ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="default",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand Down Expand Up @@ -74,6 +75,7 @@ def test_EmailRenderer_checkpoint_validation_results_with_datadocs():
validation_result_suite = ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="default",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand Down
3 changes: 3 additions & 0 deletions tests/render/test_OpsgenieRenderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ def test_OpsgenieRenderer_validation_results_success():
validation_result_suite = ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="default",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand Down Expand Up @@ -50,6 +51,7 @@ def test_OpsgenieRenderer_checkpoint_validation_results_success():
validation_result_suite = ExpectationSuiteValidationResult(
results=[],
success=True,
suite_name="default",
statistics={
"evaluated_expectations": 0,
"successful_expectations": 0,
Expand All @@ -75,6 +77,7 @@ def test_OpsgenieRenderer_validation_results_failure():
validation_result_suite = ExpectationSuiteValidationResult(
results=[],
success=False,
suite_name="default",
statistics={
"evaluated_expectations": 1,
"successful_expectations": 0,
Expand Down