testground

README

Testground

What is Testground

Testground's goal is to provide a set of tools for testing next generation P2P applications (i.e. Filecoin, IPFS, libp2p & others).

Table of Contents

• Background
• How to use Testground
• Team
• Contributing
• License

Background

You may have noticed a few test efforts with similar names underway! Testing at scale is a hard problem. We are indeed exploring and experimenting a lot, until we land on an end-to-end solution that works for us.

• Interplanetary Testbed (IPTB): https://github.com/ipfs/iptb
  • a simple utility to manage local clusters/aggregates of IPFS instances.
• libp2p testlab: https://github.com/libp2p/testlab
  • a Nomad deployer for libp2p nodes with a DSL for test scenarios.
• And others such as https://github.com/ipfs/interop and https://github.com/ipfs/benchmarks

Testground aims to leverage the learnings and tooling resulting from those efforts to provide a scalable runtime environment for the execution of various types of tests and benchmarks, written in different languages, by different teams, targeting a specific commit of IPFS and/or libp2p, and quantifying its characteristics in terms of performance, resource and network utilisation, stability, interoperability, etc., when compared to other commits.

Testground aims to be tightly integrated with the software engineering practices and tooling IPFS and libp2p teams rely on.

How to use Testground

• Consult the USAGE to learn how to get it running
• Refer to the SPEC document to understand how it all works.
• Consult the repo structure below to know where to find the multiple subsystems and test plans of Testground

├── README.md                       # This file
├── docs                            # Documentation of the project
│   ├── SPEC.md
│   ├── ...
├── main.go                         # Testground entrypoint file
├── cmd                             # Testground CLI commands
│   ├── all.go
│   ├── ...
├── sdk                             # SDK available to each test plan
│   ├── runtime
│   └── ...
├── pkg                             # Internals to Testground
│   ├── api
│   ├── ...
├── manifests                       # Manifests for each test Plan. These exist independent from plans to enable plans to live elsewhere
│   ├── dht.toml
│   └── smlbench.toml
├── plans                           # The Test Plan. Includes Image to be run, Assertions and more
│   ├── dht
│   └── smlbench
└── tools                           # ??
    └── src_generate.go

Team

The current Testground Team is composed of:

• @raulk - Tech Lead, Lead Software Engineer
• @nonsense - Software Engineer, Testground as a Service / Infrastructure Lead
• @Robmat05 - Technical Project Manager (TPM)
• @coryschwartz - Software Engineer
• you! Yes, you can contribute as well, however, do understand that this is a brand new and fast moving project and so contributing might require extra time to onboard

To learn how this team works together read HOW_WE_WORK

Contributing

Please read our CONTRIBUTING Guidelines before making a contribution.

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.