master..940eb34 · docker-hs

.travis.yml−8

since splitsnapshots

unifiedsplit

@@ -39,14 +39,6 @@ env:

39 - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.0.2

40 - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.0.2

41

42− - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=8.6.4

43− - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.6.4

44− - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.6.4

45−

46− - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=8.8.2

47− - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.8.2

48− - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.8.2

49−

50addons:

42addons:

51 apt:

43 apt:

52 packages:

44 packages:

CHANGELOG.md−19

@@ -1,24 +1,5 @@

1# CHANGELOG

2

3−## 0.6.0.3 (2020-02-17)

4−

5−- Support for ghc 8.8.2.

6−- Bump dependency version.

7−- Use MonadFail for later versions.

8−

9−## 0.6.0.1 (2019-05-23)

10−

11−- Support ghc 8.6.4.

12−- Bump containers version.

13−

14−## 0.6.0.0 (2018-06-28)

15−

16−- Rename DeleteOpts to ContainerDeleteOpts.

17−- Implement image deletion.

18−- Bump aeson version.

19−- Implement network aliases.

20−- Implement creating/deleting networks.

21−

22## 0.5.1.1 (2018-03-09)

3## 0.5.1.1 (2018-03-09)

23

4

24- Bump aeson version.

5- Bump aeson version.

docker.cabal+6−6

@@ -1,5 +1,5 @@

1name: docker

2−version: 0.6.0.3

2+version: 0.5.1.1

3synopsis: An API client for docker written in Haskell

4description: See API documentation below.

5homepage: https://github.com/denibertovic/docker-hs

@@ -25,12 +25,12 @@ library

25 exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http, Docker.Client.Utils

26 -- other-modules: Docker.Internal

27 build-depends: base >= 4.7 && < 5

28− , aeson >= 0.9.0 && < 2.0.0

28+ , aeson >= 0.9.0 && < 1.4.0

29 , blaze-builder >= 0.4.0 && < 0.5.0

30 , bytestring >= 0.10.0 && < 0.11.0

31− , containers >= 0.5.0 && < 0.7.0

31+ , containers >= 0.5.0 && < 0.6.0

32 , data-default-class >= 0.0.1 && < 0.2.0

33− , http-client >= 0.4.0 && < 0.7.0

33+ , http-client >= 0.4.0 && < 0.6.0

34 , http-types >= 0.9 && < 0.13

35 , vector

36 , conduit

@@ -51,9 +51,9 @@ library

51 , mtl >= 2.0.0 && < 3.0.0

52 , network >= 2.6.0

53 , text >= 1.0.0 && < 2.0.0

54− , time >= 1.5.0 && < 2.0.0

54+ , time >= 1.5.0 && < 1.9.0

55 , scientific >= 0.3.0 && < 0.4.0

56− , tls >= 1.3.7 && < 1.6.0

56+ , tls >= 1.3.7 && < 1.5.0

57 , unordered-containers >= 0.2.0 && < 0.3.0

58 , x509 >= 1.6.0 && < 1.8.0

59 , x509-store >= 1.6.0 && < 1.8.0

src/Docker/Client/Api.hs+2−9

@@ -18,7 +18,6 @@ module Docker.Client.Api (

18 , getContainerLogsStream

19 -- * Images

20 , listImages

21− , deleteImage

22 , buildImageFromDockerfile

21 , buildImageFromDockerfile

23 , pullImage

22 , pullImage

24 -- * Network

23 -- * Network

@@ -94,12 +93,6 @@ listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseR

94listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])

93listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])

95listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse

94listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse

96

95

97−-- | Deletes an image with the given 'ImageID'.

98−-- See "ImageDeleteOpts" for options and use 'defaultImageDeleteOpts' for sane

99−-- defaults.

100−deleteImage :: forall m. (MonadIO m, MonadMask m) => ImageDeleteOpts -> ImageID -> DockerT m (Either DockerError ())

101−deleteImage dopts iid = requestUnit DELETE $ DeleteImageEndpoint dopts iid

102−

103-- | Creates a docker container but does __not__ start it. See

96-- | Creates a docker container but does __not__ start it. See

104-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'

97-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'

105-- for some sane defaults.

98-- for some sane defaults.

@@ -145,9 +138,9 @@ unpauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT

145unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid

138unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid

146

139

147-- | Deletes a container with the given 'ContainerID'.

140-- | Deletes a container with the given 'ContainerID'.

148−-- See "ContainerDeleteOpts" for options and use 'defaultContainerDeleteOpts' for sane

141+-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane

149-- defaults.

142-- defaults.

150−deleteContainer :: forall m. (MonadIO m, MonadMask m) => ContainerDeleteOpts -> ContainerID -> DockerT m (Either DockerError ())

143+deleteContainer :: forall m. (MonadIO m, MonadMask m) => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())

151deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid

144deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid

152

145

153-- | Gets 'ContainerDetails' for a given 'ContainerID'.

146-- | Gets 'ContainerDetails' for a given 'ContainerID'.

src/Docker/Client/Http.hs+1−5

@@ -273,11 +273,6 @@ statusCodeToError (CreateImageEndpoint _ _ _) st =

273 Nothing

274 else

275 Just $ DockerInvalidStatusCode st

276−statusCodeToError (DeleteImageEndpoint _ _) st =

277− if st == status200 then

278− Nothing

279− else

280− Just $ DockerInvalidStatusCode st

281statusCodeToError (CreateNetworkEndpoint _) st =

276statusCodeToError (CreateNetworkEndpoint _) st =

282 if st == status201 then

277 if st == status201 then

283 Nothing

278 Nothing

@@ -288,3 +283,4 @@ statusCodeToError (RemoveNetworkEndpoint _) st =

288 Nothing

283 Nothing

289 else

284 else

290 Just $ DockerInvalidStatusCode st

285 Just $ DockerInvalidStatusCode st

286+

src/Docker/Client/Internal.hs+1−4

@@ -57,7 +57,7 @@ getEndpoint v (UnpauseContainerEndpoint cid) = encodeURL [v, "containers", fromC

57getEndpoint v (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =

58 encodeURLWithQuery [v, "containers", fromContainerID cid, "logs"] query

59 where query = [("stdout", Just (encodeQ $ show stdout)), ("stderr", Just (encodeQ $ show stderr)), ("follow", Just (encodeQ $ show follow))]

60−getEndpoint v (DeleteContainerEndpoint (ContainerDeleteOpts removeVolumes force) cid) =

60+getEndpoint v (DeleteContainerEndpoint (DeleteOpts removeVolumes force) cid) =

61 encodeURLWithQuery [v, "containers", fromContainerID cid] query

62 where query = [("v", Just (encodeQ $ show removeVolumes)), ("force", Just (encodeQ $ show force))]

63getEndpoint v (InspectContainerEndpoint cid) =

@@ -75,7 +75,6 @@ getEndpoint v (CreateImageEndpoint name tag _) = encodeURLWithQuery [v, "images"

75 where query = [("fromImage", Just n), ("tag", Just t)]

76 n = encodeQ $ T.unpack name

77 t = encodeQ $ T.unpack tag

78−getEndpoint v (DeleteImageEndpoint _ cid) = encodeURL [v, "images", fromImageID cid]

79getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]

78getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]

80getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]

79getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]

81

80

@@ -97,8 +96,6 @@ getEndpointRequestBody (InspectContainerEndpoint _) = Nothing

97

96

98getEndpointRequestBody (BuildImageEndpoint _ fp) = Just $ requestBodySourceChunked $ CB.sourceFile fp

97getEndpointRequestBody (BuildImageEndpoint _ fp) = Just $ requestBodySourceChunked $ CB.sourceFile fp

99getEndpointRequestBody (CreateImageEndpoint _ _ _) = Nothing

98getEndpointRequestBody (CreateImageEndpoint _ _ _) = Nothing

100−getEndpointRequestBody (DeleteImageEndpoint _ _) = Nothing

101−

102getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)

99getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)

103getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing

100getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing

104

101

src/Docker/Client/Types.hs+6−20

@@ -40,10 +40,8 @@ module Docker.Client.Types (

40 , DetachKeys(..)

41 , StartOpts(..)

42 , defaultStartOpts

43− , ContainerDeleteOpts(..)

43+ , DeleteOpts(..)

44− , defaultContainerDeleteOpts

44+ , defaultDeleteOpts

45− , ImageDeleteOpts(..)

46− , defaultImageDeleteOpts

47 , Timestamp

45 , Timestamp

48 , TailLogOpt(..)

46 , TailLogOpt(..)

49 , LogOpts(..)

47 , LogOpts(..)

@@ -132,11 +130,10 @@ data Endpoint =

132 | UnpauseContainerEndpoint ContainerID

130 | UnpauseContainerEndpoint ContainerID

133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.

131 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.

134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.

132 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.

135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID

133+ | DeleteContainerEndpoint DeleteOpts ContainerID

136 | InspectContainerEndpoint ContainerID

134 | InspectContainerEndpoint ContainerID

137 | BuildImageEndpoint BuildOpts FilePath

135 | BuildImageEndpoint BuildOpts FilePath

138 | CreateImageEndpoint T.Text Tag (Maybe T.Text) -- ^ Either pull an image from docker hub or imports an image from a tarball (or URL)

136 | CreateImageEndpoint T.Text Tag (Maybe T.Text) -- ^ Either pull an image from docker hub or imports an image from a tarball (or URL)

139− | DeleteImageEndpoint ImageDeleteOpts ImageID

140 | CreateNetworkEndpoint CreateNetworkOpts

137 | CreateNetworkEndpoint CreateNetworkOpts

141 | RemoveNetworkEndpoint NetworkID

138 | RemoveNetworkEndpoint NetworkID

142 deriving (Eq, Show)

139 deriving (Eq, Show)

@@ -762,7 +759,7 @@ defaultStartOpts :: StartOpts

762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }

759defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }

763

760

764-- | Options for deleting a container.

761-- | Options for deleting a container.

765−data ContainerDeleteOpts = ContainerDeleteOpts {

762+data DeleteOpts = DeleteOpts {

766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.

763 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.

767 , force :: Bool -- ^ If the container is still running force deletion anyway.

764 , force :: Bool -- ^ If the container is still running force deletion anyway.

768 } deriving (Eq, Show)

765 } deriving (Eq, Show)

@@ -792,15 +789,8 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag

792-- | Default options for deleting a container. Most of the time we DON'T

789-- | Default options for deleting a container. Most of the time we DON'T

793-- want to delete the container's volumes or force delete it if it's

790-- want to delete the container's volumes or force delete it if it's

794-- running.

791-- running.

795−defaultContainerDeleteOpts :: ContainerDeleteOpts

792+defaultDeleteOpts :: DeleteOpts

796−defaultContainerDeleteOpts = ContainerDeleteOpts { deleteVolumes = False, force = False }

793+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }

797−

798−-- | Image delete opts

799−data ImageDeleteOpts = ImageDeleteOpts deriving (Eq, Show)

800−

801−-- | Sane image deletion defaults

802−defaultImageDeleteOpts :: ImageDeleteOpts

803−defaultImageDeleteOpts = ImageDeleteOpts

804

794

805-- | Timestamp alias.

795-- | Timestamp alias.

806type Timestamp = Integer

796type Timestamp = Integer

@@ -1564,11 +1554,7 @@ instance FromJSON ContainerConfig where

1564 macAddress labels stopSignal

1554 macAddress labels stopSignal

1565 parseJSON _ = fail "NetworkSettings is not an object."

1555 parseJSON _ = fail "NetworkSettings is not an object."

1566

1556

1567−#if MIN_VERSION_base(4,13,0)

1568−parseIntegerText :: (MonadFail m) => Text -> m Integer

1569−#else

1570parseIntegerText :: (Monad m) => Text -> m Integer

1557parseIntegerText :: (Monad m) => Text -> m Integer

1571−#endif

1572parseIntegerText t = case readMaybe $ T.unpack t of

1558parseIntegerText t = case readMaybe $ T.unpack t of

1573 Nothing ->

1559 Nothing ->

1574 fail "Could not parse Integer"

1560 fail "Could not parse Integer"

stack-7.10.yaml−1

@@ -14,7 +14,6 @@ flags: {}

14extra-deps:

15- directory-1.2.7.0

16- unliftio-core-0.1.1.0

17−- process-1.6.5.1

18

17

19# Control whether we use the GHC we find on the path

18# Control whether we use the GHC we find on the path

20# system-ghc: true

19# system-ghc: true

stack-8.6.4.yamldeleted−4

@@ -1,4 +0,0 @@

1−resolver: lts-13.19

2−packages:

3−- '.'

4−extra-deps: []

stack-8.8.2.yamldeleted−5

@@ -1,5 +0,0 @@

1−resolver: lts-15.0

2−packages:

3−- '.'

4−extra-deps: []

5−

stack.yaml+1−1

@@ -1 +1 @@

1−stack-8.6.4.yaml

1+stack-8.0.2.yaml

tests/tests.hs+4−24

@@ -24,7 +24,7 @@ import qualified Data.ByteString.Lazy as BL

24import qualified Data.HashMap.Strict as HM

25import Data.Int (Int)

26import qualified Data.Map as M

27−import Data.Maybe (fromJust, isJust, isNothing, listToMaybe)

27+import Data.Maybe (fromJust, isJust)

28import Data.Monoid

29import Data.Text (Text, unpack)

30import qualified Data.Vector as V

@@ -40,7 +40,6 @@ import Docker.Client

40

41-- opts = defaultClientOpts

42testImageName = "docker-hs/test"

43−imageToDeleteFullName = "hello-world:latest"

44

43

45toStrict1 = B.concat . BL.toChunks

44toStrict1 = B.concat . BL.toChunks

46

45

@@ -74,27 +73,13 @@ testFindImage =

74 where

73 where

75 imageFullName = testImageName <> ":latest"

74 imageFullName = testImageName <> ":latest"

76

75

77−testDeleteImage :: IO ()

78−testDeleteImage = runDocker $ do

79− img <- fmap fromJust findTestImage

80− result <- deleteImage defaultImageDeleteOpts (imageId img)

81− lift $ assert $ isRight result

82− maybeTestImageAfter <- findTestImage

83− lift $ assert $ isNothing maybeTestImageAfter

84− where

85− findTestImage =

86− do

87− images <- listImages defaultListOpts >>= fromRight

88− return $ listToMaybe

89− $ filter (elem imageToDeleteFullName . imageRepoTags) images

90−

91testListContainers :: IO ()

76testListContainers :: IO ()

92testListContainers =

77testListContainers =

93 runDocker $

78 runDocker $

94 do containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing

79 do containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing

95 c <- fromRight containerId

80 c <- fromRight containerId

96 res <- listContainers $ ListOpts { all=True }

81 res <- listContainers $ ListOpts { all=True }

97− deleteContainer (ContainerDeleteOpts True True) c

82+ deleteContainer (DeleteOpts True True) c

98 lift $ assert $ isRight res

83 lift $ assert $ isRight res

99

84

100testBuildFromDockerfile :: IO ()

85testBuildFromDockerfile :: IO ()

@@ -125,7 +110,7 @@ testRunAndReadLogHelper networkingConfig =

125 lift $ assertBool ("starting the container, unexpected status: " ++ show status1) $ isRightUnit status1

110 lift $ assertBool ("starting the container, unexpected status: " ++ show status1) $ isRightUnit status1

126 logs <- getContainerLogs defaultLogOpts c >>= fromRight

111 logs <- getContainerLogs defaultLogOpts c >>= fromRight

127 lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)

112 lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)

128− status3 <- deleteContainer (ContainerDeleteOpts True True) c

113+ status3 <- deleteContainer (DeleteOpts True True) c

129 lift $ assertBool ("deleting container, unexpected status: " ++ show status3) $ isRightUnit status3

114 lift $ assertBool ("deleting container, unexpected status: " ++ show status3) $ isRightUnit status3

130 mapM_ removeNetwork createdNetworks

115 mapM_ removeNetwork createdNetworks

131 where

116 where

@@ -243,7 +228,6 @@ integrationTests =

243 [ testCase "Get docker version" testDockerVersion

228 [ testCase "Get docker version" testDockerVersion

244 , testCase "Build image from Dockerfile" testBuildFromDockerfile

229 , testCase "Build image from Dockerfile" testBuildFromDockerfile

245 , testCase "Find image by name" testFindImage

230 , testCase "Find image by name" testFindImage

246− , testCase "Delete image" testDeleteImage

247 , testCase "List containers" testListContainers

231 , testCase "List containers" testListContainers

248 , testCase "Run a dummy container and read its log" testRunAndReadLog

232 , testCase "Run a dummy container and read its log" testRunAndReadLog

249 , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking

233 , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking

@@ -265,11 +249,7 @@ jsonTests =

265 ]

249 ]

266

250

267setup :: IO ()

251setup :: IO ()

268−setup =

269− mapM_ system

270− [ "docker pull " ++ unpack imageToDeleteFullName

271− , "docker build -t " ++ unpack testImageName ++ " tests"

252+setup = system ("docker build -t " ++ unpack testImageName ++ " tests") >> return ()

272− ]

273

253

274isLeft = not . isRight

254isLeft = not . isRight

275

255