abstract class HttpSuite extends Http4sSuite[Unit] with CatsEffectFunFixtures
Base class for suites testing remote HTTP servers.
To use this class you'll need to provide the Uri of the remote container by
overriding baseUri.
import io.circe.Json import org.http4s.Method.GET import org.http4s.Uri import org.http4s.circe._ import org.http4s.client.dsl.io._ import org.http4s.syntax.all._ class HttpSuiteSuite extends munit.HttpSuite { override def baseUri(): Uri = uri"https://api.github.com" test(GET(uri"users/gutiory")) { response => assertEquals(response.status.code, 200) val result = response.as[Json].map(_.hcursor.get[String]("login")) assertIO(result, Right("gutiory")) } }
Example:
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- HttpSuite
- Http4sSuite
- CatsEffectSuite
- CatsEffectFunFixtures
- CatsEffectAssertions
- FunSuite
- ValueTransforms
- SuiteTransforms
- TestTransforms
- TestOptionsConversions
- FunFixtures
- Assertions
- CompileErrorMacro
- Suite
- PlatformSuite
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new HttpSuite()
Type Members
- case class Http4sMUnitTestCreator(request: ContextRequest[IO, A], followingRequests: List[(String, (Response[IO]) => IO[ContextRequest[IO, A]])] = Nil, testOptions: TestOptions = TestOptions(""), config: Http4sMUnitConfig = Http4sMUnitConfig.default) extends Product with Serializable
- Definition Classes
- Http4sSuite
- final type AfterEach = GenericAfterEach[TestValue]
- Definition Classes
- Suite
- final type BeforeEach = GenericBeforeEach[TestValue]
- Definition Classes
- Suite
- abstract class Fixture[T] extends AnyRef
- Definition Classes
- Suite
- class FunFixture[T] extends AnyRef
- Definition Classes
- FunFixtures
- implicit class Http4sMUnitTestCreatorOps extends AnyRef
- implicit class MUnitCatsAssertionsForIOBooleanOps extends AnyRef
- Definition Classes
- CatsEffectAssertions
- implicit class MUnitCatsAssertionsForIOOps[A] extends AnyRef
- Definition Classes
- CatsEffectAssertions
- implicit class MUnitCatsAssertionsForSyncIOOps[A] extends AnyRef
- Definition Classes
- CatsEffectAssertions
- final class SuiteTransform extends (List[FunSuite.Test]) => List[FunSuite.Test]
- Definition Classes
- SuiteTransforms
- implicit class SyncIOFunFixtureOps[T] extends AnyRef
- Definition Classes
- CatsEffectFunFixtures
- final type Test = GenericTest[TestValue]
- Definition Classes
- Suite
- final class TestTransform extends (FunSuite.Test) => FunSuite.Test
- Definition Classes
- TestTransforms
- final type TestValue = Future[Any]
- Definition Classes
- FunSuite → Suite
- final class ValueTransform extends (Any) => Option[Future[Any]]
- Definition Classes
- ValueTransforms
Abstract Value Members
- abstract def baseUri(): Uri
The base URI for all tests.
The base URI for all tests. This URI will prepend the one used in each test's request.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def afterAll(): Unit
- Definition Classes
- Suite
- def afterEach(context: AfterEach): Unit
- Definition Classes
- Suite
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def assert(cond: => Boolean, clue: => Any)(implicit loc: Location): Unit
- Definition Classes
- Assertions
- def assertEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: <:<[B, A]): Unit
- Definition Classes
- Assertions
- def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: => Any)(implicit loc: Location): Unit
- Definition Classes
- Assertions
- def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: => Any)(implicit loc: Location): Unit
- Definition Classes
- Assertions
- def assertIO[A, B](obtained: IO[A], returns: B, clue: => Any)(implicit loc: Location, ev: <:<[B, A]): IO[Unit]
- Definition Classes
- CatsEffectAssertions
- def assertIOBoolean(obtained: IO[Boolean], clue: => Any)(implicit loc: Location): IO[Unit]
- Attributes
- protected
- Definition Classes
- CatsEffectAssertions
- def assertNoDiff(obtained: String, expected: String, clue: => Any)(implicit loc: Location): Unit
- Definition Classes
- Assertions
- def assertNotEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: =:=[A, B]): Unit
- Definition Classes
- Assertions
- def assertSyncIO[A, B](obtained: SyncIO[A], returns: B, clue: => Any)(implicit loc: Location, ev: <:<[B, A]): SyncIO[Unit]
- Definition Classes
- CatsEffectAssertions
- def assume(cond: Boolean, clue: => Any)(implicit loc: Location): Unit
- Definition Classes
- Assertions
- def beforeAll(): Unit
- Definition Classes
- Suite
- def beforeEach(context: BeforeEach): Unit
- Definition Classes
- Suite
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def clue[T](c: Clue[T]): T
- Definition Classes
- Assertions
- def clues(clue: Clue[_]*): Clues
- Definition Classes
- Assertions
- macro def compileErrors(code: String): String
- Definition Classes
- CompileErrorMacro
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fail(message: String, clues: Clues)(implicit loc: Location): Nothing
- Definition Classes
- Assertions
- def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing
- Definition Classes
- Assertions
- def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing
- Definition Classes
- Assertions
- def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing
- Definition Classes
- Assertions
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def http4sMUnitBodyPrettifier(body: String): String
Allows pretiffing the response's body before outputting it to logs.
Allows pretiffing the response's body before outputting it to logs.
By default it will try to parse it as JSON and apply a code highlight if
munitAnsiColorsistrue.- body
the response's body to prettify
- returns
the prettified version of the response's body
- Definition Classes
- Http4sSuite
- def http4sMUnitClient: Resource[IO, Client[IO]]
This client is used under the hood to execute the requests.
This client is used under the hood to execute the requests.
Override it if you want to use a different implementation or if you want to initalize it in any way out of the default one (different timeouts, SSL certificates...).
- def http4sMUnitFunFixture: SyncIO[FunFixture[(ContextRequest[IO, Unit]) => Resource[IO, Response[IO]]]]
Base fixture used to obtain a response from a request.
Base fixture used to obtain a response from a request. Can be re-implemented if you want to override the default behaviour of a suite.
- Definition Classes
- HttpSuite → Http4sSuite
- def http4sMUnitNameCreator(request: ContextRequest[IO, Unit], followingRequests: List[String], testOptions: TestOptions, config: Http4sMUnitConfig): String
Allows altering the name of the generated tests.
Allows altering the name of the generated tests.
By default it will generate test names like:
// GET -> users/42 test(GET(uri"users" / 42)) // GET -> users (All users) test(GET(uri"users")).alias("All users") // GET -> users as user-1 test(GET(uri"users").as("user-1")) // GET -> users - executed 10 times with 2 in parallel test(GET(uri"users")).repeat(10).parallel(2) // GET -> users (retrieve the list of users and get the first user from the list) test(GET(uri"users")) .alias("retrieve the list of users") .andThen("get the first user from the list")(_.as[List[User]].flatMap { case Nil => fail("The list of users should not be empty") case (head: User) :: _ => GET(uri"users" / head.id.show) })
- request
the test's request
- followingRequests
the following request' aliases
- testOptions
the options for the current test
- config
the configuration for this test
- returns
the test's name
- Definition Classes
- Http4sSuite
- def intercept[T <: Throwable](body: => Any)(implicit T: ClassTag[T], loc: Location): T
- Definition Classes
- Assertions
- def interceptIO[T <: Throwable](io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]
- Definition Classes
- CatsEffectAssertions
- def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: => Any)(implicit T: ClassTag[T], loc: Location): T
- Definition Classes
- Assertions
- def interceptMessageIO[T <: Throwable](expectedExceptionMessage: String)(io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]
- Definition Classes
- CatsEffectAssertions
- def interceptMessageSyncIO[T <: Throwable](expectedExceptionMessage: String)(io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]
- Definition Classes
- CatsEffectAssertions
- def interceptSyncIO[T <: Throwable](io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]
- Definition Classes
- CatsEffectAssertions
- def isCI: Boolean
- Definition Classes
- SuiteTransforms
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def munitAnsiColors: Boolean
- Definition Classes
- Assertions
- def munitCaptureClues[T](thunk: => T): (T, Clues)
- Definition Classes
- Assertions
- implicit def munitContextShift: ContextShift[IO]
- Definition Classes
- CatsEffectSuite
- def munitExecutionContext: ExecutionContext
- Definition Classes
- Suite
- final def munitFailTransform: TestTransform
- Definition Classes
- TestTransforms
- def munitFixtures: Seq[Fixture[_]]
- Definition Classes
- Suite
- def munitFlakyOK: Boolean
- Definition Classes
- TestTransforms
- final def munitFlakyTransform: TestTransform
- Definition Classes
- TestTransforms
- final def munitFutureTransform: ValueTransform
- Definition Classes
- ValueTransforms
- def munitIgnore: Boolean
- Definition Classes
- SuiteTransforms
- final def munitIgnoreSuiteTransform: SuiteTransform
- Definition Classes
- SuiteTransforms
- val munitLines: Lines
- Definition Classes
- Assertions
- final def munitOnlySuiteTransform: SuiteTransform
- Definition Classes
- SuiteTransforms
- def munitPrint(clue: => Any): String
- Definition Classes
- Assertions
- final def munitSuiteTransform(tests: List[Test]): List[Test]
- Definition Classes
- SuiteTransforms
- def munitSuiteTransforms: List[SuiteTransform]
- Definition Classes
- SuiteTransforms
- final def munitTestTransform(test: Test): Test
- Definition Classes
- TestTransforms
- def munitTestTransforms: List[TestTransform]
- Definition Classes
- TestTransforms
- def munitTests(): Seq[Test]
- Definition Classes
- FunSuite → Suite
- final val munitTestsBuffer: ListBuffer[Test]
- Definition Classes
- FunSuite
- def munitTimeout: Duration
- Definition Classes
- FunSuite
- implicit def munitTimer: Timer[IO]
- Definition Classes
- CatsEffectSuite
- final def munitValueTransform(testValue: => Any): Future[Any]
- Definition Classes
- ValueTransforms
- def munitValueTransforms: List[ValueTransform]
- Definition Classes
- CatsEffectSuite → ValueTransforms
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def test(request: IO[Request[IO]]): Http4sMUnitTestCreator
Declares a test for the provided request.
Declares a test for the provided request. That request will be executed using the provided client in
httpClientto the server indicated inbaseUri.test(GET(uri"users" / 42)) { response => // test body }
, test(POST(json, uri"users")).alias("Create a new user") { response => // test body }
, test(GET(uri"users" / 42)).flaky { response => // test body }
Examples: - def test(options: TestOptions)(body: => Any)(implicit loc: Location): Unit
- Definition Classes
- FunSuite
- def test(name: String)(body: => Any)(implicit loc: Location): Unit
- Definition Classes
- FunSuite
- implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
- Definition Classes
- TestOptionsConversions
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object FunFixture
- Definition Classes
- FunFixtures
- object ResourceFixture
- Definition Classes
- CatsEffectFunFixtures