(fix) Handle redeeming more points than available

br-imen · br-imen · commit 4e1e43e4631a · 2024-09-05T01:03:24.000+02:00
diff --git a/.coverage b/.coverage
diff --git a/requirements.txt b/requirements.txt
@@ -6,4 +6,4 @@ MarkupSafe==1.1.1
 Werkzeug==1.0.1
 pytest
 black
-flake8
+flake8
diff --git a/server.py b/server.py
@@ -62,21 +62,66 @@ def book(competition, club):
         )
 
 
+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 check_places(places, club):
+    if not places or int(places) < 1:
+        return "Places required must be a positive integer"
+    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
+
+
 @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]
+    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"])
-    competition["numberOfPlaces"] = (
-        int(competition["numberOfPlaces"]) - placesRequired
-    )
-    flash("Great-booking complete!")
-    return render_template("welcome.html", club=club, competitions=competitions)
 
-
-# TODO: Add route for points display
+    if take_places(placesRequired, club, competition):
+        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")
diff --git a/templates/booking.html b/templates/booking.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
@@ -6,11 +7,20 @@
 </head>
 <body>
     <h2>{{competition['name']}}</h2>
+    {% with messages = get_flashed_messages()%}
+    {% if messages %}
+        <ul>
+       {% for message in messages %}
+            <li>{{message}}</li>
+        {% endfor %}
+       </ul>
+    {% endif%}
+    {% endwith %}
     Places available: {{competition['numberOfPlaces']}}
     <form action="/purchasePlaces" method="post">
         <input type="hidden" name="club" value="{{club['name']}}">
         <input type="hidden" name="competition" value="{{competition['name']}}">
-        <label for="places">How many places?</label><input type="number" name="places" id=""/>
+        <label for="places">How many places?</label><input type="number" name="places" id="places"/>
         <button type="submit">Book</button>
     </form>
 </body>
diff --git a/tests/integration_tests/conftest.py b/tests/integration_tests/conftest.py
@@ -3,23 +3,21 @@
 from unittest.mock import mock_open, patch
 
 # Mock data for clubs.json and competitions.json
-mock_clubs_json = json.dumps(
-    {
-        "clubs": [
-            {"name": "Club 1", "email": "club1@example.com"},
-            {"name": "Club 2", "email": "club2@example.com"},
-        ]
-    }
-)
-
-mock_competitions_json = json.dumps(
-    {
-        "competitions": [
-            {"name": "Competition 1", "numberOfPlaces": "25"},
-            {"name": "Competition 2", "numberOfPlaces": "15"},
-        ]
-    }
-)
+mock_clubs_json = json.dumps({
+    "clubs": [
+        {"name": "Club 1", "email": "club1@example.com", "points": "10"},
+        {"name": "Club 2", "email": "club2@example.com", "points": "15"}
+    ]
+})
+
+mock_competitions_json = json.dumps({
+    "competitions": [
+        {"name": "Competition 1", "date": "2023-03-27 10:00:00",
+         "numberOfPlaces": "25"},
+        {"name": "Competition 2", "date": "2023-10-22 13:30:00",
+         "numberOfPlaces": "15"}
+    ]
+})
 
 
 def mocked_open(file, *args, **kwargs):
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
@@ -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": "20"  # 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&#39;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/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
@@ -0,0 +1,86 @@
+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("20", 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
diff --git a/tests/unit_tests/utils.py b/tests/unit_tests/utils.py
@@ -1,23 +1,25 @@
-
 import json
 
 
 # Mock data for clubs and competitions
 mock_clubs_list = [
-    {"name": "Club 1", "email": "club1@example.com"},
-    {"name": "Club 2", "email": "club2@example.com"}
+    {"name": "Club 1", "email": "club1@example.com", "points": "10"},
+    {"name": "Club 2", "email": "club2@example.com", "points": "15"},
 ]
 
 mock_competitions_list = [
-    {"name": "Competition 1", "numberOfPlaces": "25"},
-    {"name": "Competition 2", "numberOfPlaces": "15"}
+    {
+        "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_clubs_json = json.dumps({"clubs": mock_clubs_list})
 
-mock_competitions_json = json.dumps({
-    "competitions": mock_competitions_list
-})
+mock_competitions_json = json.dumps({"competitions": mock_competitions_list})

-Original file line number
+Diff line change
 Werkzeug==1.0.1
 pytest
 black
 -flake8
 +flake8