Skip to content

TESTING.md

Latest commit

 

History

History
82 lines (67 loc) · 4.09 KB

TESTING.md

File metadata and controls

82 lines (67 loc) · 4.09 KB
Raw

Testing

The tests of Netom live in a few places:

  • unit tests in the source code
  • doctests in the source code
  • end-to-end tests in a separate, private repo called REEDS

Running these tests is done with a single command:

cargo test --all-features --release

End-to-end testing (REEDS)

The end-to-end tests for Netom are maintained in a separate repository that is private. Keeping it private enables us to store real-world network data, which is used as input in the test suites.

While this makes the end-to-end tests invisible, we do encourage contributors to think about what types of input data would be required to test their contributions in an end-to-end fashion. For example, when a PR adds certain new fields to the response of an API endpoint, we should create a test where the input (e.g. pcap or binary BMP) contains PDUs that result in API responses featuring the newly added output.

Ideally, a PR is accompanied with a pcap or likewise (perhaps transferred to use in private) for us to create an end-to-end test from. This might not always be trivial: in that case, please reach out to discuss how we can proceed to get proper testing in place.

End-to-end FlowSpec testing

FlowSpec (RFC 8955/8956) is covered end-to-end on both ingest paths, with the decoded rules verified through the HTTP API (/api/v1/ribs/ipv{4,6}flowspec/routes):

  • cargo test --lib ingests_mrtgen_flowspec_rules — in-process test: a mrtgen-generated BGP4MP file with diverse rules goes through the mrt-file-in unit into the flowspec store. Runs as part of the normal test suite and CI.
  • scripts/e2e-flowspec-mrt.sh — the same corpus against a real netom binary: the mrtgen CLI (pinned to the Cargo.toml revision) writes the MRT file, an mrt-file-in unit ingests it, assertions run over the HTTP API.
  • scripts/e2e-flowspec-exabgp.sh — live BGP session: exabgp announces 8 diverse FlowSpec rules (plus one unicast route for RFC 8955 §6 validation) to a bgp-tcp-in unit that negotiates the FlowSpec families.
  • scripts/e2e-addpath-bmp.sh — ADD-PATH (RFC 7911) through the full BMP pipeline: a crafted BMP session negotiates ADD-PATH (cap 69 in both OPENs), announces one prefix under two path ids, withdraws one, and goes down. Asserts on the bmp-out side that the synthesized Peer Up advertises cap 69 in both OPENs, both paths restream live with their path ids, the withdrawal carries its path id, a reconnect dump replays only the active path, /api/v1/ingresses shows the two bgpPath children, and Peer Down fires exactly once (driver: scripts/e2e-addpath-bmp.py). Runs two downstream consumers: one on a fastpath unit (verbatim raw forwarding — catches duplicate delivery if the raw-coverage check fails to map path-children to their session) and one on a rebuild unit (fastpath = false, bmp-out re-encodes the path ids itself).
  • scripts/e2e-cli.sh — netom-cli against a live daemon: a real BGP session is driven in by scripts/e2e-cli-speaker.py while a second peer is configured but unreachable. Asserts that the established peer is reported with its prefix count, that the peer which never came up appears as Active rather than being missing, that show running-config redacts a configured md5_key, and that abbreviation, output filters, --json (including NDJSON whole-table dumps), broken-pipe handling, batch stdin, endpoint discovery via -c, and the exit codes all behave. Set NETOM_CLI_BIN alongside NETOM_BIN to skip the build.

Both scripts build netom themselves (set NETOM_BIN to skip that), install their tools (mrtgen, exabgp) into a scratch directory when missing, and clean up after themselves. The corpus in each covers every component type — dst/src prefix, protocol, ports, TCP flags, packet length, ICMP type/code, DSCP, fragment, IPv6 flow label — rules without a destination prefix (keyed at the family default route), all decodable traffic actions, and the RFC 8955 §6 validity states.

The e2e-flowspec GitHub workflow runs both scripts on demand (workflow_dispatch).