-
Notifications
You must be signed in to change notification settings - Fork 147
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
Clean up some tests for programmatic descriptions feature #407
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
amundsen_application/static/js/components/TableDetail/constants.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export const PROGRMMATIC_DESC_HEADER = 'Read-only information, auto-generated' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,115 +1,65 @@ | ||
| import unittest | ||
|
|
||
| from amundsen_application.api.utils.metadata_utils import marshall_table_full | ||
| from unittest.mock import patch, Mock | ||
|
|
||
| from amundsen_application.api.utils.metadata_utils import _update_prog_descriptions, _sort_prog_descriptions | ||
| from amundsen_application import create_app | ||
|
|
||
| local_app = create_app('amundsen_application.config.TestConfig', 'tests/templates') | ||
|
|
||
|
|
||
| class MetadataUtilsTest(unittest.TestCase): | ||
| class ProgrammaticDescriptionsTest(unittest.TestCase): | ||
| def setUp(self) -> None: | ||
| self.input_data = { | ||
| 'cluster': 'test_cluster', | ||
| 'columns': [ | ||
| { | ||
| 'name': 'column_1', | ||
| 'description': 'This is a test', | ||
| 'col_type': 'bigint', | ||
| 'sort_order': 0, | ||
| 'stats': [ | ||
| {'stat_type': 'count', 'stat_val': '100', 'start_epoch': 1538352000, 'end_epoch': 1538352000}, | ||
| {'stat_type': 'count_null', 'stat_val': '0', 'start_epoch': 1538352000, 'end_epoch': 1538352000} | ||
| ] | ||
| } | ||
| ], | ||
| 'database': 'test_db', | ||
| 'is_view': False, | ||
| 'key': 'test_db://test_cluster.test_schema/test_table', | ||
| 'owners': [], | ||
| 'schema': 'test_schema', | ||
| 'name': 'test_table', | ||
| 'table_description': 'This is a test', | ||
| 'tags': [], | ||
| 'table_readers': [ | ||
| {'user': {'email': '[email protected]', 'first_name': None, 'last_name': None}, 'read_count': 100} | ||
| ], | ||
| 'watermarks': [ | ||
| {'watermark_type': 'low_watermark', 'partition_key': 'ds', 'partition_value': '', 'create_time': ''}, | ||
| {'watermark_type': 'high_watermark', 'partition_key': 'ds', 'partition_value': '', 'create_time': ''} | ||
| ], | ||
| 'table_writer': { | ||
| 'application_url': 'https://test-test.test.test', | ||
| 'name': 'test_name', | ||
| 'id': 'test_id', | ||
| 'description': 'This is a test' | ||
| }, | ||
| 'programmatic_descriptions': [ | ||
| pass | ||
|
|
||
| @patch('amundsen_application.api.utils.metadata_utils._sort_prog_descriptions') | ||
| def test_update_prog_descriptions(self, sort_mock) -> None: | ||
| with local_app.app_context(): | ||
| test_desc = [ | ||
| {'source': 'c_1', 'text': 'description c'}, | ||
| {'source': 'a_1', 'text': 'description a'}, | ||
| {'source': 'b_1', 'text': 'description b'} | ||
| ] | ||
| } | ||
| # Pretend config exists | ||
| local_app.config['PROGRAMMATIC_DISPLAY'] = Mock() | ||
| # Mock the effects of the sort method | ||
| sort_mock.side_effect = [1, 0, 1] | ||
| # Expected order based on mocked side effect | ||
| expected_programmatic_desc = [ | ||
| {'source': 'a_1', 'text': 'description a'}, | ||
| {'source': 'c_1', 'text': 'description c'}, | ||
| {'source': 'b_1', 'text': 'description b'} | ||
| ] | ||
| _update_prog_descriptions(test_desc) | ||
| self.assertEqual(test_desc, expected_programmatic_desc) | ||
|
|
||
| self.expected_data = {'badges': [], | ||
| 'cluster': 'test_cluster', | ||
| 'columns': [{'col_type': 'bigint', | ||
| 'description': 'This is a test', | ||
| 'name': 'column_1', | ||
| 'sort_order': 0, | ||
| 'stats': [{'end_epoch': 1538352000, | ||
| 'start_epoch': 1538352000, | ||
| 'stat_type': 'count', | ||
| 'stat_val': '100'}, | ||
| {'end_epoch': 1538352000, | ||
| 'start_epoch': 1538352000, | ||
| 'stat_type': 'count_null', | ||
| 'stat_val': '0'}]}], | ||
| 'database': 'test_db', | ||
| 'description': None, | ||
| 'is_editable': True, | ||
| 'is_view': False, | ||
| 'key': 'test_db://test_cluster.test_schema/test_table', | ||
| 'last_updated_timestamp': None, | ||
| 'name': 'test_table', | ||
| 'owners': [], | ||
| 'partition': {'is_partitioned': True, 'key': 'ds', 'value': ''}, | ||
| 'programmatic_descriptions': [{'source': 'a_1', 'text': 'description a'}, | ||
| {'source': 'c_1', 'text': 'description c'}, | ||
| {'source': 'b_1', 'text': 'description b'}], | ||
| 'schema': 'test_schema', | ||
| 'source': None, | ||
| 'table_readers': [{'read_count': 100, | ||
| 'user': {'display_name': '[email protected]', | ||
| 'email': '[email protected]', | ||
| 'employee_type': None, | ||
| 'first_name': None, | ||
| 'full_name': None, | ||
| 'github_username': None, | ||
| 'is_active': True, | ||
| 'last_name': None, | ||
| 'manager_email': None, | ||
| 'manager_fullname': None, | ||
| 'profile_url': '', | ||
| 'role_name': None, | ||
| 'slack_id': None, | ||
| 'team_name': None, | ||
| 'user_id': '[email protected]'}}], | ||
| 'table_writer': {'application_url': 'https://test-test.test.test', | ||
| 'description': 'This is a test', | ||
| 'id': 'test_id', | ||
| 'kind': None, | ||
| 'name': 'test_name'}, | ||
| 'tags': [], | ||
| 'watermarks': [{'create_time': '', | ||
| 'partition_key': 'ds', | ||
| 'partition_value': '', | ||
| 'watermark_type': 'low_watermark'}, | ||
| {'create_time': '', | ||
| 'partition_key': 'ds', | ||
| 'partition_value': '', | ||
| 'watermark_type': 'high_watermark'}]} | ||
| def test_sort_prog_descriptions_returns_value_from_config(self) -> None: | ||
| """ | ||
| Verify the method will return the display order from the programmtic description | ||
| configuration if it exists for the given source | ||
| :return: | ||
| """ | ||
| with local_app.app_context(): | ||
| mock_order = 1 | ||
| mock_config = { | ||
| "c_1": { | ||
| "display_order": mock_order | ||
| } | ||
| } | ||
| in_config_value = {'source': 'c_1', 'text': 'I am a test'} | ||
| self.assertEqual(_sort_prog_descriptions(mock_config, in_config_value), mock_order) | ||
|
|
||
| def test_marshal_table_full(self) -> None: | ||
| def test_sort_prog_descriptions_returns_default_value(self) -> None: | ||
| """ | ||
| Verify the method will return the expected default value if programmtic decsription | ||
| source is not included in teh configuration | ||
| :return: | ||
| """ | ||
| with local_app.app_context(): | ||
| actual_result = marshall_table_full(self.input_data) | ||
| self.assertEqual(actual_result, self.expected_data) | ||
| mock_config = { | ||
| "c_1": { | ||
| "display_order": 0 | ||
| } | ||
| } | ||
| not_in_config_value = {'source': 'test', 'text': 'I am a test'} | ||
| self.assertEqual(_sort_prog_descriptions(mock_config, not_in_config_value), len(mock_config)) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ttannis @feng-tao same issue with the truthy conditions here as well. if this value is null then this is breaking the UI. 😢
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@verdan is this for the case of the quickstart as well? In practice the metadata service is supposed to be returning an empty array/list for this.
We can fix all these cases but I do want to understand if this is either a confirmed quickstart issue, if it is affecting your use of Amundsen at ING, or if you're just calling this out to be addressed in the future. Will help prioritize how soon I go through and look for all these cases that may have been introduced in 2.1.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ttannis
I am using the latest version of both frontend and metadata and it's failing.
Two things here:
Tablemodel in amundsen common says the default value of this variable is None. i.e.,programmatic_descriptions: Optional[List[ProgrammaticDescription]] = NoneHowever, in my opinion it should be
programmatic_descriptions: Optional[List[ProgrammaticDescription]] = []or even this will work:
programmatic_descriptions: List[ProgrammaticDescription] = []There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let me know if I can be of any help. It seems like the amundsen common change would be an easy solution?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samshuster I think that would be correct. I was under the impression the metadata service would be returning an empty list, and should have sanity checked the code in the metada library to ensure this was the case.
@verdan thanks for flagging this. Either of you can feel free to fix if you are able to get to it before I can, and we will be sure to get the PR through and create a new release to unblock as soon as possible.