Testing strategy

Unit tests

As you've probably noticed, there aren't many. Lots of the interesting behavior in A/B Street - UI interactions, details of the simulation, map importing -- would take lots of infrastructure to specify a setup and expected outcomes. If you have ideas for new tests, contributions always welcome! In the meantime, one useful test covers how OSM tags translate into individual lanes.

Screenshot diffs

Downloading fresh OSM data or modifying any part of the map importing pipeline could easily break things. Expressing invariants about the map output is hard, because importing is far from perfect, and OSM data is often quite buggy. So the approach to preventing regressions here is to look for visual changes to the final rendered map.

  1. When a new map is opted into this type of test, somebody manually squints carefully at it and sanity checks that it works to some degree.
  2. They use the screen capture tool in debug mode to tile the map into 1920x960 chunks and screengrab everything.
  3. Later, somebody regenerates the map with some possible changes.
  4. They grab screenshots again, then use compare_screenshots.sh to quickly look at the visual diff. Changes to intersection geometry, number of lanes, rendering, etc are all easy to spot.
  5. If this manual inspection of the diff is good, they commit the new screenshots as the new goldenfiles.

How do you actually run this test? Open the main sandbox mode (on a release build, unless you're very patient), go to debug mode (Ctrl+D), then hit "screenshot all of the everything" on the right. This will fly through a few maps, tiling them into screen-sized chunks and saving a screenshot for each one. The maps configured for this test are in game/src/debug/mod.rs, near the string "screenshot all of the everything".

This process produces a screenshots/ directory. You can then use ./compare_screencaps.sh us phoenix tempe to see if that map's screenshots have changed since the last recorded run of the test. This script assumes you've opted into the input data and run the updater for the appropriate cities. It also assumes the compare command (from ImageMagick) and feh (to view images; you could change the script to something else). Very critically, all the stored screenshots are sized 1920 x 948 (from a 1920 x 1080 monitor, subtracting titlebars and such for my GNOME setup). The diffs won't make sense if the size is different!

After confirming any diffs are intentional, the ./confirm_screencap.sh script replaces the new source-of-truth in data/input/us/phoenix/screenshots/tempe.zip or similar. The updater tool is then used to upload the new data to S3 -- this is a step that currently only Dustin has access to run.


This tool regenerates all maps and scenarios from scratch. cargo run --bin updater -- dry-run then reveals what files have changed.

Additionally, this script does a few more tests:

  • --prebake runs the full weekday scenario on two maps that've previously been coerced into being gridlock-free

Integration tests

The tests crate contains some integration tests.

One part runs the full importer against really simple .osm files. To iterate rapidly on interpreting turn restrictions, it produces goldenfiles describing all turns in the tiny map.

The "smoke-test" section simulates one hour on all maps, flushing out bugs with bus spawning, agents hitting odd parts of the map, etc

The "check proposals" section makes sure the edits shipped with the game still load properly.

Old tests

Once upon a time, I made a little test harness that would run the simulation headlessly (without graphics), set up certain situations forcing a car to park in a certain spot, and asserted that different sim/src/events.rs were produced in the right order. The map_editor tool was used to manually draw really simple maps for these situations. I deleted everything, because the effort to specify the input and expected output were too tedious to maintain, and this never really helped catch bugs. There was a way to label roads and buildings in the synthetic maps, so the test code could assert person 2 made it to the "house" building, but even with all of this, it was pretty hard.

This approach is maybe worth reviving, though.