API UI Automation using Python Selenium Framework

Use the Python Selenium framework with algoQA to automate API UI testing through a browser interface. This guide covers the prerequisites, test design, and script execution steps needed to validate API endpoints.

Prerequisites

• Install Python and required libraries:

  Download and install Python from Python.org.

  Install Selenium by running the following command:

  pip install selenium
  

• Install the required packages by running the following commands:

  Package                    Version
  -------------------------- ---------
  allure-behave              2.13.2
  Appium-Python-Client       3.0.0
  behave                     1.2.6
  numpy                      1.26.0
  opencv-python              4.8.0.76
  Pillow                     10.0.1
  pixelmatch                 0.3.0
  PyYAML                     6.0.1
  requests                   2.31.0
  scikit-image               0.21.0
  scipy                      1.11.2
  selenium                   4.13.0
  webdriver-manager          4.0.1
  xmltodict                  0.13.0
  

• View Installed Packages:

  After installing Python and the required libraries, you can use the pip list command to view a list of installed packages and verify that requests and selenium are included.

• In addition, the following components are required. Click only the required links corresponding to the components you need for the installation procedure.

  algoQA, Academy, algoScraper Extension, and Downloads

Leveraging algoQA

Test Design the Application

Test Designing is the process of creating an offline model of an application under test (AUT), by mimicking a UI model of an AUT using nodes, features and UI elements.

Profiling involves:

• Create an Offline Model - To create an offline model, see the Profiling article.

• Recording the scenarios using Offline Recorder

  The Record Scenario feature is used to record and save the workflow, scenario, or use case. The scenario will be saved in the same sequence it has been recorded. Refer to Record a scenario using offline recorder.

• Generating Test Cases and Test Scripts

  Test cases are generated in Gherkin language and are Behavior-Driven Development (BDD) compliant. Refer to the Generate Test Cases and Test Scripts.

Execute Scripts

To execute Python Selenium scripts, refer to the Executing Test Scripts for Python Selenium Framework article.