Add a new utility script that helps update very simple regression tests.
This script is currently specific to x86 and limited to use with very
small regression or feature tests using 'llc' and 'FileCheck' in
a reasonably canonical way. It is in no way general purpose or robust at
this point. However, it works quite well for simple examples. Here is
the intended workflow:
- Make a change that requires updating N test files and M functions' assertions within those files.
- Stash the change.
- Update those N test files' RUN-lines to look "canonical".
- Refresh the FileCheck lines for either the entire file or select functions by running this script.
- The script will parse the RUN lines and run the 'llc' binary you give it according to each line, collecting the asm.
- It will then annotate each function with the appropriate FileCheck comments to check every instruction from the start of the first basic block to the last return.
- There will be numerous cases where the script either fails to remove the old lines, or inserts checks which need to be manually editted, but the manual edits tend to be deletions or replacements of registers with FileCheck variables which are fast manual edits.
- A common pattern is to have the script insert complete checking of every instruction, and then edit it down to only check the relevant ones.
- Be careful to do all of these cleanups though! The script is designed to make transferring and formatting the asm output of llc into a test case fast, it is *not* designed to be authoratitive about what constitutes a good test!
- Commit the nice fresh baseline of checks.
- Unstash your change and rebuild llc.
- Re-run script to regenerate the FileCheck annotations
- Remember to re-cleanup these annotations!!!
- Check the diff to make sure this is sane, checking the things you expected it to, and check that the newly updated tests actually pass.
Also, I'm *terrible* at writing Python, and frankly I didn't spend a lot
of time making this script beautiful or well engineered. But it's useful
to me and may be useful to others so I thought I'd send it out.