Safe Haskell	None
Language	Haskell2010

Test.Sandwich.Contexts.MinIO

Contents

Introducing MinIO
Lower-level versions
Helpers for constructing connections
Re-exports
Types

Description

MinIO is a popular S3-compatible object storage system. This module provides some tools to introduce it, either as a raw binary or via a container system.

The MinIO server will be introduced as a generic TestS3Server. This gives you the ability to easily swap out different S3-compatible stores in your tests.

Synopsis

introduceMinIOViaNix :: forall context (m :: Type -> Type). (HasBaseContext context, HasNixContext context, MonadMask m, MonadUnliftIO m) => MinIOContextOptions -> SpecFree (LabelValue "testS3Server" TestS3Server :> (LabelValue (AppendSymbol "file-" "minio") (EnvironmentFile "minio") :> context)) m () -> SpecFree context m ()
introduceMinIOViaBinary :: forall context (m :: Type -> Type). (HasBaseContext context, HasFile context "minio", MonadMask m, MonadUnliftIO m) => MinIOContextOptions -> SpecFree (LabelValue "testS3Server" TestS3Server :> context) m () -> SpecFree context m ()
introduceMinIOViaContainer :: forall context (m :: Type -> Type). (HasBaseContext context, MonadMask m, MonadUnliftIO m) => MinIOContextOptions -> ContainerOptions -> SpecFree (LabelValue "testS3Server" TestS3Server :> context) m () -> SpecFree context m ()
withMinIOViaBinary :: (HasBaseContextMonad context m, HasFile context "minio", MonadLoggerIO m, MonadMask m, MonadUnliftIO m) => MinIOContextOptions -> (TestS3Server -> m [Result]) -> m ()
withMinIOViaBinary' :: (HasBaseContextMonad context m, MonadLoggerIO m, MonadMask m, MonadUnliftIO m) => FilePath -> MinIOContextOptions -> (TestS3Server -> m [Result]) -> m ()
withMinIOViaContainer :: (HasBaseContextMonad context m, MonadLoggerIO m, MonadMask m, MonadUnliftIO m) => MinIOContextOptions -> ContainerOptions -> (TestS3Server -> m [Result]) -> m ()
testS3ServerEndpoint :: TestS3Server -> Text
testS3ServerContainerEndpoint :: TestS3Server -> Maybe Text
testS3ServerConnectInfo :: TestS3Server -> ConnectInfo
testS3Server :: Label "testS3Server" TestS3Server
data TestS3Server = TestS3Server {
}
type HasTestS3Server context = HasLabel context "testS3Server" TestS3Server
data ContainerOptions = ContainerOptions {
- containerOptionsSystem :: ContainerSystem
- containerOptionsName :: Maybe Text
}
defaultContainerOptions :: ContainerOptions
data HttpMode
data NetworkAddress
- = NetworkAddressTCP {
  - networkAddressTcpHostname :: String
  - networkAddressTcpPort :: PortNumber
  }
- | NetworkAddressUnix {
  - networkAddressUnixPath :: String
  }
data MinIOContextOptions = MinIOContextOptions {
- minioContextBucket :: Maybe Text
- minioContextLabels :: Map Text Text
- minioContextStartupTimeout :: Int
}
defaultMinIOContextOptions :: MinIOContextOptions

Introducing MinIO

introduceMinIOViaNix Source #

Arguments

:: forall context (m :: Type -> Type). (HasBaseContext context, HasNixContext context, MonadMask m, MonadUnliftIO m)
=> MinIOContextOptions	Options
-> SpecFree (LabelValue "testS3Server" TestS3Server :> (LabelValue (AppendSymbol "file-" "minio") (EnvironmentFile "minio") :> context)) m ()
-> SpecFree context m ()

Introduce a MinIO server, deriving the MinIO binary from the Nix context.

introduceMinIOViaBinary Source #

Arguments

:: forall context (m :: Type -> Type). (HasBaseContext context, HasFile context "minio", MonadMask m, MonadUnliftIO m)
=> MinIOContextOptions	Options
-> SpecFree (LabelValue "testS3Server" TestS3Server :> context) m ()
-> SpecFree context m ()

Introduce a MinIO server, assuming the binary is already available as a HasFile context.

introduceMinIOViaContainer Source #

Arguments

:: forall context (m :: Type -> Type). (HasBaseContext context, MonadMask m, MonadUnliftIO m)
=> MinIOContextOptions	Options
-> ContainerOptions
-> SpecFree (LabelValue "testS3Server" TestS3Server :> context) m ()
-> SpecFree context m ()

Introduce a MinIO server by launching a container.

Lower-level versions

withMinIOViaBinary Source #

Arguments

:: (HasBaseContextMonad context m, HasFile context "minio", MonadLoggerIO m, MonadMask m, MonadUnliftIO m)
=> MinIOContextOptions	Options
-> (TestS3Server -> m [Result])
-> m ()

Bracket-style variant of introduceMinIOViaBinary.

withMinIOViaBinary' Source #

Arguments

:: (HasBaseContextMonad context m, MonadLoggerIO m, MonadMask m, MonadUnliftIO m)
=> FilePath	Path to the `minio` binary
-> MinIOContextOptions
-> (TestS3Server -> m [Result])
-> m ()

Introduce a MinIO server by manually providing the path to the binary.

withMinIOViaContainer Source #

Arguments

:: (HasBaseContextMonad context m, MonadLoggerIO m, MonadMask m, MonadUnliftIO m)
=> MinIOContextOptions	Options
-> ContainerOptions
-> (TestS3Server -> m [Result])
-> m ()

Bracket-style variant of introduceMinIOViaContainer.

Helpers for constructing connections

testS3ServerEndpoint :: TestS3Server -> Text #

Generate an S3 connection string for the given server.

testS3ServerContainerEndpoint :: TestS3Server -> Maybe Text #

Generate an S3 connection string for the given containerized server, for the network address inside the container. Returns Nothing if this server isn't containerized.

testS3ServerConnectInfo :: TestS3Server -> ConnectInfo Source #

Construct a ConnectInfo (from the minio-hs package) for the given TestS3Server.

Re-exports

testS3Server :: Label "testS3Server" TestS3Server #

data TestS3Server #

A generic test S3 server. This can be used by downstream packages like sandwich-contexts-minio.

Constructors

TestS3Server
Fields testS3ServerAddress :: NetworkAddress testS3ServerContainerAddress :: Maybe NetworkAddress The address of the S3 server within its container, if present. Useful if you're doing container-to-container networking. testS3ServerAccessKeyId :: Text testS3ServerSecretAccessKey :: Text testS3ServerBucket :: Maybe Text testS3ServerHttpMode :: HttpMode

Instances

Instances details

Show TestS3Server #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods showsPrec :: Int -> TestS3Server -> ShowS # show :: TestS3Server -> String # showList :: [TestS3Server] -> ShowS #
Eq TestS3Server #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods (==) :: TestS3Server -> TestS3Server -> Bool # (/=) :: TestS3Server -> TestS3Server -> Bool #

type HasTestS3Server context = HasLabel context "testS3Server" TestS3Server #

data ContainerOptions #

Type to represent generic options for launching containers.

Constructors

ContainerOptions
Fields containerOptionsSystem :: ContainerSystem containerOptionsName :: Maybe Text

Instances

Instances details

Show ContainerOptions #
Instance details Defined in Test.Sandwich.Contexts.Container Methods showsPrec :: Int -> ContainerOptions -> ShowS # show :: ContainerOptions -> String # showList :: [ContainerOptions] -> ShowS #
Eq ContainerOptions #
Instance details Defined in Test.Sandwich.Contexts.Container Methods (==) :: ContainerOptions -> ContainerOptions -> Bool # (/=) :: ContainerOptions -> ContainerOptions -> Bool #

defaultContainerOptions :: ContainerOptions #

data HttpMode #

Constructors

HttpModeHttp
HttpModeHttps
HttpModeHttpsNoValidate	A special mode to allow a server to run in HTTPS mode, but connect to it without HTTPS validation. Useful for tests.

Instances

Instances details

Show HttpMode #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods showsPrec :: Int -> HttpMode -> ShowS # show :: HttpMode -> String # showList :: [HttpMode] -> ShowS #
Eq HttpMode #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods (==) :: HttpMode -> HttpMode -> Bool # (/=) :: HttpMode -> HttpMode -> Bool #

data NetworkAddress #

Constructors

NetworkAddressTCP
Fields networkAddressTcpHostname :: String networkAddressTcpPort :: PortNumber
NetworkAddressUnix
Fields networkAddressUnixPath :: String

Instances

Instances details

Show NetworkAddress #
Instance details Defined in Test.Sandwich.Contexts.Types.Network Methods showsPrec :: Int -> NetworkAddress -> ShowS # show :: NetworkAddress -> String # showList :: [NetworkAddress] -> ShowS #
Eq NetworkAddress #
Instance details Defined in Test.Sandwich.Contexts.Types.Network Methods (==) :: NetworkAddress -> NetworkAddress -> Bool # (/=) :: NetworkAddress -> NetworkAddress -> Bool #

Types

data MinIOContextOptions Source #

Constructors

MinIOContextOptions
Fields minioContextBucket :: Maybe Text minioContextLabels :: Map Text Text minioContextStartupTimeout :: Int Maximum time to wait in microseconds before seeing an "API:" message during startup

Instances

Instances details

Show MinIOContextOptions Source #
Instance details Defined in Test.Sandwich.Contexts.MinIO Methods showsPrec :: Int -> MinIOContextOptions -> ShowS # show :: MinIOContextOptions -> String # showList :: [MinIOContextOptions] -> ShowS #
Eq MinIOContextOptions Source #
Instance details Defined in Test.Sandwich.Contexts.MinIO Methods (==) :: MinIOContextOptions -> MinIOContextOptions -> Bool # (/=) :: MinIOContextOptions -> MinIOContextOptions -> Bool #

defaultMinIOContextOptions :: MinIOContextOptions Source #