Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gguridi/exercise-python

This is an basic exercise example for people to get a grasp of python
https://github.com/gguridi/exercise-python

Last synced: 24 days ago
JSON representation

This is an basic exercise example for people to get a grasp of python

Awesome Lists containing this project

README 

        
## Synopsis



This is a basic webservice intended to work with the SoE website. This webservice gives the

website the functionality to access internal data that otherwise shouldn't be accessible.



## Installation



This code needs docker to run. Please [install docker](https://docs.docker.com/engine/installation/)

in your local environment before proceed. The installation might be different depending on the

operating system you are running. 



Once docker is installed, go to this folder and build the virtual machine with:



```

cd 

docker build -t soe .

```



Then execute the following code to run the virtual machine. The webservice will be mapped automatically to the port 80 

of our local machine. (ensure no other process is running in the port 80 or it might conflict):



```

docker run --name soe-test -p 80:5000 -p 3306:3306 -v `pwd`:/storage/app/ soe

```



Note that the container has been created to run as an application. Once running it will

show the standard output and terminating the process will terminate also the container.



To connect to the container we can use (this will allow us to execute commands from

inside the container using the bash shell):



```

docker exec -it soe-test /bin/bash

```



If you need to rerun the virtual machine then we need to remove it first. Maybe the 

following commands will help you executing _docker run_ again.



```

docker stop soe-test

docker rm soe-test

```



## API Usage



Once the docker instance is up we should see the flask framework running in the

port 5000, but this port is automatically mapped with the port 80 of the host.



Usually it's not recommended to write the API documentation in the README.md file as there

are better tools to generate documentation from the code, but in this case we will do

an exception.



There are some endpoints created around students administration. A postman export has

been added to the repository (postman-tests.json) to be able to test it.



That file can be imported in the [Postman extension](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en) 

of chrome to be able to execute HTTP requests to the endpoints.



## Testing



This example comes with two different kinds of tests: unit tests and integration/behavioural

tests to check every aspect of the code. The unit tests code coverage is not great as 

it's intended to be kept simple.



### Unit testing



The tests are located under tests/ directory.



To run the tests first we have to connect with the container.



Once inside, we can execute from the command line:



```

cd /storage/app

pytest

```



The command will output the results of the tests. If any assertion didn't succeed, the 

system will show the error and a stack trace to know where the problem started.



### Integration testing



The tests are located under tests_api/ directory.



The tests are build through a library called [frisby](https://www.frisbyjs.com/) and 

executed using [jasmine](https://jasmine.github.io/). The dependencies are in a 

package.json file and installed through [npm](https://www.npmjs.com/)



The dependencies of nodejs are usually installed inside a folder called node_modules.



To run the tests first we have to connect with the container. And then execute:



```

cd /storage/app/test_api

./node_modules/jasmine-node/bin/jasmine-node . --verbose

```



## Improvements



Several improvements can be done to the code:



- Create a Response class that wraps any response from our webservice, so the

format is consistent across any endpoint (status, message, etc. might be

something present at all of them).

- Create a route (endpoint) that returns the number of students currently

available in the system.

- Create a route (endpoint) that returns the list of students ordered by the 

birthdate. A parameter can be sent to specify if the oldest one comes first or the

youngest one instead. Choose one behaviour as default if the parameter is not specified.

- Create a test for the above behaviours.



## Contributors



Gorka Guridi