Tests

.github/workflows/django.yml

@@ -9,26 +9,49 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.7, 3.8, 3.9]
+    runs-on: self-hosted
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: github_actions_2
+
+        ports:
+          - 5433:5432
+
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: '3.10'
     - name: Install Dependencies
       run: |
-        python -m pip install --upgrade pip
+        python3 -m pip install --upgrade pip
         pip install -r requirements.txt
     - name: Linting API
       run: |
         flake8 ./api
     - name: Run Tests
+      env:
+        CLIENT_ID: ${{ secrets.CLIENT_ID }}
+        CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+        TENANT_ID: ${{ secrets.TENANT_ID }}
+        AD_URL: ${{ secrets.AD_URL }}
+        SECRET_KEY: ${{ secrets.SECRET_KEY }}
+        DB_NAME: ${{ secrets.DB_NAME }}
+        DB_USER: ${{ secrets.DB_USER }}
+        DB_PASSWORD: ${{ secrets.DB_PASSWORD }}
+        DB_HOST: ${{ secrets.DB_HOST }}
+        DB_PORT: ${{ secrets.DB_PORT }}
+        DB_ENGINE: ${{secrets.DB_ENGINE}}
+
       run: |
         python manage.py makemigrations api
         python manage.py migrate api

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+projectenv
+venv
+.idea
+/venv/
+**/__pycache__/
+migrations
+.env
+htmlcov
+data
+uploads

README.md

@@ -1 +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/admin.py

@@ -0,0 +1,15 @@
+from django.contrib import admin
+from api.models.gebruiker import Gebruiker
+from api.models.vak import Vak
+from api.models.groep import Groep
+from api.models.project import Project
+from api.models.indiening import Indiening, IndieningBestand
+from api.models.score import Score
+
+admin.site.register(Gebruiker)
+admin.site.register(Vak)
+admin.site.register(Groep)
+admin.site.register(Project)
+admin.site.register(Indiening)
+admin.site.register(Score)
+admin.site.register(IndieningBestand)

selab_project/selab_project/asgi.py → api/asgi.py

@@ -1,5 +1,5 @@
 """
-ASGI config for selab_project project.
+ASGI config for api project.
 
 It exposes the ASGI callable as a module-level variable named ``application``.
 
@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'selab_project.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "api.settings")
 
 application = get_asgi_application()

api/middleware.py

@@ -0,0 +1,32 @@
+from django.conf import settings
+from django.shortcuts import redirect
+
+
+class RedirectAnonymousUserMiddleware:
+    """
+    Middleware die anonieme gebruikers omleidt naar de inlogpagina.
+    Deze middleware controleert of de gebruiker anoniem is en of het huidige pad niet de inlogpagina is.
+    Als dit het geval is, wordt de gebruiker omgeleid naar de inlogpagina die is geconfigureerd in de instellingen.
+
+    Args:
+        get_response (function): De functie die wordt aangeroepen om het verzoek te verwerken.
+
+    Returns:
+        HttpResponse: Een HTTP-omleiding naar de inlogpagina als de gebruiker anoniem is
+        en het huidige pad niet de inlogpagina is.
+                      Anders wordt het verzoek verder verwerkt door de volgende middleware of de weergavefunctie.
+    """
+
+    def __init__(self, get_response):
+        self.get_response = 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",
+        ]:
+            # Redirect to the login page
+            return redirect(settings.LOGIN_URL)
+
+        return self.get_response(request)

api/models/gebruiker.py

@@ -0,0 +1,24 @@
+from django.db import models
+from django.contrib.auth.models import User
+
+
+class Gebruiker(models.Model):
+    """
+    Model voor een gebruiker, dat zich uitbreidt op het standaardgebruikermodel van Django.
+
+    Fields:
+        user (OneToOneField): Een veld dat verwijst naar het standaardgebruikermodel van Django
+        met een één-op-één-relatie. Dit veld fungeert als het primaire sleutelveld.
+        is_lesgever (BooleanField): Een boolean veld dat aangeeft of de gebruiker een lesgever is of niet.
+        Standaard ingesteld op False.
+
+    Methods:
+        __str__(): Geeft een representatie van het model als een string terug,
+        die de voornaam en achternaam van de gebruiker bevat.
+    """
+
+    user = models.OneToOneField(User, on_delete=models.CASCADE, primary_key=True)
+    is_lesgever = models.BooleanField(default=False)
+
+    def __str__(self):
+        return self.user.first_name + " " + self.user.last_name

api/models/groep.py

@@ -0,0 +1,29 @@
+from django.db import models
+
+
+class Groep(models.Model):
+    """
+    Model voor een groep van studenten voor een project.
+
+    Fields:
+        groep_id (AutoField): Een automatisch gegenereerd veld dat fungeert als
+        de primaire sleutel voor de groep.
+        studenten (ManyToManyField): Een Many-to-Many relatie met het 'Gebruiker' model,
+        waarmee meerdere gebruikers aan een groep kunnen worden gekoppeld.
+        project (ForeignKey): Een ForeignKey relatie met het 'Project' model,
+        waarmee wordt aangegeven tot welk project deze groep behoort.
+        Als het bijbehorende project wordt verwijderd,
+        worden ook de bijbehorende groepen verwijderd.
+
+    Methods:
+        __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)
+
+    def __str__(self):
+        return f"Group {self.groep_id}"

api/models/indiening.py

@@ -0,0 +1,66 @@
+from django.db import models
+
+
+def upload_to(instance, filename):
+    """
+    Functie om het pad te genereren waar het bestand wordt opgeslagen.
+
+    Args:
+        instance: De huidige instantie van het model.
+        filename (str): De oorspronkelijke bestandsnaam.
+
+    Returns:
+        str: Het pad waar het bestand moet worden opgeslagen.
+    """
+    return f"data/indieningen/indiening_{instance.indiening_id}/{filename}"
+
+
+class Indiening(models.Model):
+    """
+    Model voor een indiening van een groep.
+
+    Fields:
+        indiening_id (AutoField): Een automatisch gegenereerd veld dat fungeert
+        als de primaire sleutel voor de indiening.
+        groep (ForeignKey): Een ForeignKey relatie met het 'Groep' model,
+        waarmee wordt aangegeven tot welke groep deze indiening behoort.
+        Als de bijbehorende groep wordt verwijderd, worden ook de bijbehorende
+        indieningen verwijderd.
+        tijdstip (DateTimeField): Een veld dat automatisch het tijdstip
+        registreert waarop de indiening is aangemaakt.
+
+    Methods:
+        __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)
+    tijdstip = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return str(self.indiening_id)
+
+
+class IndieningBestand(models.Model):
+    """
+    Model voor een bestand dat aan een indiening is gekoppeld.
+
+    Fields:
+        indiening_bestand_id (AutoField): Een automatisch gegenereerd veld dat fungeert als
+        de primaire sleutel voor het bestand.
+        indiening (ForeignKey): Een ForeignKey relatie met het 'Indiening' model,
+        waarmee wordt aangegeven tot welke indiening dit bestand behoort.
+        Als de bijbehorende indiening wordt verwijderd,
+        wordt ook het bijbehorende bestand verwijderd.
+        bestand (FileField): Een veld voor het uploaden van het bestand.
+
+    Methods:
+        __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)
+    bestand = models.FileField(upload_to=upload_to)
+
+    def __str__(self):
+        return str(self.bestand.name)

api/models/project.py

@@ -0,0 +1,54 @@
+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.
+
+    Args:
+        instance: De huidige instantie van het model.
+        filename (str): De oorspronkelijke bestandsnaam.
+
+    Returns:
+        str: Het pad waar het opgavebestand moet worden opgeslagen.
+    """
+    vak_id = instance.vak.vak_id
+    return f"data/opgaves/vak_{vak_id}/{filename}"
+
+
+class Project(models.Model):
+    """
+    Model voor een project binnen een vak.
+
+    Fields:
+        project_id (AutoField): Een automatisch gegenereerd veld dat fungeert als de primaire sleutel voor het project.
+        titel (CharField): Titel van het project.
+        beschrijving (TextField): Beschrijving van het project.
+        opgave_bestand (FileField): Een veld voor het uploaden van het opgavebestand voor het project.
+        (eventueel uit te breiden tot meerdere bestanden mogelijk)
+        vak (ForeignKey): Een ForeignKey relatie met het 'Vak' model,
+        waarmee wordt aangegeven tot welk vak dit project behoort.
+        Als het bijbehorende vak wordt verwijderd, worden ook de bijbehorende projecten verwijderd.
+        deadline (DateTimeField): Een veld voor het instellen van de deadline voor het project.
+        Kan optioneel zijn (null=True).
+        max_score (IntegerField): Een veld voor het instellen van de maximale score voor het project.
+        Standaard ingesteld op 20.
+        # indiening restricties (TODO): Restricties/tests bij indiening moeten nog toegevoegd worden.
+
+    Methods:
+        __str__(): Geeft een representatie van het model als een string terug,
+        die de titel van het project bevat.
+    """
+
+    project_id = models.AutoField(primary_key=True)
+    titel = models.CharField(max_length=100)
+    beschrijving = models.TextField()
+    opgave_bestand = models.FileField(upload_to=upload_to)
+    vak = models.ForeignKey(Vak, on_delete=models.CASCADE)
+    deadline = models.DateTimeField(null=True)
+    max_score = models.IntegerField(default=20)
+    # indiening restricties
+
+    def __str__(self):
+        return self.titel

api/models/score.py

@@ -0,0 +1,25 @@
+from django.db import models
+
+
+class Score(models.Model):
+    """
+    Model voor het bijhouden van scores voor indieningen.
+
+    Fields:
+        score_id (AutoField): Een automatisch gegenereerd veld dat fungeert als de primaire sleutel voor de score.
+        score (SmallIntegerField): Een veld om de scorewaarde op te slaan.
+        indiening (ForeignKey): Een ForeignKey relatie met het 'Indiening' model,
+        waarmee wordt aangegeven tot welke indiening deze score behoort.
+        Als de bijbehorende indiening wordt verwijderd,
+        wordt ook de bijbehorende score verwijderd.
+
+    Methods:
+        __str__(): Geeft een representatie van het model als een string terug, die de score-ID bevat.
+    """
+
+    score_id = models.AutoField(primary_key=True)
+    score = models.SmallIntegerField()
+    indiening = models.ForeignKey("Indiening", on_delete=models.CASCADE)
+
+    def __str__(self):
+        return str(self.score_id)