BootflashFiles() address tech debt #555
Open
+303
−198
Conversation
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 commit addresses tech debt in class BootflashFile. The main changes are: - Remove class decorators in favor of class properties - Simplify logic in refresh_switch_details - Update unit-tests to align with changes Details 1. Remove class decorators 1a. Properties.add_rest_send 1b. Properties.add_results 2. Remove import for Properties 3. Add class properties for RestSend and Results 4. Import Results and RestSend for use in validation in their respective properties 5. import Typing.Literal for use in rest_send and results properties. 6. BootflashFiles.refresh_switch_details 6a. Diff lines 150-168, because rest_send validation occurs in the setter and getter, we can remove validation from refresh_switch_details and simplify this method. 7. test_bootflash_files.py 7a. test_bootflash_files_00000 - add asserts for rest_send and results 7b. test_bootflash_files_00100 - modify assert for earlier validation of rest_send 7c. test_bootflash_files_00110. modify assert for earlier validation of rest_send 7c. test_bootflash_files_00120. Remove. Results() is now initialized in BootflashFiles.__init__()
No functional changes in this commit. 1. Add pylint directive to suppress invalid-name 2 black reformating lines for more relaxed line length
No functional changs in this commit.
No functional changes in this commit 1. Add pylint directive to suppress invalid-name 2 black reformating lines for more relaxed line length
1. Add type-hints 2. Add two methods to verify proper instantiation of rest_send and switch_details - _rest_send_instantiated - _switch_details_instantiated 3. add_file_to_existing_payload - Simplify logic 4. test_bootflash_files.py - Update all unit tests to reflect changes to BootflashFiles. - Some unit-tests started to fail because item 2 improved detection of improperly-validated RestSend and SwitchDetails. These tests were fixed. Mainly this had to do with switch_details.rest_send not being set.
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.
Address tech debt within BootflashFiles
NOTE: This PR cannot be completed until #553 is merged.
Summary
Add type-hints
Remove class decorators and replace with local properties for RestSend and Results
Add pylint directive to suppress invalid-name
black reformatting lines for more relaxed line length
refresh_switch_details(), simplify
Add two methods to verify proper instantiation of rest_send and switch_details
add_file_to_existing_payload(), simplify logic
test_bootflash_files.py