API Testing Report In Excel via Playwright

Playwright is a opensource framework that provides a high-level capability to enable automation testing. It also allows you to write scripts in Python that can control web browsers and perform various tasks such as filling out forms, clicking buttons, navigating pages, and taking screenshots.

Playwright offers several advantages over other browser automation tools:

• It supports multiple browsers, which means you can test your web application on different browsers using the same script.
• It has a simple and intuitive API that makes it easy to use even for beginners.
• It provides better performance and reliability compared to other tools. In summary, Playwright is a powerful and flexible tool for automating web browsers in Python, and it can be used for a wide range of tasks such as testing, web scraping, and web automation.

Playwright enables automation of web browsers (including Chrome, Firefox, and Safari) for end-to-end testing of web applications. While Playwright is primarily designed to be used with JavaScript, it is possible to use it with Python as well by using the py_playwright library, which provides a Python API for Playwright.

How to Install :

Install Playwright and its dependencies using pip:

pip install playwright
playwright install

Example Test :

Create a test_playwright.py file inside the current working directory or in a sub-directory with the code below:

import re
from playwright.sync_api import Page, expect


def test_homepage_has_Playwright_in_title_and_get_started_link_linking_to_the_intro_page(page: Page):
page.goto("https://playwright.dev/")

# Expect a title "to contain" a substring.
expect(page).to_have_title(re.compile("Playwright"))

# create a locator
get_started = page.get_by_role("link", name="Get started")

# Expect an attribute "to be strictly equal" to the value.
expect(get_started).to_have_attribute("href", "/docs/intro")

# Click the get started link.
get_started.click()

# Expects the URL to contain intro.
expect(page).to_have_url(re.compile(".*intro"))

Running the Example Test :

By default tests will be run on chromium. This can be configured via the CLI options. Tests are run in headless mode meaning no browser UI will open up when running the tests. Results of the tests and test logs will be shown in the terminal.

pytest

How to use Playwright for API testing :

Playwright can used to get access to the REST API of your application.

Sometimes you may want to send requests to the server directly from Python without loading a page and running js code in it. A few examples where it may come in handy:

• Test your server API.
• Prepare server side state before visiting the web application in a test.
• Validate server side post-conditions after running some actions in the browser. All of that could achieved via APIRequestContext methods.

Writing API Test :

APIRequestContext can send all kinds of HTTP(S) requests over network.

The following example demonstrates how to use Playwright to test issues creation via GitHub API. The test suite will do the following:

• Create a new repository before running tests.
• Create a few issues and validate server state.
• Delete the repository after running tests.

Configure :

In our case; VivifyHealthCare API requires authorization, so we can configure the token once for all tests. While at it, we’ll also set the baseURL to simplify the tests. below example set is without JWT authentication.

import pytest
from playwright.sync_api import Playwright, APIRequestContext
from typing import Generator

@pytest.fixture(scope="session")

def api_request_context(
playwright: Playwright,
)-> Generator[APIRequestContext,None,None]:
request_context = playwright.request.new_context()
yield request_context
request_context.dispose()

Write tests :

Now that we initialized request object we can add a few tests

Post :

from playwright.sync_api import Playwright,APIRequestContext


def test_post_example(api_request_context: APIRequestContext) -> None:
headers = {"Content-type": "application/json"}
data = {
"title": "foo",
"body": "bar",
"userId": 1
}
post_todo = api_request_context.post(
f"https://jsonplaceholder.typicode.com/posts", data=data, headers=headers
)
# assert post_todo.ok
assert post_todo.json()["title"] == "foo"

Get :

def test_get_example(api_request_context: APIRequestContext:
headers = {"Content-type": "application/json"}
get_todo = api_request_context.get(
f"https://jsonplaceholder.typicode.com/posts/1",  headers=headers
)
assert get_todo.ok

Put (Update):

def test_put_example(api_request_context: APIRequestContext:
headers = {"Content-type": "application/json"}
data = {
"title": "foo2",
"body": "bar",
"userId": 1
}
put_todo = api_request_context.put(
f"https://jsonplaceholder.typicode.com/posts/1", data=data, headers=headers
)
assert put_todo.ok
assert put_todo.status == 200
assert put_todo.json()["title"] == "foo2"

Delete :

def test_delete_example(api_request_context: APIRequestContext):
headers = {"Content-type": "application/json"}
delete_todo = api_request_context.delete(
f"https://jsonplaceholder.typicode.com/posts/1", headers=headers)
assert delete_todo.ok
assert delete_todo.status == 200

To Run :

To run this script, need to be in directory and run the following command :

pytest

Results :

Playwright Report In Excel:

It is a open-source framework that allows you to automate and test web applications. Playwright Excel generation feature allows users to generate Excel spreadsheet using openpyxl library. It can also used to read from a file and write to a file which can be in xlsx format.

With Playwright’s Excel generation,you can automate the process of generating reports,saving time and effort.Playwright for Python allows developers to generate Excel files in different web browsers, including Choromium, Firefox, and Webkit.

To generate an Excel file for a Playwright using python,you can use the openpyxl library: Here are the steps to follow:

• Install openpyxl library:You can install the library by running the following command in your terminal or command prompt:pip install openpyxl
• After Installation of openpyxl follow the steps given below:from openpyxl import load_workbook##Create a new workbook and Excel filenameworkbook = load_workbook(“Excel_name.xlsx”, data_only=True)##Create a sheet namesheet = workbook[“Sheet_name”]d = sheet.max_row ### This is for maximum rows you wantsh[f’A{d + 1}’].value = “Value”##Save the workbookworkbook.save(‘workbook_name.xlsx’)##Close the workbookworkbook.close()

Write Tests:

* Here some examples for generating Excel report

Configure:

    import datetime
    import json

    from playwright.sync_api import APIRequestContext,Playwright
    from typing import Generator
    import pytest
    from openpyxl import load_workbook


    EnvironmentName = "https://jsonplaceholder.typicode.com"
    Version = "v3"

    @pytest.fixture(scope="session")
    def api_request_context(
        playwright: Playwright,
    )-> Generator[APIRequestContext,None,None]:
        request_context = playwright.request.new_context()
        yield request_context
        request_context.dispose()

Post:

    def test_post_example(api_request_context: APIRequestContext) -> None:
    wb = load_workbook("Report.xlsx", data_only=True)
    sh = wb["API"]
    d = sh.max_row
    endpoint = 'https://jsonplaceholder.typicode.com/posts'
    headers = {"Content-type": "application/json"}
    data = {
        "title": "foo",
        "body": "bar",
        "userId": 1
    }
    post_todo = api_request_context.post(
        f"https://jsonplaceholder.typicode.com/posts", data=data, headers=headers
    )
    # assert post_todo.ok
    # assert post_todo.json()["title"] == "foo"
    test1 = post_todo.json()
    if test1['title'] == 'foo':
        sh[f'A{d + 1}'].value = '1'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        # sh[f'E{d + 1}'].value = test1['Status']
        sh[f'E{d + 1}'].value = 200
        sh[f'F{d + 1}'].value = "Success"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    else:
        sh[f'A{d + 1}'].value = '1'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 400
        sh[f'F{d + 1}'].value = "Fail"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    wb.save("Report.xlsx")
    wb.close()
    assert post_todo.json()["title"] == "foo"

Get:

    def test_get_example(api_request_context: APIRequestContext):
    headers = {"Content-type": "application/json"}
    wb = load_workbook("Report.xlsx", data_only=True)
    sh = wb["API"]
    d = sh.max_row
    endpoint = 'https://jsonplaceholder.typicode.com/posts/1'
    ### In place of getbyid you have to give which id details needs tobe get
    get_todo = api_request_context.get(
        f"https://jsonplaceholder.typicode.com/posts/getbyid",  headers=headers
    )

    test1 = get_todo.json()
    if test1['userId'] == 1:
        sh[f'A{d + 1}'].value = '2'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 200
        sh[f'F{d + 1}'].value = "Success"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    else:
        sh[f'A{d + 1}'].value = '2'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 400
        sh[f'F{d + 1}'].value = "Fail"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    wb.save("Report.xlsx")
    wb.close()
    assert get_todo.ok

Put:

    def test_put_example(api_request_context: APIRequestContext):
    headers = {"Content-type": "application/json"}
    wb = load_workbook("Report.xlsx", data_only=True)
    sh = wb["API"]
    d = sh.max_row
    endpoint = 'https://jsonplaceholder.typicode.com/posts/updatebyid'
    ### In place of updatebyid you have to give which id needs tobe update
    data = {
        "title": "foo2",
        "body": "bar",
        "userId": 1
    }
    put_todo = api_request_context.put(
        f"https://jsonplaceholder.typicode.com/posts/1", data=data, headers=headers
    )
    # assert put_todo.ok

    test1 = put_todo.json()
    if test1['title'] == 'foo2':
        sh[f'A{d + 1}'].value = '3'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 200
        sh[f'F{d + 1}'].value = "Success"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    else:
        sh[f'A{d + 1}'].value = '3'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 400
        sh[f'F{d + 1}'].value = "Fail"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    wb.save("Report.xlsx")
    wb.close()
    assert put_todo.ok

Delete:

    def test_delete_example(api_request_context: APIRequestContext):
    headers = {"Content-type": "application/json"}
    wb = load_workbook("Report.xlsx", data_only=True)
    sh = wb["API"]
    d = sh.max_row
    endpoint = 'https://jsonplaceholder.typicode.com/posts/deletebyid'

    ### In place of deletebyid you have to give which id needs tobe delete

    delete_todo = api_request_context.delete(
        f"https://jsonplaceholder.typicode.com/posts/1", headers=headers)

    test1 = delete_todo.json()
    print(test1)
    if test1 == {}:
        sh[f'A{d + 1}'].value = '4'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 200
        sh[f'F{d + 1}'].value = "Success"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
        sh[f'I{d + 1}'].value = str(EnvironmentName)
    else:
        sh[f'A{d + 1}'].value = '4'
        sh[f'B{d + 1}'].value = str(endpoint)
        sh[f'C{d + 1}'].value = 'User'
        sh[f'D{d + 1}'].value = "User"
        sh[f'E{d + 1}'].value = 400
        sh[f'F{d + 1}'].value = "Fail"
        sh[f'G{d + 1}'].value = str(datetime.datetime.now())
        sh[f'H{d + 1}'].value = str(Version)
    wb.save("Report.xlsx")
    wb.close()
    assert delete_todo.ok

Results :