scodec-testkit
2.2.1
API
Generated with
scodec-testkit/scodec/CodecSuite

CodecSuite

scodec.CodecSuite
abstract class CodecSuite extends ScalaCheckSuite

Attributes

Source:
CodecSuite.scala
Graph
Supertypes
trait ScalaCheckSuite
class FunSuite
trait BaseFunSuite
trait ValueTransforms
trait SuiteTransforms
trait TestTransforms
trait TestOptionsConversions
trait FunFixtures
trait Assertions
trait CompileErrorMacro
class Suite
trait PlatformSuite
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Inherited classlikes

class FunFixture[T]

Attributes

Inherited from:
FunFixtures
Source:
FunFixtures.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object FunFixture

Attributes

Inherited from:
FunFixtures
Source:
FunFixtures.scala
Graph
Supertypes
class Object
trait Matchable
class Any
final class SuiteTransform(val name: String, fn: List[Test] => List[Test]) extends List[Test] => List[Test]

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
Graph
Supertypes
trait List[Test] => List[Test]
class Object
trait Matchable
class Any
final class TestTransform(val name: String, fn: Test => Test) extends Test => Test

Attributes

Inherited from:
TestTransforms
Source:
TestTransforms.scala
Graph
Supertypes
trait Test => Test
class Object
trait Matchable
class Any
final class ValueTransform(val name: String, fn: PartialFunction[Any, Future[Any]]) extends Any => Option[Future[Any]]

Attributes

Inherited from:
ValueTransforms
Source:
ValueTransforms.scala
Graph
Supertypes
trait Any => Option[Future[Any]]
class Object
trait Matchable
class Any

Inherited types

final type AfterEach = AfterEach

Attributes

Inherited from:
Suite
Source:
Suite.scala
final type BeforeEach = BeforeEach

Attributes

Inherited from:
Suite
Source:
Suite.scala
final type Fixture[T] = Fixture[T]

Attributes

Inherited from:
Suite
Source:
Suite.scala
final type Test = Test

Attributes

Inherited from:
Suite
Source:
Suite.scala
final type TestValue = Future[Any]

The value produced by test bodies.

The value produced by test bodies.

Attributes

Inherited from:
Suite
Source:
Suite.scala

Value members

Concrete methods

protected def assertBitsEqual(actual: BitVector, expected: BitVector)(using Location): Unit

Attributes

Source:
CodecSuite.scala
protected def definedSamples[A](gen: Gen[A]): LazyList[A]

Attributes

Source:
CodecSuite.scala
protected def encodeError[A](codec: Codec[A], a: A, err: Err)(using Location): Unit

Attributes

Source:
CodecSuite.scala
protected def roundtrip[A](a: A)(using c: Codec[A], l: Location): Unit

Attributes

Source:
CodecSuite.scala
protected def roundtrip[A](codec: Codec[A], value: A)(using Location): Unit

Attributes

Source:
CodecSuite.scala
protected def roundtripAll[A](codec: Codec[A], as: Iterable[A])(using Location): Unit

Attributes

Source:
CodecSuite.scala
protected def samples[A](gen: Gen[A]): LazyList[Option[A]]

Attributes

Source:
CodecSuite.scala
override def scalaCheckTestParameters: Parameters

Attributes

Definition Classes
ScalaCheckSuite
Source:
CodecSuite.scala
protected def shouldDecodeFullyTo[A](codec: Codec[A], buf: BitVector, expected: A)(using Location): Unit

Attributes

Source:
CodecSuite.scala
protected def time[A](f: => A): (A, FiniteDuration)

Attributes

Source:
CodecSuite.scala

Inherited methods

def afterAll(): Unit

Runs once after all test cases and after all suite-local fixtures have been tear down.

Runs once after all test cases and after all suite-local fixtures have been tear down.

Attributes

Inherited from:
Suite
Source:
Suite.scala
def afterEach(context: AfterEach): Unit

Runs after each individual test case.

Runs after each individual test case.

Attributes

Inherited from:
Suite
Source:
Suite.scala
def assert(cond: => Boolean, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assertEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, compare: Compare[A, B]): Unit

Asserts that two elements are equal according to the Compare[A, B] type-class.

Asserts that two elements are equal according to the Compare[A, B] type-class.

By default, uses == to compare values.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: => Any)(implicit loc: Location): Unit

Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.

Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: => Any)(implicit loc: Location): Unit

Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.

Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assertNoDiff(obtained: String, expected: String, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assertNotEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, compare: Compare[A, B]): Unit

Asserts that two elements are not equal according to the Compare[A, B] type-class.

Asserts that two elements are not equal according to the Compare[A, B] type-class.

By default, uses == to compare values.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def assume(cond: Boolean, clue: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def beforeAll(): Unit

Runs once before all test cases and before all suite-local fixtures are setup. An error in this method aborts the test suite.

Runs once before all test cases and before all suite-local fixtures are setup. An error in this method aborts the test suite.

Attributes

Inherited from:
Suite
Source:
Suite.scala
def beforeEach(context: BeforeEach): Unit

Runs before each individual test case. An error in this method aborts the test case.

Runs before each individual test case. An error in this method aborts the test case.

Attributes

Inherited from:
Suite
Source:
Suite.scala
def clue[T](c: Clue[T]): T

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def clues(clue: Clue[_]*): Clues

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
inline def compileErrors(inline code: String): String

Attributes

Inherited from:
CompileErrorMacro
Source:
MacroCompat.scala
def fail(message: String, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fails this test with the given message and optional clues.

Unconditionally fails this test with the given message and optional clues.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing

Unconditionally fails this test with the given message and exception marked as the cause.

Unconditionally fails this test with the given message and exception marked as the cause.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fails this test due to result of comparing two values.

Unconditionally fails this test due to result of comparing two values.

The only reason to use this method instead of fail() is if you want to allow comparing the two different values in the the IntelliJ GUI diff viewer.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing

Unconditionally fail this test case and cancel all the subsequent tests in this suite.

Unconditionally fail this test case and cancel all the subsequent tests in this suite.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def intercept[T <: Throwable](body: => Any)(implicit T: ClassTag[T], loc: Location): T

Evalutes the given expression and asserts that an exception of type T is thrown.

Evalutes the given expression and asserts that an exception of type T is thrown.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: => Any)(implicit T: ClassTag[T], loc: Location): T

Evalutes the given expression and asserts that an exception of type T with the expected message is thrown.

Evalutes the given expression and asserts that an exception of type T with the expected message is thrown.

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def isCI: Boolean

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
def munitAnsiColors: Boolean

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def munitCaptureClues[T](thunk: => T): (T, Clues)

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
def munitExecutionContext: ExecutionContext

Attributes

Inherited from:
Suite
Source:
Suite.scala
final def munitFailTransform: TestTransform

Attributes

Inherited from:
TestTransforms
Source:
TestTransforms.scala
def munitFixtures: Seq[AnyFixture[_]]

Fixtures that can be reused for individual test cases or entire suites.

Fixtures that can be reused for individual test cases or entire suites.

Attributes

Inherited from:
Suite
Source:
Suite.scala
def munitFlakyOK: Boolean

Attributes

Inherited from:
TestTransforms
Source:
TestTransforms.scala
final def munitFlakyTransform: TestTransform

Attributes

Inherited from:
TestTransforms
Source:
TestTransforms.scala
final def munitFutureTransform: ValueTransform

Attributes

Inherited from:
ValueTransforms
Source:
ValueTransforms.scala
def munitIgnore: Boolean

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
final def munitIgnoreSuiteTransform: SuiteTransform

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
final def munitOnlySuiteTransform: SuiteTransform

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
def munitPrint(clue: => Any): String

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
final def munitSuiteTransform(tests: List[Test]): List[Test]

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
def munitSuiteTransforms: List[SuiteTransform]

Attributes

Inherited from:
SuiteTransforms
Source:
SuiteTransforms.scala
final def munitTestTransform(test: Test): Test

Attributes

Inherited from:
TestTransforms
Source:
TestTransforms.scala
override def munitTestTransforms: List[TestTransform]

Attributes

Definition Classes
ScalaCheckSuite -> TestTransforms
Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
def munitTests(): Seq[Test]

The base class for all test suites

The base class for all test suites

Attributes

Inherited from:
BaseFunSuite
Source:
FunSuite.scala
def munitTimeout: Duration

Attributes

Inherited from:
BaseFunSuite
Source:
FunSuite.scala
final def munitValueTransform(testValue: => Any): Future[Any]

Attributes

Inherited from:
ValueTransforms
Source:
ValueTransforms.scala
def munitValueTransforms: List[ValueTransform]

Attributes

Inherited from:
ValueTransforms
Source:
ValueTransforms.scala
def property(options: TestOptions)(body: => Prop)(implicit loc: Location): Unit

Attributes

Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
def property(name: String)(body: => Prop)(implicit loc: Location): Unit

Attributes

Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
protected def scalaCheckInitialSeed: String

Attributes

Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
protected def scalaCheckPrettyParameters: Params

Attributes

Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
def test(options: TestOptions)(body: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
BaseFunSuite
Source:
FunSuite.scala
def test(name: String)(body: => Any)(implicit loc: Location): Unit

Attributes

Inherited from:
BaseFunSuite
Source:
FunSuite.scala

Inherited fields

val munitLines: Lines

Attributes

Inherited from:
Assertions
Source:
Assertions.scala
final val munitTestsBuffer: ListBuffer[Test]

Attributes

Inherited from:
BaseFunSuite
Source:
FunSuite.scala

Givens

Givens

Implicits

Inherited implicits

implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions

Implicitly create a TestOptions given a test name. This allows writing test("name") { ... } even if test accepts a TestOptions

Implicitly create a TestOptions given a test name. This allows writing test("name") { ... } even if test accepts a TestOptions

Attributes

Inherited from:
TestOptionsConversions
Source:
TestOptions.scala
implicit def unitToProp(unit: Unit): Prop

Attributes

Inherited from:
ScalaCheckSuite
Source:
ScalaCheckSuite.scala
Generated with