Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ZIO Test: Support Labeled Assertions #2200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 11, 2019
Merged

ZIO Test: Support Labeled Assertions #2200

merged 2 commits into from
Nov 11, 2019

Conversation

@adamgfraser
Copy link
Contributor

In some cases it can be useful to label assertions to provide additional information for test reporting. For example, consider the following test:

testM("test") {
  for {
    a <- ZIO.effectTotal(Some(1))
    b <- ZIO.effectTotal(Some(1))
    c <- ZIO.effectTotal(Some(0))
    d <- ZIO.effectTotal(Some(1))
  } yield assert(a, isSome(equalTo(1)) &&
    assert(b, isSome(equalTo(1)) &&
    assert(c, isSome(equalTo(1)) &&
    assert(d, isSome(equalTo(1))
}

This test will fail with an error message that "0 did not satisfy equalTo(1)", but that is not particularly helpful here because we don't know which of the four composed assertions failed. This PR adds a method label to Assertion that labels an assertion with an arbitrary string. Using this, the test could be rewritten as:

testM("test") {
  for {
    a <- ZIO.effectTotal(Some(1))
    b <- ZIO.effectTotal(Some(1))
    c <- ZIO.effectTotal(Some(0))
    d <- ZIO.effectTotal(Some(1))
  } yield assert(a, isSome(equalTo(1)).label("first")) &&
    assert(b, isSome(equalTo(1)).label("second")) &&
    assert(c, isSome(equalTo(1)).label("third")) &&
    assert(d, isSome(equalTo(1)).label("fourth"))
}

The error message would now get reported like so:

image

@adamgfraser adamgfraser requested a review from jdegoes November 10, 2019 02:43
ghostdogpr
ghostdogpr previously approved these changes Nov 10, 2019
View reviewed changes
jdegoes
jdegoes reviewed Nov 11, 2019
View reviewed changes
test/shared/src/main/scala/zio/test/Assertion.scala Outdated
* Labels this assertion with the specified string.
*/
final def label(string: String): Assertion[A] =
new Assertion(infix(param(self), "@@", param(quoted(string))), run)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might suggest ?? instead of @@ to match ZIO Config; and also have ?? operator alias.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Will change now.

@jdegoes jdegoes merged commit ed76e1d into zio:master Nov 11, 2019
@adamgfraser adamgfraser deleted the label branch November 11, 2019 03:04
Twizty pushed a commit to Twizty/zio that referenced this pull request Nov 13, 2019
@adamgfraser @Twizty
ZIO Test: Support Labeled Assertions (zio#2200)
dfe9dfa 
* implement Assertion#label

* use ?? instead of @@ and add operator alias
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jdegoes jdegoes jdegoes approved these changes

@ghostdogpr ghostdogpr ghostdogpr left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@adamgfraser @jdegoes @ghostdogpr