e2etest/

README

E2E Tests

The MetalLB E2E test suite can be run by creating a development cluster:

inv dev-env

and running the E2E tests against the development cluster:

inv e2etest

Run only BGP test suite:

inv e2etest --focus BGP

Run only L2 test suite:

inv e2etest --focus L2

The test suite will run the appropriate tests against the cluster. Be sure to cleanup any previously created development clusters using inv dev-env-cleanup.

BGP tests network topology

In order to test the multiple scenarios required for BGP, three different containers are required. The following diagram describes the networks, the pods and the containers involved.

  ┌────────────────────────────────────────────┐
  │                exec network                │
  │ ┌─────────┐                                │
  │ │         │                                │
  │ │ Speaker ├────┐      ┌─────────────────┐  │
  │ │         │    │      │                 │  │
  │ └─────────┘    │      │ ibgp-single-hop │  │
  │                │      │                 │  │
  │ ┌─────────┐    │      └─────────────────┘  │
  │ │         │    │                           │
  │ │ Speaker ├────┤   ┌───────────────────────┼──────────────────────────┐
  │ │         │    │   │                       │                          │
  │ └─────────┘    │   │  ┌─────────────────┐  │       ┌────────────────┐ │
  │                │   │  │                 │  │       │                │ │
  │ ┌─────────┐    ├───┼──┤ ebgp-single-hop ├──┼───────┤ ibgp-multi-hop │ │
  │ │         │    │   │  │                 │  │       │                │ │
  │ │ Speaker │    │   │  └─────────────────┘  │       └────────────────┘ │
  │ │         ├────┘   │                       │                          │
  │ └─────────┘        │                       │       ┌────────────────┐ │
  │                    │                       │       │                │ │
  └────────────────────┼───────────────────────┘       │ ebgp-multi-hop │ │
                       │                               │                │ │
                       │       multi-hop-net           └────────────────┘ │
                       │       172.30.0.0/16                              │
                       │  fc00:f853:ccd:e798::/64                         │
                       └──────────────────────────────────────────────────┘

The above diagram is implemented in infra_setup.go.

Use Existing Containers

The E2E tests can run while using existing FRR containers that act as the single/multi-hop BGP routers.

To do so, pass the flag external-containers with the value of a comma-separated list of containers names. The valid names are: ibgp-single-hop / ibgp-multi-hop / ebgp-single-hop / ebgp-multi-hop.

The test setup will use them instead of creating the external frr containers on its own.

The requirements for this are:

• The external FRR containers must be named as ibgp-single-hop / ibgp-multi-hop / ebgp-single-hop / ebgp-multi-hop.
• When running with an multi-hop container, the ebgp-single-hop container must be present. Other than that, the multi-hop containers must be connected to a docker network named multi-hop-net. The test suite will take care of connecting the ebgp-single-hop to the multi-hop-net and creating the required static routes between the speakers and the containers, as well as configuring the external FRR containers.
• When using existing container, i.e. ibgp_single_hop, you have to mount a directory named ibgp-single-hop that has the initial frr configurations files (vtysh.conf, zebra.conf, daemons, bgpd.conf, bfdd.conf). See metallb/e2etest/config/frr for example. Note that the test's teardown will delete the directory, so it's recommended to keep a copy of the directory in a different place.