[Resolves #1268] Modify ConfigFileNotFound Error to Conditionally Include Valid Stack Paths #1270
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
sceptre/plan/plan.py
Outdated
Comment on lines
63
to
72
| command_path = pathlib.PurePath(self.context.command_path) | ||
| filtered_valid_stack_paths = [] | ||
| for stack_path in self._valid_stack_paths(): | ||
| for parent in pathlib.PurePath(stack_path).parents: | ||
| if command_path.parent == parent: | ||
| filtered_valid_stack_paths.append(stack_path) | ||
| break | ||
| if filtered_valid_stack_paths and len(filtered_valid_stack_paths) > MAX_VALID_STACK_PATH_COUNT: | ||
| filtered_valid_stack_paths = None | ||
| break |
There was a problem hiding this comment.
A few thoughts on this:
- This seems rather deeply nested. I'd like to avoid getting so nested, especially in this function. It hurts readability. I also don't think we need to do it this way.
- Rather than crawling every combination of segments and comparing parents, I don't think we need to get that intense about it. Rather, I think a simpler and more straight-forward logic here would be to do this:
- Check if there's a "/" in the command path. If not, then the prefix to use is
''(all strings technically start with''). If there IS, doprefix, _ = command_path.rsplit('/' 1)to get the prefix. - Filter the valid paths for those that start with the prefix. You can either use
filter()or a list comprehension.
- Check if there's a "/" in the command path. If not, then the prefix to use is
Done this way, it would look more like:
Suggested change
| command_path = pathlib.PurePath(self.context.command_path) | |
| filtered_valid_stack_paths = [] | |
| for stack_path in self._valid_stack_paths(): | |
| for parent in pathlib.PurePath(stack_path).parents: | |
| if command_path.parent == parent: | |
| filtered_valid_stack_paths.append(stack_path) | |
| break | |
| if filtered_valid_stack_paths and len(filtered_valid_stack_paths) > MAX_VALID_STACK_PATH_COUNT: | |
| filtered_valid_stack_paths = None | |
| break | |
| if '/' in self.context.command_path: | |
| prefix, _ = self.context.command_path.rsplit('/', 1) | |
| else: | |
| prefix = '' | |
| all_paths = self._valid_stack_paths() | |
| # We'll fall back to all_paths if no valid path starts with the prefix | |
| filtered_valid_stack_paths = [p for p in all_paths if p.startswith(prefix + '/')] or all_paths | |
| if len(filtered_valid_stack_paths) > MAX_VALID_STACK_PATH_COUNT: | |
| filtered_valid_stack_paths = [] |
There was a problem hiding this comment.
Refactored function to use this suggestion with pathlib rather than / processing.
jfalkenstein
requested changes
Nov 29, 2022
X-Guardian
force-pushed
the
1268-Valid-Stack-Paths
branch
from
fe7bc0b
to
de92670
Compare
|
@X-Guardian, what are the status on the tests for this PR? |
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.
Modifies the Sceptre Plan
ConfigFileNotFounderror to only include the list of valid stack paths from the command path specified and only there are less than 10 stacks.Example
New Error Message (when there are less than 10 stacks under the specified parent path)
New Error Message (when there are 10 stacks or more under the specified parent path)
PR Checklist
[Resolve #issue-number].make test) are passing.pre-commit run --all-files).and description in grammatically correct, complete sentences.
Approver/Reviewer Checklist
Other Information
Guide to writing a good commit