Introduction

Helpful Reporter for your Test Framework

Last updated 5 months ago

Introduction

Helpful Reporter for your Test Framework

Handshake simplifies the process of exporting test results and sharing them in various formats. It processes the test results collected from test frameworks and ensures they are simplified for better clarity.

requires python 3.11 or 3.12

PyPI Package:

Quick Example:

# content of test_sample.py
def inc(x):
    return x + 1


def test_answer():
    assert inc(3) == 5
    
def test_simple():
    assert inc(3) == 4

Execute these tests and ensure that Handshake is installed. For example, we will use the pytest test framework. We have a custom reporter implemented for pytest, so once the package is installed, you can execute the tests by running: pytest.

Test Results Available

After running the tests, as shown above, the results are stored in the TeStReSuLtS.db file within the TestResults directory (configurable).

Sample File:

Please note the structure could vary over time, but you can get the base idea from the sample file

after the results are stored in the DB, we can execute a few commands, to export the required results.

Execute: handshake patch TestResults -e json -o JsonReport

Execute the command: handshake patch TestResults -xl

Please note in order to use Excel export you would need to install optional extras: excel-export

pip install handshakes[excel-export]

poetry add "handshakes[excel-export]"

Sample File:

Features 🗽

Aggregates reports from various test frameworks
Stores reports in a .sqlite database
Supports export to Excel
Supports export to JSON files
Archives reports of multiple test runs
Enables grouping of test runs by project name
Rotates stored test reports

Upcoming features 🐳

Allow Export by HTML (Revamp Designs)
Write as many custom reporters as possible
Deliver real-time reports.
Make sure the Custom Reporter for pytest covers all the features and scenarios
Improve Docs and Provide Options for Configuring Handshake Reporter

Introduction

Introduction

Quick Example:

Test Results Available

Features 🗽

Upcoming features 🐳

Demo ✨

Documentation 📦

Bugs/Feature Requests

Quick Example:

Test Results Available

Features 🗽

Upcoming features 🐳

Demo ✨

Documentation 📦

Bugs/Feature Requests