Merge pull request #61 from ProgrammingBuddies/setup_tests

Setup tests

Author: petak5

Pipfile

@@ -15,6 +15,7 @@ flask-dance = "*"
 pyopenssl = "*"
 flask-swagger = "*"
 flask-swagger-ui = "*"
+pytest = "*"
 
 [requires]
 python_version = "3.7"

Pipfile.lock

@@ -40,6 +40,12 @@ Install docker-compose and do `docker-compose up`. Don't forget to setup your
 
 Your `.env` file should now look something like [example.env](https://github.com/ProgrammingBuddies/programmingbuddies-api/blob/develop/example.env)
 
+### Testing
+
+- to run multiple tests just specify the directory which contains them for example `pipenv run pytest tests/`
+- - this will run all the tests in the `tests` directory
+- if you want to run test cases only in a particular file, then just give the full file path `pipenv run pytest tests/example.py`
+
 ## Milestones
 - [ ] build DB and endpoints with basic CRUD
 - [ ] add security for app (ie - bots, and non-human actors/clients)

README.md

@@ -19,7 +19,7 @@ def update_project(self, id, **kwargs):
 
         if project == None:
             return None
-        
+
         for key, value in kwargs.items():
             if not hasattr(project, key):
                 return None
@@ -69,6 +69,7 @@ def create_link(self, project_id, **kwargs):
 
             return link
         except:
+            self.session.rollback()
             return None
 
     def update_link(self, project_id, link_id, **kwargs):
@@ -113,6 +114,7 @@ def create_feedback(self, project_id, **kwargs):
 
             return feedback
         except:
+            self.session.rollback()
             return None
 
     def get_all_feedbacks(self, project_id):

src/api/controllers/projectController.py

@@ -12,6 +12,7 @@ def create_user(self, **kwargs):
 
             return user
         except:
+            self.session.rollback()
             return None
 
     def update_user(self, id, **kwargs):
@@ -69,6 +70,7 @@ def create_link(self, user_id, **kwargs):
 
             return link
         except:
+            self.session.rollback()
             return None
 
     def update_link(self, user_id, link_id, **kwargs):
@@ -113,6 +115,7 @@ def create_feedback(self, user_id, **kwargs):
 
             return feedback
         except:
+            self.session.rollback()
             return None
 
     def get_all_feedbacks(self, user_id):

src/api/controllers/userController.py

@@ -0,0 +1,11 @@
+import os
+import sys
+
+# todo: change this importing solution
+sys.path.insert(0, os.getcwd()+'/src')
+
+from api import app
+from api.models import db
+from api.models import User, Project, UserFeedback, ProjectFeedback, UserLink, ProjectLink
+
+sys.path.insert(0, os.getcwd()+'/tests')

tests/__init__.py

@@ -0,0 +1,56 @@
+
+"""
+
+  Creates valid model objects for testing purposes:
+
+    - insert data to the database which could be used for testing
+
+    - these functions will give back the created objects in dict format which is hardcoded at every model's as_dict instance method
+
+    - call these functions form any test case.
+
+"""
+
+from tests import db, Project, User, UserLink, ProjectLink, UserFeedback
+
+def create_project_for_test_cases(data):
+    new_project = Project(**data)
+    db.session.add(new_project)
+    db.session.commit()
+
+    return new_project.as_dict()
+
+def create_project_link_for_test_cases(data):
+    new_project_link = ProjectLink(**data)
+    db.session.add(new_project_link)
+    db.session.commit()
+
+    return new_project_link.as_dict()
+
+def create_user_for_test_cases(data):
+    new_user = User(**data)
+    db.session.add(new_user)
+    db.session.commit()
+
+    return new_user.as_dict()
+
+def create_user_link_for_test_cases(data):
+    new_user_link = UserLink(**data)
+    db.session.add(new_user_link)
+    db.session.commit()
+
+    return new_user_link.as_dict()
+
+def create_user_feedback_for_test_cases(user1, user2):
+    feedback_data = {
+        "author_id": user1["id"],
+        "user_id": user2["id"],
+        "description": "This is the description",
+        "rating": 1
+    }
+
+    new_user_feedback = UserFeedback(**feedback_data)
+    db.session.add(new_user_feedback)
+    db.session.commit()
+
+    return new_user_feedback.as_dict()

tests/api/__init__.py

@@ -0,0 +1,5 @@
+from tests.conftest import client
+from tests import db, User
+
+class TestUserModel(object):
+    pass