Tests

.github/workflows/django.yml

@@ -2,9 +2,9 @@ name: Django CI
 
 on:
   push:
-    branches: [ "develop" ]
+    branches: [ "develop", "tests" ]
   pull_request:
-    branches: [ "develop" ]
+    branches: [ "develop", "tests" ]
 
 jobs:
   build:
@@ -17,7 +17,7 @@ jobs:
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: github_actions
+          POSTGRES_DB: github_actions_2
 
         ports:
           - 5433:5432
@@ -37,7 +37,9 @@ jobs:
         pip install -r requirements.txt
     - name: Linting API
       run: |
-        flake8 ./api
+        cd api
+        flake8 .
+        cd ..
     - name: Run Tests
       env:
         CLIENT_ID: ${{ secrets.CLIENT_ID }}

.gitignore

@@ -7,4 +7,5 @@ venv
 migrations
 .env
 htmlcov
-data
+data
+uploads

README.md

@@ -1,2 +1,5 @@
 # UGent-4
+<<<<<<< HEAD
+=======
 
+>>>>>>> 43302259fa87109dcb81dc91d568e658a9aa7358

api/README.md

@@ -0,0 +1,36 @@
+# Backend
+Deze folder bevat de code van de backend.
+
+## Hoe runnen?
+
+### Benodigdheden:
+- .env bestand: In deze folder moet je lokaal een .env bestand zetten. Het .env bestand bevat geheime variabelen en codes die je niet in deze repo zal vinden. Vraag het aan iemand van het backend team als je de file wilt krijgen.
+
+- postgres databank: Je zal zelf een postgres databank moeten opzetten. De naam van de databank, user, paswoord, ... Kan je vinden in het .env bestand.
+
+- virtual environment: Je zal ook een virtual environment moeten maken. Doe dit op linux met het commando: `python -m venv /path/to/new/virtual/environment`.
+Vervolgens activeer je de virtual environment als volgt: `source my_env/bin/activate`.
+Tenslotte installeer je alle dependencies: `pip install -r requirements.txt`.
+
+### de api lokaal runnen:
+Om de api lokaal te runnen activeer je eerst de virtual environment. Daarna voer je volgende commando's uit in de UGent-4 directory: 
+```sh
+./manage.py makemigrations api
+./manage.py migrate api
+./manage.py runserver
+```
+Je kan dan surfen naar http://127.0.0.1:8000/ om de api te zien.
+
+## Hoe testen?
+
+**OPMERKING**: Al de volgende commando's moeten uitgevoerd worden terwijl de virtual environment geactiveerd is.
+
+Je checkt zowel de linting als de tests.
+
+### Linting:
+De volgende commando's run je van de ***api*** directory:
+Run het commando `flake8 .`. De output vertelt je waar de codestijl fout is. Om snel deze stijlfouten op te lossen kan je `black .`runnen.
+
+
+### Testing:
+Run het commando `./manage.py test` in de ***UGENT-4*** directory.

api/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "api.settings")
 
 application = get_asgi_application()

api/middleware.py

@@ -1,6 +1,6 @@
 from django.conf import settings
 from django.shortcuts import redirect
-from django.urls import reverse
+
 
 class RedirectAnonymousUserMiddleware:
     """
@@ -20,8 +20,11 @@ def __init__(self, get_response):
 
     def __call__(self, request):
         # Check if the user is anonymous and the current path is not the login page
-        if request.user.is_anonymous and request.path not in ['/oauth2/login', '/oauth2/callback']:
+        if request.user.is_anonymous and request.path not in [
+            "/oauth2/login",
+            "/oauth2/callback",
+        ]:
             # Redirect to the login page
             return redirect(settings.LOGIN_URL)
 
-        return self.get_response(request)
+        return self.get_response(request)

api/models/gebruiker.py

@@ -17,4 +17,4 @@ class Gebruiker(models.Model):
     is_lesgever = models.BooleanField(default=False)
 
     def __str__(self):
-        return self.user.first_name + ' ' + self.user.last_name
+        return self.user.first_name + " " + self.user.last_name

api/models/groep.py

@@ -14,9 +14,10 @@ class Groep(models.Model):
         __str__(): Geeft een representatie van het model als een string terug, die de groeps-ID bevat.
     """
     groep_id = models.AutoField(primary_key=True)
-    studenten = models.ManyToManyField('Gebruiker', related_name='groep_studenten', blank=True)
-    project = models.ForeignKey('Project', on_delete=models.CASCADE)
+    studenten = models.ManyToManyField(
+        "Gebruiker", related_name="groep_studenten", blank=True
+    )
+    project = models.ForeignKey("Project", on_delete=models.CASCADE)
 
     def __str__(self):
         return f"Group {self.groep_id}"
-

api/models/indiening.py

@@ -27,12 +27,12 @@ class Indiening(models.Model):
         __str__(): Geeft een representatie van het model als een string terug, die de ID van de indiening bevat.
     """
     indiening_id = models.AutoField(primary_key=True)
-    groep = models.ForeignKey('Groep', on_delete=models.CASCADE)
+    groep = models.ForeignKey("Groep", on_delete=models.CASCADE)
     tijdstip = models.DateTimeField(auto_now_add=True)
 
     def __str__(self):
         return str(self.indiening_id)
-    
+
 
 class IndieningBestand(models.Model):
     """
@@ -47,8 +47,8 @@ class IndieningBestand(models.Model):
         __str__(): Geeft een representatie van het model als een string terug, die de bestandsnaam bevat.
     """
     indiening_bestand_id = models.AutoField(primary_key=True)
-    indiening = models.ForeignKey('Indiening', on_delete=models.CASCADE)
+    indiening = models.ForeignKey("Indiening", on_delete=models.CASCADE)
     bestand = models.FileField(upload_to=upload_to)
 
     def __str__(self):
-        return str(self.bestand.name)
+        return str(self.bestand.name)

api/models/project.py

@@ -1,6 +1,7 @@
 from django.db import models
 from .vak import Vak
 
+
 def upload_to(instance, filename):
     """
     Functie om het pad te genereren waar het opgavebestand wordt opgeslagen.
@@ -13,7 +14,7 @@ def upload_to(instance, filename):
         str: Het pad waar het opgavebestand moet worden opgeslagen.
     """
     vak_id = instance.vak.vak_id
-    return f'data/opgaves/vak_{vak_id}/{filename}'
+    return f"data/opgaves/vak_{vak_id}/{filename}"
 
 
 class Project(models.Model):
@@ -44,4 +45,3 @@ class Project(models.Model):
 
     def __str__(self):
         return self.titel
-

api/models/score.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-    
+
 class Score(models.Model):
     """
     Model voor het bijhouden van scores voor indieningen.
@@ -15,7 +15,7 @@ class Score(models.Model):
     """
     score_id = models.AutoField(primary_key=True)
     score = models.SmallIntegerField()
-    indiening = models.ForeignKey('Indiening', on_delete=models.CASCADE)
+    indiening = models.ForeignKey("Indiening", on_delete=models.CASCADE)
 
     def __str__(self):
-        return self.score_id
+        return str(self.score_id)

api/models/vak.py

@@ -16,10 +16,12 @@ class Vak(models.Model):
     """
     vak_id = models.AutoField(primary_key=True)
     naam = models.CharField(max_length=100)
-    studenten = models.ManyToManyField('Gebruiker', related_name='vak_gebruikers', blank=True)
-    lesgevers = models.ManyToManyField('Gebruiker', related_name='vak_lesgevers', blank=True)
+    studenten = models.ManyToManyField(
+        "Gebruiker", related_name="vak_gebruikers", blank=True
+    )
+    lesgevers = models.ManyToManyField(
+        "Gebruiker", related_name="vak_lesgevers", blank=True
+    )
 
     def __str__(self):
         return self.naam
-
-

api/serializers/gebruiker.py

@@ -16,7 +16,7 @@ class GebruikerSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = Gebruiker
-        fields = '__all__'
+        fields = "__all__"
 
     def create(self, validated_data):
         """

api/serializers/groep.py

@@ -1,5 +1,6 @@
 from rest_framework import serializers
 from api.models.groep import Groep
+from collections import Counter
 
 
 class GroepSerializer(serializers.ModelSerializer):
@@ -16,9 +17,10 @@ class GroepSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = Groep
-        fields = '__all__'
+        fields = "__all__"
 
     def create(self, validated_data):
+
         """
         Args:
             validated_data (dict): Gevalideerde gegevens over de groep.
@@ -28,13 +30,13 @@ def create(self, validated_data):
         """
         students_data = validated_data.pop('studenten')
         validate_students(students_data, validated_data['project'])
-
         instance = Groep.objects.create(**validated_data)
         instance.studenten.set(students_data)
 
         return instance
 
     def update(self, instance, validated_data):
+
         """
         Args:
             instance (Groep): De groep die moet worden bijgewerkt.

api/serializers/indiening.py

@@ -13,7 +13,7 @@ class IndieningSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = Indiening
-        fields = ('__all__')
+        fields = "__all__"
 
 
 class IndieningBestandSerializer(serializers.ModelSerializer):
@@ -27,4 +27,4 @@ class IndieningBestandSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = IndieningBestand
-        fields = ('__all__')
+        fields = "__all__"

api/serializers/project.py

@@ -17,7 +17,7 @@ class ProjectSerializer(serializers.ModelSerializer):
     """
     class Meta:
         model = Project
-        fields = '__all__'
+        fields = "__all__"
 
     def create(self, validated_data):
         """