assert_eq failure message easier to read by gilescope · Pull Request #42541 · rust-lang/rust

gilescope · 2017-06-08T17:43:21Z

By having the left and right strings aligned with one another it helps spot the difference between the two far quicker than if they are on the same line.

E.g.
Before:

thread 'tests::test_safe_filename' panicked at 'assertion failed: `(left == right)` left: `"-aandb--S123.html"` right: `"-aandb-S123.html"`',

After:

thread 'tests::test_safe_filename' panicked at 'assertion failed: `(left == right)`
left: `"-aandb--S123.html"`
right: `"-aandb-S123.html"`',

When the strings are both on the same line it take a lot longer to spot the difference. It is a small change but the small time savings add up with repetition. This would help Rust be an excellent language to write tests in out of the box.

Closes#41615

By having the left and right strings above and below on the same line it helps spot the difference between the two. E.g. thread 'tests::test_safe_filename' panicked at 'assertion failed: `(left == right)` left: `"-aandb--S123.html"` right: `"-aandb-S123.html"`', When the strings are both on the same line it take a lot longer to spot the difference. It is a small change but the small time savings add up with repetition. This helps Rust be an excellent language to write tests in.

rust-highfive · 2017-06-08T17:43:33Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

kennytm · 2017-06-08T19:40:53Z

The test case for assert_eq needs to be updated as well.

[00:52:03] failures:
[00:52:03][00:52:03] ---- [run-fail] run-fail/assert-eq-macro-panic.rs stdout ----
[00:52:03][00:52:03] error: error pattern 'assertion failed: `(left == right)` (left: `14`, right: `15`)' not found!
[00:52:03] status: exit code: 101
[00:52:03] command: /checkout/obj/build/x86_64-unknown-linux-gnu/test/run-fail/assert-eq-macro-panic.stage2-x86_64-unknown-linux-gnu [00:52:03] stdout:
[00:52:03] ------------------------------------------
[00:52:03][00:52:03] ------------------------------------------
[00:52:03] stderr:
[00:52:03] ------------------------------------------
[00:52:03] thread 'main' panicked at 'assertion failed: `(left == right)`[00:52:03] left: `14`[00:52:03] right: `15`', /checkout/src/test/run-fail/assert-eq-macro-panic.rs:14
[00:52:03] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[00:52:03][00:52:03] ------------------------------------------
[00:52:03][00:52:03] thread '[run-fail] run-fail/assert-eq-macro-panic.rs' panicked at 'explicit panic', /checkout/src/tools/compiletest/src/runtest.rs:2480
[00:52:03] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[00:52:03][00:52:03][00:52:03] failures:
[00:52:03] [run-fail] run-fail/assert-eq-macro-panic.rs
[00:52:03][00:52:03] test result: FAILED. 125 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out

But the error-pattern header doesn't support multi-line expectation AFAIK...

frewsxcv · 2017-06-08T20:44:51Z

Might also be good to change the assert_ne! macro to match this formatting directly below the assert_eq! definition

…est.

gilescope · 2017-06-13T13:34:02Z

multiple error-pattern seems to work nicely 👍 .
I noticed assert_eq printed left == right as well as assert_ne. I've changed assert_ne to print left != right and added a test to prove it works as expected.

Ready for review.

gilescope · 2017-06-14T16:41:03Z

@alexcrichton is it looking ok now?

alexcrichton · 2017-06-14T18:52:36Z

Oops thanks for the ping @gilescope, turns out you're not the first to have this idea! Looks like this closes that issue so I'll update the PR description as well. Otherwise looks great to me, thanks!

@bors: r+

bors · 2017-06-14T18:52:38Z

📌 Commit 02969a7 has been approved by alexcrichton

bors · 2017-06-14T21:50:19Z

⌛ Testing commit 02969a7 with merge 2add77b...

bors · 2017-06-14T23:16:09Z

💔 Test failed - status-travis

Mark-Simulacrum · 2017-06-14T23:21:29Z

Legitimate failure.

[01:04:38] ---- cargo_bench_failing_test stdout ----
[01:04:38] running `/checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/release/cargo build`
[01:04:38] running `/checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/cit/t11/foo/target/debug/foo`
[01:04:38] running `/checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/release/cargo bench`
[01:04:38] thread 'cargo_bench_failing_test' panicked at '
[01:04:38] Expected: execs
[01:04:38] but: expected to find:
[01:04:38] [COMPILING] foo v0.5.0 (file:///checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/cit/t11/foo)
[01:04:38] [FINISHED] release [optimized] target(s) in [..]
[01:04:38] [RUNNING] target[/]release[/]deps[/]foo-[..][EXE]
[01:04:38] thread '[..]' panicked at 'assertion failed: `(left == right)` (left: `"hello"`, right: `"nope"`)', src[/]foo.rs:14
[01:04:38] [..]
[01:04:38] [01:04:38] [01:04:38] did not find in output:
[01:04:38] Compiling foo v0.5.0 (file:///checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/cit/t11/foo)
[01:04:38] Finished release [optimized] target(s) in 0.63 secs
[01:04:38] Running target/release/deps/foo-dfc15783c07e4d52
[01:04:38] thread 'main' panicked at 'assertion failed: `(left == right)`
[01:04:38] left: `"hello"`
[01:04:38] right: `"nope"`', src/foo.rs:14
[01:04:38] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[01:04:38] error: bench failed
[01:04:38] ', /cargo/registry/src/github.com-1ecc6299db9ec823/hamcrest-0.1.1/src/core.rs:31
[01:04:38] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[01:04:38] [01:04:38] [01:04:38] failures:
[01:04:38] cargo_bench_failing_test

kennytm · 2017-06-14T23:46:16Z

Cargo strikes again 😆

gilescope · 2017-06-16T07:53:03Z

The fix for the cargo/tests/bench.rs is on gilescope/cargo revision 65ea42e8a847171e4f93fef6df5154aba7f832e3 (master branch). I'm unclear as to whether I should be creating a separate pull request for Cargo? Apologies - my git-foo seems to be lacking on submodules. Apologies for being a newbie in this respect.

kennytm · 2017-06-16T08:02:37Z

@gilescope Yes you need to submit a PR to cargo, wait for cargo to merge it, and then update the submodule here. You may see how this is handled in #41910 and rust-lang/cargo#4055.

bors · 2017-06-18T23:24:37Z

☔ The latest upstream changes (presumably #42676) made this pull request unmergeable. Please resolve the merge conflicts.

gilescope · 2017-06-20T11:39:25Z

@alexcrichton good morning, hopefully second time luck with cargo!

alexcrichton · 2017-06-20T15:12:18Z

@bors: r+

bors · 2017-06-20T15:12:19Z

📌 Commit 7acaf18 has been approved by alexcrichton

alexcrichton · 2017-06-23T15:04:21Z

@gilescope ah sorry there's no way to restart a travis build other than with a new commit, but I think this is ready to go, right? Want to remove the noop commits and I'll r+?

gilescope · 2017-06-23T18:12:25Z

My git-fu has certainly improved a bit! Ok, I think I've managed to scrub those two no-op commits. Please feel free to r+

alexcrichton · 2017-06-23T19:12:50Z

@bors: r+

Thanks!

bors · 2017-06-23T19:12:51Z

📌 Commit 940d5ca has been approved by alexcrichton

bors · 2017-06-23T20:33:48Z

⌛ Testing commit 940d5ca with merge 5e696959cd5a3b42e58705aa5079a442c1f441d3...

bors · 2017-06-23T21:58:07Z

💔 Test failed - status-travis

Mark-Simulacrum · 2017-06-23T22:02:41Z

@bors retry

network failure, I hope: [00:03:14] curl: (6) Could not resolve host: codeload.github.com

Mark-Simulacrum · 2017-06-23T22:03:44Z

@bors r=alexcrichton retry

Didn't mean to close...

bors · 2017-06-23T22:03:44Z

💡 This pull request was already approved, no need to approve it again.

There's another pull request that is currently being tested, blocking this pull request: Add tests for a few issues. #42724

bors · 2017-06-23T22:03:45Z

📌 Commit 940d5ca has been approved by alexcrichton

bors · 2017-06-24T01:41:55Z

⌛ Testing commit 940d5ca with merge 22c905e1f145cbf7cbc188ad308a7bfc8d2a8d6e...

bors · 2017-06-24T04:42:14Z

💔 Test failed - status-travis

kennytm · 2017-06-24T04:51:27Z

macOS timed out, spurious.

gilescope · 2017-06-24T09:01:09Z

Hmm, Travis timed out at 3h but it was happily chugging away running the tests. Maybe it hit a slow / heavily loaded server? I guess at some point we need to split the build from running the tests so that we can parallelise the tests further. Then again speeding up the rust compiler would help these build times and might have some side benefits. Not sure I'm quite ready to take that on as my second PR.

kennytm · 2017-06-24T09:12:28Z

@gilescope no need to worry about that, some rust team member will just retry in these cases

Mark-Simulacrum · 2017-06-24T11:34:40Z

@bors retry

OS X timed out

bors · 2017-06-24T12:18:45Z

⌛ Testing commit 940d5ca with merge 3cf9f5d...

bors · 2017-06-24T14:42:57Z

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing 3cf9f5d to master...

lpil · 2017-12-25T20:55:10Z

Late to the game here, just wanted to say thanks for this. Thanks!

rust-highfive assigned alexcrichton Jun 8, 2017

shepmaster added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jun 9, 2017

gilescope added 2 commits June 13, 2017 14:17

updated assert_eq test, fixed incorrect assert_ne message and added t…
1ec1b1f
…est.

Updated tests and fixed inconsistent message on assert_eq
87cfb54

Removing tabs. Sorry - have updated my .vimrc
02969a7

Fixed cargo bench test for assert_eq multi-line message
0a07803

gilescope mentioned this pull request Jun 16, 2017
Make test less brittle prior to assert_eq failure message format change rust-lang/cargo#4181
Merged

gilescope added 3 commits June 19, 2017 23:00

Merge remote-tracking branch 'upstream/master'
4b8446a

Updating cargo to includerust-lang#4181.
26ed78c

Whitespace change
7acaf18

gilescope force-pushed the patch-1 branch from b37b5a9 to 940d5caCompare June 23, 2017 18:08

Mark-Simulacrum closed this Jun 23, 2017

Mark-Simulacrum reopened this Jun 23, 2017

bors merged commit 940d5ca into rust-lang:masterJun 24, 2017

This was referenced Aug 5, 2017
repeated-assert-0.1.2 beta regression #43676
Closed
hashconsing-0.3.0 beta regression #43669
Closed
inotify-0.1.12 beta regression #43670
Closed

aturon mentioned this pull request Dec 26, 2017
Tracking issue for RFC 1866: More readable assert_eq #41615
Closed
3 tasks

Uh oh!

Uh oh!

Conversation

gilescope commented Jun 8, 2017• edited by alexcrichton Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Jun 8, 2017

Uh oh!

kennytm commented Jun 8, 2017

Uh oh!

frewsxcv commented Jun 8, 2017

Uh oh!

gilescope commented Jun 13, 2017

Uh oh!

gilescope commented Jun 14, 2017

Uh oh!

alexcrichton commented Jun 14, 2017

Uh oh!

bors commented Jun 14, 2017

Uh oh!

bors commented Jun 14, 2017

Uh oh!

bors commented Jun 14, 2017

Uh oh!

Mark-Simulacrum commented Jun 14, 2017

Uh oh!

kennytm commented Jun 14, 2017

Uh oh!

gilescope commented Jun 16, 2017

Uh oh!

kennytm commented Jun 16, 2017

Uh oh!

bors commented Jun 18, 2017

Uh oh!

gilescope commented Jun 20, 2017

Uh oh!

alexcrichton commented Jun 20, 2017

Uh oh!

bors commented Jun 20, 2017

Uh oh!

alexcrichton commented Jun 23, 2017

Uh oh!

gilescope commented Jun 23, 2017

Uh oh!

alexcrichton commented Jun 23, 2017

Uh oh!

bors commented Jun 23, 2017

Uh oh!

bors commented Jun 23, 2017

Uh oh!

bors commented Jun 23, 2017

Uh oh!

Mark-Simulacrum commented Jun 23, 2017

Uh oh!

Mark-Simulacrum commented Jun 23, 2017

Uh oh!

bors commented Jun 23, 2017

Uh oh!

bors commented Jun 23, 2017

Uh oh!

bors commented Jun 24, 2017

Uh oh!

bors commented Jun 24, 2017

Uh oh!

kennytm commented Jun 24, 2017

Uh oh!

gilescope commented Jun 24, 2017

Uh oh!

kennytm commented Jun 24, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Mark-Simulacrum commented Jun 24, 2017

Uh oh!

bors commented Jun 24, 2017

Uh oh!

bors commented Jun 24, 2017

Uh oh!

lpil commented Dec 25, 2017

Uh oh!

Reviewers

gilescope commented Jun 8, 2017•
edited by alexcrichton
Loading

kennytm commented Jun 24, 2017•
edited
Loading