Skip to content
🐣 Incubating Interplanetary Testground
Go HCL Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE docs: Spelling fix + grammar (#234) Dec 11, 2019
_meeting-notes Weekly Sync 2020-01-14 notes (#344) Jan 16, 2020
cmd test(sidecar): ping pong with latencies Jan 2, 2020
docs
infra remove Docker Hub paragraph (#350) Jan 16, 2020
manifests
pkg sidecar on Kubernetes (#336) Jan 16, 2020
plans feat: traffic shaping for bitswap plan (#352) Jan 17, 2020
sdk sidecar on Kubernetes (#336) Jan 16, 2020
tools implement the exec:go builder, and the local:exec runner (#86) Nov 4, 2019
.codecov.yml add flag to `patch` section (#326) Jan 7, 2020
.gitignore feat: run plans on AWS Docker Swarm + harden the logic to guess sourc… Nov 7, 2019
.pre-commit-config.yaml Add precommit hooks (#136) Nov 7, 2019
.travis.yml add dht test plan compilation to tests (#330) Jan 9, 2020
CONTRIBUTING.md docs: coalesce contributing guildelines Dec 4, 2019
Dockerfile sidecar on Kubernetes (#336) Jan 16, 2020
LICENSE-APACHE
LICENSE-MIT add licenses. Jul 16, 2019
Makefile feat: Add Makefile to build ipfs/testground image (#209) Dec 10, 2019
README.md Update README.md Dec 11, 2019
env-example.toml adding dockerhub registry as an option (#273) Dec 16, 2019
go.mod sidecar on Kubernetes (#336) Jan 16, 2020
go.sum sidecar on Kubernetes (#336) Jan 16, 2020
main.go refactor cmd integration tests to use ephemeral daemon. Dec 17, 2019

README.md

Testground

codecov

⚠️ Heavy WIP. beware of the Dragons πŸ‰..

This repository is incubating the 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

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.

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 - Lead Architect, Engineer, Developer
  • @daviddias - Engineer, Developer, acting as interim PM for the project
  • @nonsense - Engineer, Developer, Testground as a Service / Infrastructure Lead
  • @jimpick - Engineer, Developer
  • @stebalien - Engineer, Developer
  • @hacdias - Engineer, Developer
  • 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.

You can’t perform that action at this time.