feat: [+] Custom matchers for DoricErrors testing (issue hablapps#212)

core/src/test/scala/doric/matchers/CustomMatchers.scala

@@ -0,0 +1,30 @@
+package doric.matchers
+
+import cats.data.NonEmptyChain
+import doric.sem.{DoricMultiError, DoricSingleError}
+import org.scalatest._
+import matchers._
+
+/**
+  * Object to ease the import
+  */
+object CustomMatchers extends CustomMatchers
+
+/**
+  * Custom Doric errors matcher
+  */
+trait CustomMatchers {
+  class DoricErrorMatcher(exception: DoricSingleError*)
+      extends Matcher[DoricMultiError] {
+    override def apply(multiError: DoricMultiError): MatchResult = MatchResult(
+      matches = multiError.errors == NonEmptyChain(exception),
+      rawFailureMessage =
+        s"Expected\n${NonEmptyChain(exception)}\nbut found\n${multiError.errors}",
+      rawNegatedFailureMessage = s"Doric errors expected and found:\n${multiError.errors}"
+    )
+  }
+
+  def includeErrors(exception: DoricSingleError*) = new DoricErrorMatcher(
+    exception: _*
+  )
+}

core/src/test/scala/doric/syntax/DStructOpsSpec.scala

@@ -1,25 +1,25 @@
 package doric
 package syntax
 
-import doric.sem.{ChildColumnNotFound, ColumnTypeError}
+import cats.data.NonEmptyChain
+import doric.matchers.CustomMatchers.includeErrors
+import doric.sem.{ChildColumnNotFound, ColumnTypeError, DoricMultiError}
 import org.scalatest.EitherValues
 import org.scalatest.matchers.should.Matchers
-
 import org.apache.spark.sql.types.{IntegerType, StringType}
 
 case class User(name: String, surname: String, age: Int)
 
 class DStructOpsSpec extends DoricTestElements with EitherValues with Matchers {
 
-  import doric.implicitConversions.stringCname
   import spark.implicits._
 
   private val df = List((User("John", "doe", 34), 1))
     .toDF("col", "delete")
     .select("col")
 
-  describe("Dinamic struct column") {
-    it("can get values subcolumns") {
+  describe("Dynamic struct column") {
+    it("can get values sub-columns") {
       df.validateColumnType(colStruct("col").getChild[String]("name"))
       df.validateColumnType(colStruct("col").getChild[Int]("age"))
     }
@@ -48,14 +48,21 @@ class DStructOpsSpec extends DoricTestElements with EitherValues with Matchers {
     }
 
     it("throws an error if the sub column is not of the provided type") {
-      colStruct("col")
-        .getChild[String]("age")
-        .elem
-        .run(df)
-        .toEither
-        .left
-        .value
-        .head shouldBe ColumnTypeError("age", StringType, IntegerType)
+      intercept[DoricMultiError] {
+        df.select(colStruct("col").getChild[String]("age"))
+      } should includeErrors(
+        ColumnTypeError("age", StringType, IntegerType),
+        ColumnTypeError("agea", StringType, IntegerType),
+      )
+//      err shouldBe ColumnTypeError("age", StringType, IntegerType)
+//      colStruct("col")
+//        .getChild[String]("age")
+//        .elem
+//        .run(df)
+//        .toEither
+//        .left
+//        .value
+//        .head shouldBe ColumnTypeError("age", StringType, IntegerType)
     }
   }