prometheus4cats-docs
2.0.0
API
Generated with
prometheus4cats-docs/prometheus4cats/prometheus4cats.testkit/RegistrySuite

RegistrySuite

prometheus4cats.testkit.RegistrySuite
trait RegistrySuite[State] extends ScalaCheckEffectSuite

Attributes

Source
RegistrySuite.scala
Graph
Supertypes
trait ScalaCheckSuite
class FunSuite
trait ValueTransforms
trait SuiteTransforms
trait TestTransforms
trait TestOptionsConversions
trait FunFixtures
trait Assertions
trait CompileErrorMacro
class Suite
trait PlatformSuite
class Object
trait Matchable
class Any
Show all
Known subtypes
trait CallbackRegistrySuite[State]
trait MetricRegistrySuite[State]
Self type
CatsEffectSuite

Members list

Type members

Inherited classlikes

abstract class Fixture[T](val fixtureName: String)

Value parameters

name

The name of this fixture, used for displaying an error message if beforeAll() or afterAll() fail.

Attributes

Inherited from:
Suite
Source
Suite.scala
Supertypes
class Object
trait Matchable
class Any
class FunFixture[T]

Attributes

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

Attributes

Inherited from:
FunFixtures
Source
FunFixtures.scala
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
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
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
Supertypes
trait Any => Option[Future[Any]]
class Object
trait Matchable
class Any

Inherited types

final type AfterEach = GenericAfterEach[TestValue]

Attributes

Inherited from:
Suite
Source
Suite.scala
final type BeforeEach = GenericBeforeEach[TestValue]

Attributes

Inherited from:
Suite
Source
Suite.scala
final type Test = GenericTest[TestValue]

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:
FunSuite
Source
FunSuite.scala

Value members

Abstract methods

def getCounterValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, extraLabels: Map[Name, String]): IO[Option[Double]]

Attributes

Source
RegistrySuite.scala
def getExemplarCounterValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, extraLabels: Map[Name, String]): IO[Option[(Double, Option[Map[String, String]])]]

Attributes

Source
RegistrySuite.scala
def getExemplarHistogramValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, buckets: NonEmptySeq[Double], extraLabels: Map[Name, String]): IO[Option[Map[String, (Double, Option[Map[String, String]])]]]

Attributes

Source
RegistrySuite.scala
def getGaugeValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, extraLabels: Map[Name, String]): IO[Option[Double]]

Attributes

Source
RegistrySuite.scala
def getHistogramValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, buckets: NonEmptySeq[Double], extraLabels: Map[Name, String]): IO[Option[Map[String, Double]]]

Attributes

Source
RegistrySuite.scala
def getSummaryValue(state: State, prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, extraLabels: Map[Name, String]): IO[(Option[Map[String, Double]], Option[Double], Option[Double])]

Attributes

Source
RegistrySuite.scala
def stateResource: Resource[IO, State]

Attributes

Source
RegistrySuite.scala

Concrete methods

protected def niceStringArb[A](f: String => Either[String, A], initialChar: Option[Gen[Char]]): Arbitrary[A]

Attributes

Source
RegistrySuite.scala
def prefixedLabelMapArb(initialChar: Gen[Char]): Arbitrary[Map[Name, String]]

Attributes

Source
RegistrySuite.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, ev: B <:< A): Unit

Asserts that two elements are equal using == equality.

Asserts that two elements are equal using == equality.

The "expected" value (second argument) must have the same type or be a subtype of the "obtained" value (first argument). For example:

 assertEquals(Option(1), Some(1)) // OK
 assertEquals(Some(1), Option(1)) // Error: Option[Int] is not a subtype of Some[Int]

Use assertEquals[Any, Any](a, b) as an escape hatch to compare two values of different types. For example:

 val a: Either[List[String], Int] = Right(42)
 val b: Either[String, Int]       = Right(42)
 assertEquals[Any, Any](a, b) // OK
 assertEquals(a, b) // Error: Either[String, Int] is not a subtype of Either[List[String], Int]

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, ev: A =:= B): Unit

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

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[Fixture[_]]

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

Functinonal 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:
FunSuite
Source
FunSuite.scala
def munitTimeout: Duration

Attributes

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

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
protected def scalaCheckTestParameters: Parameters

Attributes

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

Attributes

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

Attributes

Inherited from:
FunSuite
Source
FunSuite.scala

Inherited fields

val munitLines: Lines

Attributes

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

Attributes

Inherited from:
FunSuite
Source
FunSuite.scala

Implicits

Implicits

implicit val commonLabelsArb: Arbitrary[CommonLabels]

Attributes

Source
RegistrySuite.scala
implicit val counterNameArb: Arbitrary[Name]

Attributes

Source
RegistrySuite.scala
implicit val errorArb: Arbitrary[AllowedError]

Attributes

Source
RegistrySuite.scala
implicit val gaugeNameArb: Arbitrary[Name]

Attributes

Source
RegistrySuite.scala
implicit val helpArb: Arbitrary[Help]

Attributes

Source
RegistrySuite.scala
implicit val histogramNameArb: Arbitrary[Name]

Attributes

Source
RegistrySuite.scala
implicit val labelArb: Arbitrary[Name]

Attributes

Source
RegistrySuite.scala
implicit val labelMapArb: Arbitrary[Map[Name, String]]

Attributes

Source
RegistrySuite.scala
implicit val maxAgeArb: Arbitrary[AgeBuckets]

Attributes

Source
RegistrySuite.scala
implicit val prefixArb: Arbitrary[Prefix]

Attributes

Source
RegistrySuite.scala
implicit val quantileArb: Arbitrary[Quantile]

Attributes

Source
RegistrySuite.scala
implicit val summaryNameArb: Arbitrary[Name]

Attributes

Source
RegistrySuite.scala

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 => Prop

Attributes

Inherited from:
ScalaCheckSuite
Source
ScalaCheckSuite.scala
Generated with