Backend: Add field to store github branch for challenge creation(Cloud-CV#4737)

Zahed-Riyaz · web-flow · commit 6549fcb70038 · 2025-07-10T15:41:28.000-07:00
* Store Github branch with challenge data

* Modify backend to store github branch

* Handle empty branches

* Merge migrations

* Update seed.py

* Add GitHub branch versioning support for multi-version challenges

- Update create_or_update_github_challenge to use both github_repository and github_branch for challenge lookup
- Add default branch logic: when GITHUB_REF_NAME is empty, defaults to 'challenge'
- Create combined migration 0113 that adds github_branch field and unique constraint
- Fix database seeder to use unique github values for each challenge
- Update tests to expect 'challenge' as default branch name
- Enable multiple challenge versions from same repository using different branches

Fixes issue where different branches would update existing challenges instead of creating new ones.

* Revert unnecessary changes

* Fix tests

* Update Github branch var

* Fix failing tests

* Pass flake8 and pylint tests
diff --git a/.travis.yml b/.travis.yml
@@ -81,4 +81,4 @@ notifications:
   email:
     on_success: change
     on_failure: always
-  slack: cloudcv:gy3CGQGNXLwXOqVyzXGZfdea
+  slack: cloudcv:gy3CGQGNXLwXOqVyzXGZfdea
diff --git a/apps/challenges/admin.py b/apps/challenges/admin.py
@@ -58,6 +58,7 @@ class ChallengeAdmin(ImportExportTimeStampedAdmin):
         "workers",
         "task_def_arn",
         "github_repository",
+        "github_branch",
     )
     list_filter = (
         ChallengeFilter,
@@ -75,6 +76,7 @@ class ChallengeAdmin(ImportExportTimeStampedAdmin):
         "creator__team_name",
         "slug",
         "github_repository",
+        "github_branch",
     )
     actions = [
         "start_selected_workers",
diff --git a/apps/challenges/challenge_config_utils.py b/apps/challenges/challenge_config_utils.py
@@ -586,6 +586,9 @@ def validate_serializer(self):
                     "github_repository": self.request.data[
                         "GITHUB_REPOSITORY"
                     ],
+                    "github_branch": self.request.data.get(
+                        "GITHUB_BRANCH_NAME", ""
+                    ),
                 },
             )
             if not serializer.is_valid():
diff --git a/apps/challenges/migrations/0113_add_github_branch_field_and_unique_constraint.py b/apps/challenges/migrations/0113_add_github_branch_field_and_unique_constraint.py
@@ -0,0 +1,43 @@
+# Generated by Django 2.2.20 on 2025-07-09 15:00
+
+from django.db import migrations, models
+
+
+def fix_duplicate_github_fields(apps, schema_editor):
+    """
+    No data migration needed since we're using a partial unique constraint.
+    """
+    pass
+
+
+def reverse_fix_duplicate_github_fields(apps, schema_editor):
+    """
+    No reverse migration needed.
+    """
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("challenges", "0112_challenge_sqs_retention_period"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="challenge",
+            name="github_branch",
+            field=models.CharField(
+                blank=True, default="", max_length=200, null=True
+            ),
+        ),
+        migrations.RunPython(
+            fix_duplicate_github_fields,
+            reverse_fix_duplicate_github_fields,
+        ),
+        # Add a partial unique constraint that only applies when both fields are not empty
+        migrations.RunSQL(
+            "CREATE UNIQUE INDEX challenge_github_repo_branch_partial_idx ON challenge (github_repository, github_branch) WHERE github_repository != '' AND github_branch != '';",
+            reverse_sql="DROP INDEX IF EXISTS challenge_github_repo_branch_partial_idx;",
+        ),
+    ]
diff --git a/apps/challenges/models.py b/apps/challenges/models.py
@@ -186,6 +186,10 @@ def __init__(self, *args, **kwargs):
     github_repository = models.CharField(
         max_length=1000, null=True, blank=True, default=""
     )
+    # The github branch name used to create/update the challenge
+    github_branch = models.CharField(
+        max_length=200, null=True, blank=True, default=""
+    )
     # The number of vCPU for a Fargate worker for the challenge. Default value
     # is 0.25 vCPU.
     worker_cpu_cores = models.IntegerField(null=True, blank=True, default=512)
diff --git a/apps/challenges/serializers.py b/apps/challenges/serializers.py
@@ -95,6 +95,7 @@ class Meta:
             "worker_instance_type",
             "sqs_retention_period",
             "github_repository",
+            "github_branch",
         )
 
 
@@ -256,6 +257,9 @@ def __init__(self, *args, **kwargs):
             github_repository = context.get("github_repository")
             if github_repository:
                 kwargs["data"]["github_repository"] = github_repository
+            github_branch = context.get("github_branch")
+            if github_branch:
+                kwargs["data"]["github_branch"] = github_branch
 
     class Meta:
         model = Challenge
@@ -294,6 +298,7 @@ class Meta:
             "max_docker_image_size",
             "cli_version",
             "github_repository",
+            "github_branch",
             "vpc_cidr",
             "subnet_1_cidr",
             "subnet_2_cidr",
diff --git a/apps/challenges/views.py b/apps/challenges/views.py
@@ -3897,8 +3897,12 @@ def create_or_update_github_challenge(request, challenge_host_team_pk):
         response_data = {"error": "ChallengeHostTeam does not exist"}
         return Response(response_data, status=status.HTTP_406_NOT_ACCEPTABLE)
 
+    # Get branch name with default fallback
+    github_branch = request.data.get("GITHUB_BRANCH_NAME", "")
+
     challenge_queryset = Challenge.objects.filter(
-        github_repository=request.data["GITHUB_REPOSITORY"]
+        github_repository=request.data["GITHUB_REPOSITORY"],
+        github_branch=github_branch,
     )
 
     if challenge_queryset:
@@ -3979,6 +3983,7 @@ def create_or_update_github_challenge(request, challenge_host_team_pk):
                             "github_repository": request.data[
                                 "GITHUB_REPOSITORY"
                             ],
+                            "github_branch": github_branch,
                             "worker_image_url": worker_image_url,
                         },
                     )
diff --git a/scripts/seed.py b/scripts/seed.py
@@ -255,6 +255,8 @@ def create_challenge(
         queue=queue,
         featured=is_featured,
         image=image_file,
+        github_repository=f"evalai-examples/{slug}",
+        github_branch="main",
     )
     challenge.save()
 
diff --git a/tests/unit/challenges/test_views.py b/tests/unit/challenges/test_views.py
@@ -205,11 +205,14 @@ def test_get_challenge(self):
                 "worker_instance_type": self.challenge.worker_instance_type,
                 "sqs_retention_period": self.challenge.sqs_retention_period,
                 "github_repository": self.challenge.github_repository,
+                "github_branch": self.challenge.github_branch,
             }
         ]
 
         response = self.client.get(self.url, {})
-        self.assertEqual(response.data["results"], expected)
+        self.assertEqual(
+            response.data["results"], json.loads(json.dumps(expected))
+        )
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
     def test_particular_challenge_host_team_for_challenge_does_not_exist(self):
@@ -577,6 +580,7 @@ def test_get_particular_challenge(self):
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
             "github_repository": self.challenge.github_repository,
+            "github_branch": self.challenge.github_branch,
         }
         response = self.client.get(self.url, {})
         self.assertEqual(response.data, expected)
@@ -680,6 +684,7 @@ def test_update_challenge_when_user_is_its_creator(self):
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
             "github_repository": self.challenge.github_repository,
+            "github_branch": self.challenge.github_branch,
         }
         response = self.client.put(
             self.url, {"title": new_title, "description": new_description}
@@ -809,6 +814,7 @@ def test_particular_challenge_partial_update(self):
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
             "github_repository": self.challenge.github_repository,
+            "github_branch": self.challenge.github_branch,
         }
         response = self.client.patch(self.url, self.partial_update_data)
         self.assertEqual(response.data, expected)
@@ -887,6 +893,7 @@ def test_particular_challenge_update(self):
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
             "github_repository": self.challenge.github_repository,
+            "github_branch": self.challenge.github_branch,
         }
         response = self.client.put(self.url, self.data)
         self.assertEqual(response.data, expected)
@@ -1484,6 +1491,7 @@ def test_get_past_challenges(self):
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
                 "github_repository": self.challenge3.github_repository,
+                "github_branch": self.challenge3.github_branch,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1568,6 +1576,7 @@ def test_get_present_challenges(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1652,6 +1661,7 @@ def test_get_future_challenges(self):
                 "worker_instance_type": self.challenge4.worker_instance_type,
                 "sqs_retention_period": self.challenge4.sqs_retention_period,
                 "github_repository": self.challenge4.github_repository,
+                "github_branch": self.challenge4.github_branch,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1736,6 +1746,7 @@ def test_get_all_challenges(self):
                 "worker_instance_type": self.challenge4.worker_instance_type,
                 "sqs_retention_period": self.challenge4.sqs_retention_period,
                 "github_repository": self.challenge4.github_repository,
+                "github_branch": self.challenge4.github_branch,
             },
             {
                 "id": self.challenge3.pk,
@@ -1804,6 +1815,7 @@ def test_get_all_challenges(self):
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
                 "github_repository": self.challenge3.github_repository,
+                "github_branch": self.challenge3.github_branch,
             },
             {
                 "id": self.challenge2.pk,
@@ -1872,6 +1884,7 @@ def test_get_all_challenges(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             },
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -2012,6 +2025,7 @@ def test_get_featured_challenges(self):
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
                 "github_repository": self.challenge3.github_repository,
+                "github_branch": self.challenge3.github_branch,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -2177,6 +2191,7 @@ def test_get_challenge_by_pk_when_user_is_challenge_host(self):
             "worker_instance_type": self.challenge3.worker_instance_type,
             "sqs_retention_period": self.challenge3.sqs_retention_period,
             "github_repository": self.challenge3.github_repository,
+            "github_branch": self.challenge3.github_branch,
         }
 
         response = self.client.get(self.url, {})
@@ -2269,6 +2284,7 @@ def test_get_challenge_by_pk_when_user_is_participant(self):
             "worker_instance_type": self.challenge4.worker_instance_type,
             "sqs_retention_period": self.challenge4.sqs_retention_period,
             "github_repository": self.challenge4.github_repository,
+            "github_branch": self.challenge4.github_branch,
         }
 
         self.client.force_authenticate(user=self.user1)
@@ -2423,6 +2439,7 @@ def test_get_challenge_when_host_team_is_given(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             }
         ]
 
@@ -2503,6 +2520,7 @@ def test_get_challenge_when_participant_team_is_given(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             }
         ]
 
@@ -2583,6 +2601,7 @@ def test_get_challenge_when_mode_is_participant(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             }
         ]
 
@@ -2661,6 +2680,7 @@ def test_get_challenge_when_mode_is_host(self):
                 "worker_instance_type": self.challenge.worker_instance_type,
                 "sqs_retention_period": self.challenge.sqs_retention_period,
                 "github_repository": self.challenge.github_repository,
+                "github_branch": self.challenge.github_branch,
             },
             {
                 "id": self.challenge2.pk,
@@ -2729,6 +2749,7 @@ def test_get_challenge_when_mode_is_host(self):
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
                 "github_repository": self.challenge2.github_repository,
+                "github_branch": self.challenge2.github_branch,
             },
         ]
 
@@ -5911,6 +5932,7 @@ def test_create_challenge_using_github_success(self):
                 self.url,
                 {
                     "GITHUB_REPOSITORY": "https://github.com/yourusername/repository",
+                    "GITHUB_BRANCH_NAME": "refs/heads/challenge",
                     "zip_configuration": self.input_zip_file,
                 },
                 format="multipart",
@@ -5926,6 +5948,14 @@ def test_create_challenge_using_github_success(self):
         self.assertEqual(Leaderboard.objects.count(), 1)
         self.assertEqual(ChallengePhaseSplit.objects.count(), 1)
 
+        # Verify github_branch is properly stored
+        challenge = Challenge.objects.first()
+        self.assertEqual(
+            challenge.github_repository,
+            "https://github.com/yourusername/repository",
+        )
+        self.assertEqual(challenge.github_branch, "refs/heads/challenge")
+
     def test_create_challenge_using_github_when_challenge_host_team_does_not_exist(
         self,
     ):
@@ -5964,6 +5994,40 @@ def test_create_challenge_using_github_when_user_is_not_authenticated(
         self.assertEqual(list(response.data.values())[0], expected["error"])
         self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
 
+    def test_create_challenge_using_github_without_branch_name(self):
+        self.url = reverse_lazy(
+            "challenges:create_or_update_github_challenge",
+            kwargs={"challenge_host_team_pk": self.challenge_host_team.pk},
+        )
+
+        with mock.patch("challenges.views.requests.get") as m:
+            resp = mock.Mock()
+            resp.content = self.test_zip_file.read()
+            resp.status_code = 200
+            m.return_value = resp
+            response = self.client.post(
+                self.url,
+                {
+                    "GITHUB_REPOSITORY": "https://github.com/yourusername/repository",
+                    "zip_configuration": self.input_zip_file,
+                },
+                format="multipart",
+            )
+            expected = {
+                "Success": "Challenge Challenge Title has been created successfully and sent for review to EvalAI Admin."
+            }
+
+            self.assertEqual(response.status_code, 201)
+            self.assertEqual(response.json(), expected)
+
+        # Verify github_branch defaults to empty string when not provided
+        challenge = Challenge.objects.first()
+        self.assertEqual(
+            challenge.github_repository,
+            "https://github.com/yourusername/repository",
+        )
+        self.assertEqual(challenge.github_branch, "")
+
 
 class ValidateChallengeTest(APITestCase):
     def setUp(self):
@@ -6030,6 +6094,7 @@ def test_validate_challenge_using_success(self):
                 self.url,
                 {
                     "GITHUB_REPOSITORY": "https://github.com/yourusername/repository",
+                    "GITHUB_BRANCH_NAME": "refs/heads/challenge",
                     "zip_configuration": self.input_zip_file,
                 },
                 format="multipart",
diff --git a/tests/unit/participants/test_views.py b/tests/unit/participants/test_views.py
@@ -884,6 +884,7 @@ def test_get_teams_and_corresponding_challenges_for_a_participant(self):
                         "worker_instance_type": self.challenge1.worker_instance_type,
                         "sqs_retention_period": self.challenge1.sqs_retention_period,
                         "github_repository": self.challenge1.github_repository,
+                        "github_branch": self.challenge1.github_branch,
                     },
                     "participant_team": {
                         "id": self.participant_team.id,
@@ -981,6 +982,7 @@ def test_get_participant_team_challenge_list(self):
                 "worker_instance_type": self.challenge1.worker_instance_type,
                 "sqs_retention_period": self.challenge1.sqs_retention_period,
                 "github_repository": self.challenge1.github_repository,
+                "github_branch": self.challenge1.github_branch,
             }
         ]
 

Original file line number	Diff line number	Diff line change
`@@ -255,6 +255,8 @@ def create_challenge(`
`255`	`255`	`queue=queue,`
`256`	`256`	`featured=is_featured,`
`257`	`257`	`image=image_file,`
	`258`	`+ github_repository=f"evalai-examples/{slug}",`
	`259`	`+ github_branch="main",`
`258`	`260`	`)`
`259`	`261`	`challenge.save()`
`260`	`262`
Original file line number	Diff line number	Diff line change
`@@ -884,6 +884,7 @@ def test_get_teams_and_corresponding_challenges_for_a_participant(self):`
`884`	`884`	`"worker_instance_type": self.challenge1.worker_instance_type,`
`885`	`885`	`"sqs_retention_period": self.challenge1.sqs_retention_period,`
`886`	`886`	`"github_repository": self.challenge1.github_repository,`
	`887`	`+ "github_branch": self.challenge1.github_branch,`
`887`	`888`	`},`
`888`	`889`	`"participant_team": {`
`889`	`890`	`"id": self.participant_team.id,`
`@@ -981,6 +982,7 @@ def test_get_participant_team_challenge_list(self):`
`981`	`982`	`"worker_instance_type": self.challenge1.worker_instance_type,`
`982`	`983`	`"sqs_retention_period": self.challenge1.sqs_retention_period,`
`983`	`984`	`"github_repository": self.challenge1.github_repository,`
	`985`	`+ "github_branch": self.challenge1.github_branch,`
`984`	`986`	`}`
`985`	`987`	`]`
`986`	`988`