This application is the start point for Sprint 1 of the Lloyds Bank Group Modern Engineering Bootcamp Project Specification.

To initialise the project you will need to install several dependencies, open up a git bash terminal from the repo directory and run the command:

pip install -r requirements.txt

In order to run the application, from your git bash terminal run:

python lbg.py
API Listening on http://localhost:8080

In order to stop the application from the git bash terminal that is running the server press CTRL + C

In order to interact with this application through a browser navigate to http://localhost:8080/index.html

There is a full CRUD functionality through the buttons on the web page.

To create the example product run the command:

curl -s -X POST http://localhost:8080/create -H 'Content-type:application/json' -d '{"name":"example product", "description":"this is an example", "price":9.99}'

To read all of the products run the command:

curl -s -X GET http://localhost:8080/read

To read one of the products run the command:

curl -s -X GET http://localhost:8080/read/<id>

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

To update one of the products run the command:

curl -s -X PUT http://localhost:8080/update/<id> -H 'Content-type:application/json'  -d '{"name":"updated product", "description":"its brand new", "price":99.99}'

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

To delete one of the products run the command:

curl -s -X DELETE http://localhost:8080/delete/<id>

n.b: For these commands anything surrounded by angled braces <> needs to be replaced by you

To run unit/integration tests on this project, make sure the server is running. In a new terminal window use the command

python lbg.test.py

To run acceptance tests on this project, you must first download a webdriver for the browser of your choice and update the path in .\features\environment.py. Then make sure the server is running. In a new terminal window use the command

behave .\features\restapp.feature

There are unit tests included with this project, we are testing the item builder for the object that it returns.

def test_item_builder_data(self):
        expected = {'name': 'Tool', 'description': 'Hammer', 'price': 10.5, '_id': 99}
        self.assertEqual(item_builder("Tool", "Hammer", 10.50, 99), expected)

If we test the builder and input a name of "Tool", a description of "Hammer", a price of "10.5" and an _id of "99" we can expect and object to be created that matches this format.

An example integration test is included in the project.

For integration tests we can test the RESTful endpoints.

 def test_create_post_request_status(self):
        response = requests.post(BASE_URL + '/create', json = {'name': 'Tool', 'description': 'Hammer', 'price': 10.5})
        self.assertEqual(response.status_code, status.HTTP_201_CREATED)

If we test the Create endpoint by sending a request with a method of POST and a path of /create we should expect the response to be... Status code: 201, Status text: Created

This is similar to a 'black-box' system test as we are testing the front-end with no knowledge of the back-end.

An example user acceptance test is included with this project.

Scenario Outline: User adding a new item successfully
        Given That a user is on the url "http://localhost:8080/index.html"
        When The user enters the item name "<name>", description "<description>", and price "<price>" into the CREATE section
        And The user clicks the POST button
        Then The READ ALL section will populate with JSON containing _id "<_id>", name "<name>", description "<description>", and price "<price>"
        Examples:
            | name |  description | price | _id |
            | Test Name | Test Description | 9.99 | 1 |

A user story has been used to create a behaviour driven test for the system.

Given that a user can access the front-end of the application When they input correct details for an item And they submit those details Then the item is created and added to the database