Detect invalid characters in file/directory names #116
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #116 +/- ##
==========================================
+ Coverage 59.77% 59.97% +0.19%
==========================================
Files 39 39
Lines 2603 2616 +13
==========================================
+ Hits 1556 1569 +13
Misses 920 920
Partials 127 127 ☔ View full report in Codecov by Sentry. |
mcantelon
force-pushed
the
dev/check-name-chars
branch
from
935049c to
a498615
Compare
mcantelon
force-pushed
the
dev/check-name-chars
branch
4 times, most recently
from
d2a330f to
0b76296
Compare
jraddaoui
requested changes
Jan 23, 2025
| @@ -180,6 +196,13 @@ func TestValidateStructure(t *testing.T) { | |||
| Failures: []string{"More than one dossier in the content directory"}, | |||
| }, | |||
| }, | |||
| { | |||
| name: "Returns a failure when a SIP a directory name with an invalid character", | |||
Comment on lines
181
to
186
| validChars := "-_.()" | ||
|
|
||
| // Generate string containing valid characters. | ||
| validChars = appendRuneRange(validChars, 'a', 'z') | ||
| validChars = appendRuneRange(validChars, 'A', 'Z') | ||
| validChars = appendRuneRange(validChars, '0', '9') |
There was a problem hiding this comment.
This is nice, but I think it would be a lot clearer with a long string constant. It will also prevent from calculating it each time.
|
Thanks @jraddaoui ! PR updated! |
jraddaoui
approved these changes
Jan 24, 2025
| func validateName(name string) bool { | ||
| const validChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_.()" | ||
|
|
||
| // Make sure only valid characters exist in name. |
There was a problem hiding this comment.
This type of comments are better above the function name:
// validateName makes sure only valid characters exist in name.
func validateName(name string) bool {
Not a big deal in this case for a small private function, but that way it documents the function and you can read it when you use it.
Added logic to validate structure to return validation errors if a file or directory's name contains characters incompatible with Archivematica.
mcantelon
force-pushed
the
dev/check-name-chars
branch
from
0dd3aa8 to
d763a0f
Compare
|
Thanks @jraddaoui ! |
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.
Added logic to validate structure to return validation errors if a file or directory's name contains characters incompatible with Archivematica.