http4k-connect-amazon-iot-fake/org.http4k.connect.amazon.iot

Package-level declarations

Types

class FakeIot(jobs: Storage<StoredJob> = Storage.InMemory(), streams: Storage<StoredStream> = Storage.InMemory(), certificates: Storage<StoredCertificate> = Storage.InMemory(), region: Region = Region.of("ldn-north-1"), clock: Clock = Clock.systemUTC()) : ChaoticHttpHandler

The AWS IoT control plane, of which the Jobs and stream operations are implemented. Share the jobs storage with a FakeIotJobsDataPlane and the control plane and the device API see one jobs state.

StoredCertificate

data class StoredCertificate(val certificateId: CertificateId, val certificateArn: ARN, val status: CertificateStatus, val certificatePem: String? = null, val caCertificateId: CertificateId? = null, val ownedBy: String? = null, val customerVersion: Int? = null, val generationId: String? = null, val certificateMode: CertificateMode? = null, val notBefore: Timestamp? = null, val notAfter: Timestamp? = null, val creationDate: Timestamp, val lastModifiedDate: Timestamp)

StoredJob

data class StoredJob(val jobId: JobId, val jobArn: ARN, val targets: List<ARN>, val document: String?, val description: String?, val targetSelection: TargetSelection, val status: JobStatus, val comment: String?, val forceCanceled: Boolean?, val timeoutConfig: TimeoutConfig?, val createdAt: Timestamp, val lastUpdatedAt: Timestamp, val completedAt: Timestamp?, val executions: Map<ThingName, StoredJobExecution>)

The job record FakeIot keeps, keyed by jobId. Public so that a Storage can be shared with FakeIotJobsDataPlane: construct both fakes over the same Storage instance and the control plane and the device API see one jobs state.

StoredJobExecution

data class StoredJobExecution(val thingName: ThingName, val thingArn: ARN, val status: JobExecutionStatus, val statusDetails: Map<String, String>, val queuedAt: Timestamp, val startedAt: Timestamp?, val lastUpdatedAt: Timestamp, val versionNumber: Long, val executionNumber: Long, val forceCanceled: Boolean? = null)

StoredStream

data class StoredStream(val streamId: StreamId, val streamArn: ARN, val streamVersion: Int, val files: List<StreamFile>, val roleArn: ARN, val description: String?, val createdAt: Timestamp, val lastUpdatedAt: Timestamp)

The stream record FakeIot keeps, keyed by streamId. A stream's bytes are not modelled: the fake records where they were said to be, since devices fetch them over MQTT rather than from this API.

Properties

isTerminal

val JobExecutionStatus.isTerminal: Boolean

Functions

approximateSecondsBeforeTimedOut

fun StoredJob.approximateSecondsBeforeTimedOut(execution: StoredJobExecution): Long?

The fake runs no live timers, so an in-progress execution of a job with a timeout config always reports its full budget as remaining.

completedIfAllExecutionsTerminal

fun StoredJob.completedIfAllExecutionsTerminal(now: Timestamp): StoredJob

When every execution of an in-progress SNAPSHOT job is terminal, the job completes.

executionsFor

fun Storage<StoredJob>.executionsFor(thingName: ThingName): List<Pair<StoredJob, StoredJobExecution>>

Every (job, execution) pair for the thing, oldest first.

main

fun main()

nextPendingExecutionFor

fun Storage<StoredJob>.nextPendingExecutionFor(thingName: ThingName): Pair<StoredJob, StoredJobExecution>?

The $next selection: the oldest IN_PROGRESS execution for the thing first, else the oldest QUEUED one, considering only jobs which are themselves still IN_PROGRESS. This is a read: callers decide whether the pick transitions.

thingNameOrNull

fun ARN.thingNameOrNull(): ThingName?

The thing an arn:...:thing/NAME target names, or null for any other resource type - a thinggroup/NAME target most of all, whose tail is a group name and not a device.