diff --git a/.coverage b/.coverage new file mode 100644 index 000000000..e8f487177 Binary files /dev/null and b/.coverage differ diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 000000000..16fd435e9 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,6 @@ +[run] +omit = + lib/ + bin/ + */__init__.py + tests/* diff --git a/.flake8 b/.flake8 new file mode 100644 index 000000000..905ee7c71 --- /dev/null +++ b/.flake8 @@ -0,0 +1,12 @@ +[flake8] +max-line-length = 80 +exclude = + bin/activate.py, + lib, + packages, + migrations, + build, + dist, + *.pyc, + __pycache__, + bin/activate_this.py \ No newline at end of file diff --git a/.gitignore b/.gitignore index 2cba99d87..824b7e2da 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ bin include lib .Python -tests/ .envrc -__pycache__ \ No newline at end of file +__pycache__ +pyvenv.cfg +.DS_Store diff --git a/competitions.json b/competitions.json index 039fc61bd..a40f93442 100644 --- a/competitions.json +++ b/competitions.json @@ -9,6 +9,11 @@ "name": "Fall Classic", "date": "2020-10-22 13:30:00", "numberOfPlaces": "13" + }, + { + "name": "New", + "date": "2024-10-22 13:30:00", + "numberOfPlaces": "13" } ] } \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 000000000..627a23c90 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,2 @@ +[tool.black] +line-length = 80 \ No newline at end of file diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 000000000..9627e15b7 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,3 @@ +[pytest] + +testpaths = tests \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 139affa05..5edb0fa42 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,6 @@ itsdangerous==1.1.0 Jinja2==2.11.2 MarkupSafe==1.1.1 Werkzeug==1.0.1 +pytest +black +flake8 diff --git a/server.py b/server.py index 4084baeac..68486c422 100644 --- a/server.py +++ b/server.py @@ -1,59 +1,170 @@ import json -from flask import Flask,render_template,request,redirect,flash,url_for +from datetime import datetime +from flask import Flask, render_template, request, redirect, flash, url_for + +app = Flask(__name__) +app.secret_key = "something_special" +app.config["CLUB_FILE"] = "clubs.json" +app.config["COMPETITIONS_FILE"] = "competitions.json" def loadClubs(): - with open('clubs.json') as c: - listOfClubs = json.load(c)['clubs'] - return listOfClubs + with open(app.config["CLUB_FILE"]) as c: + listOfClubs = json.load(c)["clubs"] + return listOfClubs def loadCompetitions(): - with open('competitions.json') as comps: - listOfCompetitions = json.load(comps)['competitions'] - return listOfCompetitions + with open(app.config["COMPETITIONS_FILE"], "r") as comps: + listOfCompetitions = json.load(comps)["competitions"] + return listOfCompetitions -app = Flask(__name__) -app.secret_key = 'something_special' - competitions = loadCompetitions() clubs = loadClubs() -@app.route('/') + +@app.route("/") def index(): - return render_template('index.html') + return render_template("index.html") -@app.route('/showSummary',methods=['POST']) -def showSummary(): - club = [club for club in clubs if club['email'] == request.form['email']][0] - return render_template('welcome.html',club=club,competitions=competitions) +def get_club_from_email(email): + try: + club = [club for club in clubs if club["email"] == email][0] + return club + except IndexError: + return None -@app.route('/book//') -def book(competition,club): - foundClub = [c for c in clubs if c['name'] == club][0] - foundCompetition = [c for c in competitions if c['name'] == competition][0] - if foundClub and foundCompetition: - return render_template('booking.html',club=foundClub,competition=foundCompetition) + +@app.route("/showSummary", methods=["POST"]) +def showSummary(): + club = get_club_from_email(request.form["email"]) + if club: + return render_template( + "welcome.html", club=club, competitions=competitions + ) else: - flash("Something went wrong-please try again") - return render_template('welcome.html', club=club, competitions=competitions) + flash("Sorry, that email wasn't found.") + return redirect(url_for("index")) -@app.route('/purchasePlaces',methods=['POST']) -def purchasePlaces(): - competition = [c for c in competitions if c['name'] == request.form['competition']][0] - club = [c for c in clubs if c['name'] == request.form['club']][0] - placesRequired = int(request.form['places']) - competition['numberOfPlaces'] = int(competition['numberOfPlaces'])-placesRequired - flash('Great-booking complete!') - return render_template('welcome.html', club=club, competitions=competitions) +def validate_competition_date(competition): + competition_date = datetime.strptime( + competition["date"], "%Y-%m-%d %H:%M:%S" + ) + if competition_date < datetime.now(): + return "This competition is already over. You cannot book a place." -# TODO: Add route for points display +@app.route("/book//") +def book(competition, club): + foundClub = get_club_from_name(club) + foundCompetition = get_competition_from_name(competition) + if not foundClub or not foundCompetition: + flash("Something went wrong-please try again") + return render_template( + "welcome.html", club=club, competitions=competitions + ) + error_message = validate_competition_date(foundCompetition) + if error_message: + flash(error_message) + return render_template( + "welcome.html", club=foundClub, competitions=competitions + ) + return render_template( + "booking.html", club=foundClub, competition=foundCompetition + ) + + +def get_competition_from_name(name): + try: + competition = [ + competition + for competition in competitions + if competition["name"] == name + ][0] + return competition + except IndexError: + return None + + +def get_club_from_name(name): + try: + club = [club for club in clubs if club["name"] == name][0] + return club + except IndexError: + return None + + +def get_index_club(club): + return clubs.index(club) + + +def check_places(places, club): + if not places or int(places) < 1: + return "Places required must be a positive integer" + if int(places) > 12: + return ( + "Places required must be a positive integer " + "that does not exceed 12" + ) + if int(places) > int(club["points"]): + return "Places required exceed club's total points" + + +def take_places(places, club, competition): + try: + competition["numberOfPlaces"] = ( + int(competition["numberOfPlaces"]) - places + ) + club["points"] = int(club["points"]) - places + return True + except Exception: + return False + + +def update_clubs(club, index_club): + try: + with open(app.config["CLUB_FILE"], "w") as file_club: + dict_clubs = {} + clubs[index_club]["points"] = str(club["points"]) + dict_clubs["clubs"] = clubs + json.dump(dict_clubs, file_club, indent=4) + return True + except FileNotFoundError: + return False + + +@app.route("/purchasePlaces", methods=["POST"]) +def purchasePlaces(): + competition = get_competition_from_name(request.form["competition"]) + club = get_club_from_name(request.form["club"]) + error_message = check_places(request.form["places"], club) + if error_message: + flash(error_message) + return redirect( + url_for("book", competition=competition["name"], club=club["name"]) + ) + placesRequired = int(request.form["places"]) + if take_places(placesRequired, club, competition) and update_clubs( + club, get_index_club(club) + ): + flash("Great-booking complete!") + return render_template( + "welcome.html", club=club, competitions=competitions + ) + else: + flash("Something went wrong-please try again") + return redirect( + url_for("book", competition=competition["name"], club=club["name"]) + ) -@app.route('/logout') +@app.route("/logout") def logout(): - return redirect(url_for('index')) \ No newline at end of file + return redirect(url_for("index")) + + +if __name__ == "__main__": + app.run(debug=True) diff --git a/templates/booking.html b/templates/booking.html index 06ae1156c..b0f4938ff 100644 --- a/templates/booking.html +++ b/templates/booking.html @@ -1,3 +1,4 @@ + @@ -6,11 +7,20 @@

{{competition['name']}}

+ {% with messages = get_flashed_messages()%} + {% if messages %} +
    + {% for message in messages %} +
  • {{message}}
  • + {% endfor %} +
+ {% endif%} + {% endwith %} Places available: {{competition['numberOfPlaces']}}
- +
diff --git a/templates/index.html b/templates/index.html index 926526b7d..0d9e52c9f 100644 --- a/templates/index.html +++ b/templates/index.html @@ -1,3 +1,4 @@ + @@ -6,10 +7,20 @@

Welcome to the GUDLFT Registration Portal!

+ {% with messages = get_flashed_messages() %} + {% if messages %} +
    + {% for message in messages %} +
  • {{message}}
  • + {% endfor %} +
+ {% endif %} + {% endwith %} + Please enter your secretary email to continue:
- +
diff --git a/templates/welcome.html b/templates/welcome.html index ff6b261a2..db7c1e47e 100644 --- a/templates/welcome.html +++ b/templates/welcome.html @@ -7,7 +7,7 @@

Welcome, {{club['email']}}

Logout - {% with messages = get_flashed_messages()%} + {% with messages = get_flashed_messages() %} {% if messages %}
    {% for message in messages %} @@ -15,6 +15,7 @@

    Welcome, {{club['email']}}

    Logout {% endfor %}
{% endif%} + Points available: {{club['points']}}

Competitions:

    @@ -30,7 +31,6 @@

    Competitions:


    {% endfor %}
- {%endwith%} - + {% endwith %} \ No newline at end of file diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/integration_tests/__init__.py b/tests/integration_tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/integration_tests/conftest.py b/tests/integration_tests/conftest.py new file mode 100644 index 000000000..f22360217 --- /dev/null +++ b/tests/integration_tests/conftest.py @@ -0,0 +1,85 @@ +import builtins +import json +import os +import tempfile +import pytest +from unittest.mock import mock_open, patch + + +clubs_list = [ + {"name": "Club 1", "email": "club1@example.com", "points": "10"}, + {"name": "Club 2", "email": "club2@example.com", "points": "15"}, +] + +competitions_list = [ + { + "name": "Competition 1", + "date": "2023-03-27 10:00:00", + "numberOfPlaces": "25", + }, + { + "name": "Competition 2", + "date": "2023-10-22 13:30:00", + "numberOfPlaces": "15", + }, +] + + +# Mock data for clubs.json and competitions.json +mock_clubs_json = json.dumps({"clubs": clubs_list}) + +mock_competitions_json = json.dumps({"competitions": competitions_list}) + + +def mocked_open(file, *args, **kwargs): + """ + Mock open function to return mock data for + clubs.json and competitions.json + """ + if file == "clubs.json": + return mock_open(read_data=mock_clubs_json)() + elif file == "competitions.json": + return mock_open(read_data=mock_competitions_json)() + else: + return builtins.open(file, *args, **kwargs) + + +# Patch open before importing the app to ensure clubs +# and competitions are loaded with mock data +with patch("builtins.open", side_effect=mocked_open): + from server import app # noqa + + +@pytest.fixture +def temp_clubs_file(): + """ + Create a temporary directory and file for clubs.json + """ + with tempfile.TemporaryDirectory() as temp_dir: + temp_club_file_path = os.path.join(temp_dir, "clubs.json") + + # Create a temporary clubs.json file + clubs_data = { + "clubs": clubs_list, + } + + with open(temp_club_file_path, "w") as f: + json.dump(clubs_data, f, indent=4) + + # Yield the path to the file for the tests + yield temp_club_file_path + + +@pytest.fixture +def client(temp_clubs_file): + """ + Set up the Flask test client and override the CLUB_FILE config + with the temporary file. + """ + app.config["TESTING"] = True + app.config[ + "CLUB_FILE" + ] = temp_clubs_file # Override with temp clubs.json path + + with app.test_client() as client: + yield client diff --git a/tests/integration_tests/test_booking-places-in-past-competitions.py b/tests/integration_tests/test_booking-places-in-past-competitions.py new file mode 100644 index 000000000..93ec674d4 --- /dev/null +++ b/tests/integration_tests/test_booking-places-in-past-competitions.py @@ -0,0 +1,48 @@ +def test_book_valid_competition(client): + """ + Test booking a valid competition with a valid club + (future competition date). + """ + response = client.get("/book/Competition%201/Club%201") + + # Ensure the correct template is rendered (booking.html) + assert response.status_code == 200 + assert ( + b"Competition 1" in response.data + ) # Assuming the booking page has the word "Booking" + + +def test_book_past_competition(client): + """ + Test booking a competition with a past date. + """ + response = client.get("/book/Competition%202/Club%201") + + # Ensure the user is shown a message that the competition is in the past + assert response.status_code == 200 + assert ( + b"This competition is already over. You cannot book a place." + in response.data + ) + + +def test_book_invalid_competition(client): + """ + Test trying to book with an invalid competition name. + """ + response = client.get("/book/Invalid%20Competition/Club%201") + + # Ensure the correct message is shown when competition is invalid + assert response.status_code == 200 + assert b"Something went wrong-please try again" in response.data + + +def test_book_invalid_club(client): + """ + Test trying to book with an invalid club name. + """ + response = client.get("/book/Competition%201/Invalid%20Club") + + # Ensure the correct message is shown when club is invalid + assert response.status_code == 200 + assert b"Something went wrong-please try again" in response.data diff --git a/tests/integration_tests/test_clubs_should_not_use_more_than_12.py b/tests/integration_tests/test_clubs_should_not_use_more_than_12.py new file mode 100644 index 000000000..4780a5440 --- /dev/null +++ b/tests/integration_tests/test_clubs_should_not_use_more_than_12.py @@ -0,0 +1,15 @@ + +def test_purchase_places_exceeds_12(client): + """ + Test purchasing more places than 12. + """ + response = client.post("/purchasePlaces", data={ + "competition": "Competition 1", + "club": "Club 1", + "places": "13" + }) + + assert response.status_code == 302 # Redirect expected + response = client.get(response.headers["Location"]) # Follow the redirect + assert b"Places required must be a positive integer" + b" that does not exceed 12" in response.data diff --git a/tests/integration_tests/test_clubs_should_not_use_more_than_their_points.py b/tests/integration_tests/test_clubs_should_not_use_more_than_their_points.py new file mode 100644 index 000000000..8219ecdd3 --- /dev/null +++ b/tests/integration_tests/test_clubs_should_not_use_more_than_their_points.py @@ -0,0 +1,44 @@ + +def test_purchase_places_valid(client): + """ + Test purchasing places with valid club points and valid competition. + """ + response = client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "5"}, + ) + + assert response.status_code == 200 + assert b"Great-booking complete!" in response.data + + +def test_purchase_places_insufficient_points(client): + """ + Test purchasing more places than the club's available points. + """ + response = client.post( + "/purchasePlaces", + data={ + "competition": "Competition 1", + "club": "Club 1", + "places": "11", # Club 1 has only 10 points + }, + ) + + assert response.status_code == 302 # Redirect expected + response = client.get(response.headers["Location"]) # Follow the redirect + assert b"Places required exceed club's total points" in response.data + + +def test_purchase_places_zero_places(client): + """ + Test purchasing zero places, which is an invalid input. + """ + response = client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "0"}, + ) + + assert response.status_code == 302 # Redirect expected + response = client.get(response.headers["Location"]) # Follow the redirect + assert b"Places required must be a positive integer" in response.data diff --git a/tests/integration_tests/test_point_updates_are_not_reflected.py b/tests/integration_tests/test_point_updates_are_not_reflected.py new file mode 100644 index 000000000..b224e86d3 --- /dev/null +++ b/tests/integration_tests/test_point_updates_are_not_reflected.py @@ -0,0 +1,20 @@ +import json + + +def test_purchase_places_valid(client): + """ + Test purchasing places with valid club points and valid competition. + """ + response = client.post("/purchasePlaces", data={ + "competition": "Competition 1", + "club": "Club 1", + "places": "5" + }) + + # Check the response and verify the club's points were updated + assert response.status_code == 200 + assert b"Great-booking complete!" in response.data + + with open(client.application.config['CLUB_FILE'], 'r') as f: + updated_clubs = json.load(f) + assert updated_clubs["clubs"][0]["points"] == "0" diff --git a/tests/integration_tests/test_unknown_email.py b/tests/integration_tests/test_unknown_email.py new file mode 100644 index 000000000..f77e75899 --- /dev/null +++ b/tests/integration_tests/test_unknown_email.py @@ -0,0 +1,24 @@ + +# Integration test for valid email +def test_showSummary_valid_email_integration(client): + # Simulate POST request with a valid email + response = client.post("/showSummary", data={"email": "club1@example.com"}) + + # Check if the welcome page is rendered with the correct club data + assert response.status_code == 200 + assert b"Welcome" in response.data + + +# Integration test for invalid email +def test_showSummary_invalid_email_integration(client): + # Simulate POST request with an invalid email + response = client.post( + "/showSummary", data={"email": "invalid@example.com"} + ) + + # Validate that the response redirects to the index page + assert response.status_code == 302 + response = client.get(response.headers["Location"]) # Follow the redirect + + # Check if the flash message appears in the redirected page + assert b"Sorry, that email wasn't found." in response.data 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/conftest.py b/tests/unit_tests/conftest.py new file mode 100644 index 000000000..45526b3bf --- /dev/null +++ b/tests/unit_tests/conftest.py @@ -0,0 +1,16 @@ +import pytest +from server import app + + +@pytest.fixture +def client(): + with app.test_client() as client: + yield client + + +@pytest.fixture +def mock_clubs_fixture(): + return [ + {"name": "Club 1", "email": "club1@example.com", "points": "10"}, + {"name": "Club 2", "email": "club2@example.com", "points": "15"}, + ] diff --git a/tests/unit_tests/test_booking-places-in-past-competitions.py b/tests/unit_tests/test_booking-places-in-past-competitions.py new file mode 100644 index 000000000..c31115ae9 --- /dev/null +++ b/tests/unit_tests/test_booking-places-in-past-competitions.py @@ -0,0 +1,189 @@ +from unittest.mock import patch +from datetime import datetime + +from server import validate_competition_date +from .utils import mock_competitions_list, mock_clubs_list + +mock_competition_past = { + "name": "Competition 2", + "date": "2020-03-27 10:00:00", + "numberOfPlaces": "15", +} +mock_future_competition = { + "name": "Future Competition", + "date": "2024-03-27 10:00:00", +} + + +# Test for a valid future competition date +@patch("server.datetime") +def test_validate_competition_date_future(mock_datetime): + # Mock datetime.now() to return a date before the competition date + mock_datetime.now.return_value = datetime(2023, 3, 27) + mock_datetime.strptime.side_effect = datetime.strptime + + # Call the function with a future competition + result = validate_competition_date(mock_future_competition) + + # Assert that no error message is returned + assert result is None + + +# Test for a past competition date +@patch("server.datetime") +def test_validate_competition_date_past(mock_datetime): + # Mock datetime.now() to return a date after the competition date + mock_datetime.now.return_value = datetime(2023, 3, 27) + mock_datetime.strptime.side_effect = datetime.strptime + + # Call the function with a past competition + result = validate_competition_date(mock_competition_past) + + # Assert that the correct error message is returned + assert ( + result == "This competition is already over. You cannot book a place." + ) + + +# Test for valid club and valid competition (future date) +@patch("server.render_template") +@patch("server.validate_competition_date") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_book_valid_competition( + mock_get_competition, + mock_get_club, + mock_validate_date, + mock_render_template, + client, +): + # Mock valid club and competition + mock_get_competition.return_value = mock_competitions_list[0] + mock_get_club.return_value = mock_clubs_list[0] + mock_validate_date.return_value = None # No validation error + + # Simulate GET request to the route + response = client.get("/book/Competition%201/Club%201") + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_validate_date.assert_called_once_with(mock_competitions_list[0]) + mock_render_template.assert_called_once_with( + "booking.html", + club=mock_clubs_list[0], + competition=mock_competitions_list[0], + ) + + # Check the response status code + assert response.status_code == 200 + + +# Test for valid club and past competition (competition already over) +@patch("server.competitions", mock_competitions_list) +@patch("server.render_template") +@patch("server.flash") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +@patch("server.validate_competition_date") +def test_book_past_competition( + mock_validate_date, + mock_get_competition, + mock_get_club, + mock_flash, + mock_render_template, + client, +): + # Mock valid club but past competition + mock_get_competition.return_value = mock_competition_past + mock_get_club.return_value = mock_clubs_list[0] + mock_validate_date.return_value = ( + "This competition is already over. You cannot book a place." + ) + + # Simulate GET request to the route + response = client.get("/book/Competition%202/Club%201") + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 2") + mock_get_club.assert_called_once_with("Club 1") + mock_validate_date.assert_called_once_with(mock_competition_past) + mock_flash.assert_called_once_with( + "This competition is already over. You cannot book a place." + ) + mock_render_template.assert_called_once_with( + "welcome.html", + club=mock_clubs_list[0], + competitions=mock_competitions_list, + ) + + # Check the response status code + assert response.status_code == 200 + + +# Test for missing club or competition +@patch("server.competitions", mock_competitions_list) +@patch("server.render_template") +@patch("server.flash") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_book_missing_club_or_competition( + mock_get_competition, + mock_get_club, + mock_flash, + mock_render_template, + client, +): + # Mock a case where the competition is missing + mock_get_competition.return_value = None # Competition not found + mock_get_club.return_value = mock_clubs_list[0] # Club found + + # Simulate GET request to the route + response = client.get("/book/Competition%201/Club%201") + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_flash.assert_called_once_with("Something went wrong-please try again") + mock_render_template.assert_called_once_with( + "welcome.html", + club=mock_clubs_list[0]["name"], + competitions=mock_competitions_list, + ) + + # Check the response status code + assert response.status_code == 200 + + +# Test for invalid club +@patch("server.competitions", mock_competitions_list) +@patch("server.render_template") +@patch("server.flash") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_book_invalid_club( + mock_get_competition, + mock_get_club, + mock_flash, + mock_render_template, + client, +): + # Mock a case where the club is invalid + mock_get_competition.return_value = mock_competitions_list[ + 0 + ] # Competition found + mock_get_club.return_value = None # Club not found + + # Simulate GET request to the route + response = client.get("/book/Competition%201/Invalid%20Club") + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Invalid Club") + mock_flash.assert_called_once_with("Something went wrong-please try again") + mock_render_template.assert_called_once_with( + "welcome.html", club="Invalid Club", competitions=mock_competitions_list + ) + + # Check the response status code + assert response.status_code == 200 diff --git a/tests/unit_tests/test_clubs_should_not_use_more_than_12.py b/tests/unit_tests/test_clubs_should_not_use_more_than_12.py new file mode 100644 index 000000000..a7c4bfff4 --- /dev/null +++ b/tests/unit_tests/test_clubs_should_not_use_more_than_12.py @@ -0,0 +1,57 @@ +from unittest.mock import patch +from .utils import mock_clubs_list, mock_competitions_list + + +def test_check_places_invalid_more_than_12(): + from server import check_places + + error = check_places("13", mock_clubs_list[0]) + assert error == ("Places required must be a positive" + " integer that does not exceed 12") + + +# Unit test for booking with error in places +@patch("server.redirect") +@patch("server.url_for") +@patch("server.flash") +@patch("server.check_places") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_purchase_places_invalid_places( + mock_get_competition, + mock_get_club, + mock_check_places, + mock_flash, + mock_url_for, + mock_redirect, + client, +): + # Mock the functions to simulate an error in places + mock_get_competition.return_value = mock_competitions_list[0] + mock_get_club.return_value = mock_clubs_list[0] + mock_check_places.return_value = ( + "Places required must be a positive integer that does not exceed 12" + ) + + # Mock the redirect and url_for to return a redirect response + mock_url_for.return_value = "/book" + + # Simulate POST request to the route + client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "20"}, + ) + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_check_places.assert_called_once_with("20", mock_clubs_list[0]) + mock_flash.assert_called_once_with( + "Places required must be a positive integer that does not exceed 12" + ) + mock_url_for.assert_called_once_with( + "book", + competition=mock_competitions_list[0]["name"], + club=mock_clubs_list[0]["name"], + ) + mock_redirect.assert_called_once_with("/book") diff --git a/tests/unit_tests/test_clubs_should_not_use_more_than_their_points.py b/tests/unit_tests/test_clubs_should_not_use_more_than_their_points.py new file mode 100644 index 000000000..0e3e6ff77 --- /dev/null +++ b/tests/unit_tests/test_clubs_should_not_use_more_than_their_points.py @@ -0,0 +1,233 @@ +from unittest.mock import patch +from .utils import mock_clubs_list, mock_competitions_list + + +# Unit Tests for get_competition_from_name +@patch("server.competitions", mock_competitions_list) +def test_get_competition_from_name_valid(): + from server import get_competition_from_name + + competition = get_competition_from_name("Competition 1") + assert competition is not None + assert competition["name"] == "Competition 1" + + +@patch("server.competitions", mock_competitions_list) +def test_get_competition_from_name_invalid(): + from server import get_competition_from_name + + competition = get_competition_from_name("Invalid Competition") + assert competition is None + + +# Unit Tests for get_club_from_name ### +@patch("server.clubs", mock_clubs_list) +def test_get_club_from_name_valid(): + from server import get_club_from_name + + club = get_club_from_name("Club 1") + assert club is not None + assert club["name"] == "Club 1" + + +@patch("server.clubs", mock_clubs_list) +def test_get_club_from_name_invalid(): + from server import get_club_from_name + + club = get_club_from_name("Invalid Club") + assert club is None + + +# Unit Tests for check_places ### +def test_check_places_valid(): + from server import check_places + + error = check_places("5", mock_clubs_list[0]) + assert error is None + + +def test_check_places_invalid_zero(): + from server import check_places + + error = check_places("0", mock_clubs_list[0]) + assert error == "Places required must be a positive integer" + + +def test_check_places_invalid_negative(): + from server import check_places + + error = check_places("-3", mock_clubs_list[0]) + assert error == "Places required must be a positive integer" + + +def test_check_places_exceeds_points(): + from server import check_places + + error = check_places("11", mock_clubs_list[0]) + assert error == "Places required exceed club's total points" + + +# Unit Tests for take_places ### +def test_take_places_valid(): + from server import take_places + + result = take_places(5, mock_clubs_list[0], mock_competitions_list[0]) + assert result is True + assert mock_clubs_list[0]["points"] == 5 # 10 - 5 + assert mock_competitions_list[0]["numberOfPlaces"] == 20 # 25 - 5 + + +def test_take_places_invalid(): + from server import take_places + + result = take_places( + "invalid", mock_clubs_list[0], mock_competitions_list[0] + ) + assert result is False + + +# Unit test for valid booking + +@patch("server.competitions", mock_competitions_list) +@patch("server.render_template") +@patch("server.update_clubs") +@patch("server.take_places") +@patch("server.check_places") +@patch("server.get_index_club") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +@patch("server.flash") +def test_purchase_places_valid( + mock_flash, + mock_get_competition, + mock_get_club, + mock_get_index_club, + mock_check_places, + mock_take_places, + mock_update_clubs, + mock_render_template, + client, +): + # Mock the functions to return valid data + mock_get_competition.return_value = mock_competitions_list[0] + mock_get_club.return_value = mock_clubs_list[0] + mock_get_index_club.return_value = 0 + mock_check_places.return_value = None # No error message + mock_take_places.return_value = True # Simulate successful booking + mock_update_clubs.return_value = True + + # Simulate POST request to the route + client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "5"}, + ) + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_check_places.assert_called_once_with("5", mock_clubs_list[0]) + mock_take_places.assert_called_once_with( + 5, mock_clubs_list[0], mock_competitions_list[0] + ) + mock_flash.assert_called_once_with("Great-booking complete!") + mock_render_template.assert_called_once_with( + "welcome.html", + club=mock_clubs_list[0], + competitions=mock_competitions_list, + ) + + +# Unit test for booking with error in places +@patch("server.redirect") +@patch("server.url_for") +@patch("server.flash") +@patch("server.check_places") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_purchase_places_invalid_places( + mock_get_competition, + mock_get_club, + mock_check_places, + mock_flash, + mock_url_for, + mock_redirect, + client, +): + # Mock the functions to simulate an error in places + mock_get_competition.return_value = mock_competitions_list[0] + mock_get_club.return_value = mock_clubs_list[0] + mock_check_places.return_value = ( + "Places required exceed club's total points" + ) + + # Mock the redirect and url_for to return a redirect response + mock_url_for.return_value = "/book" + + # Simulate POST request to the route + client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "20"}, + ) + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_check_places.assert_called_once_with("20", mock_clubs_list[0]) + mock_flash.assert_called_once_with( + "Places required exceed club's total points" + ) + mock_url_for.assert_called_once_with( + "book", + competition=mock_competitions_list[0]["name"], + club=mock_clubs_list[0]["name"], + ) + mock_redirect.assert_called_once_with("/book") + + +# Unit test for failed booking due to take_places failure +@patch("server.redirect") +@patch("server.url_for") +@patch("server.flash") +@patch("server.take_places") +@patch("server.check_places") +@patch("server.get_club_from_name") +@patch("server.get_competition_from_name") +def test_purchase_places_failed_take_places( + mock_get_competition, + mock_get_club, + mock_check_places, + mock_take_places, + mock_flash, + mock_url_for, + mock_redirect, + client, +): + # Mock the functions to simulate an error in take_places + mock_get_competition.return_value = mock_competitions_list[0] + mock_get_club.return_value = mock_clubs_list[0] + mock_check_places.return_value = None # No error message + mock_take_places.return_value = False # Simulate failure in taking places + + # Mock the redirect and url_for to return a redirect response + mock_url_for.return_value = "/book" + + # Simulate POST request to the route + client.post( + "/purchasePlaces", + data={"competition": "Competition 1", "club": "Club 1", "places": "5"}, + ) + + # Assert that the necessary functions are called with the correct parameters + mock_get_competition.assert_called_once_with("Competition 1") + mock_get_club.assert_called_once_with("Club 1") + mock_check_places.assert_called_once_with("5", mock_clubs_list[0]) + mock_take_places.assert_called_once_with( + 5, mock_clubs_list[0], mock_competitions_list[0] + ) + mock_flash.assert_called_once_with("Something went wrong-please try again") + mock_url_for.assert_called_once_with( + "book", + competition=mock_competitions_list[0]["name"], + club=mock_clubs_list[0]["name"], + ) + mock_redirect.assert_called_once_with("/book") diff --git a/tests/unit_tests/test_point_updates_are_not_reflected.py b/tests/unit_tests/test_point_updates_are_not_reflected.py new file mode 100644 index 000000000..da438aae8 --- /dev/null +++ b/tests/unit_tests/test_point_updates_are_not_reflected.py @@ -0,0 +1,43 @@ +from unittest.mock import mock_open, patch +from server import update_clubs, get_index_club + + +def test_get_index_club(mock_clubs_fixture): + # Test finding the index of a club + with patch("server.clubs", mock_clubs_fixture): + club = mock_clubs_fixture[0] + index = get_index_club(club) + assert index == 0 + + +@patch("builtins.open", new_callable=mock_open) +@patch("json.dump") +def test_update_clubs_success(mock_json_dump, mock_file, mock_clubs_fixture): + club = {"name": "Club 1", "points": "20"} + index = 0 + with patch("server.clubs", mock_clubs_fixture): + result = update_clubs(club, index) + + assert result is True + assert mock_clubs_fixture[0]["points"] == "20" + mock_json_dump.assert_called_once() + mock_file.assert_called_once() + + +@patch("builtins.open", side_effect=FileNotFoundError) +def test_update_clubs_file_not_found(mock_file, mock_clubs_fixture): + # Club to be updated + club = {"name": "Club 1", "points": "20"} + index = 0 + + # Test update_clubs when FileNotFoundError is raised + with patch("server.clubs", mock_clubs_fixture): + result = update_clubs(club, index) + + # Assert that the function returns False + assert result is False + + # Assert that no changes were made to the clubs list + assert ( + mock_clubs_fixture[0]["points"] == "10" + ) # The points shouldn't be updated diff --git a/tests/unit_tests/test_unknown_email.py b/tests/unit_tests/test_unknown_email.py new file mode 100644 index 000000000..d0bd5446e --- /dev/null +++ b/tests/unit_tests/test_unknown_email.py @@ -0,0 +1,101 @@ +import json +from unittest.mock import mock_open, patch + +from server import get_club_from_email, loadClubs, loadCompetitions +from .utils import ( + mock_clubs_list, + mock_competitions_list, + mock_clubs_json, + mock_competitions_json, +) + + +# Test for loadClubs function +@patch("builtins.open", new_callable=mock_open, read_data=mock_clubs_json) +@patch("server.json.load") +def test_loadClubs(mock_json_load, mock_file): + # Mock json.load to return the parsed data + mock_json_load.return_value = json.loads(mock_clubs_json) + + # Call loadClubs and check if it returns the correct data + clubs = loadClubs() + assert len(clubs) == 2 + assert clubs[0]["name"] == "Club 1" + assert clubs[1]["email"] == "club2@example.com" + + +# Test for loadCompetitions function +@patch( + "builtins.open", new_callable=mock_open, read_data=mock_competitions_json +) +@patch("server.json.load") +def test_loadCompetitions(mock_json_load, mock_file): + # Mock json.load to return the parsed data + mock_json_load.return_value = json.loads(mock_competitions_json) + + # Call loadCompetitions and check if it returns the correct data + competitions = loadCompetitions() + assert len(competitions) == 2 + assert competitions[0]["name"] == "Competition 1" + assert competitions[1]["numberOfPlaces"] == "15" + + +@patch("server.clubs", mock_clubs_list) +def test_get_club_from_email_valid(): + club = get_club_from_email("club1@example.com") + assert club is not None + assert club["name"] == "Club 1" + + +@patch("server.clubs", mock_clubs_list) +def test_get_club_from_email_invalid(): + club = get_club_from_email("invalid@example.com") + assert club is None + + +# Unit test for showSummary with valid email +@patch( + "server.competitions", mock_competitions_list +) # Directly patch the value of competitions +@patch("server.get_club_from_email") +@patch("server.render_template") +def test_showSummary_valid_email(mock_render_template, mock_get_club, client): + # Mock get_club_from_email to return a valid club + mock_get_club.return_value = mock_clubs_list[0] + + # Simulate POST request with a valid email + response = client.post("/showSummary", data={"email": "club1@example.com"}) + + # Check if render_template was called with the correct arguments + mock_render_template.assert_called_once_with( + "welcome.html", + club=mock_clubs_list[0], + competitions=mock_competitions_list, + ) + assert response.status_code == 200 + + +# Unit test for showSummary with invalid email +@patch("server.get_club_from_email") +@patch("server.flash") +@patch("server.redirect") +@patch("server.url_for") +def test_showSummary_invalid_email( + mock_url_for, mock_redirect, mock_flash, mock_get_club, client +): + # Mock get_club_from_email to return None (simulating an invalid email) + mock_get_club.return_value = None + + # Mock url_for to return a URL for the index page + mock_url_for.return_value = "/" + + # Simulate POST request with an invalid email + client.post( + "/showSummary", data={"email": "invalid@example.com"} + ) + + # Check if flash was called with the correct message + mock_flash.assert_called_once_with("Sorry, that email wasn't found.") + + # Check if redirect was called with the correct arguments + mock_redirect.assert_called_once_with("/") diff --git a/tests/unit_tests/utils.py b/tests/unit_tests/utils.py new file mode 100644 index 000000000..233e88226 --- /dev/null +++ b/tests/unit_tests/utils.py @@ -0,0 +1,25 @@ +import json + + +# Mock data for clubs and competitions +mock_clubs_list = [ + {"name": "Club 1", "email": "club1@example.com", "points": "10"}, + {"name": "Club 2", "email": "club2@example.com", "points": "15"}, +] + +mock_competitions_list = [ + { + "name": "Competition 1", + "date": "2023-03-27 10:00:00", + "numberOfPlaces": "25", + }, + { + "name": "Competition 2", + "date": "2023-10-22 13:30:00", + "numberOfPlaces": "15", + }, +] +# Mock data for clubs.json and competitions.json +mock_clubs_json = json.dumps({"clubs": mock_clubs_list}) + +mock_competitions_json = json.dumps({"competitions": mock_competitions_list})