How do I set up PTF to test a P4 switch with veth interfaces?

Follow the README example: use veth_setup.sh to create interfaces, compile the switch, and run PTF with --interface options mapping ports to veths (e.g., --interface 0@veth1). Ensure Python bindings are included via --pypath for control-plane integration.

PTF or OFTest: which is better for my project?

PTF is dataplane-agnostic and ideal for testing forwarding behavior independent of control protocols, while OFTest is specialized for OpenFlow. Choose PTF if you need protocol flexibility or are not using OpenFlow, as PTF evolved from OFTest with added features.

How can I run PTF tests in parallel?

Use the sharding feature: run multiple PTF instances with --num-shards and --shard-id to split tests. For example, with three shards, run separate processes with shard-id 0,1,2 to distribute the test load across hosts or cores.

What licensing issues should I consider with PTF's packet modules?

Scapy uses GPL v2.0, which may require your test code to be GPL-compatible, while bf_pktpy is Apache 2.0 for permissive use. Choose bf_pktpy to avoid copyleft, but be aware of its limited packet manipulation capabilities.

How to write a custom filter in PTF to ignore specific packets?

Define a Python callable that takes a Scapy packet and returns True to keep or False to discard. Add it using testutils.add_filter() in your test setup, as demonstrated in the sai_base_test.py example for filtering IPv6 packets.

Can PTF test multiple switches simultaneously?

Yes, PTF supports multi-device testing by specifying device numbers in interface mappings (e.g., --device-socket for nn platform) and using device-aware functions like send_packet with (device,port) tuples, enabling validation of networked topologies.

Open-Awesome

ptf

NOASSERTIONPythonv0.12.1

A Python-based dataplane test framework for network switches, built on unittest and supporting packet injection/verification.

GitHub

173 stars117 forks0 contributors

What is ptf?

PTF (Packet Test Framework) is a Python-based dataplane test framework built on unittest, designed for testing network switch forwarding behavior. It enables developers to inject, capture, and verify packets to validate switch functionality independently of control-plane protocols like OpenFlow. The framework supports flexible packet manipulation, ternary matching, and multi-device testing scenarios.

Target Audience

Network engineers and developers working on P4-programmable switches, software-defined networking (SDN) dataplanes, or custom network hardware who need to automate dataplane testing.

Value Proposition

PTF offers a protocol-agnostic, extensible testing framework with features like pluggable packet modules and multi-device support, derived from OFTest but focused purely on dataplane validation. Its integration with Python unittest and support for parallel execution make it a versatile choice for scalable network testing.

Overview

Packet Test Framework

Use Cases

Best For

Testing P4-programmable switch dataplanes
Validating packet forwarding logic in SDN environments
Automating functional testing of network hardware
Performing regression tests on switch firmware
Developing custom test suites for proprietary networking equipment
Parallelizing network test execution across multiple hosts

Not Ideal For

Teams testing control-plane protocols like BGP or OSPF that require integrated protocol state validation
Environments where root/sudo access is prohibited or tightly controlled, such as locked-down production systems
Projects needing out-of-the-box test suites for commercial, non-P4 switches without custom Python development

Pros & Cons

Pros

Pluggable Packet Modules

Offers choice between Scapy for comprehensive features and bf_pktpy for Apache 2.0 licensing, catering to different legal and functional needs as outlined in the README's tradeoff discussion.

Multi-Device Network Testing

Extends beyond single-switch testing to support networks of interconnected devices, enabling complex topology validation with device-aware send and verify functions.

Flexible Platform Options

Supports eth, remote, and nn platforms, allowing testing from local Ethernet interfaces to remote hosts via NNG sockets, as detailed in the configuration section.

Parallel Execution Support

Includes test sharding via --num-shards and --shard-id options to run tests across multiple PTF processes, improving scalability for large test suites.

Cons

Mandatory Root Privileges

Requires sudo to run all tests, which can limit deployment in secure, containerized, or cloud environments and adds operational complexity.

Steep Configuration Learning Curve

Setting up interfaces, platforms, and packet modules involves manual Python scripting and deep network topology understanding, as seen in the veth and platform mapping examples.

Limited Alternative Packet Module

The included bf_pktpy module implements only a subset of Scapy's functionality, constraining advanced packet crafting unless you accept Scapy's copyleft GPL license.

Frequently Asked Questions

Related Projects

ZeroTier

A Smart Ethernet Switch for Earth

F-Stack is an user space network development kit with high performance based on DPDK, FreeBSD TCP/IP stack and coroutine API.

Stars4,248

Forks957

Last commit8 hours ago

gobgp

BGP implemented in the Go Programming Language

Stars4,089

Forks802

Last commit3 days ago

snabbswitch

Snabb: Simple and fast packet networking

Stars3,035

Forks298

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

ptf