libp2p-test-plans/README.md

# Interoperability/end to end test-plans & performance benchmarking for libp2p

[![Interop Dashboard](https://github.com/libp2p/test-plans/workflows/libp2p%20transport%20interop%20test/badge.svg?branch=master)](https://github.com/libp2p/test-plans/actions/runs/9200478751/attempts/1#summary-25307109684)

[![Made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)

This repository contains:
* interoperability tests for libp2p's transport layers modules across different implementations and versions
* components to run performance benchmarks for different libp2p implementations

## Transport Interop
### Specs

Please see our first specification for interoperability tests between transports, multiplexers, and secure channels here: [Transport Interoperability Test Specs](transport-interop/README.md)

More specs to come soon!

## History

These test-plans historically used Testground. To read why we're now using `docker compose` instead please see: [Why we're moving away from Testground](https://github.com/libp2p/test-plans/issues/103)

## Performance Benchmarking

Please see the [benchmarking README](./perf#libp2p-performance-benchmarking).

## Roadmap

Our roadmap for test-plans can be found here: https://github.com/libp2p/test-plans/blob/master/ROADMAP.md

It represents current projects the test-plans maintainers are focused on and provides an estimation of completion targets.
It is complementary to those of [go-libp2p](https://github.com/libp2p/go-libp2p/blob/master/ROADMAP.md), [rust-libp2p](https://github.com/libp2p/rust-libp2p/blob/master/ROADMAP.md), [js-libp2p](https://github.com/libp2p/js-libp2p/blob/master/ROADMAP.md), and the [overarching libp2p project roadmap](https://github.com/libp2p/specs/blob/master/ROADMAP.md).

## License

Dual-licensed: [MIT](./LICENSE-MIT), [Apache Software License v2](./LICENSE-APACHE), by way of the
[Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).
chore: add perf to readme (#271) 2023-08-25 14:47:09 +00:00			`# Interoperability/end to end test-plans & performance benchmarking for libp2p`
initial commit. 2020-04-22 15:25:28 +00:00
chore: update the link to the interop dashboard [skip ci] 2024-05-23 01:15:30 +00:00			`[![Interop Dashboard](https://github.com/libp2p/test-plans/workflows/libp2p%20transport%20interop%20test/badge.svg?branch=master)](https://github.com/libp2p/test-plans/actions/runs/9200478751/attempts/1#summary-25307109684)`
feat: multidim-interop: Setup badge (#105) 2023-01-18 00:44:22 +00:00
initial commit. 2020-04-22 15:25:28 +00:00			`[![Made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)`

chore: add perf to readme (#271) 2023-08-25 14:47:09 +00:00			`This repository contains:`
Rename `multidim-interop` to `transport-interop` (#308) 2023-10-05 03:12:39 +00:00			`* interoperability tests for libp2p's transport layers modules across different implementations and versions`
chore: add perf to readme (#271) 2023-08-25 14:47:09 +00:00			`* components to run performance benchmarks for different libp2p implementations`
chore: update readme and update references to Testground (#128) 2023-02-07 20:10:24 +00:00
Rename `multidim-interop` to `transport-interop` (#308) 2023-10-05 03:12:39 +00:00			`## Transport Interop`
chore: add perf to readme (#271) 2023-08-25 14:47:09 +00:00			`### Specs`
chore: update readme and update references to Testground (#128) 2023-02-07 20:10:24 +00:00
Rename `multidim-interop` to `transport-interop` (#308) 2023-10-05 03:12:39 +00:00			`Please see our first specification for interoperability tests between transports, multiplexers, and secure channels here: [Transport Interoperability Test Specs](transport-interop/README.md)`
chore: update readme and update references to Testground (#128) 2023-02-07 20:10:24 +00:00
			`More specs to come soon!`

			`## History`

			These test-plans historically used Testground. To read why we're now using `docker compose` instead please see: [Why we're moving away from Testground](https://github.com/libp2p/test-plans/issues/103)
initial commit. 2020-04-22 15:25:28 +00:00
chore: add perf to readme (#271) 2023-08-25 14:47:09 +00:00			`## Performance Benchmarking`

			`Please see the [benchmarking README](./perf#libp2p-performance-benchmarking).`

Organization: add DESIGN.md and ROADMAP.md (#44) Co-authored-by: Steve Loeppky <stvn@loeppky.com> Co-authored-by: Prithvi Shahi <shahi.prithvi@gmail.com> 2022-10-21 00:30:36 +00:00			`## Roadmap`

			`Our roadmap for test-plans can be found here: https://github.com/libp2p/test-plans/blob/master/ROADMAP.md`

			`It represents current projects the test-plans maintainers are focused on and provides an estimation of completion targets.`
			`It is complementary to those of [go-libp2p](https://github.com/libp2p/go-libp2p/blob/master/ROADMAP.md), [rust-libp2p](https://github.com/libp2p/rust-libp2p/blob/master/ROADMAP.md), [js-libp2p](https://github.com/libp2p/js-libp2p/blob/master/ROADMAP.md), and the [overarching libp2p project roadmap](https://github.com/libp2p/specs/blob/master/ROADMAP.md).`

initial commit. 2020-04-22 15:25:28 +00:00			`## License`

			`Dual-licensed: [MIT](./LICENSE-MIT), [Apache Software License v2](./LICENSE-APACHE), by way of the`
			`[Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).`