refactor and document formatters #4014
Merged
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
diitaz93
reviewed
Dec 10, 2024
cg/services/deliver_files/deliver_files_service/deliver_files_service.py
Outdated
Show resolved
Hide resolved
diitaz93
reviewed
Dec 11, 2024
| @@ -2,15 +2,15 @@ | |||
| from pathlib import Path | |||
diitaz93
reviewed
Dec 11, 2024
| delivery_path: The path to deliver the files to | ||
| """ | ||
| LOG.debug("[FORMAT SERVICE] Formatting case files") | ||
| """Format the case files to deliver and return the formatted files.""" |
ChrOertlin
commented
Dec 11, 2024
cg/services/deliver_files/file_formatter/component_files/case_service.py
Outdated
Show resolved
Hide resolved
|
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
Refactors the formatter logic of the delivery services.
Adds Documentation to the formatter logic
The formatting logic was a bit unstructured and difficult to deal with. I tried to add some more logic to it by introducing same name space boundaries, reducing the amount of logic and hopefully a clearer build structure.
The formatting happens on three levels.
individual path names
path names bundled for certain components (case, sample, mutant)
destination (where files should be delivered to, i.e. a generic base path or a customer inbox)
A siimilar logic was applied to the Filemover service, i.e. CustomerInboxFileMover and BaseFileMover inherit from DestinationFileMover
Added
Changed
Fixed
How to prepare for test
uspaxaHow to test
Expected test outcome
Review
Thanks for filling in who performed the code review and the test!
This version is a
Implementation Plan