Software Testing Course Project: Add tests to discover bugs

.gitignore

@@ -1,4 +1,5 @@
-# Ignore all Markdown files
-
+*.pyc
 README.md
-
+.coverage
+*.gif
+venv

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

README.md

@@ -1,19 +1,19 @@
 # College Enterprise Resource Planner
+
 This is a College Enterprise Resource Planner Developed by me and my project partners for my college.
 We use Python/Django Framwork for building an fully functional web application. (If facing problem!! : put discussion)
-## Deployed at <a href="https://syncx.pythonanywhere.com" target="_blank" rel="SIGCE"><img src="media/SIGCE.png" width="20" height="20" alt="SIGCE" /><span> SIGCE</span></a>   v1.1.0
-
-For viewing the home page of student you must have required credentials given below 
 
--> E-Mail : student@student.com 
--> Password : student@erp
+## Deployed at <a href="https://syncx.pythonanywhere.com" target="_blank" rel="SIGCE"><img src="media/SIGCE.png" width="20" height="20" alt="SIGCE" /><span> SIGCE</span></a> v1.1.0
 
+For viewing the home page of student you must have required credentials given below
 
+-> E-Mail : student@student.com
+-> Password : student@erp
 
 ## Features of this Project
 
-
 ### A. Admin Users Can
+
 1. See Overall Summary Charts of Students Performances, Staff Performances, Courses, Subjects, Leave, etc.
 2. Manage Staff (Add, Update and Delete)
 3. Manage Students (Add, Update and Delete)
@@ -25,119 +25,138 @@ For viewing the home page of student you must have required credentials given be
 9. Review (Approve/Reject) Student/Staff Leave
 
 ### B. Staff/Teachers Can
+
 1. See the Overall Summary Charts related to their students, their subjects, leave status, etc.
 2. Take/Update Students Attendance
 3. Add/Update Result
 4. Apply for Leave
 5. Send Feedback to HOD
 
 ### C. Students Can
+
 1. See the Overall Summary Charts related to their attendance, their subjects, leave status, etc.
 2. View Attendance
 3. View Result
 4. Apply for Leave
 5. Send Feedback to HOD
 
-
 ## Support Developer
-1. Add a Star 🌟  to this 👆 Repository
-2. Follow on Github & LinkedIn 
 
+1. Add a Star 🌟 to this 👆 Repository
+2. Follow on Github & LinkedIn
 
 ## How to Install and Run this project?
 
 ### Pre-Requisites:
+
 1. Install Git Version Control
-[ https://git-scm.com/ ]
+   [ https://git-scm.com/ ]
 
 2. Install Python Latest Version
-[ https://www.python.org/downloads/ ]
+   [ https://www.python.org/downloads/ ]
 
 3. Install Pip (Package Manager)
-[ https://pip.pypa.io/en/stable/installing/ ]
+   [ https://pip.pypa.io/en/stable/installing/ ]
 
-*Alternative to Pip is Homebrew*
+_Alternative to Pip is Homebrew_
 
 ### Installation
+
 **1. Create a Folder where you want to save the project**
 
 **2. Create a Virtual Environment and Activate**
 
 Install Virtual Environment First
+
 ```
 $  pip install virtualenv
 ```
 
 Create Virtual Environment
 
 For Windows
+
 ```
 $  python -m venv venv
 ```
+
 For Mac
+
 ```
 $  python3 -m venv venv
 ```
+
 For Linux
+
 ```
 $  virtualenv .
 ```
 
 Activate Virtual Environment
 
 For Windows
+
 ```
 $  source venv/scripts/activate
 ```
 
 For Mac
+
 ```
 $  source venv/bin/activate
 ```
 
 For Linux
+
 ```
 $  source bin/activate
 ```
 
 **3. Clone this project**
+
 ```
 $  git clone https://github.com/Ansarimajid/College-ERP.git
 ```
 
 Then, Enter the project
+
 ```
 $  cd College-ERP
 ```
 
 **4. Install Requirements from 'requirements.txt'**
+
 ```python
 $  pip3 install -r requirements.txt
 ```
 
 **5. Add the hosts**
 
-- Got to settings.py file 
-- Then, On allowed hosts, Use **[]** as your host. 
+- Got to settings.py file
+- Then, On allowed hosts, Use **[]** as your host.
+
 ```python
 ALLOWED_HOSTS = []
 ```
-*Do not use the fault allowed settings in this repo. It has security risk!*
 
+_Do not use the fault allowed settings in this repo. It has security risk!_
 
 **6. Now Run Server**
 
 Command for PC:
+
 ```python
 $ python manage.py runserver
 ```
 
 Command for Mac:
+
 ```python
 $ python3 manage.py runserver
 ```
 
 Command for Linux:
+
 ```python
 $ python3 manage.py runserver
 ```
@@ -146,33 +165,36 @@ $ python3 manage.py runserver
 
 Create Super User (HOD)
 Command for PC:
+
 ```
 $  python manage.py createsuperuser
 ```
 
 Command for Mac:
+
 ```
 $  python3 manage.py createsuperuser
 ```
 
 Command for Linux:
+
 ```
 $  python3 manage.py createsuperuser
 ```
 
-
-
 ## Project's Journey
+
 | Admin/Staff/Student Login |
 | Add and Edit Course |
+
 - [x] Add and Edit Staff
 - [x] Add and Edit Student
 - [x] Add and Edit Subject
 - [x] Upload Staff's Picture
 - [x] Upload Student's Picture
 - [x] Sidebar Active Status
 - [x] Named URLs
-- [x] Model Forms for adding  student
+- [x] Model Forms for adding student
 - [x] Model Forms for all
 - [x] Views Permission (MiddleWareMixin)
 - [x] Attendance and Update Attendance
@@ -183,12 +205,12 @@ $  python3 manage.py createsuperuser
 - [x] Reply to Leave Applications
 - [x] Reply to Feedback
 - [x] Admin View Attendance
-- [x] Password Change for Admin, Staff and Students using *set_password()*
+- [x] Password Change for Admin, Staff and Students using _set_password()_
 - [x] Admin Profile Edit
 - [x] Staff Profile Edit
 - [x] Student Profile Edit
 - [x] Student Dashboard Fixed
-- [x] Passing Page Title From View  - Improved
+- [x] Passing Page Title From View - Improved
 - [x] Staff Dashboard Fixed
 - [x] Admin Dashboard Fixed
 - [x] Staff Add Student's Result
@@ -197,3 +219,63 @@ $  python3 manage.py createsuperuser
 - [x] Student View Result
 - [x] Change all links to be dynamic
 - [x] Code Restructure - Very Important
+
+### Run tests
+
+Set up virtual environmment and install requirements
+```
+python3 -m venv venv
+source venv/bin/activate
+pip3 install -r requirements.txt
+```
+
+Create a superuser with the following specifications
+```
+python3 manage.py createsuperuser
+$ Email: superuser@gmail.com
+$ Password: superuser
+$ Password (again): superuser
+$ Bypass password validation and create user anyway? [y/N]: y
+```
+
+Run server
+```
+python3 manage.py runserver
+```
+
+Run tests in another terminal:
+Set up for GUI testing 
+```
+source venv/bin/activate
+brew install chromedriver
+brew upgrade chromedriver
+xattr -d com.apple.quarantine $(which chromedriver)
+python3 tests/GUI_setup.py
+```
+Notes
+- If the second command prints "No such xattr: com.apple.quarantine", ignore it and move on to the next command
+- Make sure to have [homebrew](https://docs.brew.sh/Installation) installed
+
+# statement coverage
+
+```
+coverage run manage.py test -v=2 tests
+```
+
+# branch coverage
+
+```
+coverage run --branch manage.py test -v=2 tests
+```
+
+# Check coverage
+
+`coverage report`: see coverage in terminal
+`coverage html`: see coverage in browser
+
+Some non-logic files are excluded. See what those are in setup.cfg
+
+# Errors
+
+If you get the error "error: externally-managed-environment" when running pip3 install-" when trying to run the server, try the following:
+`export PATH=".:/Library/Frameworks/Python.framework/Versions/3.12/bin:/usr/local/bin:${PATH}"`