Improve test failure readability #18049
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilmotta
requested review from
alwx,
cammellos,
rasom,
vkjr,
FFFra,
flexsurfer,
qfrank,
yqrashawn,
tumanov-alex,
Parveshdhull,
briansztamfater,
ajayesivan,
smohamedjavid,
clauxx and
J-Son89
Jenkins BuildsClick to see older builds (11)
|
clauxx
approved these changes
Dec 1, 2023
yqrashawn
approved these changes
Dec 4, 2023
ilmotta
force-pushed
the
ilmotta/improve-readability-of-test-failures
branch
from
774f46e
to
e2adeb7
Compare
smohamedjavid
approved these changes
Dec 4, 2023
jakubgs
approved these changes
Dec 4, 2023
The namespace matcher-combinators.test must be required in namespaces using "match?"
ilmotta
force-pushed
the
ilmotta/improve-readability-of-test-failures
branch
from
e2adeb7
to
47ec1be
Compare
77% of end-end tests have passedFailed tests (4)Click to expandClass TestOneToOneChatMultipleSharedDevicesNewUi:
Class TestCommunityMultipleDeviceMergedTwo:
Class TestCommunityOneDeviceMerged:
Expected to fail tests (7)Click to expandClass TestOneToOneChatMultipleSharedDevicesNewUi:
Class TestCommunityMultipleDeviceMerged:
Class TestOneToOneChatMultipleSharedDevicesNewUiTwo:
Class TestCommunityOneDeviceMerged:
Class TestGroupChatMultipleDeviceMergedNewUI:
Passed tests (37)Click to expandClass TestActivityMultipleDevicePRTwo:
Class TestDeepLinksOneDevice:
Class TestOneToOneChatMultipleSharedDevicesNewUi:
Class TestCommunityMultipleDeviceMerged:
Class TestActivityCenterContactRequestMultipleDevicePR:
Class TestCommunityMultipleDeviceMergedTwo:
Class TestGroupChatMultipleDeviceMergedNewUI:
Class TestCommunityOneDeviceMerged:
Class TestActivityMultipleDevicePR:
Class TestOneToOneChatMultipleSharedDevicesNewUiTwo:
|
yevh-berdnyk
pushed a commit
that referenced
this pull request
Dec 8, 2023
Problem: failed equality checks as in "(is (= expected actual))" will give a single, long line of output that for anything but the simplest data structures is unreadable by humans, and the output doesn't give a useful diff. Solution: use library https://github.com/nubank/matcher-combinators and its test directive "match?" which will pinpoint where two data structures differ. Then, instead of "(is (= ...", use "(is (match? expected actual)". It works beautifully. The library offers other nice matchers, but the majority of the time match? is sufficient. Can we use another test runner like Kaocha? kaocha-cljs2 (https://github.com/lambdaisland/kaocha-cljs2) would be able to print better test errors out of the box, among other features, but I have no clue if it would work well or at all in our stack (in theory yes, but it's a larger piece of work).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR is one of those you regret not opening before, way before. Problem: failed equality checks as in
(is (= expected actual))will give a single, long line of output that for anything but the simplest data structures is unreadable by humans, and the output doesn't give a useful diff. For me, unit testing so far in status-mobile has been one of the most insufferable experiences ever because of that alone.The solution is simple: use library https://github.com/nubank/matcher-combinators which will define a directive
match?which will pinpoint where two data structures differ. Then, instead of(is (= ..., use(is (match? expected actual). It works beautifully.No need to require any extra namespace, the directives are injected once in(false, in the CI the ClojureScript compiler couldn't find thestatus-im.test-runnermatch?directive).Without this PR, if a test fails, I often had to copy the output, format it with zprint and diff two buffers and still manually scan the output hunting for a diff. It could be automated more, but it's just not worth it and it doesn't solve the problem for other devs.
Note
Guidelines were updated too: https://github.com/status-im/status-mobile/blob/ilmotta/improve-readability-of-test-failures/doc/new-guidelines.md#prefer-match-over--when-comparing-data-structures.
The library offers other nice matchers, but the majority of the time
match?is sufficient.Can we use another test runner like Kaocha?
kaocha-cljs2 would be able to print better test errors out of the box, among other features, but I have no clue if it would work well or at all in our stack (in theory yes, but it's a larger piece of work).
Demo
Areas that maybe impacted
None, just a few test namespaces were changed from using
(is (= ...)to(is (match? ...)status: ready