Backend/feature/projects endpoint #31

Gerwoud · 2024-02-25T20:40:28Z

Draft pull request for implementation of projects end point

AronBuzogany

You are adding 2 blueprints. You should instead use one blueprint for both /projects and /projects/{project_id}. The implementations are in 2 different files, you can place them into 1 bigger file.

backend/project/endpoints/projects/project_detail.py

backend/project/__main__.py

backend/project/endpoints/projects/project_detail.py

backend/tests/endpoints/index_test.py

backend/tests/endpoints/project_test.py

Vucis · 2024-03-03T17:29:51Z

backend/project/endpoints/index/OpenAPI_Object.json

+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "ojbect",


"ojbect" -> "object"

Vucis · 2024-03-03T17:30:07Z

backend/project/endpoints/index/OpenAPI_Object.json

+        }
+      },
+      "patch": {
+        "description": "Patch certain fields op a project",


"op" -> "of"

Vucis · 2024-03-03T17:30:28Z

backend/project/endpoints/index/OpenAPI_Object.json

+            }
+          },
+          "404": {
+            "description": "Tried to patch a user that is not present",


"user" -> "project"

Vucis · 2024-03-03T17:30:38Z

backend/project/endpoints/index/OpenAPI_Object.json

+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "ojbect",


"ojbect" -> "object"

Vucis · 2024-03-03T17:32:11Z

backend/project/endpoints/projects/project_detail.py

+        # get the project that need to be edited
+        project = Projects.query.filter_by(project_id=project_id).first()
+
+        # check which values are not None is the dict


"is" -> "in"

backend/project/endpoints/projects/project_detail.py

Vucis · 2024-03-03T17:33:01Z

backend/project/endpoints/projects/project_detail.py

+
+    def delete(self, project_id):
+        """
+        Detele a project and all of its submissions in cascade


"Detele" -> "Delete"

Vucis · 2024-03-03T17:33:41Z

backend/project/endpoints/projects/project_endpoint.py

@@ -0,0 +1,23 @@
+"""
+Module for providing the blueprint to the api
+of both route


"route" -> "routes"

Vucis · 2024-03-03T17:34:39Z

backend/project/models/projects.py

    """This class describes the projects table,
    a projects has an id, a title, a description, 
    an optional assignment file that can contain more explanation of the projects,
    an optional deadline,
    the course id of the course to which the project belongs,
    visible for students variable so a teacher can decide if the students can see it yet,
    archieved var so we can implement the archiving functionality,
-    a test path,script name and regex experssions for automated testing"""
+    a test path,script name and regex experssions for automated testing


"experssions" -> "expressions"

Vucis · 2024-03-03T17:35:37Z

backend/project/models/projects.py


 from sqlalchemy import ARRAY, Boolean, Column, DateTime, ForeignKey, Integer, String, Text
 from project import db

-class Projects(db.Model):
+@dataclasses.dataclass
+class Projects(db.Model): # pylint: disable=too-many-instance-attributes
    """This class describes the projects table,
    a projects has an id, a title, a description, 
    an optional assignment file that can contain more explanation of the projects,
    an optional deadline,
    the course id of the course to which the project belongs,
    visible for students variable so a teacher can decide if the students can see it yet,
    archieved var so we can implement the archiving functionality,


I know it's still archieved in the database but maybe change it to archived here already for when we update the db

This is not part of this pull request and this should be resolved in #32

Vucis · 2024-03-03T17:35:55Z

backend/project/models/projects.py

-    a test path,script name and regex experssions for automated testing"""
+    a test path,script name and regex experssions for automated testing
+
+    Pylint disalbe too many intance attributes because we can't reduce the amount


"disalbe" -> "disable"

"intance" -> "instance"

Vucis · 2024-03-03T17:37:47Z

backend/project/models/projects.py

+    deadline: str = Column(DateTime(timezone=True))
+    course_id: int = Column(Integer, ForeignKey("courses.course_id"), nullable=False)
+    visible_for_students: bool = Column(Boolean, nullable=False)
+    archieved: bool = Column(Boolean, nullable=False)


Same as the other archieved, but I think the code won't work anymore if you change this one, so maybe place a todo comment for when we change the db so we can remember

Vucis · 2024-03-03T17:38:15Z

backend/tests/endpoints/conftest.py

+
+@pytest.fixture
+def course_teacher():
+    """A user that's a teacher for for testing"""


Vucis · 2024-03-03T17:39:28Z

backend/tests/endpoints/conftest.py

+        assignment_file="testfile",
+        deadline=date,
+        visible_for_students=True,
+        archieved=False,


Honestly maybe just wait with all the archieved's and do one big find replace when the db changes, but still maybe place todo's just in case

Vucis · 2024-03-03T17:39:39Z

backend/tests/endpoints/conftest.py

+        "deadline": project.deadline,
+        "course_id": project.course_id,
+        "visible_for_students": project.visible_for_students,
+        "archieved": project.archieved,


same as the others

Vucis · 2024-03-03T17:40:33Z

backend/tests/endpoints/project_test.py

+
+
+def test_post_project(db_session, client, course, course_teacher, project_json):
+    """Test posting a project to the datab and testing if it's present"""


maybe just write database in full

Vucis · 2024-03-03T17:41:29Z

backend/tests/endpoints/project_test.py

+
+
+def test_remove_project(db_session, client, course, course_teacher, project_json):
+    """Test removing a project to the datab and fetching it, testing if its not present anymore"""


"""Test removing a project to the datab and fetching it, testing if its not present anymore""" -> """Test removing a project from the database and fetching it, testing if it's not present anymore"""

Vucis · 2024-03-03T17:42:14Z

backend/tests/endpoints/project_test.py

+
+def test_update_project(db_session, client, course, course_teacher, project):
+    """
+    Test functionality of the PUT method for projects


doesn't this test the PATCH method?

# Conflicts: # backend/project/__init__.py # backend/project/__main__.py # backend/project/db_in.py # backend/project/endpoints/index/OpenAPI_Object.json # backend/project/models/projects.py # backend/tests/endpoints/conftest.py # backend/tests/models/conftest.py

Gerwoud added 23 commits February 24, 2024 14:34

route /projects/ added

91e6dd6

added functionality for parsing the dict once the query is ran

de332a7

display json data at endpoint instead of dummy data

b032e39

detail endpoint created

9f5e4f3

post functionality for projects

2dc1340

remove functionality for projects, only works with updated sql script

aed5d38

added right exit codes

eeb38b5

code reformat

e1125c2

added 404 page if you're trying to remove a non-existing project

6475ea5

404 function made

c6fb5eb

added basic add and remove test for project

3399e6d

wrote extra test for just getting the users

100572a

added put for a project

aa0269d

added test for put

792ddd9

testing working

28b82fa

added comments to project_test project and projects_detail

5db9ded

added pytest fixture

8bd67ae

added right dummy data for fixtures

3ec266d

linter fixes, project endpoint files now score 10/10

f9295fc

more linter fixes

3cedf3e

linter import order fix

7206efa

added ingores for linter

b3a53bd

more linter

5be4c0a

Gerwoud marked this pull request as ready for review February 26, 2024 18:29

Gerwoud requested review from Vucis and AronBuzogany February 26, 2024 18:30

AronBuzogany requested changes Feb 26, 2024

View reviewed changes

Gerwoud added 3 commits February 26, 2024 21:40

renamed is_existing_project function

061dbd8

changed arguments of get functions to not use **kwargs anymore

5b544f9

fixed jsonify issue for response

9f5033a

Vucis reviewed Mar 3, 2024

View reviewed changes

backend/project/endpoints/projects/project_detail.py Outdated Show resolved Hide resolved

Vucis reviewed Mar 3, 2024

View reviewed changes

Gerwoud added 5 commits March 3, 2024 19:53

fixed typos in OpenAPI_Object.json

604cd92

fixed typos in project_detail

97f0866

fixed typos in model Projects

b89f5b3

typo fixed

5c2b718

route -> routes

12b1a29

Gerwoud requested a review from Vucis March 4, 2024 11:38

Vucis approved these changes Mar 4, 2024

View reviewed changes

Gerwoud added 3 commits March 5, 2024 10:30

fix: naming of new database schemes

cdd94d2

i <3 linters

e055344

AronBuzogany merged commit f918b18 into development Mar 5, 2024
4 checks passed

AronBuzogany deleted the backend/feature/projects-endpoint branch March 5, 2024 10:31



		def test_post_project(db_session, client, course, course_teacher, project_json):
		"""Test posting a project to the datab and testing if it's present"""



		def test_remove_project(db_session, client, course, course_teacher, project_json):
		"""Test removing a project to the datab and fetching it, testing if its not present anymore"""

Backend/feature/projects endpoint #31

Backend/feature/projects endpoint #31

Conversation

Gerwoud commented Feb 25, 2024

AronBuzogany left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment