-
Notifications
You must be signed in to change notification settings - Fork 18
fix: enhance manifest handling by validating and expanding YAML docum… #1022
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
Open
anson627
wants to merge
1
commit into
main
Choose a base branch
from
fix-yaml-mapping-or-list-handling
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -5993,6 +5993,256 @@ def test_get_config_map_with_labels_and_annotations(self, mock_read_config_map): | |
| self.assertEqual(result.metadata.annotations["description"], "Test configuration") | ||
| self.assertEqual(result.data["database.url"], "mysql://localhost:3306/testdb") | ||
|
|
||
| def test_expand_and_validate_manifests_with_valid_dict(self): | ||
| """Test _expand_and_validate_manifests with valid dictionary manifest.""" | ||
| manifests = [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-namespace'} | ||
| } | ||
| ] | ||
|
|
||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
||
|
|
||
| self.assertEqual(len(result), 1) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
| self.assertEqual(result[0]['metadata']['name'], 'test-namespace') | ||
|
|
||
| def test_expand_and_validate_manifests_with_list_kind(self): | ||
| """Test _expand_and_validate_manifests with kind: List manifest.""" | ||
| manifests = [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'List', | ||
| 'items': [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-ns-1'} | ||
| }, | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Service', | ||
| 'metadata': {'name': 'test-service', 'namespace': 'default'} | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
|
|
||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| self.assertEqual(len(result), 2) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
| self.assertEqual(result[0]['metadata']['name'], 'test-ns-1') | ||
| self.assertEqual(result[1]['kind'], 'Service') | ||
| self.assertEqual(result[1]['metadata']['name'], 'test-service') | ||
|
|
||
| def test_expand_and_validate_manifests_with_nested_list_kind(self): | ||
| """Test _expand_and_validate_manifests with nested kind: List manifests.""" | ||
| manifests = [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'List', | ||
| 'items': [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-ns-1'} | ||
| }, | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'List', | ||
| 'items': [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'ConfigMap', | ||
| 'metadata': {'name': 'test-cm', 'namespace': 'default'} | ||
| }, | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Secret', | ||
| 'metadata': {'name': 'test-secret', 'namespace': 'default'} | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
|
|
||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| self.assertEqual(len(result), 3) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
| self.assertEqual(result[1]['kind'], 'ConfigMap') | ||
| self.assertEqual(result[2]['kind'], 'Secret') | ||
|
|
||
| def test_expand_and_validate_manifests_with_non_dict_list(self): | ||
| """Test _expand_and_validate_manifests with list (not dict) manifest - should be skipped.""" | ||
| manifests = [ | ||
| ['item1', 'item2', 'item3'], | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-namespace'} | ||
| } | ||
| ] | ||
|
|
||
| with self.assertLogs('clients.kubernetes_client', level='WARNING') as log: | ||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| # Only the valid dict should be returned | ||
| self.assertEqual(len(result), 1) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
|
|
||
| # Check warning was logged | ||
| self.assertTrue(any('Skipping non-dictionary manifest' in message for message in log.output)) | ||
| self.assertTrue(any('list' in message for message in log.output)) | ||
|
|
||
| def test_expand_and_validate_manifests_with_scalar(self): | ||
| """Test _expand_and_validate_manifests with scalar manifest - should be skipped.""" | ||
| manifests = [ | ||
| 'just a string', | ||
| 42, | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-namespace'} | ||
| } | ||
| ] | ||
|
|
||
| with self.assertLogs('clients.kubernetes_client', level='WARNING') as log: | ||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| # Only the valid dict should be returned | ||
| self.assertEqual(len(result), 1) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
|
|
||
| # Check warnings were logged for both scalar values | ||
| warning_messages = [msg for msg in log.output if 'Skipping non-dictionary manifest' in msg] | ||
| self.assertEqual(len(warning_messages), 2) | ||
|
|
||
| def test_expand_and_validate_manifests_with_none_and_empty(self): | ||
| """Test _expand_and_validate_manifests with None and empty manifests - should be skipped.""" | ||
| manifests = [ | ||
| None, | ||
| {}, | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'Namespace', | ||
| 'metadata': {'name': 'test-namespace'} | ||
| }, | ||
| None | ||
| ] | ||
|
|
||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| # Both None and empty dict are skipped, only valid Namespace is kept | ||
| self.assertEqual(len(result), 1) | ||
| self.assertEqual(result[0]['kind'], 'Namespace') | ||
|
|
||
| def test_expand_and_validate_manifests_with_list_kind_invalid_items(self): | ||
| """Test _expand_and_validate_manifests with kind: List but invalid items field.""" | ||
| manifests = [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'List', | ||
| 'items': 'not-a-list' # Invalid: should be a list | ||
| } | ||
| ] | ||
|
|
||
| with self.assertLogs('clients.kubernetes_client', level='WARNING') as log: | ||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| # No items should be returned since items field is invalid | ||
| self.assertEqual(len(result), 0) | ||
|
|
||
| # Check warning was logged | ||
| self.assertTrue(any('invalid' in message.lower() and 'items' in message for message in log.output)) | ||
|
|
||
| def test_expand_and_validate_manifests_with_list_kind_missing_items(self): | ||
| """Test _expand_and_validate_manifests with kind: List but missing items field.""" | ||
| manifests = [ | ||
| { | ||
| 'apiVersion': 'v1', | ||
| 'kind': 'List' | ||
| # items field is missing | ||
| } | ||
| ] | ||
|
|
||
| result = self.client._expand_and_validate_manifests(manifests) | ||
|
|
||
| # No items should be returned since items field is missing (defaults to []) | ||
| self.assertEqual(len(result), 0) | ||
|
|
||
| @patch('requests.get') | ||
| @patch('clients.kubernetes_client.KubernetesClient._apply_single_manifest') | ||
| def test_apply_manifest_from_url_with_list_kind(self, mock_apply_single, mock_requests_get): | ||
| """Test apply_manifest_from_url with kind: List manifest.""" | ||
| mock_response = MagicMock() | ||
| mock_response.text = """ | ||
| apiVersion: v1 | ||
| kind: List | ||
| items: | ||
| - apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| name: test-namespace | ||
| - apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: test-config | ||
| namespace: test-namespace | ||
| data: | ||
| key: value | ||
| """ | ||
| mock_response.raise_for_status.return_value = None | ||
| mock_requests_get.return_value = mock_response | ||
|
|
||
| self.client.apply_manifest_from_url("https://example.com/list-manifest.yaml") | ||
|
|
||
| # Verify both items from the List were applied | ||
| self.assertEqual(mock_apply_single.call_count, 2) | ||
|
|
||
| # Check first item (Namespace) | ||
| first_manifest = mock_apply_single.call_args_list[0][0][0] | ||
| self.assertEqual(first_manifest['kind'], 'Namespace') | ||
| self.assertEqual(first_manifest['metadata']['name'], 'test-namespace') | ||
|
|
||
| # Check second item (ConfigMap) | ||
| second_manifest = mock_apply_single.call_args_list[1][0][0] | ||
| self.assertEqual(second_manifest['kind'], 'ConfigMap') | ||
| self.assertEqual(second_manifest['metadata']['name'], 'test-config') | ||
|
|
||
| @patch('requests.get') | ||
| @patch('clients.kubernetes_client.KubernetesClient._apply_single_manifest') | ||
| def test_apply_manifest_from_url_with_non_dict_manifest(self, mock_apply_single, mock_requests_get): | ||
| """Test apply_manifest_from_url with non-dict YAML document - should be skipped.""" | ||
| mock_response = MagicMock() | ||
| mock_response.text = """ | ||
| - item1 | ||
| - item2 | ||
| - item3 | ||
| --- | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| name: test-namespace | ||
| """ | ||
| mock_response.raise_for_status.return_value = None | ||
| mock_requests_get.return_value = mock_response | ||
|
|
||
| with self.assertLogs('clients.kubernetes_client', level='WARNING') as log: | ||
| self.client.apply_manifest_from_url("https://example.com/mixed-manifest.yaml") | ||
|
|
||
| # Only the valid Namespace should be applied | ||
| self.assertEqual(mock_apply_single.call_count, 1) | ||
| applied_manifest = mock_apply_single.call_args[0][0] | ||
| self.assertEqual(applied_manifest['kind'], 'Namespace') | ||
|
|
||
| # Check warning was logged | ||
| self.assertTrue(any('Skipping non-dictionary manifest' in message for message in log.output)) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() | ||
Oops, something went wrong.
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.
This info-level log message for expanding List manifests may create excessive noise in logs, especially for large deployments or frequent manifest operations. Consider using debug level instead:
logger.debug(...)to keep info logs focused on significant operations.