on master help sign in
12 files changed+112−21
since splitsnapshots
unifiedsplit
.travis.yml+8 CHANGELOG.md+19 docker.cabal+6−6 src/Docker/Client/Api.hs+9−2 src/Docker/Client/Http.hs+5−1 src/Docker/Client/Internal.hs+4−1 src/Docker/Client/Types.hs+20−6 stack-7.10.yaml+1 stack-8.6.4.yaml+4 stack-8.8.2.yaml+5 stack.yaml+1−1 tests/tests.hs+30−4
.travis.yml+8
@@ -39,6 +39,14 @@ env:
3939 - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.0.2
4040 - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.0.2
4141
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+
4250addons:
4351 apt:
4452 packages:
CHANGELOG.md+19
@@ -1,5 +1,24 @@
11# CHANGELOG
22
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+
322## 0.5.1.1 (2018-03-09)
423
524- Bump aeson version.
docker.cabal+6−6
@@ -1,5 +1,5 @@
11name: docker
2−version: 0.5.1.1
2+version: 0.6.0.3
33synopsis: An API client for docker written in Haskell
44description: See API documentation below.
55homepage: https://github.com/denibertovic/docker-hs
@@ -25,12 +25,12 @@ library
2525 exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http, Docker.Client.Utils
2626 -- other-modules: Docker.Internal
2727 build-depends: base >= 4.7 && < 5
28− , aeson >= 0.9.0 && < 1.4.0
28+ , aeson >= 0.9.0 && < 2.0.0
2929 , blaze-builder >= 0.4.0 && < 0.5.0
3030 , bytestring >= 0.10.0 && < 0.11.0
31− , containers >= 0.5.0 && < 0.6.0
31+ , containers >= 0.5.0 && < 0.7.0
3232 , data-default-class >= 0.0.1 && < 0.2.0
33− , http-client >= 0.4.0 && < 0.6.0
33+ , http-client >= 0.4.0 && < 0.7.0
3434 , http-types >= 0.9 && < 0.13
3535 , vector
3636 , conduit
@@ -51,9 +51,9 @@ library
5151 , mtl >= 2.0.0 && < 3.0.0
5252 , network >= 2.6.0
5353 , text >= 1.0.0 && < 2.0.0
54− , time >= 1.5.0 && < 1.9.0
54+ , time >= 1.5.0 && < 2.0.0
5555 , scientific >= 0.3.0 && < 0.4.0
56− , tls >= 1.3.7 && < 1.5.0
56+ , tls >= 1.3.7 && < 1.6.0
5757 , unordered-containers >= 0.2.0 && < 0.3.0
5858 , x509 >= 1.6.0 && < 1.8.0
5959 , x509-store >= 1.6.0 && < 1.8.0
src/Docker/Client/Api.hs+9−2
@@ -18,6 +18,7 @@ module Docker.Client.Api (
1818 , getContainerLogsStream
1919 -- * Images
2020 , listImages
21+ , deleteImage
2122 , buildImageFromDockerfile
2223 , pullImage
2324 -- * Network
@@ -93,6 +94,12 @@ listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseR
9394listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])
9495listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
9596
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+
96103-- | Creates a docker container but does __not__ start it. See
97104-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'
98105-- for some sane defaults.
@@ -138,9 +145,9 @@ unpauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT
138145unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
139146
140147-- | Deletes a container with the given 'ContainerID'.
141−-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane
148+-- See "ContainerDeleteOpts" for options and use 'defaultContainerDeleteOpts' for sane
142149-- defaults.
143−deleteContainer :: forall m. (MonadIO m, MonadMask m) => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
150+deleteContainer :: forall m. (MonadIO m, MonadMask m) => ContainerDeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
144151deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
145152
146153-- | Gets 'ContainerDetails' for a given 'ContainerID'.
src/Docker/Client/Http.hs+5−1
@@ -273,6 +273,11 @@ statusCodeToError (CreateImageEndpoint _ _ _) st =
273273 Nothing
274274 else
275275 Just $ DockerInvalidStatusCode st
276+statusCodeToError (DeleteImageEndpoint _ _) st =
277+ if st == status200 then
278+ Nothing
279+ else
280+ Just $ DockerInvalidStatusCode st
276281statusCodeToError (CreateNetworkEndpoint _) st =
277282 if st == status201 then
278283 Nothing
@@ -283,4 +288,3 @@ statusCodeToError (RemoveNetworkEndpoint _) st =
283288 Nothing
284289 else
285290 Just $ DockerInvalidStatusCode st
286−
src/Docker/Client/Internal.hs+4−1
@@ -57,7 +57,7 @@ getEndpoint v (UnpauseContainerEndpoint cid) = encodeURL [v, "containers", fromC
5757getEndpoint v (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
5858 encodeURLWithQuery [v, "containers", fromContainerID cid, "logs"] query
5959 where query = [("stdout", Just (encodeQ $ show stdout)), ("stderr", Just (encodeQ $ show stderr)), ("follow", Just (encodeQ $ show follow))]
60−getEndpoint v (DeleteContainerEndpoint (DeleteOpts removeVolumes force) cid) =
60+getEndpoint v (DeleteContainerEndpoint (ContainerDeleteOpts removeVolumes force) cid) =
6161 encodeURLWithQuery [v, "containers", fromContainerID cid] query
6262 where query = [("v", Just (encodeQ $ show removeVolumes)), ("force", Just (encodeQ $ show force))]
6363getEndpoint v (InspectContainerEndpoint cid) =
@@ -75,6 +75,7 @@ getEndpoint v (CreateImageEndpoint name tag _) = encodeURLWithQuery [v, "images"
7575 where query = [("fromImage", Just n), ("tag", Just t)]
7676 n = encodeQ $ T.unpack name
7777 t = encodeQ $ T.unpack tag
78+getEndpoint v (DeleteImageEndpoint _ cid) = encodeURL [v, "images", fromImageID cid]
7879getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]
7980getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]
8081
@@ -96,6 +97,8 @@ getEndpointRequestBody (InspectContainerEndpoint _) = Nothing
9697
9798getEndpointRequestBody (BuildImageEndpoint _ fp) = Just $ requestBodySourceChunked $ CB.sourceFile fp
9899getEndpointRequestBody (CreateImageEndpoint _ _ _) = Nothing
100+getEndpointRequestBody (DeleteImageEndpoint _ _) = Nothing
101+
99102getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
100103getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing
101104
src/Docker/Client/Types.hs+20−6
@@ -40,8 +40,10 @@ module Docker.Client.Types (
4040 , DetachKeys(..)
4141 , StartOpts(..)
4242 , defaultStartOpts
43− , DeleteOpts(..)
44− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
4547 , Timestamp
4648 , TailLogOpt(..)
4749 , LogOpts(..)
@@ -130,10 +132,11 @@ data Endpoint =
130132 | UnpauseContainerEndpoint ContainerID
131133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
132134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
133− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
134136 | InspectContainerEndpoint ContainerID
135137 | BuildImageEndpoint BuildOpts FilePath
136138 | 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
137140 | CreateNetworkEndpoint CreateNetworkOpts
138141 | RemoveNetworkEndpoint NetworkID
139142 deriving (Eq, Show)
@@ -759,7 +762,7 @@ defaultStartOpts :: StartOpts
759762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
760763
761764-- | Options for deleting a container.
762−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
763766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
764767 , force :: Bool -- ^ If the container is still running force deletion anyway.
765768 } deriving (Eq, Show)
@@ -789,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
789792-- | Default options for deleting a container. Most of the time we DON'T
790793-- want to delete the container's volumes or force delete it if it's
791794-- running.
792−defaultDeleteOpts :: DeleteOpts
793−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
796+defaultContainerDeleteOpts = ContainerDeleteOpts { 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
794804
795805-- | Timestamp alias.
796806type Timestamp = Integer
@@ -1554,7 +1564,11 @@ instance FromJSON ContainerConfig where
15541564 macAddress labels stopSignal
15551565 parseJSON _ = fail "NetworkSettings is not an object."
15561566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
15571570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
15581572parseIntegerText t = case readMaybe $ T.unpack t of
15591573 Nothing ->
15601574 fail "Could not parse Integer"
stack-7.10.yaml+1
@@ -14,6 +14,7 @@ flags: {}
1414extra-deps:
1515- directory-1.2.7.0
1616- unliftio-core-0.1.1.0
17+- process-1.6.5.1
1718
1819# Control whether we use the GHC we find on the path
1920# system-ghc: true
stack-8.6.4.yamlnew file+4
@@ -0,0 +1,4 @@
1+resolver: lts-13.19
2+packages:
3+- '.'
4+extra-deps: []
stack-8.8.2.yamlnew file+5
@@ -0,0 +1,5 @@
1+resolver: lts-15.0
2+packages:
3+- '.'
4+extra-deps: []
5+
stack.yaml+1−1
@@ -1 +1 @@
1−stack-8.0.2.yaml
1+stack-8.6.4.yaml
tests/tests.hs+30−4
@@ -2,6 +2,7 @@
22
33module Main where
44
5+import Data.Either (rights)
56import Prelude hiding (all)
67import qualified Test.QuickCheck.Monadic as QCM
78import Test.Tasty
@@ -23,7 +24,7 @@ import qualified Data.ByteString.Lazy as BL
2324import qualified Data.HashMap.Strict as HM
2425import Data.Int (Int)
2526import qualified Data.Map as M
26−import Data.Maybe (fromJust, isJust)
27+import Data.Maybe (fromJust, isJust, isNothing, listToMaybe)
2728import Data.Monoid
2829import Data.Text (Text, unpack)
2930import qualified Data.Vector as V
@@ -39,6 +40,7 @@ import Docker.Client
3940
4041-- opts = defaultClientOpts
4142testImageName = "docker-hs/test"
43+imageToDeleteFullName = "hello-world:latest"
4244
4345toStrict1 = B.concat . BL.toChunks
4446
@@ -72,13 +74,27 @@ testFindImage =
7274 where
7375 imageFullName = testImageName <> ":latest"
7476
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+
7591testListContainers :: IO ()
7692testListContainers =
7793 runDocker $
7894 do containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing
7995 c <- fromRight containerId
8096 res <- listContainers $ ListOpts { all=True }
81− deleteContainer (DeleteOpts True True) c
97+ deleteContainer (ContainerDeleteOpts True True) c
8298 lift $ assert $ isRight res
8399
84100testBuildFromDockerfile :: IO ()
@@ -100,6 +116,7 @@ testRunAndReadLogHelper :: NetworkingConfig -> IO ()
100116testRunAndReadLogHelper networkingConfig =
101117 runDocker $
102118 do let containerConfig = (defaultContainerConfig (testImageName <> ":latest")) {env = [EnvVar "TEST" "123"]}
119+ createdNetworks <- rights <$> mapM createNetworkWithName networkNames
103120 containerId <- createContainer (CreateOpts containerConfig defaultHostConfig networkingConfig) Nothing
104121 c <- fromRight containerId
105122 status1 <- startContainer defaultStartOpts c
@@ -108,11 +125,15 @@ testRunAndReadLogHelper networkingConfig =
108125 lift $ assertBool ("starting the container, unexpected status: " ++ show status1) $ isRightUnit status1
109126 logs <- getContainerLogs defaultLogOpts c >>= fromRight
110127 lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)
111− status3 <- deleteContainer (DeleteOpts True True) c
128+ status3 <- deleteContainer (ContainerDeleteOpts True True) c
112129 lift $ assertBool ("deleting container, unexpected status: " ++ show status3) $ isRightUnit status3
130+ mapM_ removeNetwork createdNetworks
113131 where
114132 isRightUnit (Right ()) = True
115133 isRightUnit _ = False
134+ networkNames = HM.keys $ endpointsConfig networkingConfig
135+ createNetworkWithName name = createNetwork $
136+ (defaultCreateNetworkOpts name) { createNetworkCheckDuplicate = True }
116137
117138testCreateRemoveNetwork :: IO ()
118139testCreateRemoveNetwork = do
@@ -222,6 +243,7 @@ integrationTests =
222243 [ testCase "Get docker version" testDockerVersion
223244 , testCase "Build image from Dockerfile" testBuildFromDockerfile
224245 , testCase "Find image by name" testFindImage
246+ , testCase "Delete image" testDeleteImage
225247 , testCase "List containers" testListContainers
226248 , testCase "Run a dummy container and read its log" testRunAndReadLog
227249 , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking
@@ -243,7 +265,11 @@ jsonTests =
243265 ]
244266
245267setup :: IO ()
246−setup = system ("docker build -t " ++ unpack testImageName ++ " tests") >> return ()
268+setup =
269+ mapM_ system
270+ [ "docker pull " ++ unpack imageToDeleteFullName
271+ , "docker build -t " ++ unpack testImageName ++ " tests"
272+ ]
247273
248274isLeft = not . isRight
249275