byteblower-test-framework 1.0.0b8

Test Framework for the ByteBlower Traffic Generator.

An easy accessible library of basic test flows and reporting engines.

ByteBlower ® is a traffic generator/analyser system for TCP/IP networks.

This library provides you with the building blocks for:

1. Generating test traffic

2. Collect statistics

3. Analyse traffic statistics

4. Generate reports

Requirements

• byteblowerll (ByteBlower API): Our lower layer API for client-server communication (API documentation)

• scapy: Used for frame generation and parsing

• junit-xml: Used for Unit test report generation

• pandas: Used for data collection

• python-highcharts: Used for generating graphs

• jinja2: User for HTML report templating

Supported platforms

The ByteBlower Test Framework in general supports Python version 3.7 to 3.9.

Note

NOTE: Python >= 3.10 is not yet supported because of an issue with one of the dependent Python libraries (python-highcharts).

The framework has been tested for the following operating system platforms and Python versions:

OS platform	Distribution	Python version	source
Windows 10	up to feature release 21H2	Python 3.9	Official Python
Windows 10	up to feature release 21H2	Python 3.8	Official Python
Windows 10	up to feature release 21H2	Python 3.7	Official Python
Windows 10	up to feature release 21H2	Python 3.9	Windows Apps
Windows 10	up to feature release 21H2	Python 3.8	Windows Apps
Windows 10	up to feature release 21H2	Python 3.7	Windows Apps
macOS	up to Monterey	Python 3.9	Official Python (Intel-only!)
macOS	up to Monterey	Python 3.8	Official Python (Intel-only!)
Linux	Debian 11 (bullseye)	Python 3.9.2	Debian packages
Linux	Debian 10 (buster)	Python 3.7.3	Debian packages
Linux	Ubuntu 20.04 (Focal Fossa)	Python 3.8.2	Ubuntu packages
Docker	python:3.7-slim-buster	Python 3.7.3	Docker Python

Installation

Prepare runtime environment

We encourage to manage the runtime environment in a Python virtual environment. This guarantees proper separation of the system-wide installed Python and pip packages.

Python virtual environment

Using Python venv (included in Python >= 3.3):

Prepare Python virtual environment: Create the virtual environment and install/update pip and build.

Note

NOTE: Mind the leading . which means sourcing ./env/bin/activate.

python3 -m venv env
. ./env/bin/activate
pip install -U pip build

Install the ByteBlower Test Framework from PyPI

First make sure that your activated your virtual environment:

. ./env/bin/activate

Now install (or update) the ByteBlower Test Framework:

python3 -m pip install -U byteblower-test-framework

Documentation

Online usage documentation: ByteBlower Test Framework documentation

The API documentation is also always available in the API:

help(any_api_object)

Some examples:

For classes (and their members):

from byteblower_test_framework.host import Server
from byteblower_test_framework.endpoint import IPv4Port
from byteblower_test_framework.traffic import FrameBlastingFlow
help(Server)
help(Server.start)
help(Server.info)
help(IPv4Port)
help(FrameBlastingFlow)
from byteblower_test_framework.report import ByteBlowerHtmlReport
help(ByteBlowerHtmlReport)

For objects (and their members):

from byteblower_test_framework.host import Server
my_server = Server('byteblower-39.lab.excentis.com.')
help(my_server)
help(my_server.start)

Usage

First make sure that your activated your virtual environment:

. ./env/bin/activate

Let’s give it a test run: Import the test framework and show its documentation:

python

import byteblower_test_framework
help(byteblower_test_framework)

This shows you the ByteBlower Test Framework module documentation.

Note

To-do: We will provide a quick start guide in the future.

Development

Would you like to contribute to this project? You’re very welcome! 😊

Please contact us at ByteBlower Support and we’ll be there to guide you.

Support

If you have any questions or feature request you can contact the ByteBlower support team using:

🌍: Excentis Support Portal

🖂: ByteBlower Support

🕽: [phone]