added testing paragraph

Feature/issue7

.coveragerc

@@ -1,3 +1,2 @@
 [run]
-omit = tests/*
+omit = tests/*
-

Pipfile

@@ -11,6 +11,11 @@ jinja2 = "==2.11.2"
 markupsafe = "==1.1.1"
 werkzeug = "==1.0.1"
 ward = "*"
+coverage = "*"
+pytest-cov = "*"
+pytest = "*"
+pytest-flask = "*"
+bs4 = "*"
 
 [dev-packages]
 

Pipfile.lock

@@ -17,6 +17,22 @@
         ]
     },
     "default": {
+        "beautifulsoup4": {
+            "hashes": [
+                "sha256:9bbbb14bfde9d79f38b8cd5f8c7c85f4b8f2523190ebed90e950a8dea4cb1c4b",
+                "sha256:dbb3c4e1ceae6aefebdaf2423247260cd062430a410e38c66f2baa50a8437195"
+            ],
+            "markers": "python_full_version >= '3.7.0'",
+            "version": "==4.13.4"
+        },
+        "bs4": {
+            "hashes": [
+                "sha256:a48685c58f50fe127722417bae83fe6badf500d54b55f7e39ffe43b798653925",
+                "sha256:abf8742c0805ef7f662dce4b51cca104cffe52b835238afc169142ab9b3fbccc"
+            ],
+            "index": "pypi",
+            "version": "==0.0.2"
+        },
         "click": {
             "hashes": [
                 "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a",
@@ -46,6 +62,82 @@
             ],
             "markers": "python_version >= '2.7'",
             "version": "==4.1.0"
+        "coverage": {
+            "extras": 
+                "toml"
+            ],
+            "hashes": [
+                "sha256:0a07757de9feb1dfafd16ab651e0f628fd7ce551604d1bf23e47e1ddca93f08a",
+                "sha256:0a17eaf46f56ae0f870f14a3cbc2e4632fe3771eab7f687eda1ee59b73d09fe4",
+                "sha256:0b4a4cb73b9f2b891c1788711408ef9707666501ba23684387277ededab1097c",
+                "sha256:0c0378ba787681ab1897f7c89b415bd56b0b2d9a47e5a3d8dc0ea55aac118d6c",
+                "sha256:115db3d1f4d3f35f5bb021e270edd85011934ff97c8797216b62f461dd69374b",
+                "sha256:123d589f32c11d9be7fe2e66d823a236fe759b0096f5db3fb1b75b2fa414a4fa",
+                "sha256:14fa8d3da147f5fdf9d298cacc18791818f3f1a9f542c8958b80c228320e90c6",
+                "sha256:19e7be4cfec248df38ce40968c95d3952fbffd57b400d4b9bb580f28179556d2",
+                "sha256:1df6b76e737c6a92210eebcb2390af59a141f9e9430210595251fbaf02d46926",
+                "sha256:1e2f097eae0e5991e7623958a24ced3282676c93c013dde41399ff63e230fcf2",
+                "sha256:256ea87cb2a1ed992bcdfc349d8042dcea1b80436f4ddf6e246d6bee4b5d73b6",
+                "sha256:28dc1f67e83a14e7079b6cea4d314bc8b24d1aed42d3582ff89c0295f09b181e",
+                "sha256:2c8937fa16c8c9fbbd9f118588756e7bcdc7e16a470766a9aef912dd3f117dbd",
+                "sha256:2d0d4f6ecdf37fcc19c88fec3e2277d5dee740fb51ffdd69b9579b8c31e4232e",
+                "sha256:2f3da12e0ccbcb348969221d29441ac714bbddc4d74e13923d3d5a7a0bebef7a",
+                "sha256:31991156251ec202c798501e0a42bbdf2169dcb0f137b1f5c0f4267f3fc68ef9",
+                "sha256:326802760da234baf9f2f85a39e4a4b5861b94f6c8d95251f699e4f73b1835dc",
+                "sha256:333b2e0ca576a7dbd66e85ab402e35c03b0b22f525eed82681c4b866e2e2653a",
+                "sha256:42da2280c4d30c57a9b578bafd1d4494fa6c056d4c419d9689e66d775539be74",
+                "sha256:48f82f889c80af8b2a7bb6e158d95a3fbec6a3453a1004d04e4f3b5945a02694",
+                "sha256:49b752a2858b10580969ec6af6f090a9a440a64a301ac1528d7ca5f7ed497f4d",
+                "sha256:4b1c2d8363247b46bd51f393f86c94096e64a1cf6906803fa8d5a9d03784bdbf",
+                "sha256:4e01d138540ef34fcf35c1aa24d06c3de2a4cffa349e29a10056544f35cca15f",
+                "sha256:4e2c058aef613e79df00e86b6d42a641c877211384ce5bd07585ed7ba71ab31b",
+                "sha256:549cab4892fc82004f9739963163fd3aac7a7b0df430669b75b86d293d2df2a7",
+                "sha256:55a28954545f9d2f96870b40f6c3386a59ba8ed50caf2d949676dac3ecab99f5",
+                "sha256:619317bb86de4193debc712b9e59d5cffd91dc1d178627ab2a77b9870deb2868",
+                "sha256:6406cff19880aaaadc932152242523e892faff224da29e241ce2fca329866584",
+                "sha256:66283a192a14a3854b2e7f3418d7db05cdf411012ab7ff5db98ff3b181e1f912",
+                "sha256:669135a9d25df55d1ed56a11bf555f37c922cf08d80799d4f65d77d7d6123fcf",
+                "sha256:71ae8b53855644a0b1579d4041304ddc9995c7b21c8a1f16753c4d8903b4dfed",
+                "sha256:82c3939264a76d44fde7f213924021ed31f55ef28111a19649fec90c0f109e6d",
+                "sha256:82d76ad87c932935417a19b10cfe7abb15fd3f923cfe47dbdaa74ef4e503752d",
+                "sha256:88d7598b8ee130f32f8a43198ee02edd16d7f77692fa056cb779616bbea1b355",
+                "sha256:8a1166db2fb62473285bcb092f586e081e92656c7dfa8e9f62b4d39d7e6b5050",
+                "sha256:9303aed20872d7a3c9cb39c5d2b9bdbe44e3a9a1aecb52920f7e7495410dfab8",
+                "sha256:985abe7f242e0d7bba228ab01070fde1d6c8fa12f142e43debe9ed1dde686038",
+                "sha256:997024fa51e3290264ffd7492ec97d0690293ccd2b45a6cd7d82d945a4a80c8b",
+                "sha256:9ce85551f9a1119f02adc46d3014b5ee3f765deac166acf20dbb851ceb79b6f3",
+                "sha256:9d3a700304d01a627df9db4322dc082a0ce1e8fc74ac238e2af39ced4c083193",
+                "sha256:9dfb070f830739ee49d7c83e4941cc767e503e4394fdecb3b54bfdac1d7662c0",
+                "sha256:a535c0c7364acd55229749c2b3e5eebf141865de3a8f697076a3291985f02d30",
+                "sha256:a7a56a2964a9687b6aba5b5ced6971af308ef6f79a91043c05dd4ee3ebc3e9ba",
+                "sha256:ae5d563e970dbe04382f736ec214ef48103d1b875967c89d83c6e3f21706d5b3",
+                "sha256:ae9eb07f1cfacd9cfe8eaee6f4ff4b8a289a668c39c165cd0c8548484920ffc0",
+                "sha256:bc18ea9e417a04d1920a9a76fe9ebd2f43ca505b81994598482f938d5c315f46",
+                "sha256:bcd5ebe66c7a97273d5d2ddd4ad0ed2e706b39630ed4b53e713d360626c3dbb3",
+                "sha256:bdd612e59baed2a93c8843c9a7cb902260f181370f1d772f4842987535071d14",
+                "sha256:bf7d773da6af9e10dbddacbf4e5cab13d06d0ed93561d44dae0188a42c65be7e",
+                "sha256:c10c882b114faf82dbd33e876d0cbd5e1d1ebc0d2a74ceef642c6152f3f4d547",
+                "sha256:c2667a2b913e307f06aa4e5677f01a9746cd08e4b35e14ebcde6420a9ebb4c62",
+                "sha256:c33624f50cf8de418ab2b4d6ca9eda96dc45b2c4231336bac91454520e8d1fac",
+                "sha256:c48c2375287108c887ee87d13b4070a381c6537d30e8487b24ec721bf2a781cb",
+                "sha256:cdef6504637731a63c133bb2e6f0f0214e2748495ec15fe42d1e219d1b133f0b",
+                "sha256:d0d67963f9cbfc7c7f96d4ac74ed60ecbebd2ea6eeb51887af0f8dce205e545f",
+                "sha256:dd7a57b33b5cf27acb491e890720af45db05589a80c1ffc798462a765be6d4d7",
+                "sha256:ddc39510ac922a5c4c27849b739f875d3e1d9e590d1e7b64c98dadf037a16cce",
+                "sha256:de3c0378bdf7066c3988d66cd5232d161e933b87103b014ab1b0b4676098fa45",
+                "sha256:df0f9ef28e0f20c767ccdccfc5ae5f83a6f4a2fbdfbcbcc8487a8a78771168c8",
+                "sha256:e425cd5b00f6fc0ed7cdbd766c70be8baab4b7839e4d4fe5fac48581dd968ea4",
+                "sha256:f22627c1fe2745ee98d3ab87679ca73a97e75ca75eb5faee48660d060875465f",
+                "sha256:f44ae036b63c8ea432f610534a2668b0c3aee810e7037ab9d8ff6883de480f5b",
+                "sha256:f5fd54310b92741ebe00d9c0d1d7b2b27463952c022da6d47c175d246a98d1bd",
+                "sha256:f65bb452e579d5540c8b37ec105dd54d8b9307b07bcaa186818c104ffda22441",
+                "sha256:f8f6389ac977c5fb322e0e38885fbbf901743f79d47f50db706e7644dcdcb6e1",
+                "sha256:fae939811e14e53ed8a9818dad51d434a41ee09df9305663735f2e2d2d7d959b",
+                "sha256:ff0d9eae8cdfcd58fe7893b88993723583a6ce4dfbfd9f29e001922544f95615"
+            ],
+            "index": "pypi",
+            "markers": "python_version >= '3.9'",
+            "version": "==7.9.2"
         },
         "flask": {
             "hashes": [
@@ -56,6 +148,14 @@
             "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'",
             "version": "==1.1.2"
         },
+        "iniconfig": {
+            "hashes": [
+                "sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7",
+                "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760"
+            ],
+            "markers": "python_version >= '3.8'",
+            "version": "==2.1.0"
+        },
         "itsdangerous": {
             "hashes": [
                 "sha256:321b033d07f2a4136d3ec762eac9f16a10ccd60f53c0c91af90217ace7ba1f19",
@@ -148,6 +248,13 @@
             ],
             "markers": "python_version >= '3.7'",
             "version": "==0.1.2"
+        "packaging": {
+            "hashes": [
+                "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484",
+                "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f"
+            ],
+            "markers": "python_version >= '3.8'",
+            "version": "==25.0"
         },
         "pluggy": {
             "hashes": [
@@ -242,6 +349,47 @@
             "index": "pypi",
             "markers": "python_full_version >= '3.7.8' and python_full_version < '4.0.0'",
             "version": "==0.68.0b0"
+        "pytest": {
+            "hashes": [
+                "sha256:539c70ba6fcead8e78eebbf1115e8b589e7565830d7d006a8723f19ac8a0afb7",
+                "sha256:7c67fd69174877359ed9371ec3af8a3d2b04741818c51e5e99cc1742251fa93c"
+            ],
+            "markers": "python_version >= '3.9'",
+            "version": "==8.4.1"
+        },
+        "pytest-cov": {
+            "hashes": [
+                "sha256:25cc6cc0a5358204b8108ecedc51a9b57b34cc6b8c967cc2c01a4e00d8a67da2",
+                "sha256:f5bc4c23f42f1cdd23c70b1dab1bbaef4fc505ba950d53e0081d0730dd7e86d5"
+            ],
+            "index": "pypi",
+            "markers": "python_version >= '3.9'",
+            "version": "==6.2.1"
+        },
+        "pytest-flask": {
+            "hashes": [
+                "sha256:58be1c97b21ba3c4d47e0a7691eb41007748506c36bf51004f78df10691fa95e",
+                "sha256:c0e36e6b0fddc3b91c4362661db83fa694d1feb91fa505475be6732b5bc8c253"
+            ],
+            "index": "pypi",
+            "markers": "python_version >= '3.7'",
+            "version": "==1.3.0"
+        },
+        "soupsieve": {
+            "hashes": [
+                "sha256:6e60cc5c1ffaf1cebcc12e8188320b72071e922c2e897f737cadce79ad5d30c4",
+                "sha256:ad282f9b6926286d2ead4750552c8a6142bc4c783fd66b0293547c8fe6ae126a"
+            ],
+            "markers": "python_version >= '3.8'",
+            "version": "==2.7"
+        },
+        "typing-extensions": {
+            "hashes": [
+                "sha256:8676b788e32f02ab42d9e7c61324048ae4c6d844a399eebace3d4979d75ceef4",
+                "sha256:a1514509136dd0b477638fc68d6a91497af5076466ad0fa6c338e44e359944af"
+            ],
+            "markers": "python_version >= '3.9'",
+            "version": "==4.14.0"
         },
         "werkzeug": {
             "hashes": [

README.md

@@ -43,9 +43,15 @@
     * clubs.json - list of clubs with relevant information. You can look here to see what email addresses the app will accept for login.
 
 5. Testing
+   - unit and integration tests : 
 
-    You are free to use whatever testing framework you like-the main thing is that you can show what tests you are using.
+    All tests are made with Pytest, except <code>test_book_old.py</code> which uses Ward  
-
+    Run the tests by using : `pytest -s -v --cov=. --ignore=tests/test_book_old.py`  
-    We also like to show how well we're testing, so there's a module called 
+    You'll see the result, the list and the coverage rapport  
-    [coverage](https://coverage.readthedocs.io/en/coverage-5.1/) you should add to your project.
 
+    you can also run `ward` from the root folder to see the two ward tests 
+   - performance tests :  
+   
+   run the app : `FLASK_APP=server.py flask run`  
+   then run `locust -f tests/performance_test/locustfile.py` from the root directory and connect with browser to ` 
+    http://0.0.0.0:8089` and launch tests from the web interface

server.py

@@ -57,15 +57,20 @@ 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'])
+    # check if that's the first book, and update session
     if competition['name'] in session:
         places = {competition['name']: session[competition['name']] + placesRequired}
     else:
         places = {competition['name']: placesRequired}
     points = int(club['points'])
+    # prevent to book more than 12 places
     if placesRequired <= 12:
         if places[competition['name']] <= 12:
+            # prevent to book more than available points
             if placesRequired <= points:
                 competition['numberOfPlaces'] = int(competition['numberOfPlaces']) - placesRequired
+                club['points'] = int(club['points']) - placesRequired
+                # set the session if that's the first book for this competition
                 if not competition['name'] in session:
                     session[competition['name']] = placesRequired
                 flash(f"Great ! {placesRequired} places booked for {competition['name']}")
@@ -79,11 +84,11 @@ def purchasePlaces():
                            competitions=competitions, now=now)
 
 # TODO: Add route for points display
-
+@app.route('/points')
+def displayPoints():
+    return render_template('points.html', clubs=clubs)
 
 @app.route('/logout')
 def logout():
     return redirect(url_for('index'))
 
-if (__name__ == "__main__"):
-    app.run(debug=True)

templates/index.html

@@ -22,5 +22,6 @@
         <input type="email" name="email" id=""/>
         <button type="submit">Enter</button>
     </form>
+    <a href="{{ url_for('displayPoints') }}">Board of points</a>
 </body>
 </html>

templates/points.html

@@ -0,0 +1,19 @@
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Board of clubs and points || GUDLFT</title>
+</head>
+<body>
+    <h2>Current points</h2>
+    <ul>
+    {% for club in clubs %}
+        <li><strong>club : </strong> {{club['name']}} </br>
+        <strong>Points : </strong>{{club['points']}}</br>
+	</br>
+        </li>
+        {% endfor %}
+    </ul>
+    <a href="{{ url_for('index') }}"> Back </a>
+</body>
+</html>

tests/conftest.py

@@ -27,5 +27,3 @@ def connect(client):
     response = client.post('/showSummary', data={"email": EMAIL1})
     soup = BeautifulSoup(response.data, 'html.parser')
     return soup
-
-

tests/performance_tests/locustfile.py

@@ -0,0 +1,28 @@
+from locust import HttpUser, task
+
+
+class PerfConnectionTest(HttpUser):
+
+    @task
+    def index(self):
+        response = self.client.get("/")
+
+    @task    
+    def login(self):
+        response = self.client.post("/showSummary", {"email": "admin@irontemple.com"})
+
+
+
+class PerfBookTest(HttpUser):
+
+    @task
+    def bookPlaces(self):
+        response = self.client.post("/showSummary", {"email": "admin@irontemple.com"})
+        response = self.client.post("/purchasePlaces", {"club": "Iron Temple", "competition": "Fall Classic", "places": 2})
+
+
+class PerfBoard(HttpUser):
+
+    @task
+    def board(self):
+        response = self.client.get("/points")

tests/test_board.py

@@ -0,0 +1,24 @@
+from bs4 import BeautifulSoup
+from server import loadClubs
+
+
+class TestBoardDisplayPoints:
+
+    def test_should_get_200(self, client):
+        '''
+        test if the page is retrieved
+        '''
+        response = client.get('/points')
+        assert response.status_code == 200
+
+    def test_should_display_right_size_list(self, client):
+        '''
+        test if the list of club displayed and in DB have the same size 
+        '''
+        list_club = loadClubs()
+        response = client.get('/points')
+        soup = BeautifulSoup(response.data, "html.parser")
+        li = soup.find_all("li")
+        assert len(li) == len(list_club)
+
+

tests/test_connection.py

@@ -18,10 +18,5 @@ def test_shoul_display_page_on_known_email(client):
     email = "admin@irontemple.com"
     response = client.post('/showSummary', data={"email": email})
     soup = BeautifulSoup(response.data, 'html.parser')
-    #assert soup.h2.text == "Welcome, "+email
     welcome = "Welcome, "+email
     assert welcome in response.data.decode()
-
-
-
-

tests/test_purchase.py

@@ -3,51 +3,78 @@ from flask import session
 
 
 class TestPoints:
-    
+    '''
-    def test_should_nok_when_too_much_points(self, client, connect, club1):
+    testing both case, book with and without enough points
+    '''
+
+    def test_should_nok_when_too_much_points(self, client, connect, club2):
+        '''
+        test booking an amount of places greater than the available points
+        '''
         points = int(connect.span.text)
-        club1.update({"places": points+1})
+        club2.update({"places": points+1})
-        response = client.post('/purchasePlaces', data=club1)
+        response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
         assert "You don't have enough points" == soup.li.text
 
-    def test_should_ok_when_enough_points(self, client, connect, club1):
+    def test_should_ok_when_enough_points(self, client, connect, club2):
+        '''
+        test booking with enough points
+        '''
         points = int(connect.span.text)
-        club1.update({"places": points-1})
+        # One remaining point after that :
-        response = client.post('/purchasePlaces', data=club1)
+        club2.update({"places": points-1})
+        response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
-        # assert "Great-booking complete!" == soup.li.text
+        assert f"Great ! "+str(points-1)+" places booked for "+club2['competition'] == soup.li.text
-        assert f"Great ! "+str(points-1)+" places booked for "+club1['competition'] == soup.li.text
 
 
 class TestPlaces:
+    '''
+    test the booking limit of 12 places
+    '''
 
-    def test_should_refuse_more_12_once(self, client, club1):
+    def test_should_refuse_more_12_once(self, client, club2):
-        club1.update({"places": 13})
+        '''
-        response = client.post('/purchasePlaces', data=club1)
+        test to book more than 12 places in one shot
+        '''
+        club2.update({"places": 13})
+        response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
         assert "You can't book more than 12 places" == soup.li.text
 
-
+    def test_should_refuse_more_12_total(self, client, club2):
-    def test_should_refuse_more_12_total(self, client, club1):
+        '''
-        club1.update({"places": 2})
+        test to book more than 12 places in a two-part reservation
-        response = client.post('/purchasePlaces', data=club1)
+        '''
+        club2.update({"places": 1})
+        response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
-        assert "Great ! 2 places booked for "+club1['competition'] == soup.li.text 
+        assert "Great ! 1 places booked for "+club2['competition'] == soup.li.text 
-        club1.update({"places": 12})
+        club2.update({"places": 12})
-        response = client.post('/purchasePlaces', data=club1)
+        response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
-        assert "You already booked 12 places for "+club1['competition'] == soup.li.text
+        assert "You already booked 12 places for "+club2['competition'] == soup.li.text
 
+        
 class TestDate:
+    '''
+    test the booking for the past competitions 
+    '''
 
     def test_should_not_display_book_link_for_past_competitions(self, connect):
+        '''
+        test that the booking link isn't displayed when competition date is older than today
+        '''
         li = connect.find_all("li")
         assert not li[0].a
         assert li[1].a
 
-
     def test_forged_url_on_past_competition_should_raise_flash(self, client):
+        '''
+        test that a flash warning occur when trying to connect to an URL on an old competition
+        '''
         url = '/book/Spring Festival/Iron Temple'
         response = client.get(url)
         assert "You cannot book for a past competition" in response.data.decode()
+

tests/test_update.py

@@ -0,0 +1,12 @@
+
+class TestPointsUpdate:
+
+    def test_should_not_be_ok_the_second_time(self, connect, client, club2):
+        '''
+        this books an amount of points-1 places
+        then test if 1 points remains displayed on page
+        '''
+        points = int(connect.span.text)
+        club2.update({"places": points-1})
+        response = client.post('/purchasePlaces', data=club2)
+        assert f"Great ! {points-1} places booked for {club2['competition']}" in response.data.decode()