Skip to main content

(Framework) API Test automation with Ruby Rspec and Airborne

Automated tests for API and services are very important so there are lots of solutions for API test automation in the market. These solutions can be commercial-off-the-shelf (COT) or opensource libraries also, there are many frameworks created around these opensource libraries. Testing APIs with tools that have IDE can be easy to start and learn but it can be challenging to customize for your unique problems or integration to CI/CD tools can be hard. Therefore I can suggest you use one of the opensource libraries by implementing it with your favorite language. In this way, it can run faster,  easily extendable, and configurable.  I have created a framework with Airborne and Rspec for automating API tests, you can check it from Github.  In this post, I want to explain what is Airborne and how I implemented a framework around it. You can simply update the environment variables and write your specs file in the `specs` folder. 

What is API Testing

API stands for an application programming interface. APIs are providing an interface of your system to the world. API's endpoints can be called by requests and these calls return relevant data. An API can be considered as a source for clients such as web, android, ios, desktop applications, or even other APIs. Testing APIs from these clients will be difficult, expensive, and slow, therefore it is very important to test APIs as soon as any changes are introduced in the codebase. 

API testing includes calling endpoints of APIs with relevant data and credentials. Each call should be asserted in terms of validity and verification. Some of the scenarios can be end-to-end tests, which means that you can not test these scenarios in one single call, instead, you need to call several API calls in accordance with your user-scenarios. All these works called API testing. API testing can be performed manually with some tools or you can write your automation project and run them automatically. In terms of `exploratory testing`, you should adapt your testing tools to perform manual testing for exploration. 

What is Airborne

Airborne is a GEM created to test APIs on top of the Rspec and RestClient. Airborne provides a framework to write automated tests for APIs. There are many tools and libraries created for API test but Airbone is Ruby equivalent and it provides a simple response check so that you can whole JSON response at on with expected data or type of data. It also uses the RestClient for handling HTTP requests, which is very mature and reliable. If you have a struggle using Airborne you can call RestClient directly in your test either. The bad part is that Airborne doesn't have good documentation but once you start writing simple tests it becomes easier.

How to Write Tests 

Airborne is an abstraction layer on top of rest_client, it makes testing easier with providing simple syntax. Airborne provides basic HTTP methods such as get, post, put, patch, delete, head, and options requests. You can use any of these methods to write your tests, see the example below:

Testing needs assertion, for API testing assertions are written to check the object types, object values in the JSON. Airborne has built-in assertions to check the JSON effectively.  These are the Rspec based asserting functions:

  • expect_json_types - Tests the types of JSON property values returned
  • expect_json - Tests the values of the JSON property values returned
  • expect_json_keys - Tests the existence of the specified keys in the JSON object
  • expect_json_sizes - Tests the sizes of the JSON property values returned, also test if the values are arrays
  • expect_status - Tests the HTTP status code returned
  • expect_header - Tests for a specified header in the response
  • expect_header_contains - Partial match test on a specified header

Popular posts for software testing and automation

Selenium Error "Element is not currently interactable and may not be manipulated"

Selenium webdriver can drive different browsers like as Firefox, Chrome or Internet Explorer. These browsers actually cover the majority of internet users, so testing these browsers possibly covers the 90% of the internet users. However, there is no guaranty that the same automation scripts can work without a failure on these three browsers. For this reason, automation code should be error-prone for the browsers you want to cover. The following error is caught when the test script run for Chrome and Internet Explorer, but surprisingly there is no error for the Firefox. Selenium gives an error like below: Traceback (most recent call last):   File "D:\workspace\sample_project\sample_run.py", line 10, in <module>     m.login()   File "D:\workspace\ sample_project \test_case_imps.py", line 335, in login     driver.find_element_by_id("id_username").clear()   File "C:\Python27\lib\site-packages\selenium-2.35.0-py2.7.egg\selenium\webdriver\r

Change Default Timeout and Wait Time of Capybara

One of the biggest challenge for automation is handling timeout problem. Most of the time, timeout is 60 seconds but it may sometimes not enough if you have badly designed asynchronous calls or the third party ajax calls. This makes handling timeout more complex. set large enough to tolerate network related problems. For Selenium based automation frameworks, like Capybara, default Webdriver timeout is set to Net::ReadTimeout (Net::ReadTimeout) Changing ReadTimeout If you have timeout problem for Capybara, it gives an error like above. This means that the page is not fully loaded in given timeout period. Even you can see that page is loaded correctly but webdriver wait until the Ajax calls finish. class BufferedIO #:nodoc: internal use only def initialize (io) @io = io @read_timeout = 60 @continue_timeout = nil @debug_output = nil @rbuf = '' end . . . . . def rbuf_fill beg

Page-Object Pattern for Selenium Test Automation with Python

Page-object model is a pattern that you can apply it to develop efficient automation framework. With the page-model, it is possible to minimize maintenance cost. Basically page-object means that your every page is inherited from a base class which includes basic functionalities for every page. If you have some new functionalities that every page should have, you can simple add it to the base class. Base class is like the following: In this part we are creating pages which are inherited from base page. Every page has its own functionalities written as python functions. Some functions return to a new page, it means that these functions leave the current page and produce a new page. You should write as much as functions you need in the assertion part because this is the only part you can use the webdriver functions to interact with web pages . This part can be evaluate as providing data to assertion part.   The last part is related to asserting your test cases against to the

Create an Alias for Interactive Console Work: Selenium and Capybara

If you are working on shell most of the time Aliases are very helpfull and time saving. For testing purposes you can use Alias for getting ready your test suites. In this post, I want to explain both running Selenium and Capybara on console and creating aliases for each.  This post is for Windows machines, if you are using Unix-like see   this post . Creating Scripts for Selenium and Capybara First of all, it is assumed that you have installed Selenium and Capybara correctly and they work on your machines. If you haven't installed, you can see my previous posts. I am using the Selenium with Python and the Capybara with Ruby. You can use several different language for Selenium but Capybara works only with Ruby.  Create scripts in a directory called scripts (in your home folder, like as  ~/scripts ) for your automation tool as following, save them as capybara.rb, sel.py :  Creating Aliases Depends on your favourite shell, you need to add the alias to .bashrc bash

Performance Testing on CI: Locust is running on Jenkins

For a successful Continuous Integration pipeline, there should be jobs for testing the performance of the application. It is necessary if the application is still performing well. Generally performance testing is thought as kinds of activities performed one step before going to live. In general approach it is true but don't forget to test your application's performance as soon as there is an testable software, such as an api end point, functions, and etc. For CI it is a good approach to testing performance after functional testing and just before the deployment of next stage. In this post, I want to share some info about Jenkins and Locust. In my previous post you can find some information about Locust and Jenkins. Jenkins operates the CI environment and Locust is a tool for performance testing. To run the Locust on Jenkins you need command line arguments which control the number of clients ,   hatch rate,  running locust without web interface and there should be so