(fix) handle point updates are not reflected

Author: br-imen

.coverage

@@ -4,11 +4,12 @@
 
 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:
+    with open(app.config["CLUB_FILE"]) as c:
         listOfClubs = json.load(c)["clubs"]
         return listOfClubs
 
@@ -96,6 +97,10 @@ def get_club_from_name(name):
         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"
@@ -119,20 +124,32 @@ def take_places(places, club, competition):
         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):
+    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

server.py

@@ -1,23 +1,34 @@
+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": [
-        {"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"}
-    ]
-})
+mock_clubs_json = json.dumps({"clubs": clubs_list})
+
+mock_competitions_json = json.dumps({"competitions": competitions_list})
 
 
 def mocked_open(file, *args, **kwargs):
@@ -30,17 +41,45 @@ def mocked_open(file, *args, **kwargs):
     elif file == "competitions.json":
         return mock_open(read_data=mock_competitions_json)()
     else:
-        raise FileNotFoundError(f"File {file} not found")
+        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  # Import app after patching
+    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():
+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

tests/integration_tests/conftest.py

@@ -1,14 +1,12 @@
 
-
 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"
-    })
+    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
@@ -18,11 +16,14 @@ 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
-    })
+    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
@@ -33,11 +34,10 @@ 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"
-    })
+    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

tests/integration_tests/test_clubs_should_not_use_more_than_their_points.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"

tests/integration_tests/test_point_updates_are_not_reflected.py

@@ -6,3 +6,11 @@
 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"},
+    ]

tests/unit_tests/conftest.py

@@ -87,30 +87,37 @@ def test_take_places_invalid():
 
 
 # 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
-    response = client.post(
+    client.post(
         "/purchasePlaces",
         data={"competition": "Competition 1", "club": "Club 1", "places": "5"},
     )
@@ -129,9 +136,6 @@ def test_purchase_places_valid(
         competitions=mock_competitions_list,
     )
 
-    # Check response status code
-    assert response.status_code == 200
-
 
 # Unit test for booking with error in places
 @patch("server.redirect")

tests/unit_tests/test_clubs_should_not_use_more_than_their_points.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