This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
Fix bug in the convert-cisagov command
#9
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
The itertools.groupby() function only correctly functions if the list it is grouping is pre-sorted in the same manner as the grouping key. If the list is not similarly sorted it will result in lost list items. We also switch to using `.lower()` instead of `.upper()` to be consistent with other sorting in this project.
mcdonnnj
added
bug
Pull Request Test Coverage Report for Build 1725465369
💛 - Coveralls |
dav3r
approved these changes
Jan 20, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
This pull request fixes a bug in the
convert-cisagovcommand's functionality that resulted in rows being dropped while grouping. Additionally debug output was added to provide good indicators on things processing correctly if needed.💭 Motivation and context
This bug resulted in row from the Markdown file being read in getting dropped when using
itertool.groupby(). The root cause is that the source list needs to be sorted using the same logic that is used to group elements.🧪 Testing
Automated tests pass. I confirmed with the new debug output that the same number of rows that were read in were in the grouped data and that output files looked appropriate.
✅ Pre-approval checklist