rust-libp2p/interop-tests
Thomas Eizinger d53cfed236
chore: move libp2p crate to a dedicated directory
Currently, our top-level `Cargo.toml` manifest represents a crate AND a workspace. This causes surprising behaviour (e.g. #2949) where we need to explicitly pass `--workpace` to every command to run it on the entire workspace and not just the meta crate.

My moving the meta crate into its own directory, the root manifest file is a virtual manifest only and thus, every `cargo` command will automatically default to running on the entire workspace.

On top of this, I personally find it easier to understand if workspace and crate manifests are not mixed.

Pull-Request: #3536.
2023-03-08 13:20:39 +00:00
..
2023-03-02 10:45:07 +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")