Refactor aggregate #708
Open
Refactor aggregate #708
Conversation
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
Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
OVI3D0
requested review from
IanHoang,
gkamat,
beaioun,
cgchinmay,
rishabh6788 and
VijayanB
as code owners
IanHoang
requested changes
Dec 16, 2024
| # extract the necessary data from the first test execution, since the configurations should be identical for all test executions | ||
| return aggregated_results | ||
|
|
||
| def update_config_object(self, test_execution): |
There was a problem hiding this comment.
If using type hints for methods in this class, we should ensure all methods have type hints:
def update_config_object(self, test_execution: TestExecution) -> None:
| self.config.add(config.Scope.applicationOverride, "builder", "plugin.params", test_exe.plugin_params) | ||
| self.config.add(config.Scope.applicationOverride, "workload", "latency.percentiles", test_exe.latency_percentiles) | ||
| self.config.add(config.Scope.applicationOverride, "workload", "throughput.percentiles", test_exe.throughput_percentiles) | ||
| self.update_config_object(test_exe) |
There was a problem hiding this comment.
This is nice, makes build_aggregated_results() easier to read
| all_jsons = [self.test_store.find_by_test_execution_id(id).results for id in self.test_executions.keys()] | ||
|
|
||
| # retrieve nested value from a dictionary given a key path | ||
| def get_nested_value(obj: Dict[str, Any], path: List[str]) -> Any: |
There was a problem hiding this comment.
Nit: We should avoid vague terms like obj or path if possible as it doesn't inform the reader what these are and might make them insert debugging statements to find out what they are. Possible replacements for obj could be json_obj, json_data, json_content, metric_data, nested_json, or others you might have. path works but might be better to make it plural so that users know it's a group of keys.
| @@ -66,8 +66,7 @@ def aggregate_helper(objects: List[Any]) -> Any: | |||
| if not objects: | |||
There was a problem hiding this comment.
Nit: Two comments here:
- While naming it a helper is fine since it is restricted to the scope of
aggregate_by_json_key, it would be better to name it something that more closely describes what it does. - Also, it would help to add a quick comment to each if statement describing what it's doing. Would improve the readability.
| self.accumulated_iterations[test_execution_id][task_name] = iterations | ||
| else: | ||
| raise ValueError(f"Test procedure '{self.test_procedure_name}' not found in the loaded workload.") | ||
| for task in self.loaded_workload.find_test_procedure_or_default(self.test_procedure_name).schedule: |
| self.config.add(config.Scope.applicationOverride, "workload", "latency.percentiles", test_execution.latency_percentiles) | ||
| self.config.add(config.Scope.applicationOverride, "workload", "throughput.percentiles", test_execution.throughput_percentiles) | ||
|
|
||
| def build_aggregated_results(self): |
There was a problem hiding this comment.
We should add a return type hint
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Refactor the aggregate feature to make individual functions more single-purpose, as well as renaming variables and adding more explanatory comments.
Testing
New functionality includes testing
make testBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.