Google Git
Sign in
fuchsia / fuchsia / refs/heads/main / . / src / tests / end_to_end / fidlcat
tree: c786559669d4ae3a3f5687ad0704fd72a3b5ff01 [path history] [tgz]
  1. BUILD.gn
  2. echo.pb
  3. echo.test.fidl
  4. echo_client.pb
  5. echo_client_sync.pb
  6. echo_sync_crash.pb
  7. fidlcat_e2e_tests.py
  8. generate_debug.sh
  9. OWNERS
  10. pubspec.yaml
  11. README.md
  12. unknown.pb
src/tests/end_to_end/fidlcat/README.md

fidlcat_test README

What is this test about?

This is a set of tests for the host tool fidlcat. fidlcat is a host tool that communicates with a debug agent on the target. The debug agent monitors a target process for FIDL-related behavior (mostly sending and receiving FIDL messages) and reports it back to fidlcat.

Because fidlcat communicates with the target, we need to write an e2e test to exercise that interaction.

Relevant code paths with unit and integration tests:

//tools/fidlcat
//src/lib/fidl_codec
//src/developer/debug/debug_agent

See the fidlcat docs for more information about fidlcat.

How to run this test manually

  1. Add //src/tests/end_to_end/fidlcat:tests to your universe_package_labels and fx build.
  2. Run fx test --e2e fidlcat_e2e_tests.

How to update test recordings

The fidlcat e2e tests rely on two golden recordings: echo.pb and unknown.pb. The echo recording can be recreated by capturing all traffic from echo_client.cm and echo_server.cm as follows:

  1. Run ffx debug fidl -c echo_client.cm -c echo_server.cm --to echo.pb
  2. Run the echo realm: ffx component run core/ffx-laboratory:echo-realm fuchsia-pkg://fuchsia.com/echo_realm_placeholder#meta/echo_realm.cm
  3. Update the test cases with ffx debug fidl --from echo.pb -- --with=top (and --with=summary).

The same process can be used for unknown.pb, with the exception that this recording should contain some unknown FIDL messages.