Safe Haskell	None
Language	Haskell2010

Test.Sandwich.Contexts.Types.S3

Contents

Contexts
Endpoints
Misc

Description

Helper module for working with S3 servers.

Synopsis

data TestS3Server = TestS3Server {
}
data HttpMode
testS3Server :: Label "testS3Server" TestS3Server
type HasTestS3Server context = HasLabel context "testS3Server" TestS3Server
testS3ServerEndpoint :: TestS3Server -> Text
testS3ServerContainerEndpoint :: TestS3Server -> Maybe Text
s3Protocol :: TestS3Server -> Text

Documentation

data TestS3Server Source #

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 Source #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods showsPrec :: Int -> TestS3Server -> ShowS # show :: TestS3Server -> String # showList :: [TestS3Server] -> ShowS #
Eq TestS3Server Source #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods (==) :: TestS3Server -> TestS3Server -> Bool # (/=) :: TestS3Server -> TestS3Server -> Bool #

data HttpMode Source #

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 Source #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods showsPrec :: Int -> HttpMode -> ShowS # show :: HttpMode -> String # showList :: [HttpMode] -> ShowS #
Eq HttpMode Source #
Instance details Defined in Test.Sandwich.Contexts.Types.S3 Methods (==) :: HttpMode -> HttpMode -> Bool # (/=) :: HttpMode -> HttpMode -> Bool #

Contexts

testS3Server :: Label "testS3Server" TestS3Server Source #

type HasTestS3Server context = HasLabel context "testS3Server" TestS3Server Source #

Endpoints

testS3ServerEndpoint :: TestS3Server -> Text Source #

Generate an S3 connection string for the given server.

testS3ServerContainerEndpoint :: TestS3Server -> Maybe Text Source #

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.

Misc

s3Protocol :: TestS3Server -> Text Source #

Return either "http" or "https", based on the testS3ServerHttpMode.