Automating your test environment with the CDRouter web API

Tags: API

Watch our webinar on the CDRouter web API

Though CDRouter contains thousands of test cases, much of its power comes from being a fully capable automation platform for your entire test process. In addition to automating CDRouter test cases, you can use the CDRouter API to connect with your continuous integration, external test tools, or other applications to make your testing even easier.

How to interact with CDRouter

CDRouter contains three methods for interacting with its automation engine, configuration, and test packages.

  • In your browser through the web GUI
  • Through the CDRouter command line interface (CLI)
  • Through the CDRouter RESTful web API

Everything that can be done in the web GUI can be done with CDRouter’s web API, and more - extending CDRouter’s automation power to the rest of your test environment.

Use cases for CDRouter's RESTful web API

Here’s a few, but not limited, examples of using the CDRouter API:

  • External frameworks and continuous integration: As an application programming interface, the CDRouter API is best used when interacting with other tools that control automation or can receive results or notifications from the system. This includes test frameworks that may be home grown or professional grade, and continuous integration platforms like Jenkins or Bamboo. Tools like these all have different formats for tests and test results, and it is easy to map CDRouter concepts into these tools using the API.

  • Notifications: Secondly, the API makes it easy to set up diverse notification tools to get updates on test status. Using the API you could trigger notifications over email, to another webservice, or even through text message to alert you when tests are complete or when something is wrong.

  • Reporting tools and archives: Additionally you can also use the API to push results to other reporting tools. For example, you may be building a historical database of test results on your devices from many different tools, and want to incorporate CDRouter’s test results (and configs and packages) into that database, perhaps for archiving purposes. You can also use it as a great interface for generating your own report format that fits your specific needs.

  • CDRouter orchestration: Lastly, if you are running multiple tests through more than one CDRouter system, you can use the CDRouter API to orchestrate these multiple systems and coordinate results in one place.

Resources for expanding automation capabilities

  1. Watch our webinar on the topic above for an in-depth look at all of the CDRouter API tools.
  2. Read the full documentation of the CDRouter web API to learn the details.
  3. Check out the QA Cafe Github repository to download our cdrouter.py python library or a Ruby Gem library for the CDRouter API.