herald-testing/io.github.mkhytarmkhoian.herald.testing/FakeAnalyticsProvider

FakeAnalyticsProvider

class FakeAnalyticsProvider : EventTrackerService, PropertyTrackerService, IdentifiableUserService, AnalyticsLifecycleService, ConsentService(source)

A vendor that records instead of sending, for tests in apps that use Herald.

It implements all five capabilities, so you can register it as a real provider and the test then runs through the composition root you actually ship — factory chain, dispatcher and all:

val analytics = FakeAnalyticsProvider()
val herald = Herald {
    provider(name = "test", events = analytics, properties = analytics)
}

viewModel.onPayTapped()

analytics.assertTracked("checkout_pay_tapped") { param("plan", "pro") }
analytics.assertNothingElseTracked()

For a class that only tracks events a lambda is smaller — EventTrackerService { recorded += it } needs no dependency. Reach for this when the test spans more than one capability, cares about ordering between them, or runs through a real Herald.

Safe to call from several coroutines at once.

Constructors

FakeAnalyticsProvider

constructor()

Properties

events

val events: List<Event>

Just the events, in order.

properties

val properties: List<Property>

Just the properties, in order.

records

val records: List<AnalyticsRecord>

Everything received, oldest first.

Functions

assertIdentified

fun assertIdentified(userId: String)

Asserts that the user was identified as userId at some point. Unlike assertPropertySet this is historical, not current: an identify followed by reset still passes. Use records to assert on the order.

assertNothingElseTracked

fun assertNothingElseTracked()

Asserts that every event tracked has already been named by an earlier assertion.

assertNothingTracked

fun assertNothingTracked()

Asserts that no event was tracked at all.

assertNotTracked

fun assertNotTracked(name: String)

Asserts that no event with name was tracked.

assertPropertySet

fun assertPropertySet(name: String, value: AnalyticsValue)

Asserts that name is currently value: the last value it was set to, since a property is state and that is what a vendor holds. Earlier values do not count, so a property set to the right value and then overwritten fails, and the failure lists the sequence.

fun assertPropertySet(name: String, value: Boolean)

fun assertPropertySet(name: String, value: Double)

fun assertPropertySet(name: String, value: Float)

fun assertPropertySet(name: String, value: Int)

fun assertPropertySet(name: String, value: Long)

fun assertPropertySet(name: String, value: String)

assertTracked