Skip to content

Latest commit

 

History

History
242 lines (219 loc) · 8.24 KB

README.md

File metadata and controls

242 lines (219 loc) · 8.24 KB

pyRestAuto

codebeat badge Build Status

Framework for automating WEBSERVICES (REST API's).

Introduction

Framework/libraries to automate Webservice's API's. Development engineers, automation engineers should be able to leverage pyRestAuto for automating their webservices.

Features

Few features of pyRestAuto Package .

  • light weight and easy of use
  • Modular and reusable libraries
  • REST Authentication & Authorization support
    • HTTPBasicAuth
    • HTTPDigestAuth
    • jwt
    • oauth2
  • REST MIME Support
  • HTML Test Reports
  • Better Logging
  • Json parsing capabilities

Usage

Writing unit test cases for REST API's (No authentication):

Step-1: Importing pyRest_lib

from rest_lib import pyRest_lib

Step-2: Writing the setUp method

def setUp(self):
        self.rest = pyRest_lib.PyRestLib(url='https://httpbin.org')
        self.log = self.rest.get_logObj()
        self.json = self.rest.get_jsonObj()
  • Creating object for PyRestLib class and passing URL as parameter.
  • Getting logger & Json object

Step-3: Writing unittests for GET,POST,PUT,DELETE requests. send_request single method for sending GET/POST/PUT/DELETE request types.

GET Request example:

Sample GET request and response.

HTTP GET request:
`https://httpbin.org/get</dd>`
Response Data
 "args": {},
 "headers": {
   "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
   "Accept-Encoding": "gzip, deflate, br",
   "Accept-Language": "en-US,en;q=0.5",
   "Connection": "close",
   "Cookie": "_gauges_unique_year=1; _gauges_unique=1; _gauges_unique_month=1; _gauges_unique_hour=1; _gauges_unique_day=1",
   "Host": "httpbin.org",
   "Referer": "https://httpbin.org/",
   "Upgrade-Insecure-Requests": "1",
   "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0"
 },
 "origin": "36.255.85.10",
 "url": "https://httpbin.org/get"
}
  • Unittest for sending above request and verifing Host value from response.
def test_get_request(self):
        response =  self.rest.send_request('/get',method_name='GET')
        response_code = response['code']
        response_data = response['data']
        verify_host = self.json.get_key_value(response_data,'Host')
        response_headers = response['headers']
        self.assertEqual(response_code,200)
        self.assertEqual(verify_host,'httpbin.org')
  1. Passing path and request method type as passing parameters to send_request.
  2. return object response contains response data,code and headers and that can be accessed by response['data'],response['code'] & response['headers'].
  3. Passing response data and key to get_key_value method to get value.
  4. Asserting response status code & data.
POST Request example:

Sample POST request & response.

HTTP POST Request https://httpbin.org/post

Parameters {'test':'post'}

Response Data

{
  "args": {},
  "data": "{\"test\": \"post\"}",
  "files": {},
  "form": {},
  "headers": {
    "Accept": "*/*",
    "Accept-Encoding": "gzip, deflate",
    "Connection": "close",
    "Content-Length": "16",
    "Content-Type": "application/json",
    "Host": "httpbin.org",
    "User-Agent": "python-requests/2.18.4"
  },
  "json": {
    "test": "post"
  },
  "origin": "36.255.85.10",
  "url": "https://httpbin.org/post"
}
def test_post_request(self):
        data = {'test':'post'} # Step 1
        json_data = self.json.dump_json_data(data) # Step 1
        response = self.rest.send_request('/post',method_name='POST',
                                          parameters=json_data)
        response_code = response['code']
        response_data = response['data']
        verify_response_data = self.json.get_key_value(response_data,'test')
        self.assertEqual(response_code, 200)
        self.assertEqual(verify_response_data,'post')
  1. Converting python dictionary into JSON data.
  2. Passing path and request method type as parameters to send_request.
  3. return object response contains response data,code and headers and that can be accessed by response['data'],response['code'] & response['headers'].
  4. Passing response data and key to get_key_value method to get value.
  5. Asserting response status code & data.
Same way for PUT & DELETE request.
PUT Request example:
    def test_put_request(self):
        response = self.rest.send_request('/put',method_name='PUT')
        code = response['code']
        self.assertEqual(code, 200)
DELETE Request example:
def test_delete_request(self):
        response = self.rest.send_request('/delete',method_name='DELETE')
        code = response['code']
        self.assertEqual(code, 200)

Writing unit test cases for REST API's with authentication):

Authentications supported HTTPBasicAuth,HTTPDigestAuth and Session

Step 1: Add authentication details in config.yaml file.

url : https://api.github.com
Authentication_Type: HTTPBasicAuth
HTTPBasicAuth:
  username: xxxxxxxxx
  password: xxxxxxxxx
HTTPDigestAuth:
  username: null
  password: null
Session:
  cookie_header:
    header: 'sample cookie'
  Auth: False
  username: 'user'
  password: 'password'

#Make rest_header when you want to send any custom headers
headers:
  "Content-Type": "application/json"
  • url: API test URL
  • Authentication_Type: Authentication type has to be given. Default null.
  • headers: Custom headers has to be added to send in every request.

Step 2: Importing pyRest_lib from rest_lib import pyRest_lib

Step 3:

def setUp(self):
        file = os.path.abspath('resources//config.yaml')        # Step 1
        self.rest_obj = pyRest_lib.PyRestLib(file_path=file,auth='HTTPBasicAuth')    # Step 2
        self.log = self.rest_obj.get_logObj()                   # Step 3
        self.json = self.rest_obj.get_jsonObj()                 # Step 3
  1. Getting the config file path location
  2. Passing file path to PyRestLib class and authentication type.
  3. Getting json and logger object

Step 4: Now writing unittests for GET request. GET Sample Request: GET https://api.github.com/user/following Response: Status: 200 OK

[{
	"login": "jeevan449",
	"id": 20350885,
	"avatar_url": "https://avatars1.githubusercontent.com/u/20350885?v=4",
	"gravatar_id": "",
	"url": "https://api.github.com/users/jeevan449",
	"html_url": "https://github.com/jeevan449",
	"followers_url": "https://api.github.com/users/jeevan449/followers",
	"following_url": "https://api.github.com/users/jeevan449/following{/other_user}",
	"gists_url": "https://api.github.com/users/jeevan449/gists{/gist_id}",
	"starred_url": "https://api.github.com/users/jeevan449/starred{/owner}{/repo}",
	"subscriptions_url": "https://api.github.com/users/jeevan449/subscriptions",
	"organizations_url": "https://api.github.com/users/jeevan449/orgs",
	"repos_url": "https://api.github.com/users/jeevan449/repos",
	"events_url": "https://api.github.com/users/jeevan449/events{/privacy}",
	"received_events_url": "https://api.github.com/users/jeevan449/received_events",
	"type": "User",
	"site_admin": false
}]

Unittest for sending GET request and verifying response data & status code .

    def test_get_following(self):
        path = '/user/following'
        response = self.rest_obj.send_request(path,method_name='GET')   # Step 1
        code = response['code']                                         # Step 2
        data = response['data']                                         # Step 2
        verify_data = self.json.get_key_value(response_data,'login')    # Step 3
        self.assertEqual(verify_data,'jeevan449')                       # Step 4
        self.assertEqual(code,200)                                      # Step 4
  1. Passing path and method_name to send_request method.
  2. Assigning response code and data to variable
  3. Parsing login key value from the response data.
  4. Verifying response data and code.