Meziantou.Framework.TemporaryContainers namespace

Classes

NameDescription
BindMountA bind mount that maps a host path into the container.
ContainerCleanupOptionsConfigures what ContainerRuntime.CleanupAsync removes.
ContainerCleanupResultWhat a cleanup removed, and what it could not remove.
ContainerCommandCollectionAn ordered collection of command tokens (used for the entrypoint or command of a container).
ContainerDefinitionDescribes how a container should be created. Configure an instance and call ContainerDefinition.CreateContainer to obtain a runnable TemporaryContainer.
ContainerDefinitionMongoDbExtensionsProvides MongoDB factory members for ContainerDefinition.
ContainerDefinitionPostgreSqlExtensionsProvides PostgreSQL factory members for ContainerDefinition.
ContainerDefinitionRedisExtensionsProvides Redis factory members for ContainerDefinition.
ContainerDefinitionSqlServerExtensionsProvides SQL Server factory members for ContainerDefinition.
ContainerEnvironmentCollectionA collection of environment variables passed to a container.
ContainerExecExceptionThrown by ExecResult.EnsureSuccess when a command executed inside a container exits with a non-zero exit code.
ContainerExposedPortA container port that is exposed without being published to the host. It is metadata: the other containers of a network reach every port of the container, exposed or not.
ContainerExtraHostAn entry added to the /etc/hosts file of a container (--add-host).
ContainerHealthcheckOverrides the healthcheck an image declares (HEALTHCHECK), or disables it.
ContainerInfoA snapshot of a container's state, obtained from an inspect operation.
ContainerLabelCollectionA collection of labels applied to a container or a volume.
ContainerLoggingOptionsLogging options for a container.
ContainerLogsOptionsSelects the log entries returned by TemporaryContainer.GetLogsAsync.
ContainerMountCollectionA collection of mounts attached to a container.
ContainerNetworkAttachmentA network a container joins, with the aliases the other containers of that network reach it by.
ContainerNetworkOptionsNetwork options for a container.
ContainerPortRepresents a container port that is published to the host.
ContainerPortCollectionA collection of ports published by a container. A container port is published on a single host port.
ContainerReaperA watchdog container that removes the containers, images and volumes of the current session when this process goes away, including when it is killed and cannot run its own cleanup.
ContainerReaperOptionsConfigures the watchdog container started by ContainerRuntime.StartReaperAsync.
ContainerResourceOptionsResource limits for a container.
ContainerRuntimeIdentifies the runtime used to manage containers.
ContainerRuntimeExceptionThrown when the container runtime fails an operation: its command line exits with a non-zero exit code, or the Docker Engine API refuses a request or reports a failure. Every runtime reports its failures with this exception.
ContainerUlimitA resource limit (ulimit) of the processes of a container.
ContainerWaitStrategyCollectionAn ordered collection of wait strategies run when a container starts.
DockerfileBuildOptionsOptions for building an image from a Dockerfile. Pass them to ImageSource.FromDockerfile, which copies them: later changes do not affect the image source.
ExecOptionsOptions for a command executed inside a running container.
ExecResultThe result of a command executed inside a container.
HttpWaitStrategyOptionsOptions of the wait strategy created by Wait.ForHttp.
ImageSourceDescribes where the image used to create a container comes from.
LogEntryRepresents a single log line emitted by a container.
MongoDbContainerA temporary MongoDB container. Obtain one from MongoDbContainerDefinition.CreateContainer.
MongoDbContainerDefinitionA ContainerDefinition pre-configured for MongoDB. Create one with ContainerDefinition.CreateMongoDb.
NetworkDefinitionDescribes how a network should be created. Configure an instance and call NetworkDefinition.CreateNetwork to obtain a TemporaryNetwork.
PollingWaitStrategyOptionsOptions shared by the wait strategies that check the container repeatedly until it is ready.
PostgreSqlContainerA temporary PostgreSQL container. Obtain one from PostgreSqlContainerDefinition.CreateContainer.
PostgreSqlContainerDefinitionA ContainerDefinition pre-configured for PostgreSQL. Create one with ContainerDefinition.CreatePostgreSql.
RedisContainerA temporary Redis container. Obtain one from RedisContainerDefinition.CreateContainer.
RedisContainerDefinitionA ContainerDefinition pre-configured for Redis. Create one with ContainerDefinition.CreateRedis.
SqlServerContainerA temporary SQL Server container. Obtain one from SqlServerContainerDefinition.CreateContainer.
SqlServerContainerDefinitionA ContainerDefinition pre-configured for SQL Server. Create one with ContainerDefinition.CreateSqlServer.
TemporaryContainerA temporary container created from a ContainerDefinition. Dispose the instance to remove the container (unless ContainerDefinition.ReuseId is set).
TemporaryNetworkA temporary network created from a NetworkDefinition. Dispose the instance to remove the network.
TemporaryVolumeA temporary volume created from a VolumeDefinition. Dispose the instance to remove the volume.
TmpfsMountA tmpfs (in-memory) mount inside the container.
VolumeDefinitionDescribes how a volume should be created. Configure an instance and call VolumeDefinition.CreateVolume to obtain a TemporaryVolume.
VolumeDriverOptionCollectionA collection of driver-specific options applied to a volume.
VolumeMountA named volume mounted into the container.
WaitProvides factory methods for the built-in IWaitStrategy implementations.
WaitStrategyExtensionsProvides extension members for IWaitStrategy.

Interfaces

NameDescription
IMountRepresents a mount attached to a container. Implemented by BindMount, VolumeMount, and TmpfsMount, the only mounts the runtimes know how to create: the interface cannot be implemented outside of this library.
IWaitStrategyRepresents a readiness check that completes once a container is ready to be used.

Enums

NameDescription
ContainerCleanupScopeSelects which of the resources created by this library a cleanup removes.
ContainerHealthStatusRepresents the status of the health check of a container (the HEALTHCHECK instruction of its image).
ContainerPortProtocolThe transport protocol of a container port.
ContainerStateRepresents the runtime state of a container as reported by the runtime.
LogStreamIdentifies the stream a log entry was written to.
PullPolicyControls when the container image is pulled from its registry.