datasourcex-kotest/com.caplin.integration.kotest/LiberatorContainerExtension

LiberatorContainerExtension

class LiberatorContainerExtension(containerConfig: LiberatorContainerExtension.ContainerConfig = DefaultContainerConfig(), objectMapper: ObjectMapper = jacksonObjectMapper()) : MountableExtension<LiberatorContainerExtension.Config, LiberatorContainerExtension.Liberator> , AfterProjectListener, TestListener(source)

A Kotest MountableExtension that runs a Caplin Liberator inside a Testcontainers container for the duration of a test project.

Mount it on a spec to obtain a Liberator handle, which exposes the mapped ports and a factory for opening authenticated StreamLink connections. The container is started lazily on first mount and stopped once via afterProject when the project completes.

class MySpec : FunSpec({
  val liberator = install(LiberatorContainerExtension())
  test("...") {
    val connection = liberator.connect("alice")
    autoClose(connection)
    // ...
  }
})

Parameters

containerConfig

how the container is built and how clients authenticate against it. Defaults to a DefaultContainerConfig that builds a Liberator image with a generated KeyMaster key pair. Supply a CustomContainerConfig to run against a pre-built container.

objectMapper

Jackson mapper used when (de)serialising messages over the connection.

Constructors

LiberatorContainerExtension

constructor(containerConfig: LiberatorContainerExtension.ContainerConfig = DefaultContainerConfig(), objectMapper: ObjectMapper = jacksonObjectMapper())

Types

Config

class Config

Configuration receiver passed to mount; currently exposes no options.

ContainerConfig

sealed interface ContainerConfig

Describes the container to run and how StreamLink clients authenticate against it.

CustomContainerConfig

class CustomContainerConfig(val keymasterConfiguration: IKeyMasterConfiguration, val httpPort: Int, val dataSourcePort: Int, val container: GenericContainer<*>) : LiberatorContainerExtension.ContainerConfig

A ContainerConfig for running against a container and KeyMaster configuration you supply yourself, rather than the one built by DefaultContainerConfig.

DefaultContainerConfig

class DefaultContainerConfig(val adapterConfig: InputStream? = null, val beforeScript: InputStream? = null, val extraFiles: Map<String, InputStream> = mutableMapOf(), val baseImage: String = DEFAULT_BASE_IMAGE) : LiberatorContainerExtension.ContainerConfig

A ContainerConfig that builds a Liberator image from the bundled Dockerfile and generates a fresh RSA KeyMaster key pair, deploying the public key into the container.

Liberator

class Liberator(val streamLinkConnectionFactory: StreamLinkConnectionFactory, val dataSourcePort: Int, val httpPort: Int, val containerState: ContainerState)

A handle to a running Liberator container, returned when the extension is mounted.