- Added test to show use of POST method to create a new person and assert if it is present in get requests

- Also added inline comments to explain the test

Author: Gaurav Singh

tests/people_test.py

@@ -8,30 +8,41 @@
 
 
 def test_read_all_has_kent():
+    # We use requests.get() with url to make a get request
     response = requests.get(BASE_URI)
+    # response from requests has many useful properties
+    # We can get python dict as response by using .json() method
     response_text = response.json()
     pretty_print(response_text)
 
+    # Also we can assert on the response status code
     assert_that(response.status_code).is_equal_to(200)
     first_names = [people['fname'] for people in response_text]
     assert_that(first_names).contains('Kent')
 
 
 def test_new_person_can_be_added():
+    # Ensure a user with a unique last name is created everytime the test runs
+    # Note: json.dumps() is used to convert python dict to json string
     unique_last_name = f'User {str(uuid4())}'
     payload = dumps({
         'fname': 'New',
         'lname': unique_last_name
     })
 
+    # Setting default headers to show that the client accepts json
+    # And will send json in the headers
     headers = {
         'Content-Type': 'application/json',
         'Accept': 'application/json'
     }
 
+    # We use requests.post method with keyword params to make the request more readable
     response = requests.post(url=BASE_URI, data=payload, headers=headers)
     assert_that(response.status_code).is_equal_to(204)
 
+    # After user is created, we read all the users and then use filter expression to find if the
+    # created user is present in the response list
     people = requests.get(BASE_URI).json()
     is_new_user_created = filter(lambda person: person['lname'] == unique_last_name, people)
     assert_that(is_new_user_created).is_true()