(fix) test-endpoints purchase places

Author: br-imen

.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

competitions.json

@@ -8,7 +8,7 @@
         {
             "name": "Fall Classic",
             "date": "2020-10-22 13:30:00",
-            "numberOfPlaces": "2"
+            "numberOfPlaces": "14"
         }
     ]
 }

pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length = 80

requirements.txt

@@ -5,4 +5,5 @@ Jinja2==2.11.2
 MarkupSafe==1.1.1
 Werkzeug==1.0.1
 black
-pytest
+pytest
+flake8

server.py

@@ -1,6 +1,10 @@
 import json
 from flask import Flask, render_template, request, redirect, flash, url_for
 
+app = Flask(__name__)
+app.secret_key = "something_special"
+app.config["COMPETITIONS_FILE"] = "competitions.json"
+
 
 def loadClubs():
     with open("clubs.json") as c:
@@ -9,14 +13,11 @@ def loadClubs():
 
 
 def loadCompetitions():
-    with open("competitions.json") as comps:
+    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()
 
@@ -28,12 +29,8 @@ def index():
 
 @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
-    )
+    club = [club for club in clubs if club["email"] == request.form["email"]][0]
+    return render_template("welcome.html", club=club, competitions=competitions)
 
 
 @app.route("/book/<competition>/<club>")
@@ -62,26 +59,37 @@ def purchasePlaces():
     club = [c for c in clubs if c["name"] == request.form["club"]][0]
 
     # Check if request.form['places'] exist and positive *
-    if not request.form['places'] or int(request.form['places']) < 1 :
+    if not request.form["places"] or int(request.form["places"]) < 1:
         flash("Places required must be a positive integer")
-        return redirect(url_for('book',competition=competition['name'],club=club['name']))
+        return redirect(
+            url_for("book", competition=competition["name"], club=club["name"])
+        )
 
     # Check if placesRequired does not exceed 12
     placesRequired = int(request.form["places"])
-    if placesRequired > 12 :
+
+    if placesRequired > 12:
         flash(
             "Places required must be a positive integer that does not exceed 12"
         )
         return redirect(
-            url_for(
-                "book", competition=competition["name"], club=club["name"]
-            )
+            url_for("book", competition=competition["name"], club=club["name"])
+        )
+
+    # Check if placesRequired does not exceed places available:
+    places_available = int(competition["numberOfPlaces"])
+
+    if placesRequired > places_available:
+        flash(
+            f"Places required must be lower than places available: "
+            f"{places_available}"
+        )
+        return redirect(
+            url_for("book", competition=competition["name"], club=club["name"])
         )
 
     # Update places in competition
-    competition["numberOfPlaces"] = (
-        int(competition["numberOfPlaces"]) - placesRequired
-    )
+    competition["numberOfPlaces"] = places_available - placesRequired
 
     # Store the str() value of 'numberOfPlaces' in the dict of competition in
     # the list-dict competitions
@@ -94,13 +102,10 @@ def purchasePlaces():
     dict_competitions["competitions"] = competitions
 
     # unload
-    with open("competitions.json", "w") as file_competition:
+    with open(app.config["COMPETITIONS_FILE"], "w") as file_competition:
         json.dump(dict_competitions, file_competition, indent=4)
     flash("Great-booking complete!")
-    return render_template(
-        "welcome.html", club=club, competitions=competitions
-    )
-
+    return render_template("welcome.html", club=club, competitions=competitions)
 
 
 # TODO: Add route for points display
@@ -109,3 +114,7 @@ def purchasePlaces():
 @app.route("/logout")
 def logout():
     return redirect(url_for("index"))
+
+
+if __name__ == "__main__":
+    app.run(debug=True)

templates/booking.html

@@ -19,7 +19,7 @@ <h2>{{competition['name']}}</h2>
     <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>

tests/test_endpoints.py

@@ -1,38 +1,154 @@
 import pytest
-from server import app
+import json
 import html
+from server import app
+
+
+@pytest.fixture
+def temp_competitions_file(tmpdir, request):
+    original_competitions_file = tmpdir.join("competitions.json")
+    num_places = request.param if hasattr(request, "param") else "10"
+    initial_competitions = {
+        "competitions": [
+            {
+                "name": "Spring Festival",
+                "date": "2020-03-27 10:00:00",
+                "numberOfPlaces": "13",
+            },
+            {
+                "name": "Fall Classic",
+                "date": "2020-10-22 13:30:00",
+                "numberOfPlaces": num_places,
+            },
+        ]
+    }
+    with open(original_competitions_file, "w") as competitions_file:
+        json.dump(initial_competitions, competitions_file, indent=4)
+    app.config["COMPETITIONS_FILE"] = str(original_competitions_file)
+    return initial_competitions
+
 
+@pytest.fixture
+def client(temp_competitions_file):
+    with app.test_client() as client:
+        yield client
 
-@pytest.fixture()
-def client():
-    return app.test_client()
 
-def test_purchasePlaces_input_less_12(client):
-    response = client.post("/purchasePlaces", data = {"places":11,"competition":"Fall Classic","club":"Iron Temple"})
+@pytest.fixture(autouse=True)
+def reset_competitions(temp_competitions_file):
+    from server import competitions
+
+    competitions.clear()
+    competitions.extend(temp_competitions_file["competitions"])
+
+
+@pytest.mark.parametrize("temp_competitions_file", ["10"], indirect=True)
+def test_purchasePlaces_input_less_12_sucess(client, tmpdir):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": 9,
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
     assert response.status_code == 200
-    assert b'Great-booking complete!' in response.data
+    assert b"Great-booking complete!" in response.data
+
+
+@pytest.mark.parametrize("temp_competitions_file", ["10"], indirect=True)
+def test_purchasePlaces_input_less_12_but_more_than_places_available(
+    client, tmpdir
+):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": 11,
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
+    assert response.status_code == 302
+    response_redirect = client.get("/book/Fall%20Classic/Iron%20Temple")
+    decoding_response_data = response_redirect.data.decode("UTF-8")
+    converted_str = html.unescape(decoding_response_data)
+    assert (
+        "Places required must be lower than places available: 10"
+        in converted_str
+    )
 
 
-def test_purchasePlaces_input_more_12(client):
-    response = client.post("/purchasePlaces", data = {"places":13,"competition":"Fall Classic","club":"Iron Temple"})
+@pytest.mark.parametrize("temp_competitions_file", ["14"], indirect=True)
+def test_purchasePlaces_input_more_12(client, tmpdir):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": 13,
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
     assert response.status_code == 302
     response_redirect = client.get("/book/Fall%20Classic/Iron%20Temple")
-    decoding_response_data = response_redirect.data.decode('UTF-8')
-    converted_str = html.unescape(decoding_response_data) 
-    assert "Places required must be a positive integer that does not exceed 12" in converted_str
+    decoding_response_data = response_redirect.data.decode("UTF-8")
+    converted_str = html.unescape(decoding_response_data)
+    assert (
+        "Places required must be a positive integer that does not exceed 12"
+        in converted_str
+    )
 
-def test_purchasePlaces_input_negatif(client):
-    response = client.post("/purchasePlaces", data = {"places":-1,"competition":"Fall Classic","club":"Iron Temple"})
+
+@pytest.mark.parametrize("temp_competitions_file", ["10"], indirect=True)
+def test_purchasePlaces_input_negatif(client, tmpdir):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": -1,
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
     assert response.status_code == 302
     response_redirect = client.get("/book/Fall%20Classic/Iron%20Temple")
-    decoding_response_data = response_redirect.data.decode('UTF-8')
-    converted_str = html.unescape(decoding_response_data) 
+    decoding_response_data = response_redirect.data.decode("UTF-8")
+    converted_str = html.unescape(decoding_response_data)
     assert "Places required must be a positive integer" in converted_str
 
-def test_purchasePlaces_input_none(client):
-    response = client.post("/purchasePlaces", data = {"places":"","competition":"Fall Classic","club":"Iron Temple"})
+
+@pytest.mark.parametrize("temp_competitions_file", ["10"], indirect=True)
+def test_purchasePlaces_input_none(client, tmpdir):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": "",
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
     assert response.status_code == 302
     response_redirect = client.get("/book/Fall%20Classic/Iron%20Temple")
-    decoding_response_data = response_redirect.data.decode('UTF-8')
-    converted_str = html.unescape(decoding_response_data) 
-    assert "Places required must be a positive integer" in converted_str
+    decoding_response_data = response_redirect.data.decode("UTF-8")
+    converted_str = html.unescape(decoding_response_data)
+    assert "Places required must be a positive integer" in converted_str
+
+
+@pytest.mark.parametrize("temp_competitions_file", ["10"], indirect=True)
+def test_purchasePlaces_update_number_places(client, tmpdir):
+    response = client.post(
+        "/purchasePlaces",
+        data={
+            "places": 1,
+            "competition": "Fall Classic",
+            "club": "Iron Temple",
+        },
+    )
+    assert response.status_code == 200
+    assert b"Great-booking complete!" in response.data
+    # Verify number of places have been updated
+    with open(app.config["COMPETITIONS_FILE"]) as f:
+        updated_competitions = json.load(f)["competitions"]
+        updated_competition = next(
+            c for c in updated_competitions if c["name"] == "Fall Classic"
+        )
+        print("in test updated competition", updated_competition)
+        assert updated_competition["numberOfPlaces"] == "9"