Issue OpenClassrooms-Student-Center#2 Fixed

Issue OpenClassrooms-Student-Center#4 Fixed
Issue OpenClassrooms-Student-Center#6 Fixed
Some parts of the tree structure for the tests have been modified.

Author: tchou93

internal_functions.py

@@ -1,52 +1,91 @@
-import json
-from flask import Flask,render_template,request,redirect,flash,url_for
+from flask import Flask, render_template, request, redirect, flash, url_for, json
 from http import HTTPStatus
-from internal_functions import loadCompetitions, loadClubs
 
+
+########### Internal function ###########
+def loadclubs() -> object:
+    with open(r'D:\Tan\Travail\developpement\python\projetOC\projet11\clubs.json') as c:
+        listofclubs = json.load(c)['clubs']
+        return listofclubs
+
+
+def loadcompetitions():
+    with open(r'D:\Tan\Travail\developpement\python\projetOC\projet11\competitions.json') as comps:
+        listofcompetitions = json.load(comps)['competitions']
+        return listofcompetitions
+
+def valid_reservation(places_required, clubpoint, nb_place_competition):
+    message = ""
+    if places_required > 12:
+        message += "The places required should not be more than 12. "
+
+    if places_required > nb_place_competition:
+        message += "The places required is more than the number of places of the competition. "
+
+    if places_required > clubpoint:
+        message += "The places required is more than the number of places of the club."
+
+    if message == "":
+        message += "Great-booking complete!"
+        return True, message
+    else:
+        return False, message
+
+########### Create app ###########
 app = Flask(__name__)
 app.secret_key = 'something_special'
 
-competitions = loadCompetitions()
-clubs = loadClubs()
+competitions = loadcompetitions()
+clubs = loadclubs()
 
+########### Endpoints ###########
 @app.route('/')
 def index():
     return render_template('index.html')
 
-@app.route('/showSummary',methods=['POST'])
-def showSummary():
+
+@app.route('/showSummary', methods=['POST'])
+def showsummary():
     try:
         club = [club for club in clubs if club['email'] == request.form['email']][0]
-        return render_template('welcome.html',club=club,competitions=competitions)
+        return render_template('welcome.html', club=club, competitions=competitions)
 
     except IndexError:
         flash("Sorry, that email was not found.")
         return render_template('index.html'), HTTPStatus.UNAUTHORIZED
 
+
 @app.route('/book/<competition>/<club>')
-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)
+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)
     else:
         flash("Something went wrong-please try again")
         return render_template('welcome.html', club=club, competitions=competitions)
 
 
-@app.route('/purchasePlaces',methods=['POST'])
-def purchasePlaces():
+@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)
+    placesrequired = int(request.form['places'])
+
+    statut, message = valid_reservation(placesrequired, int(club["points"]), int(competition['numberOfPlaces']))
+    if statut:
+        competition['numberOfPlaces'] = int(competition['numberOfPlaces']) - placesrequired
+        club['points'] = int(club['points']) - placesrequired
+        flash(message)
+        return render_template('welcome.html', club=club, competitions=competitions)
+    else:
+        flash(message)
+        return render_template('booking.html', club=club, competition=competition),HTTPStatus.BAD_REQUEST
 
 
 # TODO: Add route for points display
 
 
 @app.route('/logout')
 def logout():
-    return redirect(url_for('index'))
+    return redirect(url_for('index'))

server.py

@@ -13,5 +13,15 @@ <h2>{{competition['name']}}</h2>
         <label for="places">How many places?</label><input type="number" name="places" id=""/>
         <button type="submit">Book</button>
     </form>
+
+    {% with messages = get_flashed_messages() %}
+      {% if messages %}
+        <ul class=flashes>
+        {% for message in messages %}
+          <li>{{ message }}</li>
+        {% endfor %}
+        </ul>
+      {% endif %}
+    {% endwith %}
 </body>
 </html>

templates/booking.html

@@ -1,63 +1,24 @@
 import pytest
-
 import server
 from server import app
+from tests.global_var import simu_clubs, simu_competitions
 
-
-def get_clubs_tests():
-    clubs = [
-        {
-            "name": "Simply Lift",
-            "email": "john@simplylift.com",
-            "points": "13"
-        },
-        {
-            "name": "Iron Temple",
-            "email": "admin@irontemple.com",
-            "points": "4"
-        },
-        {
-            "name": "She Lifts",
-            "email": "kate@shelifts.co.uk",
-            "points": "12"
-        },
-        {
-            "name": "Club Test",
-            "email": "clubtest@gmail.com",
-            "points": "50"
-        },
-    ]
-    return clubs
-
-
-def get_competitions_tests():
-    competitions = [
-        {
-            "name": "Spring Festival",
-            "date": "2020-03-27 10:00:00",
-            "numberOfPlaces": "25"
-        },
-        {
-            "name": "Fall Classic",
-            "date": "2020-10-22 13:30:00",
-            "numberOfPlaces": "13"
-        },
-        {
-            "name": "Competition Test",
-            "date": "2022-10-22 13:30:00",
-            "numberOfPlaces": "50"
-        },
-    ]
-    return competitions
-
-
+########### Configure Client ###########
 @pytest.fixture
 def client():
     with app.test_client() as client:
         yield client
 
+########### Configure DataBase ###########
+@pytest.fixture
+def competitions_test():
+    return simu_competitions
+
+@pytest.fixture
+def clubs_test():
+    return simu_clubs
 
 @pytest.fixture
-def databasemocker(mocker):
-    mocker.patch.object(server, "clubs", get_clubs_tests())
-    mocker.patch.object(server, "competitions", get_competitions_tests())
+def data_base_mocker(mocker):
+    mocker.patch.object(server, "clubs", simu_clubs)
+    mocker.patch.object(server, "competitions", simu_competitions)

tests/conftest.py

@@ -1 +1,44 @@
-ENDPOINT_SHOWSUMMARY= "/showSummary"
+ENDPOINT_SHOWSUMMARY = "/showSummary"
+ENDPOINT_PURCHASE_PLACES = "/purchasePlaces"
+MAX_PURCHASE = 12
+
+simu_clubs = [
+    {
+        "name": "Simply Lift 333",
+        "email": "john@simplylift.com",
+        "points": "13"
+    },
+    {
+        "name": "Iron Temple",
+        "email": "admin@irontemple.com",
+        "points": "4"
+    },
+    {
+        "name": "She Lifts",
+        "email": "kate@shelifts.co.uk",
+        "points": "12"
+    },
+    {
+        "name": "Club Test",
+        "email": "clubtest@gmail.com",
+        "points": "50"
+    },
+]
+
+simu_competitions = [
+    {
+        "name": "Spring Festival",
+        "date": "2020-03-27 10:00:00",
+        "numberOfPlaces": "25"
+    },
+    {
+        "name": "Fall Classic",
+        "date": "2020-10-22 13:30:00",
+        "numberOfPlaces": "13"
+    },
+    {
+        "name": "Competition Test",
+        "date": "2022-10-22 13:30:00",
+        "numberOfPlaces": "50"
+    },
+]

tests/global_var.py

@@ -9,7 +9,7 @@ class TestAuthentication:
         ({'email': 'clubtest@gmail.com'}, HTTPStatus.OK),
         ({'email': 'kate@shelifts.co.uk'}, HTTPStatus.OK),
     ])
-    def test_good_email(self, email, status_code, client, databasemocker):
+    def test_good_email(self, email, status_code, client, data_base_mocker):
         result = client.post(ENDPOINT_SHOWSUMMARY, data=email)
         message = f"Welcome, {email['email']}"
 
@@ -20,7 +20,7 @@ def test_good_email(self, email, status_code, client, databasemocker):
         ({'email': 'test@gmail.com'}, HTTPStatus.NOT_FOUND),
         ({'email': ''}, HTTPStatus.NOT_FOUND),
     ])
-    def test_bad_email(self, email, status_code, client, databasemocker):
+    def test_bad_email(self, email, status_code, client, data_base_mocker):
         result = client.post(ENDPOINT_SHOWSUMMARY, data=email)
 
         assert result.status_code == HTTPStatus.UNAUTHORIZED

tests/integration_test/test_authentication.py tests/integration_test/test_integration_authentication.py

@@ -0,0 +1,50 @@
+import pytest
+from http import HTTPStatus
+import random
+from tests.global_var import ENDPOINT_PURCHASE_PLACES
+from tests.global_var import MAX_PURCHASE
+
+@pytest.fixture
+def valid_reservation_mocker(mocker):
+    mocker.patch('server.valid_reservation', return_value=(True, "Valid message"))
+
+
+@pytest.fixture
+def invalid_reservation_mocker(mocker):
+    mocker.patch('server.valid_reservation', return_value=(False, "Invalid message"))
+
+
+class TestReservation:
+
+    def test_good_purchase(self, client, valid_reservation_mocker, data_base_mocker, clubs_test,
+                                  competitions_test):
+        data = {
+            'competition': (competitions_test[0])['name'],
+            'club': (clubs_test[0])['name'],
+            'places': random.randint(1, MAX_PURCHASE),
+        }
+        club_points_before_purchase = (clubs_test[0])['points']
+        competitions_places_before_purchase = (competitions_test[0])['numberOfPlaces']
+        result = client.post(ENDPOINT_PURCHASE_PLACES, data=data)
+
+        assert result.status_code == HTTPStatus.OK
+        assert "Valid message" in result.data.decode()
+        assert int(club_points_before_purchase) - data['places'] == int((clubs_test[0])['points'])
+        assert int(competitions_places_before_purchase) - data['places'] == \
+               int((competitions_test[0])['numberOfPlaces'])
+
+    def test_bad_purchase(self, client, invalid_reservation_mocker, data_base_mocker, clubs_test,
+                                  competitions_test):
+        data = {
+            'competition': (competitions_test[0])['name'],
+            'club': (clubs_test[0])['name'],
+            'places': 0,
+        }
+        club_points_before_purchase = (clubs_test[0])['points']
+        competitions_places_before_purchase = (competitions_test[0])['numberOfPlaces']
+        result = client.post(ENDPOINT_PURCHASE_PLACES, data=data)
+
+        assert result.status_code == HTTPStatus.BAD_REQUEST
+        assert "Invalid message" in result.data.decode()
+        assert int(club_points_before_purchase) == int((clubs_test[0])['points'])
+        assert int(competitions_places_before_purchase) == int((competitions_test[0])['numberOfPlaces'])

tests/integration_test/test_integration_reservation.py

@@ -0,0 +1,27 @@
+import pytest
+
+from server import valid_reservation
+
+
+@pytest.mark.parametrize("places_required, clubpoint,nb_place_competition, expected_value, messages",
+                         [(13, 20, 50, False, ["The places required should not be more than 12"]),
+                          (12, 20, 50, True, ["Great-booking complete!"]),
+                          (11, 20, 50, True, ["Great-booking complete!"]),
+                          (11, 20, 10, False, ["The places required is more than the number of places of the "
+                                               "competition."]),
+                          (10, 20, 10, True, ["Great-booking complete!"]),
+                          (9, 20, 10, True, ["Great-booking complete!"]),
+                          (11, 10, 20, False, ["The places required is more than the number of places of the club"]),
+                          (10, 10, 20, True, ["Great-booking complete!"]),
+                          (9, 10, 20, True, ["Great-booking complete!"]),
+                          (13, 30, 12, False, ["The places required should not be more than 12",
+                                               "The places required is more than the number of places of the "
+                                               "competition"]),
+                          (13, 12, 12, False, ["The places required should not be more than 12",
+                                               "The places required is more than the number of places of the "
+                                               "competition",
+                                               "The places required is more than the number of places of the club"])])
+def test_sut_validreservation(places_required, clubpoint, nb_place_competition, expected_value, messages):
+    assert (valid_reservation(places_required, clubpoint, nb_place_competition))[0] == expected_value
+    for message in messages:
+        assert message in (valid_reservation(places_required, clubpoint, nb_place_competition))[1]