From c585a1bcc740099fd0a4b76b91f9455e7c7a284e Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Tue, 25 Jul 2023 21:20:27 -0700 Subject: [PATCH] fix(ingest): hint at --update-golden-files option when tests fail (#8507) --- .../src/datahub/testing/compare_metadata_json.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/metadata-ingestion/src/datahub/testing/compare_metadata_json.py b/metadata-ingestion/src/datahub/testing/compare_metadata_json.py index 466e652277..b017afc8c1 100644 --- a/metadata-ingestion/src/datahub/testing/compare_metadata_json.py +++ b/metadata-ingestion/src/datahub/testing/compare_metadata_json.py @@ -45,7 +45,7 @@ def assert_metadata_files_equal( if copy_output: shutil.copyfile(str(output_path), str(golden_path) + ".output") - print(f"Copied output file to {golden_path}.output") + logger.info(f"Copied output file to {golden_path}.output") if not update_golden and not golden_exists: raise FileNotFoundError( @@ -77,11 +77,15 @@ def assert_metadata_files_equal( if diff: # Call pytest.fail rather than raise an exception to omit stack trace + message = ( + "Metadata files differ (use `pytest --update-golden-files` to update):\n" + ) if isinstance(diff, MCPDiff): - print(diff.pretty(verbose=True)) - pytest.fail(diff.pretty(), pytrace=False) + logger.error(message + diff.pretty(verbose=True)) + pytest.fail(message + diff.pretty(), pytrace=False) else: - pytest.fail(pprint.pformat(diff), pytrace=False) + logger.error(message + pprint.pformat(diff)) + pytest.fail(message + pprint.pformat(diff), pytrace=False) def diff_metadata_json(