Skip to content

Validate add-on ID format #44

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 1, 2025
Merged

Validate add-on ID format #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca2bba4
Validate add-on ID format
seanbudd Jul 1, 2025
33b1a92
fix tests
seanbudd Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions _tests/test_validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,46 @@ def test_invalidJSONDataAndPath(self):
errors
)

@patch('os.path.basename', return_value="invalid addon id")
def test_invalidAddonIdFormat_spaces(self, mock_basename):
""" Error when submission does not include correct addonId format
"""
self.submissionData['addonId'] = "invalid addon id"
self.manifest['name'] = "invalid addon id"
errors = list(
validate.checkAddonId(self.manifest, VALID_SUBMISSION_JSON_FILE, self.submissionData)
)

self.assertEqual(
[ # expected errors
"Submission data 'addonId' field does not match the expected format:"
" must start and end with a letter, and contain only letters,"
" numbers, and hyphens. "
"ID: invalid addon id"
],
errors
)

@patch('os.path.basename', return_value="1invalid-addon-id")
def test_invalidAddonIdFormat_invalidStartChar(self, mock_basename):
""" Error when submission does not include correct addonId format
"""
self.submissionData['addonId'] = "1invalid-addon-id"
self.manifest['name'] = "1invalid-addon-id"
errors = list(
validate.checkAddonId(self.manifest, VALID_SUBMISSION_JSON_FILE, self.submissionData)
)

self.assertEqual(
[ # expected errors
"Submission data 'addonId' field does not match the expected format:"
" must start and end with a letter, and contain only letters,"
" numbers, and hyphens. "
"ID: 1invalid-addon-id"
],
errors
)


@dataclass
class VersionNumber:
Expand Down
7 changes: 7 additions & 0 deletions _validate/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,13 @@ def checkAddonId(
"Submission data 'addonId' field does not match 'name' field in addon manifest:"
f" {expectedName} vs {submission['addonId']}"
)
if not re.match(r"^[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]$", expectedName):
yield (
"Submission data 'addonId' field does not match the expected format:"
" must start and end with a letter, and contain only letters,"
" numbers, and hyphens. "
f"ID: {submission['addonId']}"
)


VERSION_PARSE = re.compile(r"^(\d+)(?:$|(?:\.(\d+)$)|(?:\.(\d+)\.(\d+)$))")
Expand Down