rust-libp2p/interop-tests
Thomas Eizinger ab9555c8b6
feat: deprecate webrtc and quic features in libp2p crate
We currently expose `libp2p-quic` and `libp2p-webrtc` as submodules from the `libp2p` crate despite those only being "alpha" status. This causes problems because we need to pin those dependencies due to `cargo` automatically upgrading alphas (which are allowed to incur breaking changes as per semver spec). Additionally, exposing these modules practically hides the "alpha" state of those modules, rendering it kind of obsolete.

The "alpha" state is still true for those modules, thus to properly communicate this to users, we deprecate the modules and require users to spell out the dependency and the alpha version in their manifest.

Pull-Request: #3580.
2023-03-21 17:52:47 +00:00
..

Interop tests implementation

This folder defines the implementation for the interop tests.

Running this test locally

You can run this test locally by having a local Redis instance and by having another peer that this test can dial or listen for. For example to test that we can dial/listen for ourselves we can do the following:

  1. Start redis (needed by the tests): docker run --rm -it -p 6379:6379 redis/redis-stack.
  2. In one terminal run the dialer: REDIS_ADDR=localhost:6379 ip="0.0.0.0" transport=quic-v1 security=quic muxer=quic is_dialer="true" cargo run --bin ping
  3. In another terminal, run the listener: REDIS_ADDR=localhost:6379 ip="0.0.0.0" transport=quic-v1 security=quic muxer=quic is_dialer="false" cargo run --bin ping

To test the interop with other versions do something similar, except replace one of these nodes with the other version's interop test.

Running all interop tests locally with Compose

To run this test against all released libp2p versions you'll need to have the (libp2p/test-plans)[https://github.com/libp2p/test-plans] checked out. Then do the following (from the root directory of this repository):

  1. Build the image: docker build -t rust-libp2p-head . -f interop-tests/Dockerfile.
  2. Build the images for all released versions in libp2p/test-plans: (cd <path to >/libp2p/test-plans/multidim-interop/ && make).
  3. Run the test:
RUST_LIBP2P="$PWD"; (cd <path to >/libp2p/test-plans/multidim-interop/ && npm run test -- --extra-version=$RUST_LIBP2P/interop-tests/ping-version.json --name-filter="rust-libp2p-head")