Fix #4591: Adds Github icon on for challenge hosts repository (#4625)

* Added github icon on hosted challenge page

* Modified the test files to pass the Travis CI checks

* reformatted code of test_views.py file

---------

Co-authored-by: Rishabh Jain <rishabhjain2018@gmail.com>

Author: akanshajain231999

apps/challenges/serializers.py

@@ -94,6 +94,7 @@ class Meta:
             "worker_image_url",
             "worker_instance_type",
             "sqs_retention_period",
+            "github_repository",
         )
 
 

frontend/src/css/modules/challenge.scss

@@ -381,12 +381,12 @@ md-select .md-select-value span:first-child:after {
     li {
         margin-bottom: -0.5%;
     }
-    
+
     .nav-item {
       flex: 1;
       text-align: center;
       color: #4d4d4d;
-  
+
       .nav-link {
         display: block;
         padding: 10px 0;
@@ -397,7 +397,7 @@ md-select .md-select-value span:first-child:after {
         font-weight: 500;
         transition: border-bottom 0.3s ease;
         cursor: pointer;
-  
+
         &.active {
           border-bottom: 2px solid #000;
           color: #4d4d4d;
@@ -413,7 +413,7 @@ md-select .md-select-value span:first-child:after {
       a {
         color: #4d4d4d;
         font-weight: 400;
-  
+
         &.active {
           color: #3f51b5;
           font-weight: 600;
@@ -425,7 +425,7 @@ md-select .md-select-value span:first-child:after {
 .challenges-container {
     margin-top: 20px;
     min-height: 200px;
-  
+
   .card-content {
     padding: 20px;
     text-align: center;
@@ -436,4 +436,6 @@ md-select .md-select-value span:first-child:after {
     margin-right: 10px;
     display: inline-block;
     vertical-align: middle;
+    color: #000; // Ensure the icon is visible
+    font-size: 15px; // Adjust size if needed
 }

frontend/src/js/controllers/challengeCtrl.js

@@ -396,6 +396,7 @@
                 vm.has_sponsors = details.has_sponsors;
                 vm.queueName = details.queue;
                 vm.evaluation_module_error = details.evaluation_module_error;
+                vm.githubRepository = details.github_repository;
                 vm.getTeamName(vm.challengeId);
                 if (vm.page.image === null) {
                     vm.page.image = "dist/images/logo.png";

frontend/src/views/web/challenge/challenge-page.html

@@ -93,12 +93,12 @@ <h4 class="challenge-step-title w-300">{{challenge.page.title}}
                 </div>
             </div>
             <div class="col m2 l2 fs-16 w-300 center">
-                <a ng-if="(challenge.isChallengeHost ) && challenge.page.github_repository"
-                ng-href="{{ 'https://github.com/' + challenge.page.github_repository }}"
+                <a ng-if="(challenge.isChallengeHost) && challenge.githubRepository"
+                ng-href="{{ 'https://github.com/' + challenge.githubRepository }}"
                 target="_blank"
                 class="github-icon-link">
                 <i class="fa fa-github fa-2x black-text" aria-hidden="true"></i>
-             </a>   
+   </a>   
                 <button class="waves-effect waves-dark btn ev-btn-dark w-300 fs-14" type="submit"
                     ng-click="challenge.starChallenge()" ng-init="challenge.isStarred()"><i class="fa fa-star star"></i>
                     {{challenge.data}}&nbsp;&nbsp;{{challenge.count}}</button>

tests/unit/challenges/test_views.py

@@ -86,6 +86,7 @@ def setUp(self):
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
             approved_by_admin=False,
+            github_repository="challenge/github_repo",
         )
         self.challenge.slug = "{}-{}".format(
             self.challenge.title.replace(" ", "-").lower(), self.challenge.pk
@@ -203,6 +204,7 @@ def test_get_challenge(self):
                 "worker_image_url": self.challenge.worker_image_url,
                 "worker_instance_type": self.challenge.worker_instance_type,
                 "sqs_retention_period": self.challenge.sqs_retention_period,
+                "github_repository": self.challenge.github_repository,
             }
         ]
 
@@ -574,6 +576,7 @@ def test_get_particular_challenge(self):
             "worker_image_url": self.challenge.worker_image_url,
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
+            "github_repository": self.challenge.github_repository,
         }
         response = self.client.get(self.url, {})
         self.assertEqual(response.data, expected)
@@ -676,6 +679,7 @@ def test_update_challenge_when_user_is_its_creator(self):
             "worker_image_url": self.challenge.worker_image_url,
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
+            "github_repository": self.challenge.github_repository,
         }
         response = self.client.put(
             self.url, {"title": new_title, "description": new_description}
@@ -804,6 +808,7 @@ def test_particular_challenge_partial_update(self):
             "worker_image_url": self.challenge.worker_image_url,
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
+            "github_repository": self.challenge.github_repository,
         }
         response = self.client.patch(self.url, self.partial_update_data)
         self.assertEqual(response.data, expected)
@@ -881,6 +886,7 @@ def test_particular_challenge_update(self):
             "worker_image_url": self.challenge.worker_image_url,
             "worker_instance_type": self.challenge.worker_instance_type,
             "sqs_retention_period": self.challenge.sqs_retention_period,
+            "github_repository": self.challenge.github_repository,
         }
         response = self.client.put(self.url, self.data)
         self.assertEqual(response.data, expected)
@@ -1344,6 +1350,7 @@ def setUp(self):
             manual_participant_approval=False,
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
+            github_repository="challenge2/github_repo",
         )
 
         # Past Challenge challenge
@@ -1365,6 +1372,7 @@ def setUp(self):
             manual_participant_approval=False,
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() - timedelta(days=1),
+            github_repository="challenge3/github_repo",
         )
 
         # Future challenge
@@ -1385,6 +1393,7 @@ def setUp(self):
             manual_participant_approval=False,
             start_date=timezone.now() + timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
+            github_repository="challenge4/github_repo",
         )
 
         # Disabled challenge
@@ -1474,6 +1483,7 @@ def test_get_past_challenges(self):
                 "worker_image_url": self.challenge3.worker_image_url,
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
+                "github_repository": self.challenge3.github_repository,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1552,11 +1562,12 @@ def test_get_present_challenges(self):
                 "job_memory": self.challenge2.job_memory,
                 "uses_ec2_worker": self.challenge2.uses_ec2_worker,
                 "evaluation_module_error": self.challenge2.evaluation_module_error,
-                "ec2_storage": self.challenge.ec2_storage,
-                "ephemeral_storage": self.challenge.ephemeral_storage,
-                "worker_image_url": self.challenge.worker_image_url,
-                "worker_instance_type": self.challenge.worker_instance_type,
-                "sqs_retention_period": self.challenge.sqs_retention_period,
+                "ec2_storage": self.challenge2.ec2_storage,
+                "ephemeral_storage": self.challenge2.ephemeral_storage,
+                "worker_image_url": self.challenge2.worker_image_url,
+                "worker_instance_type": self.challenge2.worker_instance_type,
+                "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1640,6 +1651,7 @@ def test_get_future_challenges(self):
                 "worker_image_url": self.challenge4.worker_image_url,
                 "worker_instance_type": self.challenge4.worker_instance_type,
                 "sqs_retention_period": self.challenge4.sqs_retention_period,
+                "github_repository": self.challenge4.github_repository,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1713,16 +1725,17 @@ def test_get_all_challenges(self):
                 "queue": self.challenge4.queue,
                 "worker_cpu_cores": 512,
                 "worker_memory": 1024,
-                "cpu_only_jobs": self.challenge3.cpu_only_jobs,
-                "job_cpu_cores": self.challenge3.job_cpu_cores,
-                "job_memory": self.challenge3.job_memory,
-                "uses_ec2_worker": self.challenge3.uses_ec2_worker,
-                "evaluation_module_error": self.challenge3.evaluation_module_error,
-                "ec2_storage": self.challenge3.ec2_storage,
-                "ephemeral_storage": self.challenge3.ephemeral_storage,
-                "worker_image_url": self.challenge3.worker_image_url,
-                "worker_instance_type": self.challenge3.worker_instance_type,
-                "sqs_retention_period": self.challenge3.sqs_retention_period,
+                "cpu_only_jobs": self.challenge4.cpu_only_jobs,
+                "job_cpu_cores": self.challenge4.job_cpu_cores,
+                "job_memory": self.challenge4.job_memory,
+                "uses_ec2_worker": self.challenge4.uses_ec2_worker,
+                "evaluation_module_error": self.challenge4.evaluation_module_error,
+                "ec2_storage": self.challenge4.ec2_storage,
+                "ephemeral_storage": self.challenge4.ephemeral_storage,
+                "worker_image_url": self.challenge4.worker_image_url,
+                "worker_instance_type": self.challenge4.worker_instance_type,
+                "sqs_retention_period": self.challenge4.sqs_retention_period,
+                "github_repository": self.challenge4.github_repository,
             },
             {
                 "id": self.challenge3.pk,
@@ -1790,6 +1803,7 @@ def test_get_all_challenges(self):
                 "worker_image_url": self.challenge3.worker_image_url,
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
+                "github_repository": self.challenge3.github_repository,
             },
             {
                 "id": self.challenge2.pk,
@@ -1857,6 +1871,7 @@ def test_get_all_challenges(self):
                 "worker_image_url": self.challenge2.worker_image_url,
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             },
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -1925,6 +1940,7 @@ def setUp(self):
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() - timedelta(days=1),
             featured=True,
+            github_repository="challenge3/github_repo",
         )
 
     def test_get_featured_challenges(self):
@@ -1995,6 +2011,7 @@ def test_get_featured_challenges(self):
                 "worker_image_url": self.challenge3.worker_image_url,
                 "worker_instance_type": self.challenge3.worker_instance_type,
                 "sqs_retention_period": self.challenge3.sqs_retention_period,
+                "github_repository": self.challenge3.github_repository,
             }
         ]
         response = self.client.get(self.url, {}, format="json")
@@ -2036,6 +2053,7 @@ def setUp(self):
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
             approved_by_admin=False,
+            github_repository="challenge3/github_repo",
         )
 
         self.challenge4 = Challenge.objects.create(
@@ -2057,6 +2075,7 @@ def setUp(self):
             end_date=timezone.now() + timedelta(days=1),
             is_disabled=False,
             approved_by_admin=True,
+            github_repository="challenge4/github_repo",
         )
 
         self.challenge5 = Challenge.objects.create(
@@ -2157,6 +2176,7 @@ def test_get_challenge_by_pk_when_user_is_challenge_host(self):
             "worker_image_url": self.challenge3.worker_image_url,
             "worker_instance_type": self.challenge3.worker_instance_type,
             "sqs_retention_period": self.challenge3.sqs_retention_period,
+            "github_repository": self.challenge3.github_repository,
         }
 
         response = self.client.get(self.url, {})
@@ -2248,6 +2268,7 @@ def test_get_challenge_by_pk_when_user_is_participant(self):
             "worker_image_url": self.challenge4.worker_image_url,
             "worker_instance_type": self.challenge4.worker_instance_type,
             "sqs_retention_period": self.challenge4.sqs_retention_period,
+            "github_repository": self.challenge4.github_repository,
         }
 
         self.client.force_authenticate(user=self.user1)
@@ -2297,6 +2318,7 @@ def setUp(self):
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
             approved_by_admin=True,
+            github_repository="challenge/github_repo",
         )
 
         self.challenge2 = Challenge.objects.create(
@@ -2315,6 +2337,7 @@ def setUp(self):
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
             approved_by_admin=True,
+            github_repository="challenge2/github_repo",
         )
 
         self.participant_team2 = ParticipantTeam.objects.create(
@@ -2399,6 +2422,7 @@ def test_get_challenge_when_host_team_is_given(self):
                 "worker_image_url": self.challenge2.worker_image_url,
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             }
         ]
 
@@ -2478,6 +2502,7 @@ def test_get_challenge_when_participant_team_is_given(self):
                 "worker_image_url": self.challenge2.worker_image_url,
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             }
         ]
 
@@ -2557,6 +2582,7 @@ def test_get_challenge_when_mode_is_participant(self):
                 "worker_image_url": self.challenge2.worker_image_url,
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             }
         ]
 
@@ -2634,6 +2660,7 @@ def test_get_challenge_when_mode_is_host(self):
                 "worker_image_url": self.challenge.worker_image_url,
                 "worker_instance_type": self.challenge.worker_instance_type,
                 "sqs_retention_period": self.challenge.sqs_retention_period,
+                "github_repository": self.challenge.github_repository,
             },
             {
                 "id": self.challenge2.pk,
@@ -2701,6 +2728,7 @@ def test_get_challenge_when_mode_is_host(self):
                 "worker_image_url": self.challenge2.worker_image_url,
                 "worker_instance_type": self.challenge2.worker_instance_type,
                 "sqs_retention_period": self.challenge2.sqs_retention_period,
+                "github_repository": self.challenge2.github_repository,
             },
         ]
 

tests/unit/participants/test_views.py

@@ -780,6 +780,7 @@ def setUp(self):
             manual_participant_approval=False,
             start_date=timezone.now() - timedelta(days=2),
             end_date=timezone.now() + timedelta(days=1),
+            github_repository="challenge1/github_repo",
         )
         self.challenge1.slug = "{}-{}".format(
             self.challenge1.title.replace(" ", "-").lower(), self.challenge1.pk
@@ -882,6 +883,7 @@ def test_get_teams_and_corresponding_challenges_for_a_participant(self):
                         "worker_image_url": self.challenge1.worker_image_url,
                         "worker_instance_type": self.challenge1.worker_instance_type,
                         "sqs_retention_period": self.challenge1.sqs_retention_period,
+                        "github_repository": self.challenge1.github_repository,
                     },
                     "participant_team": {
                         "id": self.participant_team.id,
@@ -978,6 +980,7 @@ def test_get_participant_team_challenge_list(self):
                 "worker_image_url": self.challenge1.worker_image_url,
                 "worker_instance_type": self.challenge1.worker_instance_type,
                 "sqs_retention_period": self.challenge1.sqs_retention_period,
+                "github_repository": self.challenge1.github_repository,
             }
         ]