diff --git a/.gitignore b/.gitignore
index 2cba99d87..23535d79f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@ bin
include
lib
.Python
-tests/
.envrc
-__pycache__
\ No newline at end of file
+__pycache__
+.idea/
+.coverage
\ No newline at end of file
diff --git a/README.md b/README.md
index 61307d2cd..58a51c029 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,234 @@
-# gudlift-registration
+# Flask App - OpenClassrooms Project 11
+**Improve a web Flask app by testing and debugging**
-1. Why
+---
+## DESCRIPTION
- This is a proof of concept (POC) project to show a light-weight version of our competition booking platform. The aim is the keep things as light as possible, and use feedback from the users to iterate.
+This project was completed as part of the "Python Developer" path at OpenClassrooms.
-2. Getting Started
+The goal was to improve a web application, through testing and debugging, capable of:
- This project uses the following technologies:
+- managing lifting competitions
+- allowing clubs to authenticate themselves within the application
+- allowing clubs to reserve places in several lifting competitions
- * Python v3.x+
+The application must:
- * [Flask](https://flask.palletsprojects.com/en/1.1.x/)
+- allow the club secretary to log in.
+- allow the club secretary to view competitions and other clubs' points.
+- allow the club secretary to use their points to purchase competition tickets.
+- display error messages in case of incorrect action, according to the application specifications.
- Whereas Django does a lot of things for us out of the box, Flask allows us to add only what we need.
-
+---
- * [Virtual environment](https://virtualenv.pypa.io/en/stable/installation.html)
+## PROJECT STRUCTURE
+
+
+
- This ensures you'll be able to install the correct packages without interfering with Python on your machine.
+---
- Before you begin, please ensure you have this installed globally.
+## INSTALLATION
+- ### Clone the repository :
-3. Installation
+```
+git clone https://github.com/Tit-Co/OpenClassrooms_Project_11.git
+```
- - After cloning, change into the directory and type virtualenv .. This will then set up a a virtual python environment within that directory.
+- ### Navigate into the project directory :
+ `cd OpenClassrooms_Project_11`
- - Next, type source bin/activate. You should see that your command prompt has changed to the name of the folder. This means that you can install packages in here without affecting affecting files outside. To deactivate, type deactivate
+- ### Create a virtual environment and dependencies :
- - Rather than hunting around for the packages you need, you can install in one step. Type pip install -r requirements.txt. This will install all the packages listed in the respective file. If you install a package, make sure others know by updating the requirements.txt file. An easy way to do this is pip freeze > requirements.txt
+1. #### With [uv](https://docs.astral.sh/uv/)
- - Flask requires that you set an environmental variable to the python file. However you do that, you'll want to set the file to be server.py. Check [here](https://flask.palletsprojects.com/en/1.1.x/quickstart/#a-minimal-application) for more details
+ `uv` is an environment and dependencies manager.
+
+ - #### Install environment and dependencies
+
+ `uv sync`
- - You should now be ready to test the application. In the directory, type either flask run or python -m flask run. The app should respond with an address you should be able to go to using your browser.
+2. #### With pip
-4. Current Setup
+ - #### Install the virtual env :
- The app is powered by [JSON files](https://www.tutorialspoint.com/json/json_quick_guide.htm). This is to get around having a DB until we actually need one. The main ones are:
-
- * competitions.json - list of competitions
- * clubs.json - list of clubs with relevant information. You can look here to see what email addresses the app will accept for login.
+ `python -m venv env`
-5. Testing
+ - #### Activate the virtual env :
+ `source env/bin/activate`
+ Or
+ `env\Scripts\activate` on Windows
- You are free to use whatever testing framework you like-the main thing is that you can show what tests you are using.
+3. #### With [Poetry](https://python-poetry.org/docs/)
- We also like to show how well we're testing, so there's a module called
- [coverage](https://coverage.readthedocs.io/en/coverage-5.1/) you should add to your project.
+ `Poetry` is a tool for dependency management and packaging in Python.
+
+ - #### Install the virtual env :
+ `py -3.13 -m venv env`
+
+ - #### Activate the virtual env :
+ `poetry env activate`
+- ### Install dependencies
+ 1. #### With [uv](https://docs.astral.sh/uv/)
+ `uv sync` or `uv pip install -r requirements.txt`
+
+ 2. #### With pip
+ `pip install -r requirements.txt`
+
+ 3. #### With [Poetry](https://python-poetry.org/docs/)
+ `poetry install`
+
+ (NB : Poetry and uv will read the `pyproject.toml` file to know which dependencies to install)
+
+---
+
+## USAGE
+
+### Launching server
+- Open a terminal
+- Go to project folder - example : `cd gudlft`
+- Activate the virtual environment as described previously
+- Create flask environment : `$env:FLASK_APP = "server"` (for example in Powershell)
+- Launch the Django server : `flask run`
+
+### Launching the APP
+- Open a web browser
+- And type the URL : `http://127.0.0.1:5000/`
+
+---
+
+## ISSUES THAT HAS BEEN FIXED
+
+- A user types in an email not found in the system
+- The club should not be able to redeem more points than available
+- The club should be able to book no more than 12 places
+- The club should not be able to book a place on a post-dated competition (but past competitions should be visible).
+- The amount of points used should be deducted from the club's balance
+- The club should be able to see the list of clubs and their associated current points balance
+- The club should not be able to book more than the competition places available
+
+---
+
+## EXPLANATIONS OF WHAT THE APP DOES
+
+### Registration
+- The user can sign in the application by typing the club name, email and password (two times).
+
+### Authentication
+- The user can log in the application by typing the club email and password.
+
+### Profile page
+- The user can see the club profile by clicking on "go to profile" link in welcome page.
+
+### Welcome page
+- The user can view all past and upcoming competitions, and access the booking page by clicking on the competition they
+wish to participate in.
+
+### Booking page
+- The user can book places in the competition by typing the number of places. The UI will display a message according
+to the validation or rejection of the entry.
+
+### Log out
+- The user can log out by clicking the appropriate link.
+
+### Points board
+- The user can view the points board with all the clubs and their points.
+- No need to be authenticated to see this board.
+
+---
+
+## TEMPLATES EXAMPLES
+
+- Registration
+
+
+
+
+- Authentication
+
+
+
+
+- Profile page
+
+
+
+
+- Change password
+
+
+
+
+- Points board
+
+
+
+
+- Welcome page
+
+
+
+
+- Booking page
+
+
+
+
+- Log out
+
+
+
+
+---
+## PEP 8 CONVENTIONS
+
+- Flake 8 report (yet to come)
+
+
+
+
+**Type the line below in the terminal to generate another report with [flake8-html](https://pypi.org/project/flake8-html/) tool :**
+
+` flake8 --format=html --htmldir=flake8-report --max-line-length=119 --extend-exclude=env/`
+
+---
+
+## TESTS COVERAGE WITH PYTEST
+
+Cov report
+
+
+
+
+
+- **Type the line below in the terminal to generate another coverage report with pytest**
+
+ `pytest --cov=server --cov-report=html:`
+
+---
+
+## PERFORMANCE TESTS WITH LOCUST
+
+Locust report (yet to come)
+
-
-
\ No newline at end of file
+ Go back
+{% endblock %}
\ No newline at end of file
diff --git a/templates/change_password.html b/templates/change_password.html
new file mode 100644
index 000000000..796d130cb
--- /dev/null
+++ b/templates/change_password.html
@@ -0,0 +1,38 @@
+{% extends 'base.html' %}
+{% block content %}
+
+ {% with messages = get_flashed_messages()%}
+ {% if messages %}
+
+ {% for message in messages %}
+ {% if "Sorry" in message %}
+ {% if error %}
+
{{ error }} - ❌ {{message}}
+ {% else %}
+
❌ {{message}}
+ {% endif %}
+ {% else %}
+
✅ {{message}}
+ {% endif %}
+ {% endfor %}
+
+ {% endif%}
+ {%endwith%}
+
+
Change Password
+ ⯈ Please enter your new password:
+ Name : {{club['name']}}
+ Email : {{club['email']}}
+
+
+
+ Go to profile
+{% endblock %}
\ No newline at end of file
diff --git a/templates/index.html b/templates/index.html
index 926526b7d..5efb26fcb 100644
--- a/templates/index.html
+++ b/templates/index.html
@@ -1,16 +1,35 @@
-
-
-
-
- GUDLFT Registration
-
-
-
Welcome to the GUDLFT Registration Portal!
- Please enter your secretary email to continue:
+{% extends 'base.html' %}
+{% block content %}
+
+ {% with messages = get_flashed_messages()%}
+ {% if messages %}
+
+ {% for message in messages %}
+ {% if "Sorry" in message %}
+ {% if error %}
+
{{ error }} - ❌ {{message}}
+ {% else %}
+
❌ {{message}}
+ {% endif %}
+ {% else %}
+
✅ {{message}}
+ {% endif %}
+ {% endfor %}
+
+ {% endif%}
+ {%endwith%}
+
+
Authentication
+ ⯈ Please enter your secretary email and your password to continue or sign up
+
+
-
-
\ No newline at end of file
+
+{% endblock %}
\ No newline at end of file
diff --git a/templates/points_board.html b/templates/points_board.html
new file mode 100644
index 000000000..da56c498d
--- /dev/null
+++ b/templates/points_board.html
@@ -0,0 +1,28 @@
+{% extends 'base.html' %}
+{% block content %}
+
Points board
+
+ ⯈ Here is the board for all the clubs and their points.
+
+
+
+
Club
+
Points
+
+ {% for club in clubs %}
+
+
{{ club.name }}
+
{{ club.points }}
+
+ {% endfor %}
+
+
+
+ To continue into the application,
+ {% if club %}
+ go to summary
+ {% else %}
+ please log in
+ {% endif %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/templates/profile.html b/templates/profile.html
new file mode 100644
index 000000000..32bb22bc0
--- /dev/null
+++ b/templates/profile.html
@@ -0,0 +1,31 @@
+{% extends 'base.html' %}
+{% block content %}
+
+ {% with messages = get_flashed_messages()%}
+ {% if messages %}
+
+ {% for message in messages %}
+ {% if "Sorry" in message %}
+ {% if error %}
+
')
+ print(li)
+
+ assert client_response.status_code == 200
+ assert (f"Great! Booking of {purchasing_data['places']} place(s) for "
+ f"{purchasing_data['competition']} competition complete!") in data
+ assert f"Welcome, {the_club["email"]} " in data
+ assert li in all_li_str
+ assert f"Points available: {new_points}" in data
+
+ @staticmethod
+ def test_purchasing_places_not_enough_points_returns_sorry(client,
+ get_credentials_2,
+ get_existing_competition_and_club_2,
+ get_inconsistent_purchasing_data):
+ """
+ Test that the 403 status code and an error message are returned in case of not enough
+ points while purchasing.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_2 (dict): The credentials
+ get_existing_competition_and_club_2 (dict): The competition and club
+ get_inconsistent_purchasing_data (dict): The purchasing data
+ """
+ client.post('/showSummary', data=get_credentials_2)
+ client.get(url_for(endpoint='book',
+ competition=get_existing_competition_and_club_2['competition'],
+ club=get_existing_competition_and_club_2['club']))
+
+ the_club = [club for club in utils.clubs
+ if club["name"] == get_existing_competition_and_club_2['club']][0]
+
+ client_response = client.post('/purchasePlaces', data=get_inconsistent_purchasing_data)
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Not enough points" in data
+ assert f"Welcome, {the_club["email"]} " in data
+ assert "Sorry, you do not have enough points to purchase." in data
+ assert f"Points available: {the_club['points']}" in data
+
+ @staticmethod
+ def test_purchasing_places_over_12_places_returns_sorry(client,
+ get_credentials,
+ purchasing_over_12_places):
+ """
+ Test that the 403 status code and an error message are returned in case of purchasing more
+ than 12 places.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ purchasing_over_12_places (dict): The purchasing data
+ """
+ client.post('/showSummary', data=get_credentials)
+
+ purchasing_data = purchasing_over_12_places
+
+ client.get(url_for(endpoint='book',
+ competition=purchasing_data['competition'],
+ club=purchasing_data['club']))
+
+ the_club = [club for club in utils.clubs if club["name"] == purchasing_data['club']][0]
+ club_points = the_club['points']
+
+ client_response = client.post('/purchasePlaces', data=purchasing_data)
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Over 12 places" in data
+ assert f"Welcome, {the_club["email"]} " in data
+ assert "Sorry, you are not allow to purchase more than 12 places for this competition." in data
+ assert f"Points available: {club_points}" in data
+
+ @staticmethod
+ def test_purchasing_places_over_12_cumulative_places_returns_sorry(client,
+ get_credentials,
+ purchasing_13_cumulative_places):
+ """
+ Test that the 403 status code and an error message are returned in case of purchasing more
+ than 12 cumulative places.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ purchasing_13_cumulative_places (dict): The purchasing data
+ """
+ client.post('/showSummary', data=get_credentials)
+
+ purchasing_data = purchasing_13_cumulative_places
+
+ client.get(url_for(endpoint='book',
+ competition=purchasing_data['competition'],
+ club=purchasing_data['club']))
+
+ the_club = [club for club in utils.clubs if club["name"] == purchasing_data['club']][0]
+ club_points = the_club['points']
+
+ client_response = client.post('/purchasePlaces', data=purchasing_data)
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert f"Welcome, {the_club["email"]} " in data
+ assert "Over 12 places" in data
+ assert "Sorry, you are not allow to purchase more than 12 places for this competition." in data
+ assert f"Points available: {club_points}" in data
+
+ @staticmethod
+ def test_purchasing_places_negative_number_returns_sorry(client,
+ get_credentials,
+ purchasing_with_negative_places):
+ """
+ Test that the 403 status code and an error message are returned in case of purchasing with
+ negative value of places.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ purchasing_with_negative_places (dict): The purchasing data
+ """
+ client.post('/showSummary', data=get_credentials)
+
+ purchasing_data = purchasing_with_negative_places
+
+ client.get(url_for(endpoint='book',
+ competition=purchasing_data['competition'],
+ club=purchasing_data['club']))
+
+ the_club = [club for club in utils.clubs if club["name"] == purchasing_data['club']][0]
+ club_points = the_club['points']
+
+ client_response = client.post('/purchasePlaces', data=purchasing_data)
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Negative number" in data
+ assert f"Welcome, {the_club["email"]} " in data
+ assert "Sorry, you should type a positive number." in data
+ assert f"Points available: {club_points}" in data
+
+ @staticmethod
+ def test_purchasing_places_past_competitions_returns_sorry(client,
+ get_credentials_2,
+ get_existing_competition_and_club_3):
+ """
+ Test that the 403 status code and an error message are returned in case of outdated
+ competition.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_2 (dict): The credentials
+ get_existing_competition_and_club_3 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_2)
+
+ client_response = client.get(url_for(endpoint='book',
+ competition=get_existing_competition_and_club_3['competition'],
+ club=get_existing_competition_and_club_3['club']))
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Outdated" in data
+ assert "Sorry, this competition is outdated. Booking not possible." in data
+
+ @staticmethod
+ def test_purchasing_places_over_available_returns_sorry(client,
+ get_credentials,
+ purchasing_places_more_than_available):
+ """
+ Test that the 403 status code and an error message are returned in case of purchasing more
+ than places available in the competition.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ purchasing_places_more_than_available (dict): The purchasing data
+ """
+ client.post('/showSummary', data=get_credentials)
+
+ purchasing_data = purchasing_places_more_than_available
+
+ client.get(url_for(endpoint='book',
+ competition=purchasing_data['competition'],
+ club=purchasing_data['club']))
+
+ the_club = [club for club in utils.clubs if club["name"] == purchasing_data['club']][0]
+ club_points = the_club['points']
+
+ client_response = client.post('/purchasePlaces', data=purchasing_data)
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Not enough places" in data
+ assert f"Welcome, {the_club["email"]} " in data
+ assert "Sorry, there are not enough places available for this competition." in data
+ assert f"Points available: {club_points}" in data
+
+ @staticmethod
+ def test_purchasing_places_sold_out_status_code_error(client,
+ get_credentials_3,
+ get_existing_competition_and_club_4):
+ """
+ Test that the 403 status code and an error message are returned in case of purchasing in a
+ sold out competition.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_3 (dict): The credentials
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_3)
+
+ client_response = client.get(url_for(endpoint='book',
+ competition=get_existing_competition_and_club_4['competition'],
+ club=get_existing_competition_and_club_4['club']))
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 403
+ assert "Sold out" in data
+ assert "Sorry, this competition is sold out. Booking not possible." in data
+
+ @staticmethod
+ def test_change_password_status_code_ok(client,
+ get_credentials_3,
+ get_existing_competition_and_club_4):
+ """
+ Test that the 200 status code and appropriate information are returned in case of correct
+ changing password
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_3 (dict): The credentials
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_3)
+
+ passwords = {
+ "password": "tr_nl_er4",
+ "confirm_password": "tr_nl_er4",
+ }
+
+ client_response = client.post(f'/changePassword/{get_existing_competition_and_club_4["club"]}',
+ data=passwords)
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 200
+ assert "Great! You have successfully changed your password." in data
+
+ @staticmethod
+ def test_change_password_match_fails(client,
+ get_credentials_3,
+ get_existing_competition_and_club_4):
+ """
+ Test that the 406 status code and an error message are returned in case of incorrect
+ changing password.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_3 (dict): The credentials
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_3)
+
+ passwords = {
+ "password": "tr_Pl_er4",
+ "confirm_password": "tr_nl_er4",
+ }
+
+ client_response = client.post(f'/changePassword/{get_existing_competition_and_club_4["club"]}',
+ data=passwords)
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 406
+ assert "Passwords not match" in data
+ assert "Sorry, passwords do not match." in data
+
+ @staticmethod
+ def test_change_password_identical(client,
+ get_credentials_3,
+ get_existing_competition_and_club_4):
+ """
+ Test that the 406 status code and an error message are returned in case of changing
+ password with identical password as current.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_3 (dict): The credentials
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_3)
+
+ passwords = {
+ "password": "tp4_Tmn40",
+ "confirm_password": "tp4_Tmn40",
+ }
+
+ client_response = client.post(f'/changePassword/{get_existing_competition_and_club_4["club"]}',
+ data=passwords)
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 406
+ assert "Identical password" in data
+ assert "Sorry, you have to type a new different password." in data
+
+ @staticmethod
+ def test_change_password_empty_field(client,
+ get_credentials_3,
+ get_existing_competition_and_club_4):
+ """
+ Test that the 406 status code and an error message are returned in case of changing
+ password with at least one empty field.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials_3 (dict): The credentials
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials_3)
+
+ passwords = {
+ "password": "tp4_Tmn40",
+ "confirm_password": "",
+ }
+
+ client_response = client.post(f'/changePassword/{get_existing_competition_and_club_4["club"]}',
+ data=passwords)
+
+ data = client_response.data.decode('utf-8')
+
+ assert client_response.status_code == 406
+ assert "Empty field(s)" in data
+ assert "Sorry, please fill all fields." in data
diff --git a/tests/performance_tests/__init__.py b/tests/performance_tests/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/performance_tests/clubs_tmp.json b/tests/performance_tests/clubs_tmp.json
new file mode 100644
index 000000000..ac944b3e3
--- /dev/null
+++ b/tests/performance_tests/clubs_tmp.json
@@ -0,0 +1,91 @@
+{
+ "clubs": [
+ {
+ "name": "Power Lift",
+ "email": "admin@powerlift.com",
+ "password": "scrypt:32768:8:1$c0ePLkJjwFO0xhpP$a9c637393de25e3f6b121ab38d3d9c3589d66879618157ea3382ae9ee2310c28265be341d4af02c4c1d1f81427ccdbc96464b0bb19697a819f5ad987764c17ad",
+ "points": "5"
+ },
+ {
+ "name": "Titanium Tribe",
+ "email": "info@titaniumtribe.com",
+ "password": "scrypt:32768:8:1$4bM8hSwBdKH0Dj2n$d6d64d3a635cc260803451f8b0c9acc1e50bf3a48ab071e9389d9e492cce5131d6c011f841d92b7422bbfdfa6609e198ec529fc3394cb27788a1a696baba767e",
+ "points": "15"
+ },
+ {
+ "name": "Heavy Hitters",
+ "email": "admin@heavyhitters.net",
+ "password": "scrypt:32768:8:1$U4IUVIbiypkLsiwd$b57afe44db3af13b7e9772560a228c1100f41c3222b0cbbaa5c8855632fbca004c7d2ca36d7bef52624ee028373a0cd90df65fb9b73d4eb119ad1edf3a741bf9",
+ "points": "15"
+ },
+ {
+ "name": "Power Lifts Club",
+ "email": "admin@powerlifts.com",
+ "password": "scrypt:32768:8:1$zdBGCvw6xXxHzAGl$c4534f2b7b2089aeca6f50bf3221f86f885aa4139692844149becf3c56b37a3c8f6a5f7c47e8c4f60405d591f58cf8f9567d1e383396a5f4de87073d441e5fe3",
+ "points": "15"
+ },
+ {
+ "name": "Olympic Lifters",
+ "email": "contact@olympiclifters.com",
+ "password": "scrypt:32768:8:1$CO1XjG2GYak7bGad$906886f7afc2f66ac120f12b263e195fd44283a3cf0a39f963722ca25fc62e0909629165ff184ab67e43dfb44b4ca87ec7448ce95bcd896af2d2c32a31ffa604",
+ "points": "15"
+ },
+ {
+ "name": "Barbell Warriors",
+ "email": "info@barbellwarriors.com",
+ "password": "scrypt:32768:8:1$ZmtTQFYQVRwhl8cK$d4abb1c57ba950bb082a6c963605af00a0e120f7b6d7346d2a9419efad6d7d5a78c7d15a32b57d4fc2eab10aa864977be0a3734c24f69bc6694cd9b224b57545",
+ "points": "15"
+ },
+ {
+ "name": "Simply Lift",
+ "email": "john@simplylift.co",
+ "password": "scrypt:32768:8:1$cYYbKbko75gPN3N3$4883a2360abf24fcc9f8329aedfca168994222748933eff4d89c78e5764f0972fce4c478b5737ece1bd31a3d2a0f1a00586096ffbddb79809b9685eabc5e5f4e",
+ "points": "13"
+ },
+ {
+ "name": "The Weightroom",
+ "email": "team@weightroom.com",
+ "password": "scrypt:32768:8:1$38I8jEaWVYS5jgcA$0b29c9aa0e7f52b2634516d46b312ba429d2748fd4d72973f83275d4ada39907a6bae0389d31a868acdd4b5b43363515186f86e5f7419f9253d092c94d2a9185",
+ "points": "15"
+ },
+ {
+ "name": "Steel Strength",
+ "email": "hello@steelstrength.org",
+ "password": "scrypt:32768:8:1$uGiMzIndzui0kLQp$50ef79e3db9134208a46072a6297637a5636d81ca10b9a42d69883c8a12ee021fdab58df6019339ebc8924312598c4d37a6d71ce8647177241ddf012c69acafc",
+ "points": "14",
+ "booked_places": {
+ "Spring Festival": "1"
+ }
+ },
+ {
+ "name": "She Lifts",
+ "email": "kate@shelifts.co.uk",
+ "password": "scrypt:32768:8:1$E4fcXT3MQ7oVfc0w$cf31c4a6aec02d4532ffcae03670b12f20265036a3ae5ee941fae6d135ca2db5e406fe9e6c6eded7776e0c256f6d8970f2cbfb74ee50a1c7f9b49b1ad6819b40",
+ "points": "10",
+ "booked_places": {
+ "Spring Festival": "1",
+ "Heavyweight First": "1"
+ }
+ },
+ {
+ "name": "Iron Temple",
+ "email": "admin@irontemple.com",
+ "password": "scrypt:32768:8:1$rHMWqkkiOSz7QiYU$e1a798fc6d464425359fb999db786ffbe39f6059e195d6d22a15e3ed70be3b5630e1d828399ca241f9d94e109ee5b350067f14a8054079344f01495c73594021",
+ "points": "1",
+ "booked_places": {
+ "Powerlifting Open": "1",
+ "Regional Strength": "1",
+ "Heavyweight First": "1"
+ }
+ },
+ {
+ "name": "Iron Titans",
+ "email": "contact@irontitans.com",
+ "password": "scrypt:32768:8:1$kRW7krsT6zGr4iLk$6a24553114aa57f8cf4297786bf6136fa1d6f5f9832c6157fb406eb4459fcde2a82ed2a64d890ebe5e9a6efe73376239c59a124c77b6bd79b371c84095496b78",
+ "points": "13",
+ "booked_places": {
+ "Heavyweight First": "2"
+ }
+ }
+ ]
+}
\ No newline at end of file
diff --git a/tests/performance_tests/competitions_tmp.json b/tests/performance_tests/competitions_tmp.json
new file mode 100644
index 000000000..b1ba50cbc
--- /dev/null
+++ b/tests/performance_tests/competitions_tmp.json
@@ -0,0 +1,76 @@
+{
+ "competitions": [
+ {
+ "name": "Fall Classic",
+ "date": "2020-10-22 13:30:00",
+ "number_of_places": "13",
+ "is_past": true
+ },
+ {
+ "name": "Barbell Classic",
+ "date": "2025-04-15 10:00:00",
+ "number_of_places": "0",
+ "is_past": true
+ },
+ {
+ "name": "Olympic Meet",
+ "date": "2025-05-20 10:30:00",
+ "number_of_places": "25",
+ "is_past": true
+ },
+ {
+ "name": "Iron Challenge",
+ "date": "2025-10-22 09:30:00",
+ "number_of_places": "15",
+ "is_past": true
+ },
+ {
+ "name": "Summer Stronger",
+ "date": "2026-05-30 18:23:40",
+ "number_of_places": "0",
+ "is_past": false
+ },
+ {
+ "name": "Winter Power",
+ "date": "2026-06-26 12:16:00",
+ "number_of_places": "4",
+ "is_past": false
+ },
+ {
+ "name": "Strength Showdown",
+ "date": "2026-07-10 14:00:00",
+ "number_of_places": "0",
+ "is_past": false
+ },
+ {
+ "name": "Spring Festival",
+ "date": "2026-07-27 10:00:00",
+ "number_of_places": "23",
+ "is_past": false
+ },
+ {
+ "name": "Regional Strength",
+ "date": "2026-09-12 15:00:00",
+ "number_of_places": "44",
+ "is_past": false
+ },
+ {
+ "name": "Heavyweight First",
+ "date": "2026-11-08 13:00:00",
+ "number_of_places": "26",
+ "is_past": false
+ },
+ {
+ "name": "Powerlifting Open",
+ "date": "2026-12-05 11:00:00",
+ "number_of_places": "59",
+ "is_past": false
+ },
+ {
+ "name": "Lifting Championship",
+ "date": "2027-06-18 12:00:00",
+ "number_of_places": "0",
+ "is_past": false
+ }
+ ]
+}
\ No newline at end of file
diff --git a/tests/performance_tests/locustfile.py b/tests/performance_tests/locustfile.py
new file mode 100644
index 000000000..99347cb69
--- /dev/null
+++ b/tests/performance_tests/locustfile.py
@@ -0,0 +1,97 @@
+import sys
+import os
+import random
+import json
+import tempfile
+
+from locust import HttpUser, task, between
+
+
+temp_clubs_file = tempfile.NamedTemporaryFile(mode='w+', delete=False, suffix='.json')
+temp_comps_file = tempfile.NamedTemporaryFile(mode='w+', delete=False, suffix='.json')
+json.dump({"clubs": []}, temp_clubs_file)
+json.dump({"competitions": []}, temp_comps_file)
+temp_clubs_file.close()
+temp_comps_file.close()
+
+BASE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), "../../"))
+sys.path.insert(0, BASE_DIR)
+
+
+import utils, copy
+
+utils.get_clubs_path = lambda: temp_clubs_file.name
+utils.get_competitions_path = lambda: temp_comps_file.name
+
+with open(os.path.join(BASE_DIR, "clubs.json")) as f:
+ real_clubs = json.load(f)["clubs"]
+
+with open(os.path.join(BASE_DIR, "competitions.json")) as f:
+ real_competitions = json.load(f)["competitions"]
+
+class TestPerfApp(HttpUser):
+ wait_time = between(1, 3)
+
+ @staticmethod
+ def get_clubs():
+ return copy.deepcopy(real_clubs)
+
+ @staticmethod
+ def get_competitions():
+ return copy.deepcopy(real_competitions)
+
+ def on_start(self):
+ self.clubs = copy.deepcopy(real_clubs)
+ self.competitions = copy.deepcopy(real_competitions)
+
+ utils.clubs = self.clubs
+ utils.competitions = self.competitions
+
+ passwords_table = {
+ "Simply Lift": "tgl_Prn_C2",
+ "Iron Temple": "tgl_Prn_C3",
+ "Power Lift": "tgl_Prn_C4",
+ "She Lifts": "tgl_Prn_C5",
+ "Iron Titans": "tgl_Prn_C6",
+ "Barbell Warriors": "tgl_Prn_C7",
+ "Power Lifts Club": "tgl_Prn_C8",
+ "Steel Strength": "tgl_Prn_C9",
+ "The Weightroom": "tgl_Prn_C10",
+ "Olympic Lifters": "tgl_Prn_C11",
+ "Titanium Tribes": "tgl_Prn_C12",
+ "Heavy Hitters": "tgl_Prn_C13",
+ }
+
+ self.club = random.choice(utils.clubs)
+ self.club["points"] = 60
+
+ self.client.post(
+ "/showSummary",
+ data={
+ "email": self.club["email"],
+ "password": passwords_table[self.club["name"]]
+ }
+ )
+
+ @task(2)
+ def index_competitions(self):
+ self.client.get("/")
+
+ @task(3)
+ def book_places(self):
+ while True:
+ competition = random.choice(utils.competitions)
+ if not competition.get("is_past"):
+ break
+
+ competition["number_of_places"] = 60
+
+ self.client.post('/purchasePlaces', data={
+ "competition": competition["name"],
+ "club": self.club["name"],
+ "places": "1"
+ })
+
+ @task(1)
+ def logout(self):
+ self.client.get('/logout')
diff --git a/tests/unit_tests/__init__.py b/tests/unit_tests/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/unit_tests/test_utils.py b/tests/unit_tests/test_utils.py
new file mode 100644
index 000000000..02967d882
--- /dev/null
+++ b/tests/unit_tests/test_utils.py
@@ -0,0 +1,250 @@
+import pytest
+import utils
+
+from werkzeug.security import check_password_hash
+
+
+class TestUnitUtils:
+ @pytest.fixture(autouse=True)
+ def setup(self, mocker, get_clubs, get_competitions):
+ mocker.patch('utils.clubs', get_clubs)
+ mocker.patch('utils.competitions', get_competitions)
+ mocker.patch('utils.save_clubs')
+ mocker.patch('utils.save_competitions')
+
+
+ @staticmethod
+ def test_update_password_ok(get_credentials):
+ """
+ Test that the password is updated correctly.
+ Args:
+ get_credentials (dict): The credentials
+ """
+ the_club = next((c for c in utils.clubs if c['email'] == get_credentials["email"]), None)
+ the_club = utils.update_club_password(the_club, "tp5_Tmn50")
+
+ assert check_password_hash(the_club['password'], "tp5_Tmn50")
+
+ @staticmethod
+ def test_update_password_fails(get_credentials):
+ """
+ Test that the password is updated wrongly.
+ Args:
+ get_credentials (dict): The credentials
+ """
+ the_club = next((c for c in utils.clubs if c['email'] == get_credentials["email"]), None)
+ the_club = utils.update_club_password(the_club, "tp5_Tmn50")
+
+ assert not check_password_hash(the_club['password'], "tp6_Tmn60")
+
+ @staticmethod
+ def test_add_club_ok(get_new_club):
+ """
+ Test that the club is added correctly.
+ Args:
+ get_new_club (dict): The new club
+ """
+ utils.add_club(name=get_new_club["name"],
+ email=get_new_club["email"],
+ password=get_new_club["password"],
+ points=get_new_club["points"])
+
+ assert get_new_club in utils.clubs
+
+ @staticmethod
+ def test_update_booked_places_ok(get_existing_competition_and_club_2):
+ """
+ Test that the required places are booked correctly.
+ Args:
+ get_existing_competition_and_club_2 (dict): The competition and club
+ """
+ club_name = get_existing_competition_and_club_2['club']
+ club = next((c for c in utils.clubs if c['name'] == club_name), None)
+ competition_name = get_existing_competition_and_club_2['competition']
+ utils.update_club_booked_places(club=club,
+ places=5,
+ competition_name=competition_name)
+
+ assert club['booked_places'][competition_name] == str(5)
+
+ @staticmethod
+ def test_update_booked_places_fails(get_existing_competition_and_club_2):
+ """
+ Test that the required places are booked wrongly.
+ Args:
+ get_existing_competition_and_club_2 (dict): The competition and club
+ """
+ club_name = get_existing_competition_and_club_2['club']
+ club = next((c for c in utils.clubs if c['name'] == club_name), None)
+ competition_name = get_existing_competition_and_club_2['competition']
+ utils.update_club_booked_places(club=club,
+ places=5,
+ competition_name=competition_name)
+
+ assert not club['booked_places'][competition_name] == str(6)
+
+ @staticmethod
+ def test_update_competition_available_places(get_existing_competition_and_club):
+ """
+ Test that the competition available places are updated correctly.
+ Args:
+ get_existing_competition_and_club (dict): The competition and club
+ """
+ competition_name = get_existing_competition_and_club['competition']
+ competition = next((c for c in utils.competitions if c['name'] == competition_name), None)
+ places_available = int(competition['number_of_places'])
+ utils.update_competition_available_places(the_competition=competition, places=5)
+
+ assert competition['number_of_places'] == str(places_available - 5)
+
+ @staticmethod
+ def test_update_competition_available_places_fails(get_existing_competition_and_club):
+ """
+ Test that the competition available places are updated wrongly.
+ Args:
+ get_existing_competition_and_club (dict): The competition and club
+ """
+ competition_name = get_existing_competition_and_club['competition']
+ competition = next((c for c in utils.competitions if c['name'] == competition_name), None)
+ places_available = int(competition['number_of_places'])
+ utils.update_competition_available_places(the_competition=competition, places=5)
+
+ assert not competition['number_of_places'] == str(places_available - 4)
+
+ @staticmethod
+ def test_form_filled_out_ok(get_details):
+ """
+ Test that the form is filled out correctly.
+ Args:
+ get_details (dict): The details
+ """
+ name = get_details['name']
+ email = get_details['email']
+ password = get_details['password']
+ password2 = get_details['password2']
+
+ response = utils.check_all_fields_filled_out(name=name,
+ email=email,
+ password=password,
+ password2=password2)
+
+ assert response
+
+ @staticmethod
+ def test_form_filled_out_fails(get_wrong_details):
+ """
+ Test that the form is filled out wrongly.
+ Args:
+ get_wrong_details (dict): The details
+ """
+ name = get_wrong_details['name']
+ email = get_wrong_details['email']
+ password = get_wrong_details['password']
+ password2 = get_wrong_details['password2']
+
+ response = utils.check_all_fields_filled_out(name=name,
+ email=email,
+ password=password,
+ password2=password2)
+
+ assert not response
+
+ @staticmethod
+ def test_validate_places_with_negative(client, get_existing_competition_and_club):
+ """
+ Test that checks places validation process with negative value.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club (dict): The competition and club
+ """
+ club = next(
+ (c for c in utils.clubs if c['name'] == get_existing_competition_and_club["club"]), None)
+ competition_name = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club["competition"]), None)
+ error_message, error_tag = utils.validate_places(places_required=-2,
+ club=club,
+ the_competition=competition_name)
+ assert error_message == "Sorry, you should type a positive number."
+ assert error_tag == "Negative number"
+
+ @staticmethod
+ def test_validate_places_over_12(client, get_existing_competition_and_club):
+ """
+ Test that checks places validation process with more than 12 places.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club (dict): The competition and club
+ """
+ club = next(
+ (c for c in utils.clubs if c['name'] == get_existing_competition_and_club["club"]), None)
+ competition = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club["competition"]), None)
+ error_message, error_tag = utils.validate_places(places_required=13,
+ club=club,
+ the_competition=competition)
+ assert error_message == "Sorry, you are not allow to purchase more than 12 places for this competition."
+ assert error_tag == "Over 12 places"
+
+ @staticmethod
+ def test_validate_places_requires_more(client, get_existing_competition_and_club_5):
+ """
+ Test that checks places validation process with more than the number of places available.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club_5 (dict): The competition and club
+ """
+ club = next(
+ (c for c in utils.clubs if c['name'] == get_existing_competition_and_club_5["club"]), None)
+ competition = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club_5["competition"]), None)
+ error_message, error_tag = utils.validate_places(places_required=5,
+ club=club,
+ the_competition=competition)
+ assert error_message == "Sorry, there are not enough places available for this competition."
+ assert error_tag == "Not enough places"
+
+ @staticmethod
+ def test_validate_places_not_enough(client, get_existing_competition_and_club_6):
+ """
+ Test that checks places validation process with not enough places.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club_6 (dict): The competition and club
+ """
+ club = next(
+ (c for c in utils.clubs if c['name'] == get_existing_competition_and_club_6["club"]), None)
+ competition = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club_6["competition"]), None)
+ error_message, error_tag = utils.validate_places(places_required=6,
+ club=club,
+ the_competition=competition)
+ assert error_message == "Sorry, you do not have enough points to purchase."
+ assert error_tag == "Not enough points"
+
+ @staticmethod
+ def test_validate_past_competition(client, get_existing_competition_and_club_3):
+ """
+ Test that checks that the competition validation process with an outdated competition.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club_3 (dict): The competition and club
+ """
+ competition = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club_3["competition"]), None)
+ error_message, error_tag = utils.validate_competition(the_competition=competition)
+ assert error_message == "Sorry, this competition is outdated. Booking not possible."
+ assert error_tag == "Outdated"
+
+ @staticmethod
+ def test_validate_competition_sold_out(client, get_existing_competition_and_club_4):
+ """
+ Test that the competition validation process with a sold out competition.
+ Args:
+ client (FlaskClient): A Flask client
+ get_existing_competition_and_club_4 (dict): The competition and club
+ """
+ competition = next(
+ (c for c in utils.competitions if c['name'] == get_existing_competition_and_club_4["competition"]), None)
+ error_message, error_tag = utils.validate_competition(the_competition=competition)
+ assert error_message == "Sorry, this competition is sold out. Booking not possible."
+ assert error_tag == "Sold out"
diff --git a/tests/unit_tests/test_views.py b/tests/unit_tests/test_views.py
new file mode 100644
index 000000000..4afa8fb76
--- /dev/null
+++ b/tests/unit_tests/test_views.py
@@ -0,0 +1,228 @@
+import pytest
+from werkzeug.security import check_password_hash
+
+import utils
+
+from flask import url_for
+
+
+class TestUnitViews:
+ @pytest.fixture(autouse=True)
+ def setup(self, mocker, get_clubs, get_competitions):
+ mocker.patch('utils.clubs', get_clubs)
+ mocker.patch('utils.competitions', get_competitions)
+ mocker.patch('utils.save_clubs')
+ mocker.patch('utils.save_competitions')
+
+ @staticmethod
+ def test_index_status_code_ok(client):
+ """
+ Test that the index page status code is 200
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.get('/')
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_index_return_welcome(client):
+ """
+ Test that the index page is correctly return with appropriate information
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.get('/')
+ data = client_response.data.decode('utf-8')
+
+ assert "Welcome to the GUDLFT Portal!" in data
+ assert ('Please enter your secretary email and your password to continue '
+ 'or sign up') in data
+ assert "Email:" in data
+ assert "Password:" in data
+
+ @staticmethod
+ def test_index_without_authentication_fails(client, get_credentials):
+ """
+ Test that the index page is returned with an error message and with 403 status code in case
+ of non authentication
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ """
+ club = next((c for c in utils.clubs if c['email'] == get_credentials["email"]), None)
+ client_response = client.get(f'/showSummary/{club["name"]}')
+ assert client_response.status_code == 403
+ assert "Not allow" in client_response.data.decode('utf-8')
+
+ @staticmethod
+ def test_index_mail_authentication_ok(get_credentials, client):
+ """
+ Test that the summary page is returned with a 200 status code in case of fine
+ authentication
+ Args:
+ get_credentials (dict): The credentials
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.post('/showSummary', data=get_credentials)
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_index_mail_authentication_returns_summary(client, get_credentials):
+ """
+ Test that the summary page is returned with appropriate information from the club when
+ authenticated
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ """
+ client_response = client.post('/showSummary', data=get_credentials)
+ data = client_response.data.decode('utf-8')
+
+ assert "Welcome, kate@shelifts.co.uk" in data
+ assert "Spring Festival" in data
+ assert "Fall Classic" in data
+ assert "Points available: 12" in data
+
+ @staticmethod
+ def test_index_mail_authentication_fail(client, get_unexisting_credentials):
+ """
+ Test that the index page is returned with an error message and with 302 status code in case
+ of authentication with unknown mail.
+ Args:
+ client (FlaskClient): A Flask client
+ get_unexisting_credentials (dict): The credentials
+ """
+ client_response = client.post('/showSummary', data=get_unexisting_credentials)
+ data = client_response.data.decode('utf-8')
+ assert client_response.status_code == 404
+ assert "Sorry, that email was not found." in data
+
+ @staticmethod
+ def test_summary_logout_redirect_status_code_ok(client, get_credentials):
+ """
+ Test that the redirect (302) status code is returned in case of logging out.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ """
+ client.post('/showSummary', data=get_credentials)
+ logout_response = client.get('/logout')
+ assert logout_response.status_code == 302
+
+ @staticmethod
+ def test_booking_status_code_ok(client,
+ get_credentials,
+ get_existing_competition_and_club):
+ """
+ Test that the 200 status code is returned in case of booking.
+ Args:
+ client (FlaskClient): A Flask client
+ get_credentials (dict): The credentials
+ get_existing_competition_and_club (dict): The competition and club
+ """
+ client.post('/showSummary', data=get_credentials)
+
+ client_response = client.get(url_for(endpoint='book',
+ competition=get_existing_competition_and_club['competition'],
+ club=get_existing_competition_and_club['club']))
+
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_signup_status_code_ok(client):
+ """
+ Test that the 200 status code is returned in case of signup.
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.get('/signUp')
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_signup_returns_welcome(client):
+ """
+ Test that the profile page is returned with appropriate information from the club when
+ signing up
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.get('/signUp')
+ data = client_response.data.decode('utf-8')
+ assert "Welcome to the GUDLFT Portal!" in data
+ assert "Registration" in data
+ assert ("Club name:" in data)
+ assert ("Email:" in data)
+ assert ("Password:" in data)
+ assert ("Confirm Password:" in data)
+
+ @staticmethod
+ def test_change_password_status_code_ok(client):
+ """
+ Test that the 200 status code is returned in case of changing password
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ with client.session_transaction() as session:
+ session["club"] = "She Lifts"
+
+ client_response = client.get('/changePassword/She Lifts')
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_profile_ok(client):
+ """
+ Test that the 200 status code is returned in case of displaying profile by the connected
+ club.
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ with client.session_transaction() as session:
+ session["club"] = "She Lifts"
+
+ client_response = client.get('/profile/She Lifts')
+ assert client_response.status_code == 200
+
+ @staticmethod
+ def test_profile_without_authentication_fails(client):
+ """
+ Test that the profile page is not accessible in case of non authentication.
+ 403 status code and an error message are returned.
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ client_response = client.get('/profile/Simply Lift')
+ assert client_response.status_code == 403
+ assert "Not allow" in client_response.data.decode('utf-8')
+
+ @staticmethod
+ def test_profile_returns_welcome(client):
+ """
+ Test that the profile page is returned with appropriate information from the club when
+ authenticated.
+ Args:
+ client (FlaskClient): A Flask client
+ """
+ with client.session_transaction() as session:
+ session["club"] = "She Lifts"
+
+ client_response = client.get('/profile/She Lifts')
+ data = client_response.data.decode('utf-8')
+ assert "Welcome, kate@shelifts.co.uk" in data
+ assert "Profile" in data
+ assert "Name : She Lifts" in data
+ assert "Email : kate@shelifts.co.uk" in data
+ assert "Points available: 12" in data
+
+ @staticmethod
+ def test_points_board_status_code_ok(client):
+ """
+ Test that the 200 status code and appropriate information are returned in case of
+ displaying points board.
+ Args:
+ client ():
+ """
+ client_response = client.get('/pointsBoard')
+ data = client_response.data.decode('utf-8')
+ assert client_response.status_code == 200
+ assert "Welcome to the GUDLFT Portal!" in data
+ assert "⯈ Here is the board for all the clubs and their points." in data
diff --git a/utils.py b/utils.py
new file mode 100644
index 000000000..0046370a1
--- /dev/null
+++ b/utils.py
@@ -0,0 +1,245 @@
+import json
+import os
+from datetime import datetime
+from werkzeug.security import generate_password_hash, check_password_hash
+
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+
+def get_clubs_path() -> str:
+ """
+ Method that returns the path to the clubs json file
+ Returns:
+ The path to the clubs json file
+ """
+ path = os.environ.get("CLUBS_JSON")
+
+ if not path:
+ path = os.path.join(BASE_DIR, "clubs.json")
+
+ return path
+
+def get_competitions_path() -> str:
+ """
+ Method that returns the path to the competitions json file
+ Returns:
+ The path to the competitions json file
+ """
+ path = os.environ.get("COMPETITIONS_JSON")
+
+ if not path:
+ path = os.path.join(BASE_DIR, "competitions.json")
+
+ return path
+
+def load_clubs() -> list:
+ """
+ Method that loads the clubs json file
+ Returns:
+ The list of clubs
+ """
+ path = os.path.join(BASE_DIR, "clubs.json")
+ with open(path) as c:
+ return json.load(c)['clubs']
+
+def load_competitions() -> list:
+ """
+ Method that loads the competitions json file
+ Returns:
+ The sorted list of competitions
+ """
+ path = os.path.join(BASE_DIR, "competitions.json")
+ with open(path) as comps:
+ list_of_competitions = json.load(comps)['competitions']
+ return sorted(list_of_competitions, key=lambda c: c['date'])
+
+competitions = []
+
+clubs = []
+
+def save_clubs() -> None:
+ """
+ Method that saves the clubs json file
+ """
+ path = get_clubs_path()
+ with open(path, 'w') as f:
+ list_of_clubs = {"clubs": clubs}
+ json.dump(list_of_clubs, f, indent=4)
+
+def save_competitions() -> None:
+ """
+ Method that saves the competitions json file
+ """
+ path = get_competitions_path()
+ with open(path, 'w') as f:
+ list_of_competitions = {"competitions": sorted(competitions, key=lambda c: c['date'])}
+ json.dump(list_of_competitions, f, indent=4)
+
+for competition in competitions:
+ competition['is_past'] = datetime.strptime(competition['date'], "%Y-%m-%d %H:%M:%S") < datetime.now()
+
+def update_club_booked_places(club: dict, places: int, competition_name: str) -> None:
+ """
+ Method that updates the club booked places based on the number of places
+ Args:
+ club (dict): The club dictionary
+ places (int): The number of places
+ competition_name (str): The name of the competition
+ """
+ clubs.remove(club)
+
+ club.setdefault("booked_places", {})
+ current = int(club["booked_places"].get(competition_name, 0))
+ club["booked_places"][competition_name] = str(current + places)
+
+ club["points"] = str(int(club["points"]) - places)
+
+ clubs.append(club)
+ save_clubs()
+
+def update_competition_available_places(the_competition: dict, places: int) -> None:
+ """
+ Method that updates the competition available places based on the number of places
+ Args:
+ the_competition (dict): The competition dictionary
+ places (int): The number of places
+ """
+ competitions.remove(the_competition)
+
+ the_competition['number_of_places'] = str(int(the_competition['number_of_places']) - places)
+
+ competitions.append(the_competition)
+
+ save_competitions()
+
+def add_club(name: str, email: str, password: str, points: str) -> None:
+ """
+ Method that adds a club to the clubs list
+ Args:
+ name (str): The name of the club
+ email (str): The email of the club
+ password (str): The password of the club
+ points (str): The points of the club in string format
+ """
+ clubs.append({"name": name, "email": email, "password": password, "points": points})
+ save_clubs()
+
+def update_club_password(club: dict, password: str) -> dict:
+ """
+ Method that updates the club password based on the password
+ Args:
+ club (dict): The club dictionary
+ password (str): The password of the club
+
+ Returns:
+ The updated club
+ """
+ hashed_password = generate_password_hash(password)
+ club["password"] = hashed_password
+ save_clubs()
+ return club
+
+def check_all_fields_filled_out(name: str, email: str, password: str, password2: str) -> bool:
+ """
+ Method that checks if all the fields are filled out
+ Args:
+ name (str): The name of the club
+ email (str): The email of the club
+ password (str): The password of the club
+ password2 (str): The password of the club
+
+ Returns:
+ A boolean indicating if all the fields are filled out
+ """
+ if len(name) == 0 or len(email) == 0 or len(password) == 0 or len(password2) == 0:
+ return False
+ return True
+
+def validate_places(places_required: int, club: dict, the_competition: dict) -> tuple[str, str] | None:
+ """
+ Method that validates the places required
+ Args:
+ places_required (int): The number of places required
+ club (dict): The club dictionary
+ the_competition (dict): The competition dictionary
+
+ Returns:
+ A tuple containing error message and error tag or None
+ """
+ booked_places = int(club.get("booked_places", {}).get(the_competition["name"], 0))
+
+ cumulative_places = places_required + booked_places
+
+ error_message, error_tag = "", ""
+
+ if places_required <= 0:
+ error_message = "Sorry, you should type a positive number."
+ error_tag = "Negative number"
+
+ elif cumulative_places > 12:
+ error_message = "Sorry, you are not allow to purchase more than 12 places for this competition."
+ error_tag = "Over 12 places"
+
+ elif places_required > int(the_competition['number_of_places']):
+ error_message = "Sorry, there are not enough places available for this competition."
+ error_tag = "Not enough places"
+
+ elif places_required > int(club['points']):
+ error_message = "Sorry, you do not have enough points to purchase."
+ error_tag = "Not enough points"
+
+ return error_message, error_tag
+
+def validate_competition(the_competition: dict) -> tuple[str, str] | None:
+ """
+ Method that validates the competition
+ Args:
+ the_competition (dict): The competition dictionary
+
+ Returns:
+ A tuple containing error message and error tag or None
+ """
+ error_message, error_tag = "", ""
+
+ now = datetime.now()
+
+ competition_date = datetime.strptime(the_competition['date'], '%Y-%m-%d %H:%M:%S')
+
+ competition_places = int(the_competition['number_of_places'])
+
+ if now > competition_date:
+ error_message = "Sorry, this competition is outdated. Booking not possible."
+ error_tag = "Outdated"
+
+ elif competition_places == 0:
+ error_message = "Sorry, this competition is sold out. Booking not possible."
+ error_tag = "Sold out"
+
+ return error_message, error_tag
+
+def validate_password(password: str, password2: str, club: dict) -> tuple[str, str]:
+ """
+ Method that validates the password
+ Args:
+ password (str): The password of the club.
+ password2 (str): The password of the club.
+ club (dict): The club dictionary.
+
+ Returns:
+ A tuple containing error message and error tag or None
+ """
+ error_message, error_tag = "", ""
+
+ if len(password) == 0 or len(password2) == 0:
+ error_message = "Sorry, please fill all fields."
+ error_tag = "Empty field(s)"
+
+ elif password != password2:
+ error_message = "Sorry, passwords do not match."
+ error_tag = "Passwords not match"
+
+ elif check_password_hash(club['password'], password):
+ error_message = "Sorry, you have to type a new different password."
+ error_tag = "Identical password"
+
+ return error_message, error_tag
+
+
+
+
+
+
+
+
+
+
+ 
+
+