#244

Build # #244

Build Type

push

Committed by

Commit Message

<a href="https://github.com/evolution-gaming/cats-helper/commit/<a class=hub.com/evolution-gaming/cats-helper/commit/<a class="double-link" href="https://git"><a class=hub.com/evolution-gaming/cats-helper/commit/<a class="double-link" href="https://git"><a class=hub.com/evolution-gaming/cats-helper/commit/<a class="double-link" href="https://git"><a class=hub.com/evolution-gaming/cats-helper/commit/16bf39174a011ea1e7d4cdab9ca987b632a5557e">16bf39174">&lt;a href=&quot;https://github.com/evolution-gaming/cats-helper/commit/</a><a class="double-link" href="https://github.com/evolution-gaming/cats-helper/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/evolution-gaming/cats-helper/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/evolution-gaming/cats-helper/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/evolution-gaming/cats-helper/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/evolution-gaming/cats-helper/commit/16bf39174a011ea1e7d4cdab9ca987b632a5557e">16bf39174</a><a href="https://github.com/evolution-gaming/cats-helper/commit/16bf39174a011ea1e7d4cdab9ca987b632a5557e">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/evolution-gaming/cats-helper/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/evolution-gaming/cats-helper/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/evolution-gaming/cats-helper/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/evolution-gaming/cats-helper/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/evolution-gaming/cats-helper/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/evolution-gaming/cats-helper/commit/16bf39174a011ea1e7d4cdab9ca987b632a5557e&quot;&gt;16bf39174&lt;/a&gt;&lt;a href=&quot;https://github.com/evolution-gaming/cats-helper/commit/16bf39174a011ea1e7d4cdab9ca987b632a5557e&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com... (continued)

Run Details

11 of 11 new or added lines in 1 file covered. (100.0%)

305 of 439 relevant lines covered (69.48%)

0.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.0

/testkit/src/main/scala/com/evolutiongaming/catshelper/testkit/TestFrameworkApi.scala

package com.evolutiongaming.catshelper.testkit

import cats.effect.IO
import cats.effect.laws.util.TestContext
import cats.implicits._
import org.scalatest.exceptions.{TestCanceledException, TestFailedException}

/**
 * EXPERIMENTAL. Abstracts interactions with a test framework.
 */
trait TestFrameworkApi {
  /**
   * Signals a completion of a test.
   *
   * @param outcome an outcome which can be non-termination, failure, or success.
   * @param tcState `TestContext` state at the moment of completion.
   */
  def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A]
}

object TestFrameworkApi {
  /**
   * Returns either a default API (ScalaTest as of now) if it's available on the classpath.
   * Uses [[NoFrameworkApi]] as a fallback.
   */
  def resolveDefault(implicit l: Lookup): TestFrameworkApi = l.instance

  private[testkit] trait Lookup {
    def instance: TestFrameworkApi
  }

  private[testkit] object Lookup extends LookupLowPriority {
    implicit def scalaTestIsDefault(implicit ev: TestFailedException =:= TestFailedException): Lookup = {
      if (ev == null) () else ()  // A kludge to avoid "unused" warning :(
      new Lookup {
        def instance: TestFrameworkApi = ScalaTestApi
      }
    }
  }

  private[testkit] sealed trait LookupLowPriority {
    implicit def fallbackToNoFramework: Lookup = new Lookup {
      def instance: TestFrameworkApi = NoFrameworkApi
    }
  }
}

/**
 * A stub implementation to use when no test framework is available.
 */
object NoFrameworkApi extends TestFrameworkApi {
  def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A] = {
    IO.fromEither(outcome.toRight(new IllegalStateException(s"Not completed. State: $tcState")).flatten)
  }
}

/**
 * ScalaTest integration.
 */
private[testkit] object ScalaTestApi extends TestFrameworkApi {
  def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A] = IO {
    def boo(cause: Either[Throwable, String]): Nothing = {
      val err = cause match {
        case Left(e: TestFailedException)   => e
        case Left(e: TestCanceledException) => e
        case abnormal                       => AbnormalTermination(abnormal, tcState)
      }
      throw err
    }

    outcome match {
      case Some(Right(a)) => a
      case Some(Left(e))  => boo(Left(e))
      case None           => boo(Right("Not completed"))
    }
  }
}

1	package com.evolutiongaming.catshelper.testkit
2
3	import cats.effect.IO
4	import cats.effect.laws.util.TestContext
5	import cats.implicits._
6	import org.scalatest.exceptions.{TestCanceledException, TestFailedException}
7
8	/**
9	* EXPERIMENTAL. Abstracts interactions with a test framework.
10	*/
11	trait TestFrameworkApi {
12	/**
13	* Signals a completion of a test.
14	*
15	* @param outcome an outcome which can be non-termination, failure, or success.
16	* @param tcState `TestContext` state at the moment of completion.
17	*/
18	def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A]
19	}
20
21	object TestFrameworkApi {
22	/**
23	* Returns either a default API (ScalaTest as of now) if it's available on the classpath.
24	* Uses [[NoFrameworkApi]] as a fallback.
25	*/
26	def resolveDefault(implicit l: Lookup): TestFrameworkApi = l.instance	1✔
27
28	private[testkit] trait Lookup {
29	def instance: TestFrameworkApi
30	}
31
32	private[testkit] object Lookup extends LookupLowPriority {
33	implicit def scalaTestIsDefault(implicit ev: TestFailedException =:= TestFailedException): Lookup = {
34	if (ev == null) () else () // A kludge to avoid "unused" warning :(	×
35	new Lookup {	1✔
36	def instance: TestFrameworkApi = ScalaTestApi
37	}
38	}
39	}
40
41	private[testkit] sealed trait LookupLowPriority {
42	implicit def fallbackToNoFramework: Lookup = new Lookup {	×
43	def instance: TestFrameworkApi = NoFrameworkApi
44	}
45	}
46	}
47
48	/**
49	* A stub implementation to use when no test framework is available.
50	*/
51	object NoFrameworkApi extends TestFrameworkApi {
52	def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A] = {
53	IO.fromEither(outcome.toRight(new IllegalStateException(s"Not completed. State: $tcState")).flatten)	×
54	}
55	}
56
57	/**
58	* ScalaTest integration.
59	*/
60	private[testkit] object ScalaTestApi extends TestFrameworkApi {
61	def completeWith[A](outcome: Option[Either[Throwable, A]], tcState: TestContext.State): IO[A] = IO {	1✔
62	def boo(cause: Either[Throwable, String]): Nothing = {
63	val err = cause match {
64	case Left(e: TestFailedException) => e
65	case Left(e: TestCanceledException) => e
66	case abnormal => AbnormalTermination(abnormal, tcState)	1✔
67	}
68	throw err	1✔
69	}
70
71	outcome match {
72	case Some(Right(a)) => a
73	case Some(Left(e)) => boo(Left(e))	1✔
74	case None => boo(Right("Not completed"))	1✔
75	}
76	}
77	}

evolution-gaming / cats-helper / #244

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous