Karbone/com.ekino.oss.karbone.testing/FakeKarbone

FakeKarbone

class FakeKarbone(var status: ApiStatus = ApiStatus(true, HTTP_OK, "OK", "fake"), var renderer: FakeKarbone.Renderer = Renderer.Default) : KarboneClient

In-memory KarboneClient for consumer tests. No network, no Carbone.

Templates are stored by their SHA-256, exactly like Carbone's legacy ids; the hash-first render flow works as with the real client.
com.ekino.oss.karbone.Renders.render produces bytes through renderer; the default writes a small JSON description of the request, with a filename derived from reportName / convertTo.
Every call is recorded in calls; failNextWith injects one error on the next call.

Constructors

constructor(status: ApiStatus = ApiStatus(true, HTTP_OK, "OK", "fake"), renderer: FakeKarbone.Renderer = Renderer.Default)

Types

sealed interface Call

One call recorded in calls.

fun interface Renderer

Produces the bytes of a rendered document.

data class RenderRequest(val templateId: TemplateId, val template: ByteArray?, val data: JsonElement?, val options: RenderOptions)

A render request passed to Renderer.render.

data class StoredTemplate(val id: TemplateId, val content: ByteArray, val options: UploadOptions, val createdAt: Instant)

A template held in the in-memory store.

Properties

val calls: MutableList<FakeKarbone.Call>

Every call made on this fake, in order.

val rendered: MutableList<RenderedDocument>

Rendered documents recorded so far (one per render / start / startAsync).

var renderer: FakeKarbone.Renderer

Strategy used to produce rendered bytes. Defaults to Renderer.Default.

open override val renders: Renders

Document generation operations.

var status: ApiStatus

Value returned by status. Mutable so a test can simulate a degraded or custom status.

storedTemplates

val storedTemplates: Map<TemplateId, FakeKarbone.StoredTemplate>

Templates currently stored.

open override val templates: Templates

Template upload, download, listing and metadata operations.

Functions

fun addTemplate(content: ByteArray, options: UploadOptions = UploadOptions()): TemplateId

Pre-load a template so TemplateSource.Remote ids resolve. Returns its id (SHA-256).

fun KarboneClient.blocking(): KarboneBlocking

Blocking, exception-based view of any KarboneClient: the real com.ekino.oss.karbone.Karbone or a test double.

fun failNextWith(error: KarboneError)

The next call, whatever it is, raises error instead of running.

fun reset()

Clears stored templates, recorded calls and rendered documents, and any pending failNextWith error.

context(_: Raise<KarboneError>)
open suspend override fun status(): ApiStatus

GET /status.