Add doobie-munit package to integrate Doobie with the shiny new MUnit #1233

Kazark · 2020-07-13T16:00:54Z

MUnit is a the new Scala testing framework on the block. Seems reasonable for Doobie to support it along with the other two it already supports.

I copied off scalatest because it is fairly similar to MUnit. Hopefully I didn't forget to change anything after the copy and paste, particularly in the documentation (the test is green, at least).

MUnit is a the new Scala testing framework on the block. Seems reasonable for Doobie to support it along with the other two it already supports. I copied off `scalatest` because it is fairly similar to MUnit. Hopefully I didn't forget to change anything after the copy and paste, particularly in the documentation (the test is green, at least).

kevinmeredith · 2020-07-13T16:10:26Z

modules/docs/src/main/mdoc/docs/06-Checking.md

@@ -99,7 +99,7 @@ def biggerThan2(minPop: Int) =
 biggerThan2(0).check.unsafeRunSync
 ```

-**doobie** supports `check` for queries and updates in three ways: programmatically, via YOLO mode in the REPL, and via the `doobie-specs2` and `doobie-scalatest` packages, which allow checking to become part of your unit test suite. We will investigate this in the chapter on testing.
+**doobie** supports `check` for queries and updates in four ways: programmatically, via YOLO mode in the REPL, and via the `doobie-specs2`, `doobie-scalatest` and `doobie-munit` packages, which allow checking to become part of your unit test suite. We will investigate this in the chapter on testing.


Take or leave it: might a bulleted list be easier to view?

I think that's a reasonable idea; the general principle of the PR was to try to stick closely with what's there. We'll see what @tpolecat says.

idm what's currently here, since it's featured prominantly in 13-Unit-Testing.md :)

kevinmeredith · 2020-07-13T16:11:05Z

modules/docs/src/main/mdoc/docs/13-Unit-Testing.md

+```scala mdoc:silent
+import munit._
+
+class AnalysisTestScalaCheck extends FunSuite with doobie.munit.IOChecker {


Does FunSuite come from munit, @Kazark ?

alejandrohdezma · 2020-11-18T17:16:04Z

Hi @tpolecat, any chance on taking a look at this? I've been copying @Kazark implementation around and it will be super if we could have this integration out of the box 😸

tpolecat · 2020-11-18T17:19:09Z

This looks fine, sorry for the delay. I'll merge it if you bring it up to date.

Kazark · 2020-11-18T17:55:21Z

Thanks @alejandrohdezma

alejandrohdezma · 2020-11-18T17:55:37Z

@tpolecat done! I've included an update of the setup-scala Github Action since the build was broken without it

alejandrohdezma · 2021-01-28T08:52:27Z

Hey @tpolecat, I have conform doobie-munit with the latest changes in doobie-specs2. Do you think this is ready to merge now?

modules/munit/src/test/scala/doobie/munit/CheckerTests.scala

FunFunFine · 2021-02-16T11:01:45Z

So when can we expect this one released?

jatcwang · 2021-02-16T11:37:29Z

There are a few thing left that we need to release 0.11 so I've asked Rob to look at a few important PRs (including this one). No ETA sorry.

ValdemarGr · 2021-03-30T14:41:30Z

modules/munit/src/main/scala/doobie/munit/analysisspec.scala

+      val report = analyzeIO(args, transactor).unsafeRunSync()
+      if (!report.succeeded) {
+        fail(
+          formatReport(args, report, colors)
+            .padLeft("  ")
+            .toString
+        )
+      }


Wouldn't levering https://github.com/typelevel/munit-cats-effect be a better choice?
Something like.

Suggested change

val report = analyzeIO(args, transactor).unsafeRunSync()

if (!report.succeeded) {

fail(

formatReport(args, report, colors)

.padLeft(" ")

.toString

)

}

val report = analyzeIO(args, transactor)

report.flatMap{

case r if !r.succeeded =>

IO(fail(

formatReport(args, report, colors)

.padLeft(" ")

.toString

))

case _ => IO.unit

}

I have implemented the munit-cats-effect integration at
https://github.com/ValdemarGr/doobie/tree/munit
Can someone give any insight or consideration for the idea?

Sounds like a good idea. It'll also make CE3 migration easier

This implementation also changes the semantics of check; it is no longer eager, is this desired?
The scalatest and specs2 test utilities seem to be eager.

If execution thread gets to check(..) then we're running the test already right? (This PR's impl seems eager to me, unless I'm missing something)

munit (and all other test frameworks that I know) all use call-by-name to allow skipping tests, so test("asdf") { check(..) } is still skippable even if check is eager.

I mean the evaluation of the check effect.
In the initially proposed solution check runs eagerly which fails the following test:
https://github.com/ValdemarGr/doobie/blob/6ad3f9414bc7cb6f1a1bbe1e65789315bc38dd08/modules/munit/src/test/scala/doobie/munit/CheckerTests.scala#L31-L34
In the version I published the test combinator is wrapped here (I think):
https://github.com/typelevel/munit-cats-effect/blob/65604236d2a8c18bf077b5c1269ff02ce54027b7/ce3/shared/src/main/scala/munit/CatsEffectSuite.scala#L38
Thus the test succeeds in the munit-cats-effect variant:
https://github.com/ValdemarGr/doobie/blob/ebbd0ccc475bf21dd5ebee4967741c4ff0263992/modules/munit/src/test/scala/doobie/munit/CheckerTests.scala#L33-L36

Ah yeah I think the other integrations (scalatest/specs) run it eagerly. Perhaps it is worth keeping that behaviour to make it easier for people to migrate between test libs. (I know that in my codebase I have a few check(..) being called as if they're statements)

So I guess cats-effect munit won't help us here. Sorry!

hamnis · 2021-05-20T09:21:22Z

at $WORK we would really like to leave scalatest in the dust, so this would help a lot. Can we get this going again?

jatcwang · 2021-05-20T21:42:23Z

Sorry just saw that I needed to approve the CI.
@tpolecat I've approved the PR. Merge it if you're happy with it too :)

jatcwang · 2021-05-23T18:43:56Z

Thanks for the PR and sorry for the delay! I'll get this merged into the cats-effect 3 (1.x) branch too.

Keith Pinson added 2 commits July 13, 2020 11:54

fix: header check requires the copyright to have expired to years ago

ff5e0ce

BusyByte approved these changes Jul 13, 2020

View reviewed changes

kevinmeredith reviewed Jul 13, 2020

View reviewed changes

kevinmeredith approved these changes Jul 13, 2020

View reviewed changes

alejandrohdezma added 6 commits November 18, 2020 18:25

Merge branch 'master' into munit

b11538c

Update MUnit version

d641056

Avoid Auto-application to () is deprecated error

1d96dfe

Pass Location around so failure occurs at the check call

662a4dc

Update setup-scala Github Action to latest version to fix build fail

32f2de3

Re-create headers

357e6d4

alejandrohdezma added 3 commits January 19, 2021 07:47

Merge branch 'master' into munit

0ecf3b5

Conform doobie-munit with doobie-specs2

229e833

Merge branch 'master' into munit

c50c210

alejandrohdezma added 2 commits January 28, 2021 10:25

Update MUnit version so it works in Scala 3

5693893

docs should depend on munit

991b1fd

jatcwang self-requested a review January 28, 2021 11:17

munit package has to be imported as _root_.munit

f89be9b

jatcwang reviewed Feb 9, 2021

View reviewed changes

modules/munit/src/test/scala/doobie/munit/CheckerTests.scala Show resolved Hide resolved

alejandrohdezma added 3 commits February 10, 2021 12:05

Merge branch 'master' into munit

13ea0c0

Add failing assertion and conform with specs2 tests

539e1da

Merge branch 'master' into munit

6a3d5a3

jatcwang approved these changes Feb 15, 2021

View reviewed changes

alejandrohdezma and others added 4 commits February 16, 2021 14:37

Merge branch 'master' into munit

a16dda7

Merge branch 'master' into munit

b161a60

Merge branch 'master' into munit

e426df8

Merge branch 'master' into munit

936f03e

ValdemarGr reviewed Mar 30, 2021

View reviewed changes

jatcwang and others added 4 commits April 5, 2021 11:49

Merge branch 'master' into munit

1a281b8

Merge branch 'master' into munit

4ec4730

Merge branch 'master' into munit

5b488a2

Merge branch 'master' into munit

9955bee

Merge branch 'master' into munit

703211c

Kazark and others added 2 commits May 21, 2021 09:05

Update build.sbt

4b3b84b

Merge branch 'master' into munit

176a5a1

jatcwang merged commit a8021d1 into typelevel:master May 23, 2021

Kazark deleted the munit branch May 24, 2021 14:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add doobie-munit package to integrate Doobie with the shiny new MUnit #1233

Add doobie-munit package to integrate Doobie with the shiny new MUnit #1233

Kazark commented Jul 13, 2020

kevinmeredith Jul 13, 2020

Kazark Jul 13, 2020

jatcwang Feb 9, 2021

kevinmeredith Jul 13, 2020

Kazark Jul 13, 2020

alejandrohdezma commented Nov 18, 2020

tpolecat commented Nov 18, 2020

Kazark commented Nov 18, 2020

alejandrohdezma commented Nov 18, 2020 •

edited

Loading

alejandrohdezma commented Jan 28, 2021

FunFunFine commented Feb 16, 2021

jatcwang commented Feb 16, 2021

ValdemarGr Mar 30, 2021 •

edited

Loading

ValdemarGr Mar 30, 2021

jatcwang Mar 30, 2021

ValdemarGr Mar 30, 2021

jatcwang Mar 30, 2021

ValdemarGr Mar 30, 2021 •

edited

Loading

jatcwang Mar 30, 2021

hamnis commented May 20, 2021

jatcwang commented May 20, 2021

jatcwang commented May 23, 2021

Add doobie-munit package to integrate Doobie with the shiny new MUnit #1233

Add doobie-munit package to integrate Doobie with the shiny new MUnit #1233

Conversation

Kazark commented Jul 13, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alejandrohdezma commented Nov 18, 2020

tpolecat commented Nov 18, 2020

Kazark commented Nov 18, 2020

alejandrohdezma commented Nov 18, 2020 • edited Loading

alejandrohdezma commented Jan 28, 2021

FunFunFine commented Feb 16, 2021

jatcwang commented Feb 16, 2021

ValdemarGr Mar 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ValdemarGr Mar 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamnis commented May 20, 2021

jatcwang commented May 20, 2021

jatcwang commented May 23, 2021

alejandrohdezma commented Nov 18, 2020 •

edited

Loading

ValdemarGr Mar 30, 2021 •

edited

Loading

ValdemarGr Mar 30, 2021 •

edited

Loading