Merge branch 'DataTalksClub:main' into main

Author: mostafanasser2000

courses/migrations/0014_alter_projectsubmission_github_link_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.14 on 2024-07-31 05:05
+
+import courses.validators.custom_url_validators
+import courses.validators.validating_json_field
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('courses', '0013_remove_homework_is_scored_homework_state_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='projectsubmission',
+            name='github_link',
+            field=models.URLField(validators=[django.core.validators.URLValidator(), courses.validators.custom_url_validators.validate_url_200]),
+        ),
+        migrations.AlterField(
+            model_name='projectsubmission',
+            name='learning_in_public_links',
+            field=courses.validators.validating_json_field.ValidatingJSONField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='submission',
+            name='homework_link',
+            field=models.URLField(blank=True, null=True, validators=[django.core.validators.URLValidator(schemes=['http', 'https', 'git']), courses.validators.custom_url_validators.validate_url_200]),
+        ),
+        migrations.AlterField(
+            model_name='submission',
+            name='learning_in_public_links',
+            field=courses.validators.validating_json_field.ValidatingJSONField(blank=True, help_text='Links where students talk about the course', null=True),
+        ),
+    ]

courses/models/homework.py

@@ -5,6 +5,8 @@
 from django.contrib.auth import get_user_model
 
 from .course import Course, Enrollment
+from courses.validators import validate_url_200
+from courses.validators.validating_json_field import ValidatingJSONField
 
 User = get_user_model()
 
@@ -153,9 +155,9 @@ class Submission(models.Model):
     homework_link = models.URLField(
         blank=True,
         null=True,
-        validators=[URLValidator(schemes=["http", "https", "git"])],
+        validators=[URLValidator(schemes=["http", "https", "git"]), validate_url_200],
     )
-    learning_in_public_links = models.JSONField(
+    learning_in_public_links = ValidatingJSONField(
         blank=True,
         null=True,
         help_text="Links where students talk about the course",

courses/models/project.py

@@ -7,6 +7,8 @@
 from django.contrib.auth import get_user_model
 
 from .course import Course, Enrollment
+from courses.validators import validate_url_200
+from courses.validators.validating_json_field import ValidatingJSONField
 
 User = get_user_model()
 
@@ -84,10 +86,10 @@ class ProjectSubmission(models.Model):
     student = models.ForeignKey(User, on_delete=models.CASCADE)
     enrollment = models.ForeignKey(Enrollment, on_delete=models.CASCADE)
 
-    github_link = models.URLField(validators=[URLValidator()])
+    github_link = models.URLField(validators=[URLValidator(), validate_url_200])
     commit_id = models.CharField(max_length=40)
 
-    learning_in_public_links = models.JSONField(blank=True, null=True)
+    learning_in_public_links = ValidatingJSONField(blank=True, null=True)
     faq_contribution = models.TextField(blank=True)
 
     time_spent = models.FloatField(blank=True, null=True)

courses/tests/test_data.py

@@ -1,6 +1,7 @@
 from django.test import TestCase, Client
 from django.urls import reverse
 from django.utils import timezone
+from django.core.exceptions import ValidationError
 
 from courses.models import (
     User,
@@ -52,13 +53,16 @@ def test_homework_data_view(self):
             slug="test-homework",
         )
 
-        self.submission = Submission.objects.create(
+        self.submission = Submission(
             homework=self.homework,
             student=self.user,
             enrollment=self.enrollment,
-            homework_link="https://example.com/homework",
+            homework_link="https://github.com/DataTalksClub",
         )
 
+        self.submission.full_clean()
+        self.submission.save()
+
         self.question = Question.objects.create(
             homework=self.homework,
             text="What is the capital of France?",
@@ -221,14 +225,17 @@ def test_project_data_view(self):
             + timezone.timedelta(days=14),
         )
 
-        self.project_submission = ProjectSubmission.objects.create(
+        self.project_submission = ProjectSubmission(
             project=self.project,
             student=self.user,
             enrollment=self.enrollment,
-            github_link="https://github.com/test/repo",
+            github_link="https://github.com/DataTalksClub",
             commit_id="abcd1234",
         )
 
+        self.project_submission.full_clean()
+        self.project_submission.save()
+
         url = reverse(
             "data_project",
             kwargs={
@@ -331,3 +338,45 @@ def test_project_data_view(self):
         self.assertEqual(submission['total_score'], expected_submission['total_score'])
         self.assertEqual(submission['reviewed_enough_peers'], expected_submission['reviewed_enough_peers'])
         self.assertEqual(submission['passed'], expected_submission['passed'])
+
+
+    def test_homework_submission_with_404_url(self):
+        self.homework = Homework.objects.create(
+            course=self.course,
+            title="Test Homework",
+            description="Test Homework Description",
+            due_date=timezone.now() + timezone.timedelta(days=7),
+            state=HomeworkState.OPEN.value,
+            slug="test-homework",
+        )
+
+        self.submission = Submission(
+            homework=self.homework,
+            student=self.user,
+            enrollment=self.enrollment,
+            homework_link="https://httpbin.org/status/404",
+        )
+        with self.assertRaises(ValidationError):
+            self.submission.full_clean()
+
+    def test_project_submission_with_404_url(self):
+        self.project = Project.objects.create(
+            course=self.course,
+            slug="test-project",
+            title="Test Project",
+            description="Description",
+            submission_due_date=timezone.now()
+            + timezone.timedelta(days=7),
+            peer_review_due_date=timezone.now()
+            + timezone.timedelta(days=14),
+        )
+
+        self.project_submission = ProjectSubmission(
+            project=self.project,
+            student=self.user,
+            enrollment=self.enrollment,
+            github_link="https://httpbin.org/status/404",
+            commit_id="abcd1234",
+        )
+        with self.assertRaises(ValidationError):
+            self.project_submission.full_clean()

courses/tests/test_homework.py

@@ -833,10 +833,10 @@ def test_submit_homework_with_all_fields(self):
             f"answer_{self.question4.id}": ["3"],
             f"answer_{self.question5.id}": ["3.141516"],
             f"answer_{self.question6.id}": ["1", "2"],
-            "homework_url": "http://example.com/homework",
+            "homework_url": "https://httpbin.org/status/200",
             "learning_in_public_links[]": [
-                "http://example.com/link1",
-                "http://example.com/link2",
+                "https://httpbin.org/status/200",
+                "https://github.com/DataTalksClub",
                 "",
             ],
             "time_spent_lectures": "5",
@@ -868,8 +868,8 @@ def test_submit_homework_with_all_fields(self):
         )
 
         expected_learning_in_public_links = [
-            "http://example.com/link1",
-            "http://example.com/link2",
+            "https://httpbin.org/status/200",
+            "https://github.com/DataTalksClub",
         ]
         self.assertEqual(
             submission.learning_in_public_links,
@@ -913,7 +913,7 @@ def test_submit_homework_with_all_fields_optional_empty(self):
             f"answer_{self.question4.id}": ["3"],
             f"answer_{self.question5.id}": ["3.141516"],
             f"answer_{self.question6.id}": ["1", "2"],
-            "homework_url": "http://example.com/homework",
+            "homework_url": "https://httpbin.org/status/200",
             "learning_in_public_links[]": [""],
             "time_spent_lectures": "",
             "time_spent_homework": "",
@@ -967,11 +967,9 @@ def test_submit_homework_learning_in_public_empty_and_duplicates(
             f"answer_{self.question5.id}": ["3.141516"],
             f"answer_{self.question6.id}": ["1", "2"],
             "learning_in_public_links[]": [
-                "http://example.com/link1",
-                "http://example.com/link2",
-                "http://example.com/link1",
-                "",
-                "",
+                "https://httpbin.org/status/200",
+                "https://httpbin.org/status/200",
+                "https://github.com/DataTalksClub"
                 "",
             ],
         }
@@ -994,8 +992,8 @@ def test_submit_homework_learning_in_public_empty_and_duplicates(
         )
 
         expected_learning_in_public_links = [
-            "http://example.com/link1",
-            "http://example.com/link2",
+            "https://httpbin.org/status/200",
+            "https://github.com/DataTalksClub"
         ]
         self.assertEqual(
             submission.learning_in_public_links,

courses/tests/test_project_view.py

@@ -173,7 +173,7 @@ def test_project_submission_post_no_submissions(self):
         )
 
         data = {
-            "github_link": "https://github.com/testuser/project",
+            "github_link": "https://httpbin.org/status/200",
             "commit_id": "1234567",
             "time_spent": "2",
             "problems_comments": "Encountered an issue with...",
@@ -220,7 +220,7 @@ def test_project_submission_post_creates_enrollment(self):
         )
 
         data = {
-            "github_link": "https://github.com/testuser/project",
+            "github_link": "https://httpbin.org/status/200",
             "commit_id": "1234567",
             "time_spent": "2",
             "problems_comments": "Encountered an issue with...",
@@ -242,7 +242,7 @@ def test_project_submission_post_with_submissions(self):
             project=self.project,
             student=self.user,
             enrollment=self.enrollment,
-            github_link="https://github.com/testuser/project",
+            github_link="https://httpbin.org/status/200",
             commit_id="123456a",
         )
 
@@ -251,7 +251,7 @@ def test_project_submission_post_with_submissions(self):
         )
 
         data = {
-            "github_link": "https://github.com/testuser/project2",
+            "github_link": "https://httpbin.org/status/200",
             "commit_id": "123456e",
             "time_spent": "3",
             "problems_comments": "No issues encountered.",
@@ -296,7 +296,7 @@ def test_project_submission_not_accepting_responses(self):
         )
 
         data = {
-            "github_link": "https://github.com/testuser/project",
+            "github_link": "https://httpbin.org/status/200",
             "commit_id": "1234567",
             "time_spent": "2",
             "problems_comments": "Encountered an issue with...",

courses/tests/test_unit_url_validation.py

@@ -0,0 +1,65 @@
+import logging
+
+from unittest import TestCase
+
+from courses.validators.custom_url_validators import (
+    validate_url_200,
+    get_error_message,
+)
+from django.core.exceptions import ValidationError
+
+
+logger = logging.getLogger(__name__)
+
+
+class MockResponse:
+    def __init__(self, status_code):
+        self.status_code = status_code
+
+
+class UrlValidationTestCase(TestCase):
+
+    def test_validation_code_200_github_mock(self):
+        mock_get = lambda url: MockResponse(200)
+        url = "https://github.com/DataTalksClub/"
+        validate_url_200(url, mock_get)
+        # no exceptions should be raised
+
+    def test_validation_code_404_github_mock(self):
+        mock_get = lambda url: MockResponse(404)
+        url = "https://github.com/DataTalksClub/non-existing-repo"
+        with self.assertRaises(ValidationError):
+            validate_url_200(url, mock_get)
+
+    def test_error_message_404_github(self):
+        url = "https://github.com/DataTalksClub/non-existing-repo"
+        error = get_error_message(404, url)
+        expected_error = (
+            f"The submitted GitHub link {url} does not "
+            + "exist. Make sure the repository is public."
+        )
+        self.assertEqual(error, expected_error)
+
+    def test_error_message_404_github_case_insensitive(self):
+        url = "https://GitHub.com/DataTalksClub/non-existing-repo"
+        error = get_error_message(404, url)
+        expected_error = (
+            f"The submitted GitHub link {url} does not "
+            + "exist. Make sure the repository is public."
+        )
+        self.assertEqual(error, expected_error)
+
+    def test_error_message_404_linkedin(self):
+        url = "https://www.linkedin.com/feed/update/urn:li:activity:7221077695688773633/"
+        error = get_error_message(404, url)
+        expected_error = f"The submitted link {url} does not exist."
+        self.assertEqual(error, expected_error)
+
+    def test_error_message_400(self):
+        url = "https://www.linkedin.com/whatever"
+        error = get_error_message(400, url)
+        expected_error = (
+            f"The submitted link {url} does not "
+            + "return a 200 status code. Status code: 400."
+        )
+        self.assertEqual(error, expected_error)

courses/validators/__init__.py

@@ -0,0 +1,2 @@
+from .custom_url_validators import validate_url_200
+from .validating_json_field import ValidatingJSONField

courses/validators/custom_url_validators.py

@@ -0,0 +1,34 @@
+import requests
+from django.core.exceptions import ValidationError
+
+
+def get_error_message(status_code, url):
+    if status_code != 404:
+        return (
+            f"The submitted link {url} does not "
+            + "return a 200 status code. Status code: "
+            + f"{status_code}."
+        )
+    
+    # 404 status code
+    if "github" in url.lower():
+        return (
+            f"The submitted GitHub link {url} does not "
+            + "exist. Make sure the repository is public."
+        )
+
+    return f"The submitted link {url} does not exist."
+
+
+def validate_url_200(url, get_method=requests.get):
+    try:
+        response = get_method(url)
+        status_code = response.status_code
+        if status_code == 200:
+            return
+        error_message = get_error_message(status_code, url)
+        raise ValidationError(error_message)
+    except requests.exceptions.RequestException as e:
+        raise ValidationError(
+            f"An error occurred while trying to validate the URL: {e}"
+        )