nikramakrishnan / api-testing

Unit testing for API for beginners

API-Testing

This is a sample/tutorial API showing basics steps in creating API and its testing. Micro web framework written in python called Flask is used

Getting Started

hese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Type of testing performed

Though there are many frameworks for testing like nose, doctest or unittest2 and others but unittest is the one used in this Flask Application.

Reasons for using unittest

It is the built=in module for implementing unit tests in python and is easy to use and powerful at the same time. See below for a basic structure:

import unittest 

class testClass(unittest.TestCase): 

  # First method to be executed
  @classmethod
  def setUpClass(cls):
       pass 

  # Last method to be executed
  @classmethod
  def tearDownClass(cls):
       pass 

  # initialization logic
  # code that is executed before each test
  def setUp(self):
    pass 

  # clean up logic
  # code that is executed after each test
  def tearDown(self):
    pass 

  # test method
  def test_equality(self):
    self.assertEqual(1, 1) 

# runs the unit tests in the module
if __name__ == '__main__':
  unittest.main()

Installation

Although the project doesn't require virtualenv but I would recommend doing so.

• First fork the project and clone it through cmd:

  git clone https://github.com/<your username>/API-Testing.git

• If you wants to use virtualenv, then follow these steps. Otherwise jump to step 5.

  pip install virtualenv

• Then change directory and get to the project folder, then type:

  virtualenv venv

• Activate the enviroment

  venv/Scripts/activate

• Install the requirements

  pip install -r rquirements.txt

• All set, run the application

  python application.py

Instructions

There are some python libraries that is to be imported before giving the application a run. List of the libraries required is as follows

Name	Version
click	6.7
coverage	4.5.1
Flask	1.0.2
itsdangerous	0.24
Jinja2	2.10
MarkupSafe	1.0
psycopg2	2.7.4