Add integration with munit

Author: ghostbuster91

build.sbt

@@ -117,6 +117,22 @@ lazy val utest = (projectMatrix in file("utest"))
     scalaVersions = List(scala212, scala213)
   )
 
+lazy val munit = (projectMatrix in file("munit"))
+  .settings(commonSettings)
+  .settings(
+    name := "diffx-munit",
+    libraryDependencies ++= Seq(
+      "org.scalameta" %%% "munit" % "0.7.26"
+    )
+  )
+  .dependsOn(core)
+  .jvmPlatform(
+    scalaVersions = List(scala212, scala213)
+  )
+  .jsPlatform(
+    scalaVersions = List(scala212, scala213)
+  )
+
 lazy val tagging = (projectMatrix in file("tagging"))
   .settings(commonSettings)
   .settings(
@@ -189,7 +205,7 @@ lazy val docs = (projectMatrix in file("generated-docs")) // important: it must
     ),
     mdocOut := file("generated-docs/out")
   )
-  .dependsOn(core, scalatest, specs2, utest, refined, tagging, cats)
+  .dependsOn(core, scalatest, specs2, utest, refined, tagging, cats, munit)
   .jvmPlatform(scalaVersions = List(scala213))
 
 val testJVM = taskKey[Unit]("Test JVM projects")
@@ -198,7 +214,7 @@ val testJS = taskKey[Unit]("Test JS projects")
 val allAggregates =
   core.projectRefs ++ scalatest.projectRefs ++
     specs2.projectRefs ++ utest.projectRefs ++ cats.projectRefs ++
-    refined.projectRefs ++ tagging.projectRefs ++ docs.projectRefs
+    refined.projectRefs ++ tagging.projectRefs ++ docs.projectRefs ++ munit.projectRefs
 
 def filterProject(p: String => Boolean) =
   ScopeFilter(inProjects(allAggregates.filter(pr => p(display(pr.project))): _*))

docs-sources/index.md

@@ -76,6 +76,7 @@ a software development and consulting company. We help clients scale their busin
    test-frameworks/scalatest
    test-frameworks/specs2
    test-frameworks/utest
+   test-frameworks/munit
    test-frameworks/summary
    
 .. toctree::

docs-sources/test-frameworks/munit.md

@@ -0,0 +1,44 @@
+# munit
+
+To use with munit, add following dependency:
+
+## sbt
+
+```scala
+"com.softwaremill.diffx" %% "diffx-munit" % "@VERSION@" % Test
+```
+
+## mill
+
+```scala
+ivy"com.softwaremill.diffx::diffx-munit::@VERSION@"
+```
+
+## Usage
+
+Then, mixin `DiffxAssertions` trait or add `import com.softwaremill.diffx.munit.DiffxAssertions._` to your test code.
+To assert using diffx use `assertEquals` as follows:
+
+```scala mdoc:compile-only
+import com.softwaremill.diffx.munit.DiffxAssertions._
+import com.softwaremill.diffx.generic.auto._
+
+sealed trait Parent
+case class Bar(s: String, i: Int) extends Parent
+case class Foo(bar: Bar, b: List[Int], parent: Option[Parent]) extends Parent
+
+val right: Foo = Foo(
+    Bar("asdf", 5),
+    List(123, 1234),
+    Some(Bar("asdf", 5))
+)
+
+val left: Foo = Foo(
+    Bar("asdf", 66),
+    List(1234),
+    Some(right)
+)
+
+assertEqual(left, right)
+```
+

docs-sources/test-frameworks/summary.md

@@ -4,6 +4,7 @@ Following test frameworks are supported by diffx:
 - [scalatest](scalatest.md)
 - [specs2](specs2.md)
 - [utest](utest.md)
+- [munit](munit.md)
 
 Didn't find your favourite testing library? Don't hesitate and let us know, or you can add it on your own ,
 as all that needs to be done is to call `compare` function.

generated-docs/out/index.md

@@ -115,6 +115,7 @@ a software development and consulting company. We help clients scale their busin
    test-frameworks/scalatest
    test-frameworks/specs2
    test-frameworks/utest
+   test-frameworks/munit
    test-frameworks/summary
    
 .. toctree::

generated-docs/out/test-frameworks/munit.md

@@ -0,0 +1,44 @@
+# munit
+
+To use with munit, add following dependency:
+
+## sbt
+
+```scala
+"com.softwaremill.diffx" %% "diffx-munit" % "0.5.1" % Test
+```
+
+## mill
+
+```scala
+ivy"com.softwaremill.diffx::diffx-munit::0.5.1"
+```
+
+## Usage
+
+Then, mixin `DiffxAssertions` trait or add `import com.softwaremill.diffx.munit.DiffxAssertions._` to your test code.
+To assert using diffx use `assertEquals` as follows:
+
+```scala
+import com.softwaremill.diffx.munit.DiffxAssertions._
+import com.softwaremill.diffx.generic.auto._
+
+sealed trait Parent
+case class Bar(s: String, i: Int) extends Parent
+case class Foo(bar: Bar, b: List[Int], parent: Option[Parent]) extends Parent
+
+val right: Foo = Foo(
+    Bar("asdf", 5),
+    List(123, 1234),
+    Some(Bar("asdf", 5))
+)
+
+val left: Foo = Foo(
+    Bar("asdf", 66),
+    List(1234),
+    Some(right)
+)
+
+assertEqual(left, right)
+```
+

generated-docs/out/test-frameworks/summary.md

@@ -4,6 +4,7 @@ Following test frameworks are supported by diffx:
 - [scalatest](scalatest.md)
 - [specs2](specs2.md)
 - [utest](utest.md)
+- [munit](munit.md)
 
 Didn't find your favourite testing library? Don't hesitate and let us know, or you can add it on your own ,
 as all that needs to be done is to call `compare` function.

munit/src/main/scala/com/softwaremill/diffx/munit/DiffxAssertions.scala

@@ -0,0 +1,17 @@
+package com.softwaremill.diffx.munit
+
+import com.softwaremill.diffx.{ConsoleColorConfig, Diff, DiffResultDifferent}
+import munit.Assertions._
+import munit.Location
+
+trait DiffxAssertions {
+  def assertEqual[T: Diff](t1: T, t2: T)(implicit c: ConsoleColorConfig, loc: Location): Unit = {
+    val result = Diff.compare(t1, t2)
+    result match {
+      case different: DiffResultDifferent => fail(different.show())(loc)
+      case _                              => // do nothing
+    }
+  }
+}
+
+object DiffxAssertions extends DiffxAssertions

munit/src/test/scala/com/softwaremill/diffx/munit/MunitAssertTest.scala

@@ -0,0 +1,18 @@
+package com.softwaremill.diffx.munit
+
+import com.softwaremill.diffx.generic.auto._
+
+class MunitAssertTest extends munit.FunSuite with DiffxAssertions {
+//   uncomment to run
+//  test("failing test") {
+//    val n = Person("n1", 11)
+//    assertEqual(n, Person("n2", 12))
+//  }
+
+  test("hello") {
+    val n = Person("n1", 11)
+    assertEqual(n, Person("n1", 11))
+  }
+}
+
+case class Person(name: String, age: Int)