Commits on Aug 24, 2020

1. Introduce expect snapshot testing library into rustc …

   Snapshot testing is a technique for writing maintainable unit tests.
   Unlike usual `assert_eq!` tests, snapshot tests allow
   to *automatically* upgrade expected values on test failure.
   In a sense, snapshot tests are inline-version of our beloved
   UI-tests.
   
   Example:
   
   ![expect](https://user-images.githubusercontent.com/1711539/90888810-3bcc8180-e3b7-11ea-9626-d06e89e1a0bb.gif)
   
   A particular library we use, `expect_test` provides an `expect!`
   macro, which creates a sort of self-updating string literal (by using
   `file!` macro). Self-update is triggered by setting `UPDATE_EXPECT`
   environmental variable (this info is printed during the test failure).
   This library was extracted from rust-analyzer, where we use it for
   most of our tests.
   
   There are some other, more popular snapshot testing libraries:
   
   * https://github.com/mitsuhiko/insta
   * https://github.com/aaronabramov/k9
   
   The main differences of `expect` are:
   
   * first-class snapshot objects (so, tests can be written as functions,
     rather than as macros)
   * focus on inline-snapshots (but file snapshots are also supported)
   * restricted feature set (only `assert_eq` and `assert_debug_eq`)
   * no extra runtime (ie, no `cargo insta`)
   
   See rust-lang/rust-analyzer#5101 for a
   an extended comparison.
   
   It is unclear if this testing style will stick with rustc in the long
   run. At the moment, rustc is mainly tested via integrated UI tests.
   But in the library-ified world, unit-tests will become somewhat more
   important (that's why use use `rustc_lexer` library-ified library as
   an example in this PR). Given that the cost of removal shouldn't be
   too high, it probably makes sense to just see if this flies!

   

   matklad committed Aug 24, 2020
   Configuration menu

   • View commit details
   • Copy full SHA for f7be59c
   • Browse repository at this point

   Copy the full SHA

   f7be59c View commit details

   Browse the repository at this point in the history