Open jknndy opened 2 weeks ago
This generally looks good to me! It'll be reassuring to have this in place to maintain test style consistency (and therefore readability / reviewability!).
Related to the exception comment/suggestion: it would be helpful if we can provide a script to automatically fix otherwise-well-formed test JSON files that don't currently use the expected key ordering.
If we have that, then we can adjust the message in the test failure so that it both explains what the problem is, and also offers a ready-to-use command-line suggestion so that the developer can fix it (not a zero-frustration experience perhaps, but less frustrating than a hard-to-understand test failure that requires manual fixup for something that seems like it should be automatable).
Adds a test to compare the order of keys in each test JSON file against the order discussed in #1124 to make sure they match. 1 test case update was required
Example error: