-
Notifications
You must be signed in to change notification settings - Fork 261
Fix: allow dots in GitHub repository names (closes #7776) #7934
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pinakiz
wants to merge
5
commits into
taskcluster:main
Choose a base branch
from
pinakiz:fix-#7776
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
39cbf62
Fix: allow dots in GitHub repository names (closes #7776)
pinakiz 5d9f355
chore(changelog): add changelog entry for issue #7776
pinakiz c222b17
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] f2db39f
Done: added tests and improved comment.
pinakiz d641cd9
Delete ca.pem
pinakiz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
audience: developers | ||
level: patch | ||
reference: issue 7776 | ||
--- | ||
Fixed schema to allow `.` in GitHub repository names. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
import helper from './helper.js'; | ||
import assert from 'assert'; | ||
import fs from 'fs'; | ||
import yaml from 'js-yaml'; | ||
|
||
helper.secrets.mockSuite('github-identifier-pattern', [], function(mock, skipping) { | ||
suiteSetup(async function() { | ||
if (skipping()) return; | ||
const constantsYaml = fs.readFileSync('../schemas/constants.yml', 'utf8'); | ||
const constants = yaml.load(constantsYaml); | ||
|
||
this.githubPattern = new RegExp(constants['github-identifier-pattern']); | ||
this.minLength = constants['github-identifier-min-length']; | ||
this.maxLength = constants['github-identifier-max-length']; | ||
}); | ||
|
||
function testLengthConstraints(id) { | ||
assert.ok(id.length >= this.minLength, `"${id}" is shorter than min length`); | ||
assert.ok(id.length <= this.maxLength, `"${id}" is longer than max length`); | ||
} | ||
|
||
test('valid GitHub identifiers', function() { | ||
const validIdentifiers = [ | ||
'abc123', | ||
'org-name', | ||
'my_repo', | ||
'repo123', | ||
'ORG-Repo', | ||
'abc.def', | ||
'name_with_underscores', | ||
'name%repo', | ||
'percent%encoded', | ||
'a', | ||
'a'.repeat(100), | ||
]; | ||
|
||
validIdentifiers.forEach(id => { | ||
assert.ok(this.githubPattern.test(id), `Expected "${id}" to match github-identifier-pattern`); | ||
testLengthConstraints.call(this, id); | ||
}); | ||
}); | ||
|
||
test('invalid GitHub identifiers', function() { | ||
const invalidIdentifiers = [ | ||
'with space', | ||
'repo!', | ||
'abc$123', | ||
'@org/repo', | ||
'org/repo', | ||
'org//repo', | ||
'repo#1', | ||
'😀emoji', | ||
'a'.repeat(101), | ||
]; | ||
|
||
invalidIdentifiers.forEach(id => { | ||
const matchesPattern = this.githubPattern.test(id); | ||
const exceedsLength = id.length > this.maxLength; | ||
assert.ok(!matchesPattern || exceedsLength, `Expected "${id}" to be invalid`); | ||
}); | ||
}); | ||
|
||
test('edge cases for GitHub identifiers', function() { | ||
const edgeCases = [ | ||
'a-b_c', | ||
'repo-underscore_only_', | ||
'repo-dash-only-', | ||
'abc.def%ghi', | ||
]; | ||
edgeCases.forEach(id => { | ||
assert.ok(this.githubPattern.test(id), `Expected "${id}" to match github-identifier-pattern`); | ||
testLengthConstraints.call(this, id); | ||
}); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you please run
yarn generate
to update all autogenerated schemas as well? Or just let me know, I can run itThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I didn't spot any tests that would cover such checks. Would you be comfortable checking if you could add some new tests for repositories with dots?
Might be tricky to setup data for the tests though, I suggest starting with api_test.js
Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I allow '%' ? Since ' . ' is later transformed into '%', allowing '%' could create ambiguity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The git_Identifier_pattern also allows whitespace-only strings. Is this something we should be concerned about?"