mirror of https://github.com/status-im/libp2p-test-plans.git synced 2025-01-12 07:44:27 +00:00

Thomas Eizinger abce1ee483

ping/rust: Refactor into multiple binaries (#72 )

By having one Rust binary per version, we can vary the actual binary from
version to version and f.e. fix deprecated API calls. It does introduce a bit of
duplication between the different versions but I'd rather have that then not
being able to adapt the tests to new APIs.

Instead of activating a feature per libp2p version, we add them all as
dependencies. This ensures all transitive dependencies are properly tracked in
`Cargo.lock`. Additionally, this gives us a single place we are can activate all
the feature.

For `master` and pull-request builds, we replace the git target or rev with the
one coming from the CI build. Once we trigger a build, `cargo` will update and
resolve the necessary dependencies before that, thus fixing problems such as
https://github.com/libp2p/rust-libp2p/pull/2972.

2022-11-18 12:49:30 +01:00

3.1 KiB

Raw Blame History

Testground test plans for libp2p

This repository contains Testground test plans for libp2p components.

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, rust-libp2p, js-libp2p, and the overarching libp2p project roadmap.

How to add a new version to ping/go

When a new version of libp2p is released, we want to make it permanent in the ping/go test folder.

In the ping/_compositions/go.toml file,
- copy the [master] section and turn it into a [[groups]] item
- update the [master] section with the future version
In the ping/go folder,
- Add a new compatibility shim in compat/ if needed, or add your new selector to the latest shim (see compat/libp2p.v0.17.go for example).
- Create the new mod and sum files (go.v0.21.mod for example). Assuming you're updating from v$A to v$B, a simple way to do this is to:
  - cp go.v$A.mod go.v$B.mod; cp go.v$A.sum go.v$B.sum
  - ln -s go.v$B.mod go.mod; ln -s go.v$B.sum go.sum (you may also use this for local development, these files are ignored by git)
  - update the go-libp2p version, go version, and update the code if needed.
  - then go get -tags v$B && go mod tidy
Run the test on your machine
- Do once, from the test-plans root: import the test-plans with testground plan import --from ./ --name libp2p
- Run the test with testground run composition -f ping/_compositions/go-cross-versions.toml --wait

How to add a new version to ping/rust

When a new version of libp2p is released, we want to make it permanent in the ping/rust test folder.

In the ping/_compositions/rust.toml file,
- Copy the latest [[groups]] section and update it's Id and BinaryName accordingly.
In the ping/rust folder,
- Cargo.toml: Add the newly released version as a crates.io dependency.
- Cargo.toml: Update the Next release dependency to the latest master SHA.
- src/bin: Add a new binary with the next released version.
Run the test on your machine
- Do once, from the test-plans root: import the test-plans with testground plan import --from ./ --name libp2p
- Run the test with testground run composition -f ping/_compositions/rust-cross-versions.toml --wait

License

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