chore: Clean up release-related constants (#13604)

Clean up in prep for fixing a releases endpoint bug: - `VERSION_LENGTH` -> `MAX_VERSION_LENGTH` for clarity and consistency with other max constants - new `MAX_COMMIT_LENGTH` - move `BAD_RELEASE_CHARS` and `COMMIT_RANGE_DELIMITER` to `constants.py`
getsentry · Jun 10, 2019 · 13af8f5 · 13af8f5
1 parent 880d00b
commit 13af8f5
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 34 deletions.
diff --git a/src/sentry/api/serializers/rest_framework/release.py b/src/sentry/api/serializers/rest_framework/release.py
@@ -4,31 +4,31 @@
 
 from sentry.api.serializers.rest_framework import CommitSerializer, ListField
 from sentry.api.fields.user import UserField
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import MAX_COMMIT_LENGTH, MAX_VERSION_LENGTH
 from sentry.models import Release
 
 
 class ReleaseHeadCommitSerializerDeprecated(serializers.Serializer):
-    currentId = serializers.CharField(max_length=64)
+    currentId = serializers.CharField(max_length=MAX_COMMIT_LENGTH)
     repository = serializers.CharField(max_length=64)
-    previousId = serializers.CharField(max_length=64, required=False)
+    previousId = serializers.CharField(max_length=MAX_COMMIT_LENGTH, required=False)
 
 
 class ReleaseHeadCommitSerializer(serializers.Serializer):
-    commit = serializers.CharField(max_length=64)
+    commit = serializers.CharField(max_length=MAX_COMMIT_LENGTH)
     repository = serializers.CharField(max_length=200)
-    previousCommit = serializers.CharField(max_length=64, required=False)
+    previousCommit = serializers.CharField(max_length=MAX_COMMIT_LENGTH, required=False)
 
 
 class ReleaseSerializer(serializers.Serializer):
-    ref = serializers.CharField(max_length=VERSION_LENGTH, required=False)
+    ref = serializers.CharField(max_length=MAX_VERSION_LENGTH, required=False)
     url = serializers.URLField(required=False)
     dateReleased = serializers.DateTimeField(required=False)
     commits = ListField(child=CommitSerializer(), required=False, allow_null=False)
 
 
 class ReleaseWithVersionSerializer(ReleaseSerializer):
-    version = serializers.CharField(max_length=VERSION_LENGTH, required=True)
+    version = serializers.CharField(max_length=MAX_VERSION_LENGTH, required=True)
     owner = UserField(required=False)
 
     def validate_version(self, attrs, source):

diff --git a/src/sentry/constants.py b/src/sentry/constants.py
@@ -39,7 +39,10 @@ def get_all_languages():
 MODULE_ROOT = os.path.dirname(__import__('sentry').__file__)
 DATA_ROOT = os.path.join(MODULE_ROOT, 'data')
 
-VERSION_LENGTH = 200
+BAD_RELEASE_CHARS = '\n\f\t/'
+MAX_VERSION_LENGTH = 200
+MAX_COMMIT_LENGTH = 64
+COMMIT_RANGE_DELIMITER = '..'
 
 SORT_OPTIONS = OrderedDict(
     (

diff --git a/src/sentry/models/release.py b/src/sentry/models/release.py
@@ -23,6 +23,7 @@
     JSONField, Model, sane_repr
 )
 
+from sentry.constants import BAD_RELEASE_CHARS, COMMIT_RANGE_DELIMITER
 from sentry.models import CommitFileChange
 from sentry.signals import issue_resolved
 
@@ -35,9 +36,7 @@
 
 _sha1_re = re.compile(r'^[a-f0-9]{40}$')
 _dotted_path_prefix_re = re.compile(r'^([a-zA-Z][a-zA-Z0-9-]+)(\.[a-zA-Z][a-zA-Z0-9-]+)+-')
-BAD_RELEASE_CHARS = '\n\f\t/'
 DB_VERSION_LENGTH = 250
-COMMIT_RANGE_DELIMITER = '..'
 
 
 class ReleaseProject(Model):

diff --git a/tests/sentry/api/endpoints/test_organization_release_details.py b/tests/sentry/api/endpoints/test_organization_release_details.py
@@ -4,7 +4,7 @@
 from datetime import datetime
 from django.core.urlresolvers import reverse
 
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import MAX_VERSION_LENGTH
 from sentry.models import (
     Activity, Environment, File, Release, ReleaseCommit, ReleaseFile, ReleaseProject, ReleaseProjectEnvironment, Repository
 )
@@ -760,10 +760,10 @@ def test_do_not_allow_null_refs(self):
 
     def test_ref_limited_by_max_version_length(self):
         serializer = OrganizationReleaseSerializer(data={
-            'ref': 'a' * VERSION_LENGTH,
+            'ref': 'a' * MAX_VERSION_LENGTH,
         })
         assert serializer.is_valid()
         serializer = OrganizationReleaseSerializer(data={
-            'ref': 'a' * (VERSION_LENGTH + 1),
+            'ref': 'a' * (MAX_VERSION_LENGTH + 1),
         })
         assert not serializer.is_valid()
diff --git a/tests/sentry/api/endpoints/test_organization_releases.py b/tests/sentry/api/endpoints/test_organization_releases.py
@@ -11,12 +11,11 @@
 from exam import fixture
 
 from sentry.api.endpoints.organization_releases import ReleaseSerializerWithProjects
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import BAD_RELEASE_CHARS, MAX_VERSION_LENGTH
 from sentry.models import (
     Activity,
     ApiKey,
     ApiToken,
-    BAD_RELEASE_CHARS,
     Commit,
     CommitAuthor,
     CommitFileChange,
@@ -1447,24 +1446,24 @@ def test_ref_limited_by_max_version_length(self):
         serializer = ReleaseSerializerWithProjects(data={
             'version': self.version,
             'projects': self.projects,
-            'ref': 'a' * VERSION_LENGTH,
+            'ref': 'a' * MAX_VERSION_LENGTH,
         })
         assert serializer.is_valid()
         serializer = ReleaseSerializerWithProjects(data={
             'version': self.version,
             'projects': self.projects,
-            'ref': 'a' * (VERSION_LENGTH + 1),
+            'ref': 'a' * (MAX_VERSION_LENGTH + 1),
         })
         assert not serializer.is_valid()
 
     def test_version_limited_by_max_version_length(self):
         serializer = ReleaseSerializerWithProjects(data={
-            'version': 'a' * VERSION_LENGTH,
+            'version': 'a' * MAX_VERSION_LENGTH,
             'projects': self.projects,
         })
         assert serializer.is_valid()
         serializer = ReleaseSerializerWithProjects(data={
-            'version': 'a' * (VERSION_LENGTH + 1),
+            'version': 'a' * (MAX_VERSION_LENGTH + 1),
             'projects': self.projects,
         })
         assert not serializer.is_valid()

diff --git a/tests/sentry/api/endpoints/test_project_release_details.py b/tests/sentry/api/endpoints/test_project_release_details.py
@@ -4,7 +4,7 @@
 from django.core.urlresolvers import reverse
 
 from sentry.api.endpoints.project_release_details import ReleaseSerializer
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import MAX_VERSION_LENGTH
 from sentry.models import (Activity, File, Release, ReleaseCommit, ReleaseFile, ReleaseProject)
 from sentry.testutils import APITestCase
 
@@ -295,10 +295,10 @@ def test_do_not_allow_null_commits(self):
 
     def test_ref_limited_by_max_version_length(self):
         serializer = ReleaseSerializer(data={
-            'ref': 'a' * VERSION_LENGTH,
+            'ref': 'a' * MAX_VERSION_LENGTH,
         })
         assert serializer.is_valid()
         serializer = ReleaseSerializer(data={
-            'ref': 'a' * (VERSION_LENGTH + 1),
+            'ref': 'a' * (MAX_VERSION_LENGTH + 1),
         })
         assert not serializer.is_valid()
diff --git a/tests/sentry/api/endpoints/test_project_releases.py b/tests/sentry/api/endpoints/test_project_releases.py
@@ -6,9 +6,8 @@
 from exam import fixture
 
 from sentry.api.endpoints.project_releases import ReleaseWithVersionSerializer
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import BAD_RELEASE_CHARS, MAX_VERSION_LENGTH
 from sentry.models import (
-    BAD_RELEASE_CHARS,
     CommitAuthor,
     CommitFileChange,
     Environment,
@@ -743,22 +742,22 @@ def test_do_not_allow_null_commits(self):
     def test_ref_limited_by_max_version_length(self):
         serializer = ReleaseWithVersionSerializer(data={
             'version': self.version,
-            'ref': 'a' * VERSION_LENGTH,
+            'ref': 'a' * MAX_VERSION_LENGTH,
         })
         assert serializer.is_valid()
         serializer = ReleaseWithVersionSerializer(data={
             'version': self.version,
-            'ref': 'a' * (VERSION_LENGTH + 1),
+            'ref': 'a' * (MAX_VERSION_LENGTH + 1),
         })
         assert not serializer.is_valid()
 
     def test_version_limited_by_max_version_length(self):
         serializer = ReleaseWithVersionSerializer(data={
-            'version': 'a' * VERSION_LENGTH,
+            'version': 'a' * MAX_VERSION_LENGTH,
         })
         assert serializer.is_valid()
         serializer = ReleaseWithVersionSerializer(data={
-            'version': 'a' * (VERSION_LENGTH + 1),
+            'version': 'a' * (MAX_VERSION_LENGTH + 1),
         })
         assert not serializer.is_valid()
 

diff --git a/tests/sentry/event_manager/test_event_manager.py b/tests/sentry/event_manager/test_event_manager.py
@@ -13,7 +13,7 @@
 from time import time
 
 from sentry.app import tsdb
-from sentry.constants import VERSION_LENGTH
+from sentry.constants import MAX_VERSION_LENGTH
 from sentry.event_manager import HashDiscarded, EventManager, EventUser
 from sentry.grouping.utils import hash_from_values
 from sentry.models import (
@@ -688,7 +688,7 @@ def test_release_project_slug(self):
 
     def test_release_project_slug_long(self):
         project = self.create_project(name='foo')
-        partial_version_len = VERSION_LENGTH - 4
+        partial_version_len = MAX_VERSION_LENGTH - 4
         release = Release.objects.create(
             version='foo-%s' % ('a' * partial_version_len, ), organization=project.organization
         )

diff --git a/tests/sentry/event_manager/test_validate_data.py b/tests/sentry/event_manager/test_validate_data.py
@@ -4,7 +4,7 @@
 
 from datetime import datetime, timedelta
 
-from sentry.constants import VERSION_LENGTH, MAX_CULPRIT_LENGTH
+from sentry.constants import MAX_VERSION_LENGTH, MAX_CULPRIT_LENGTH
 from sentry.event_manager import EventManager
 
 
@@ -174,7 +174,7 @@ def test_extra_as_string():
 
 def test_release_tag_max_len():
     release_key = u"sentry:release"
-    release_value = "a" * VERSION_LENGTH
+    release_value = "a" * MAX_VERSION_LENGTH
     data = validate_and_normalize(
         {"message": "foo", "tags": [[release_key, release_value]]}
     )
@@ -197,8 +197,8 @@ def test_site_too_long():
 
 
 def test_release_too_long():
-    data = validate_and_normalize({"release": "a" * (VERSION_LENGTH + 1)})
-    assert len(data.get("release")) == VERSION_LENGTH
+    data = validate_and_normalize({"release": "a" * (MAX_VERSION_LENGTH + 1)})
+    assert len(data.get("release")) == MAX_VERSION_LENGTH
 
 
 def test_release_as_non_string():