on master help sign in
22 files changed+888−307
since splitsnapshots
unifiedsplit
.gitignore+1 .travis.yml+31−3 CHANGELOG.md+71 CONTRIBUTING.md+12−2 LICENSE+1−1 Makefile+21−2 README.md+37−10 docker.cabal+26−12 examples/Example.hs+52−43 src/Docker/Client.hs+12−5 src/Docker/Client/Api.hs+66−14 src/Docker/Client/Http.hs+51−13 src/Docker/Client/Internal.hs+39−25 src/Docker/Client/Types.hs+215−89 stack-7.10.yaml+5−5 stack-8.0.2.yaml+4 stack-8.0.yaml+2−1 stack-8.6.4.yaml+4 stack-8.8.2.yaml+5 stack.yaml+1−1 tests/Dockerfile+1−1 tests/tests.hs+231−80
.gitignore+1
@@ -4,3 +4,4 @@
44*~
55.stack-work/
66dist-newstyle
7+/cabal.project.local
.travis.yml+31−3
@@ -1,6 +1,12 @@
11sudo: required
22dist: trusty
33
4+# Only build master and release tags
5+branches:
6+ only:
7+ - master
8+ - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
9+
410# Choose a lightweight base image; we provide our own build tools.
511language:
612 c
@@ -16,8 +22,30 @@ services:
1622 - docker
1723
1824env:
19− - GHCVER=7.10 STACK_ARGS=""
20− - GHCVER=8.0 STACK_ARGS=""
25+ global:
26+ - RUN_INTEGRATION_TESTS=1
27+ - STACK_ARGS=""
28+
29+ matrix:
30+ - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=7.10
31+ - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=7.10
32+ - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=7.10
33+
34+ - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=8.0
35+ - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.0
36+ - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.0
37+
38+ - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=8.0.2
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
2149
2250addons:
2351 apt:
@@ -29,7 +57,7 @@ before_install:
2957 - sudo sh -c 'echo "deb https://apt.dockerproject.org/repo ubuntu-trusty main" > /etc/apt/sources.list.d/docker.list'
3058 - sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
3159 - sudo apt-get update
32− - sudo apt-get -qqy -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install docker-engine=1.12.3-0~trusty
60+ - sudo apt-get -qqy -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install docker-engine=$DOCKER_VERSION
3361
3462install:
3563 - mkdir -p "$HOME"/.local/bin
CHANGELOG.md+71
@@ -1,5 +1,76 @@
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+
22+## 0.5.1.1 (2018-03-09)
23+
24+- Bump aeson version.
25+
26+## 0.5.1.0 (2018-02-23)
27+
28+- Support http-conduit-2.3.0.
29+- Bump http-types versions.
30+
31+## 0.5.0.1 (2018-01-26)
32+
33+- Bumps upper bound for http-types (properly this time).
34+
35+## 0.5.0.0 (2018-01-24)
36+
37+- Added (some) contribution and general docs
38+- Fix case when stopping non-existent container
39+- Added more integration tests
40+- Fixed error while parsing list container endpoint output
41+- Changed State/Status data type (related to the above fix)
42+- Added tests against different docker version to travis CIA
43+- Fixed EnvVar JSON encoding
44+- Fixed NetworkMode parsing
45+- Allow http-types 0.11
46+
47+## 0.4.1.1 (2017-10-16)
48+
49+- Small change to add env var for skipping integration tests.
50+ This is mostly to avoid running those on stackage.
51+
52+## 0.4.1.0 (2017-10-04)
53+
54+- Relaxed aeson, tls and time upper bounds
55+
56+
57+## 0.4.0.2 (2017-09-19)
58+
59+- Support LTS 9.4
60+
61+## 0.4.0.1 (2017-06-29)
62+
63+- fixes omKillDisable parsing from json
64+- adds Entrypoint data type and tests edge cases
65+- more tests
66+- small comsmetic changes
67+
68+## 0.4.0.0 (2017-03-20)
69+
70+- Adds streaming support via conduits (changes API a bit hence the major version release)
71+- Added support for streaming log output
72+- Added support for pulling images from the hub (and streaming the output)
73+
374## 0.3.0.1 (2016-09-07)
475
576- Small cosmetic changes and marking OVERLAPPING instance
CONTRIBUTING.md+12−2
@@ -1,4 +1,14 @@
1−# TODO
1+# Contributing
22
3−Add basic guidelines here, things like style guide (using .configuration files from the repo) etc etc.
3+If you wish to contribute please see [any issue on GitHub tagged with "help
4+wanted"](https://github.com/denibertovic/docker-hs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
5+Before starting to work, consider commenting on the issue you want to resolve or
6+open a new issue to discuss design decisions and implementation details. This is
7+so that no development cycles go to waste on implementing a feature that might
8+not get merged either because of implementation details or other reasons.
49
10+Make sure to submit your PR's against the `master` branch.
11+
12+## Project Setup
13+
14+See the `README.md` file on how to setup the project on your development machine.
LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2016, Deni Bertovic
1+Copyright (c) 2014, Deni Bertovic
22
33All rights reserved.
44
Makefile+21−2
@@ -1,4 +1,6 @@
1−.PHONY: build repl test release
1+.PHONY: build repl test release help
2+
3+.DEFAULT_GOAL = help
24
35PROJECT_NAME ?= $(shell grep "^name" docker.cabal | cut -d " " -f17)
46VERSION ?= $(shell grep "^version:" docker.cabal | cut -d " " -f14)
@@ -6,18 +8,35 @@ RESOLVER ?= $(shell grep "^resolver:" stack.yaml | cut -d " " -f2)
68GHC_VERSION ?= $(shell stack ghc -- --version | cut -d " " -f8)
79ARCH=$(shell uname -m)
810
11+## Run build
912build:
1013 @stack build
1114
15+## Run repl
1216repl:
1317 @stack repl
1418
19+## Run tests. Example RUN_INTEGRATION_TESTS=1 make test
1520test:
16− @stack test
21+ @RUN_INTEGRATION_TESTS=1 stack test
1722
23+## Cut new release
1824release:
1925 @stack build --haddock
2026 @stack sdist
2127 @echo "\n\nDone. Now run: \n\nstack upload <path_to_tarball>\n"
2228 @echo "\nAnd: \n\ngit tag ${VERSION} && git push --tags\n"
2329
30+## Show help screen.
31+help:
32+ @echo "Please use \`make <target>' where <target> is one of\n\n"
33+ @awk '/^[a-zA-Z\-\_0-9]+:/ { \
34+ helpMessage = match(lastLine, /^## (.*)/); \
35+ if (helpMessage) { \
36+ helpCommand = substr($$1, 0, index($$1, ":")-1); \
37+ helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
38+ printf "%-30s %s\n", helpCommand, helpMessage; \
39+ } \
40+ } \
41+ { lastLine = $$0 }' $(MAKEFILE_LIST)
42+
README.md+37−10
@@ -1,21 +1,48 @@
11# An API client for docker written in Haskell
22
3−| Master | Dev |
4−| -------| ---- |
5−| [![master](https://travis-ci.org/denibertovic/docker-hs.svg?branch=master)](https://travis-ci.org/denibertovic/docker-hs) | [![dev](https://travis-ci.org/denibertovic/docker-hs.svg?branch=dev)](https://travis-ci.org/denibertovic/docker-hs) |
3+| Master |
4+| -------|
5+| [![master](https://travis-ci.org/denibertovic/docker-hs.svg?branch=master)](https://travis-ci.org/denibertovic/docker-hs) |
66
77
88## Current state
99
10−**API is still not stable.**
11−We're looking to stabilize the API after the next release (0.4.0.0)
10+Supported Docker Engine Api version: `v1.24` and onwards.
11+
12+Anything upward of that should work since Docker versions their API.
13+Older docker version and engine api versions are not supported at the moment.
14+
15+## Documentation
16+
17+The API-documentation is available at
18+[Hackage](https://hackage.haskell.org/package/docker). There are also some
19+usage-examples in the main library source file,
20+[`Client.hs`](https://hackage.haskell.org/package/docker/docs/Docker-Client.html).
1221
1322## Contributing
1423
15−If you wish to contribute please see any issue tagged with "help wanted".
16−Make sure to submit your PR's against the `dev` branch.
24+Please see [CONTRIBUTING.md](CONTRIBUTING.md).
25+
26+### Project Setup
27+
28+For working on the library, you need the Haskell Tool Stack installed (see [the
29+Haskell Tool Stack
30+website](https://docs.haskellstack.org/en/stable/install_and_upgrade/)). You
31+also need `make` to use the `Makefile` included in the project. Run `make help`
32+to see the available commands (for building, running the tests and releasing).
33+
34+### Tests
35+
36+Tests are located in the `tests` directory and can be run with `make test`. This
37+only runs the unit tests.
38+
39+To run integration tests, you need Docker installed and listening on Port `2375`
40+of `localhost` (docker only listens to a Unix socket by default, see the [Docker
41+documentation](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option)
42+for details). Set the environment variable `RUN_INTEGRATION_TESTS`, i.e.
43+`RUN_INTEGRATION_TESTS=1 make test`.
1744
18−Please consider filling an Issue first and discuss design decisions and implementation details before
19−writing any code. This is so that no development cycles go to waste on implementing a feature that
20−might not get merged either because of implementation details or other reasons.
45+## IRC
2146
47+If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
48+on freenode.
docker.cabal+26−12
@@ -1,5 +1,5 @@
11name: docker
2−version: 0.3.0.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
@@ -14,24 +14,29 @@ extra-source-files: README.md
1414cabal-version: >=1.10
1515stability: experimental
1616
17+-- Flag small-http-conduit
18+-- Description: Resolve whether http-conduit < 2.3.0.
19+-- Manual: False
20+-- Default: True
21+
1722library
18− default-extensions: DeriveGeneric, OverloadedStrings, ScopedTypeVariables, ExplicitForAll, MultiParamTypeClasses, FlexibleContexts, GeneralizedNewtypeDeriving, RankNTypes, DeriveFunctor, FlexibleInstances
23+ default-extensions: DeriveGeneric, OverloadedStrings, ScopedTypeVariables, ExplicitForAll, MultiParamTypeClasses, FlexibleContexts, GeneralizedNewtypeDeriving, RankNTypes, DeriveFunctor, FlexibleInstances, CPP
1924 hs-source-dirs: src
2025 exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http, Docker.Client.Utils
2126 -- other-modules: Docker.Internal
2227 build-depends: base >= 4.7 && < 5
23− , aeson >= 0.9.0 && < 1.1.0
28+ , aeson >= 0.9.0 && < 2.0.0
2429 , blaze-builder >= 0.4.0 && < 0.5.0
2530 , bytestring >= 0.10.0 && < 0.11.0
26− , containers >= 0.5.0 && < 0.6.0
31+ , containers >= 0.5.0 && < 0.7.0
2732 , data-default-class >= 0.0.1 && < 0.2.0
28− , http-client >= 0.4.0 && < 0.5.0
29− , http-types >= 0.9 && < 0.10.0
33+ , http-client >= 0.4.0 && < 0.7.0
34+ , http-types >= 0.9 && < 0.13
35+ , vector
3036 , conduit
3137 , conduit-combinators
3238 , conduit-extra
3339 , exceptions
34− , http-conduit
3540 , monad-control
3641 , resourcet
3742 , transformers
@@ -46,13 +51,20 @@ library
4651 , mtl >= 2.0.0 && < 3.0.0
4752 , network >= 2.6.0
4853 , text >= 1.0.0 && < 2.0.0
49− , time >= 1.5.0 && < 1.7.0
54+ , time >= 1.5.0 && < 2.0.0
5055 , scientific >= 0.3.0 && < 0.4.0
51− , tls >= 1.3.7 && < 1.4.0
56+ , tls >= 1.3.7 && < 1.6.0
5257 , unordered-containers >= 0.2.0 && < 0.3.0
53− , x509 >= 1.6.0 && < 1.7.0
54− , x509-store >= 1.6.0 && < 1.7.0
55− , x509-system >= 1.6.0 && < 1.7.0
58+ , x509 >= 1.6.0 && < 1.8.0
59+ , x509-store >= 1.6.0 && < 1.8.0
60+ , x509-system >= 1.6.0 && < 1.8.0
61+ , http-conduit
62+ , unliftio-core >= 0.1.0.0 && < 0.2.0
63+ -- if flag(small-http-conduit)
64+ -- build-depends: http-conduit < 2.3.0
65+ -- else
66+ -- build-depends: http-conduit >= 2.3.0
67+ -- , unliftio-core
5668 default-language: Haskell2010
5769 ghc-options: -Wall -fno-warn-name-shadowing
5870
@@ -61,6 +73,7 @@ test-suite docker-hs-tests
6173 , bytestring
6274 , connection
6375 , docker
76+ , directory
6477 , aeson
6578 , containers
6679 , unordered-containers
@@ -76,6 +89,7 @@ test-suite docker-hs-tests
7689 , transformers
7790 , QuickCheck
7891 , process
92+ , vector
7993 type: exitcode-stdio-1.0
8094 main-is: tests.hs
8195 hs-source-dirs: tests
examples/Example.hs+52−43
@@ -1,55 +1,64 @@
11import Docker.Client
22
33runNginxContainer :: IO ContainerID
4−runNginxContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
5− let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
6− let myCreateOpts = addPortBinding pb $ defaultCreateOpts "nginx:latest"
7− cid <- createContainer myCreateOpts (Just "myNginxContainer")
8− case cid of
9− Left err -> error $ show err
10− Right i -> do
11− _ <- startContainer defaultStartOpts i
12− return i
4+runNginxContainer = do
5+ h <- defaultHttpHandler
6+ runDockerT (defaultClientOpts, h) $
7+ do let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
8+ let myCreateOpts = addPortBinding pb $ defaultCreateOpts "nginx:latest"
9+ cid <- createContainer myCreateOpts (Just "myNginxContainer")
10+ case cid of
11+ Left err -> error $ show err
12+ Right i -> do
13+ _ <- startContainer defaultStartOpts i
14+ return i
1315
1416stopNginxContainer :: ContainerID -> IO ()
15−stopNginxContainer cid = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
16− r <- stopContainer DefaultTimeout cid
17− case r of
18− Left _ -> error "I failed to stop the container"
19− Right _ -> return ()
17+stopNginxContainer cid = do
18+ h <- defaultHttpHandler
19+ runDockerT (defaultClientOpts, h) $
20+ do r <- stopContainer DefaultTimeout cid
21+ case r of
22+ Left _ -> error "I failed to stop the container"
23+ Right _ -> return ()
2024
2125runPostgresContainer :: IO ContainerID
22−runPostgresContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
23− let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
24− let b = Bind "/tmp" "/tmp" Nothing
25− let myCreateOpts = addBind b $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
26− cid <- createContainer myCreateOpts Nothing
27− case cid of
28− Left err -> error $ show err
29− Right i -> do
30− _ <- startContainer defaultStartOpts i
31− return i
26+runPostgresContainer = do
27+ h <- defaultHttpHandler
28+ runDockerT (defaultClientOpts, h) $
29+ do let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
30+ let b = Bind "/tmp" "/tmp" Nothing
31+ let myCreateOpts = addBind b $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
32+ cid <- createContainer myCreateOpts Nothing
33+ case cid of
34+ Left err -> error $ show err
35+ Right i -> do
36+ _ <- startContainer defaultStartOpts i
37+ return i
3238
3339-- | Example of how we can start a database container while hosting it's
3440-- data in a data volume living inside another container.
3541runPostgresWithDataContainer :: IO ContainerID
36−runPostgresWithDataContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
37− -- We use a dummy command like /bin/true because we don't want to start
38− -- the postgres database in the data container we just want it to
39− -- create a container filesystem for us.
40− let dataOpts = setCmd "/bin/true" $ defaultCreateOpts "postgres:9.5"
41− cid <- createContainer dataOpts (Just "myDataContainer")
42− _ <- case cid of
43− Left err -> error $ show err
44− Right i -> startContainer defaultStartOpts i
45− let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
46− -- Default permission is read-write if we don't specify anything
47− let vf = VolumeFrom "myDataContainer" Nothing
48− let myCreateOpts = addVolumeFrom vf $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
49− ccid <- createContainer myCreateOpts (Just "pgContainer")
50− case ccid of
51− Left err -> error $ show err
52− Right i -> do
53− _ <- startContainer defaultStartOpts i
54− return i
42+runPostgresWithDataContainer = do
43+ h <- defaultHttpHandler
44+ runDockerT (defaultClientOpts, h) $
45+ -- We use a dummy command like /bin/true because we don't want to start
46+ -- the postgres database in the data container we just want it to
47+ -- create a container filesystem for us.
48+ do let dataOpts = setCmd "/bin/true" $ defaultCreateOpts "postgres:9.5"
49+ cid <- createContainer dataOpts (Just "myDataContainer")
50+ _ <-
51+ case cid of
52+ Left err -> error $ show err
53+ Right i -> startContainer defaultStartOpts i
54+ let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
55+ -- Default permission is read-write if we don't specify anything
56+ let vf = VolumeFrom "myDataContainer" Nothing
57+ let myCreateOpts = addVolumeFrom vf $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
58+ ccid <- createContainer myCreateOpts (Just "pgContainer")
59+ case ccid of
60+ Left err -> error $ show err
61+ Right i -> do
62+ _ <- startContainer defaultStartOpts i
63+ return i
5564
src/Docker/Client.hs+12−5
@@ -3,7 +3,7 @@
33
44{-|
55Module : Docker.Client
6−Copyright : (c) Deni Bertovic, 2016
6+Copyright : (c) Deni Bertovic, 2014
77License : BSD3
88Maintainer : deni@denibertovic.com
99Stability : experimental
@@ -20,7 +20,9 @@ the host.
2020import Docker.Client
2121
2222runNginxContainer :: IO ContainerID
23−runNginxContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
23+runNginxContainer = do
24+ h <- defaultHttpHandler
25+ runDockerT (defaultClientOpts, h) $ do
2426 let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
2527 let myCreateOpts = addPortBinding pb $ defaultCreateOpts "nginx:latest"
2628 cid <- createContainer myCreateOpts
@@ -42,7 +44,9 @@ Let's stop the container now:
4244
4345@
4446stopNginxContainer :: ContainerID -> IO ()
45−stopNginxContainer cid = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
47+stopNginxContainer cid = do
48+ h <- defaultHttpHandler
49+ runDockerT (defaultClientOpts, h) $ do
4650 r <- stopContainer DefaultTimeout cid
4751 case r of
4852 Left err -> error "I failed to stop the container"
@@ -57,7 +61,9 @@ persist on the host file system.
5761
5862@
5963runPostgresContainer :: IO ContainerID
60−runPostgresContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
64+runPostgresContainer = do
65+ h <- defaultHttpHandler
66+ runDockerT (defaultClientOpts, h) $ do
6167 let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
6268 let myCreateOpts = addBinds [Bind "\/tmp" "\/tmp" Nothing] $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
6369 cid <- createContainer myCreateOpts
@@ -70,7 +76,8 @@ runPostgresContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
7076
7177= Get Docker API Version
7278
73−>>> runDockerT (defaultClientOpts, defaultHttpHandler) $ getDockerVersion
79+>>> h <- defaultHttpHandler
80+>>> runDockerT (defaultClientOpts, h) $ getDockerVersion
7481Right (DockerVersion {version = "1.12.0", apiVersion = "1.24", gitCommit = "8eab29e", goVersion = "go1.6.3", os = "linux", arch = "amd64", kernelVersion = "4.6.0-1-amd64", buildTime = "2016-07-28T21:46:40.664812891+00:00"})
7582
7683= Setup SSL Authentication
src/Docker/Client/Api.hs+66−14
@@ -18,12 +18,17 @@ module Docker.Client.Api (
1818 , getContainerLogsStream
1919 -- * Images
2020 , listImages
21+ , deleteImage
2122 , buildImageFromDockerfile
23+ , pullImage
24+ -- * Network
25+ , createNetwork
26+ , removeNetwork
2227 -- * Other
2328 , getDockerVersion
2429 ) where
2530
26−import Control.Monad.Catch (MonadMask(..))
31+import Control.Monad.Catch (MonadMask (..))
2732import Control.Monad.IO.Class
2833import Control.Monad.Reader (ask, lift)
2934import Data.Aeson (FromJSON, eitherDecode')
@@ -31,17 +36,18 @@ import qualified Data.ByteString as BS
3136import qualified Data.ByteString.Lazy as BSL
3237import Data.Conduit (Sink)
3338import qualified Data.Conduit.Binary as Conduit
39+import qualified Data.Text as T
3440import qualified Data.Text as Text
35−import Network.HTTP.Client (responseStatus)
36−import Network.HTTP.Types (StdMethod (..))
37−import System.Exit (ExitCode(..))
41+import Network.HTTP.Client (responseStatus)
42+import Network.HTTP.Types (StdMethod (..))
43+import System.Exit (ExitCode (..))
3844
3945import Docker.Client.Http
4046import Docker.Client.Types
4147import Docker.Client.Utils
4248
4349requestUnit :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError ())
44−requestUnit verb endpoint = const (Right ()) <$> requestHelper verb endpoint
50+requestUnit verb endpoint = fmap (const ()) <$> requestHelper verb endpoint
4551
4652requestHelper :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError BSL.ByteString)
4753requestHelper verb endpoint = requestHelper' verb endpoint Conduit.sinkLbs
@@ -54,8 +60,8 @@ requestHelper' verb endpoint sink = do
5460 return $ Left $ DockerInvalidRequest endpoint
5561 Just request -> do
5662 -- JP: Do we need runResourceT?
57− -- lift $ NHS.httpSink request $ \response ->
58− lift $ httpHandler request $ \response ->
63+ -- lift $ NHS.httpSink request $ \response ->
64+ lift $ httpHandler request $ \response ->
5965 -- Check status code.
6066 let status = responseStatus response in
6167 case statusCodeToError endpoint status of
@@ -88,6 +94,12 @@ listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseR
8894listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])
8995listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
9096
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+
91103-- | Creates a docker container but does __not__ start it. See
92104-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'
93105-- for some sane defaults.
@@ -133,9 +145,9 @@ unpauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT
133145unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
134146
135147-- | Deletes a container with the given 'ContainerID'.
136−-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane
148+-- See "ContainerDeleteOpts" for options and use 'defaultContainerDeleteOpts' for sane
137149-- defaults.
138−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 ())
139151deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
140152
141153-- | Gets 'ContainerDetails' for a given 'ContainerID'.
@@ -149,27 +161,67 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars
149161-- See 'LogOpts' for options that you can pass and
150162-- 'defaultLogOpts' for sane defaults.
151163--
152−-- __NOTE__: Currently streaming logs is
153−-- not supported and this function will fetch the entire log that the
164+-- __NOTE__: his function will fetch the entire log that the
154165-- container produced in the json-file on disk. Depending on the logging
155166-- setup of the process in your container this can be a significant amount
156167-- which might block your application...so use with caution.
157168--
158−-- The recommended method is to use one of the other 'LogDriverType's available (like
169+-- If you want to stream the logs from the container continuosly then use
170+-- 'getContainerLogsStream'
171+--
172+-- __NOTE__: It's recommended to use one of the other 'LogDriverType's available (like
159173-- syslog) for creating your containers.
160174getContainerLogs :: forall m. (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> DockerT m (Either DockerError BSL.ByteString)
161175getContainerLogs logopts cid = requestHelper GET (ContainerLogsEndpoint logopts False cid)
162176
177+{-| Continuously gets the container's logs as a stream. Uses conduit.
178+
179+__Example__:
180+
181+@
182+>>> import Docker.Client
183+>>> import Data.Maybe
184+>>> import Conduit
185+>>> h <- defaultHttpHanlder
186+>>> let cid = fromJust $ toContainerID "fee86e1d522b"
187+>>> runDockerT (defaultClientOpts, h) $ getContainerLogsStream defaultLogOpts cid stdoutC
188+@
189+
190+-}
163191getContainerLogsStream :: forall m b . (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)
164−getContainerLogsStream logopts cid sink = requestHelper' GET (ContainerLogsEndpoint logopts True cid) sink
192+getContainerLogsStream logopts cid = requestHelper' GET (ContainerLogsEndpoint logopts True cid)
165193-- JP: Should the second (follow) argument be True? XXX
166194
195+-- | Build an Image from a Dockerfile
196+--
167197-- TODO: Add X-Registry-Config
198+--
168199-- TODO: Add support for remote URLs to a Dockerfile
200+--
169201-- TODO: Clean up temp tar.gz file after the image is built
170202buildImageFromDockerfile :: forall m. (MonadIO m, MonadMask m) => BuildOpts -> FilePath -> DockerT m (Either DockerError ())
171203buildImageFromDockerfile opts base = do
172204 ctx <- makeBuildContext $ BuildContextRootDir base
173205 case ctx of
174− Left e -> return $ Left e
206+ Left e -> return $ Left e
175207 Right c -> requestUnit POST (BuildImageEndpoint opts c)
208+
209+-- | Pulls an image from Docker Hub (by default).
210+--
211+-- TODO: Add support for X-Registry-Auth and pulling from private docker
212+-- registries.
213+--
214+-- TODO: Implement importImage function that uses he same
215+-- CreateImageEndpoint but rather than pulling from docker hub it imports
216+-- the image from a tarball or a URL.
217+pullImage :: forall m b . (MonadIO m, MonadMask m) => T.Text -> Tag -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)
218+pullImage name tag = requestHelper' POST (CreateImageEndpoint name tag Nothing)
219+
220+-- | Creates network
221+createNetwork :: forall m. (MonadIO m, MonadMask m) => CreateNetworkOpts -> DockerT m (Either DockerError NetworkID)
222+createNetwork opts = requestHelper POST (CreateNetworkEndpoint opts) >>= parseResponse
223+
224+-- | Removes a network
225+removeNetwork :: forall m. (MonadIO m, MonadMask m) => NetworkID -> DockerT m (Either DockerError ())
226+removeNetwork nid = requestUnit DELETE $ RemoveNetworkEndpoint nid
227+
src/Docker/Client/Http.hs+51−13
@@ -4,8 +4,11 @@
44module Docker.Client.Http where
55
66-- import Control.Monad.Base (MonadBase(..), liftBaseDefault)
7−import Control.Monad.Catch (MonadMask(..))
8−import Control.Monad.Reader (ReaderT(..), runReaderT)
7+import Control.Monad.Catch (MonadMask (..))
8+#if MIN_VERSION_http_conduit(2,3,0)
9+import Control.Monad.IO.Unlift (MonadUnliftIO)
10+#endif
11+import Control.Monad.Reader (ReaderT (..), runReaderT)
912import qualified Data.ByteString.Char8 as BSC
1013import qualified Data.ByteString.Lazy as BL
1114import Data.Conduit (Sink)
@@ -17,13 +20,13 @@ import Data.X509.CertificateStore (makeCertificateStore)
1720import Data.X509.File (readKeyFile, readSignedObject)
1821import Network.HTTP.Client (defaultManagerSettings,
1922 managerRawConnection, method,
20− newManager, parseUrl,
23+ newManager, parseRequest,
2124 requestBody, requestHeaders)
2225import qualified Network.HTTP.Client as HTTP
2326import Network.HTTP.Client.Internal (makeConnection)
27+import qualified Network.HTTP.Simple as NHS
2428import Network.HTTP.Types (StdMethod, status101, status200,
2529 status201, status204)
26−import qualified Network.HTTP.Simple as NHS
2730import Network.TLS (ClientHooks (..),
2831 ClientParams (..), Shared (..),
2932 Supported (..),
@@ -45,7 +48,7 @@ import Docker.Client.Internal (getEndpoint,
4548 getEndpointContentType,
4649 getEndpointRequestBody)
4750import Docker.Client.Types (DockerClientOpts, Endpoint (..),
48− baseUrl)
51+ apiVer, baseUrl)
4952
5053type Request = HTTP.Request
5154type Response = HTTP.Response BL.ByteString
@@ -93,8 +96,8 @@ runDockerT (opts, h) r = runReaderT (unDockerT r) (opts, h)
9396-- benefit from testing that on all of our Endpoints
9497mkHttpRequest :: HttpVerb -> Endpoint -> DockerClientOpts -> Maybe Request
9598mkHttpRequest verb e opts = request
96− where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint e)
97− initialR = parseUrl fullE
99+ where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint (apiVer opts) e)
100+ initialR = parseRequest fullE
98101 request' = case initialR of
99102 Just ir ->
100103 return $ ir {method = (encodeUtf8 . T.pack $ show verb),
@@ -104,18 +107,30 @@ mkHttpRequest verb e opts = request
104107 requestHeaders = [("Content-Type", "application/json; charset=utf-8")]}) $ getEndpointRequestBody e) <$> request'
105108 -- Note: Do we need to set length header?
106109
107−defaultHttpHandler :: (MonadIO m, MonadMask m) => m (HttpHandler m)
110+defaultHttpHandler :: (
111+#if MIN_VERSION_http_conduit(2,3,0)
112+ MonadUnliftIO m,
113+#endif
114+ MonadIO m, MonadMask m) => m (HttpHandler m)
108115defaultHttpHandler = do
109116 manager <- liftIO $ newManager defaultManagerSettings
110117 return $ httpHandler manager
111118
112−httpHandler :: (MonadIO m, MonadMask m) => HTTP.Manager -> HttpHandler m
113−httpHandler manager = HttpHandler $ \request' sink -> do -- runResourceT ..
119+httpHandler :: (
120+#if MIN_VERSION_http_conduit(2,3,0)
121+ MonadUnliftIO m,
122+#endif
123+ MonadIO m, MonadMask m) => HTTP.Manager -> HttpHandler m
124+httpHandler manager = HttpHandler $ \request' sink -> do -- runResourceT ..
114125 let request = NHS.setRequestManager manager request'
115126 try (NHS.httpSink request sink) >>= \res -> case res of
116127 Right res -> return res
128+#if MIN_VERSION_http_client(0,5,0)
129+ Left e@(HTTP.HttpExceptionRequest _ HTTP.ConnectionFailure{}) -> return $ Left $ DockerConnectionError e
130+#else
117131 Left e@HTTP.FailedConnectionException{} -> return $ Left $ DockerConnectionError e
118132 Left e@HTTP.FailedConnectionException2{} -> return $ Left $ DockerConnectionError e
133+#endif
119134 Left e -> return $ Left $ GenericDockerError (T.pack $ show e)
120135
121136-- | Connect to a unix domain socket (the default docker socket is
@@ -123,7 +138,11 @@ httpHandler manager = HttpHandler $ \request' sink -> do -- runResourceT ..
123138--
124139-- Docker seems to ignore the hostname in requests sent over unix domain
125140-- sockets (and the port obviously doesn't matter either)
126−unixHttpHandler :: (MonadIO m, MonadMask m) => FilePath -- ^ The socket to connect to
141+unixHttpHandler :: (
142+#if MIN_VERSION_http_conduit(2,3,0)
143+ MonadUnliftIO m,
144+#endif
145+ MonadIO m, MonadMask m) => FilePath -- ^ The socket to connect to
127146 -> m (HttpHandler m)
128147unixHttpHandler fp = do
129148 let mSettings = defaultManagerSettings
@@ -137,7 +156,7 @@ unixHttpHandler fp = do
137156 S.connect s (S.SockAddrUnix filePath)
138157 makeConnection (SBS.recv s 8096)
139158 (SBS.sendAll s)
140− (S.sClose s)
159+ (S.close s)
141160
142161-- TODO:
143162-- Move this to http-client-tls or network?
@@ -249,4 +268,23 @@ statusCodeToError (BuildImageEndpoint _ _) st =
249268 Nothing
250269 else
251270 Just $ DockerInvalidStatusCode st
252−
271+statusCodeToError (CreateImageEndpoint _ _ _) st =
272+ if st == status200 then
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
281+statusCodeToError (CreateNetworkEndpoint _) st =
282+ if st == status201 then
283+ Nothing
284+ else
285+ Just $ DockerInvalidStatusCode st
286+statusCodeToError (RemoveNetworkEndpoint _) st =
287+ if st == status204 then
288+ Nothing
289+ else
290+ Just $ DockerInvalidStatusCode st
src/Docker/Client/Internal.hs+39−25
@@ -5,12 +5,13 @@ import qualified Data.Aeson as JSON
55import Data.ByteString (ByteString)
66import qualified Data.ByteString.Char8 as BSC
77import qualified Data.Conduit.Binary as CB
8−import Data.Text as T
8+import qualified Data.Text as T
99import Data.Text.Encoding (decodeUtf8, encodeUtf8)
1010import qualified Network.HTTP.Client as HTTP
1111import Network.HTTP.Conduit (requestBodySourceChunked)
1212import Network.HTTP.Types (Query, encodePath,
1313 encodePathSegments)
14+import Prelude hiding (all)
1415
1516import Docker.Client.Types
1617
@@ -24,44 +25,44 @@ encodeURLWithQuery ps q = decodeUtf8 $ toByteString $ encodePath ps q
2425encodeQ :: String -> ByteString
2526encodeQ = encodeUtf8 . T.pack
2627
27−getEndpoint :: Endpoint -> T.Text
28−getEndpoint VersionEndpoint = encodeURL ["version"]
29−getEndpoint (ListContainersEndpoint _) = encodeURL ["containers", "json"] -- Make use of lsOpts here
30−getEndpoint (ListImagesEndpoint _) = encodeURL ["images", "json"] -- Make use of lsOpts here
31−getEndpoint (CreateContainerEndpoint _ cn) = case cn of
32− Just cn -> encodeURLWithQuery ["containers", "create"] [("name", Just (encodeQ $ T.unpack cn))]
33− Nothing -> encodeURL ["containers", "create"]
34−getEndpoint (StartContainerEndpoint startOpts cid) = encodeURLWithQuery ["containers", fromContainerID cid, "start"] query
28+getEndpoint :: ApiVersion -> Endpoint -> T.Text
29+getEndpoint v VersionEndpoint = encodeURL [v, "version"]
30+getEndpoint v (ListContainersEndpoint (ListOpts all)) = encodeURLWithQuery [v, "containers", "json"] [("all", Just (encodeQ $ show all))]
31+getEndpoint v (ListImagesEndpoint _) = encodeURL [v, "images", "json"] -- Make use of lsOpts here
32+getEndpoint v (CreateContainerEndpoint _ cn) = case cn of
33+ Just cn -> encodeURLWithQuery [v, "containers", "create"] [("name", Just (encodeQ $ T.unpack cn))]
34+ Nothing -> encodeURL [v, "containers", "create"]
35+getEndpoint v (StartContainerEndpoint startOpts cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "start"] query
3536 where query = case (detachKeys startOpts) of
3637 WithCtrl c -> [("detachKeys", Just (encodeQ $ ctrl ++ [c]))]
3738 WithoutCtrl c -> [("detachKeys", Just (encodeQ [c]))]
3839 DefaultDetachKey -> []
3940 ctrl = ['c', 't', 'r', 'l', '-']
40−getEndpoint (StopContainerEndpoint t cid) = encodeURLWithQuery ["containers", fromContainerID cid, "stop"] query
41+getEndpoint v (StopContainerEndpoint t cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "stop"] query
4142 where query = case t of
42− Timeout x -> [("t", Just (encodeQ $ show x))]
43+ Timeout x -> [("t", Just (encodeQ $ show x))]
4344 DefaultTimeout -> []
44−getEndpoint (WaitContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "wait"]
45−getEndpoint (KillContainerEndpoint s cid) = encodeURLWithQuery ["containers", fromContainerID cid, "kill"] query
45+getEndpoint v (WaitContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "wait"]
46+getEndpoint v (KillContainerEndpoint s cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "kill"] query
4647 where query = case s of
4748 SIG x -> [("signal", Just (encodeQ $ show x))]
48− _ -> [("signal", Just (encodeQ $ show s))]
49−getEndpoint (RestartContainerEndpoint t cid) = encodeURLWithQuery ["containers", fromContainerID cid, "restart"] query
49+ _ -> [("signal", Just (encodeQ $ show s))]
50+getEndpoint v (RestartContainerEndpoint t cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "restart"] query
5051 where query = case t of
51− Timeout x -> [("t", Just (encodeQ $ show x))]
52+ Timeout x -> [("t", Just (encodeQ $ show x))]
5253 DefaultTimeout -> []
53−getEndpoint (PauseContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "pause"]
54−getEndpoint (UnpauseContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "unpause"]
54+getEndpoint v (PauseContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "pause"]
55+getEndpoint v (UnpauseContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "unpause"]
5556-- Make use of since/timestamps/tail logopts here instead of ignoreing them
56−getEndpoint (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
57− encodeURLWithQuery ["containers", fromContainerID cid, "logs"] query
57+getEndpoint v (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
58+ encodeURLWithQuery [v, "containers", fromContainerID cid, "logs"] query
5859 where query = [("stdout", Just (encodeQ $ show stdout)), ("stderr", Just (encodeQ $ show stderr)), ("follow", Just (encodeQ $ show follow))]
59−getEndpoint (DeleteContainerEndpoint (DeleteOpts removeVolumes force) cid) =
60− encodeURLWithQuery ["containers", fromContainerID cid] query
60+getEndpoint v (DeleteContainerEndpoint (ContainerDeleteOpts removeVolumes force) cid) =
61+ encodeURLWithQuery [v, "containers", fromContainerID cid] query
6162 where query = [("v", Just (encodeQ $ show removeVolumes)), ("force", Just (encodeQ $ show force))]
62−getEndpoint (InspectContainerEndpoint cid) =
63− encodeURLWithQuery ["containers", fromContainerID cid, "json"] []
64−getEndpoint (BuildImageEndpoint o _) = encodeURLWithQuery ["build"] query
63+getEndpoint v (InspectContainerEndpoint cid) =
64+ encodeURLWithQuery [v, "containers", fromContainerID cid, "json"] []
65+getEndpoint v (BuildImageEndpoint o _) = encodeURLWithQuery [v, "build"] query
6566 where query = [("t", Just t), ("dockerfile", Just dockerfile), ("q", Just q), ("nocache", Just nocache), ("rm", Just rm), ("forcerm", Just forcerm), ("pull", Just pull)]
6667 t = encodeQ $ T.unpack $ buildImageName o
6768 dockerfile = encodeQ $ T.unpack $ buildDockerfileName o
@@ -70,6 +71,13 @@ getEndpoint (BuildImageEndpoint o _) = encodeURLWithQuery ["build"] query
7071 rm = encodeQ $ show $ buildRemoveItermediate o
7172 forcerm = encodeQ $ show $ buildForceRemoveIntermediate o
7273 pull = encodeQ $ show $ buildPullParent o
74+getEndpoint v (CreateImageEndpoint name tag _) = encodeURLWithQuery [v, "images", "create"] query
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]
79+getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]
80+getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]
7381
7482getEndpointRequestBody :: Endpoint -> Maybe HTTP.RequestBody
7583getEndpointRequestBody VersionEndpoint = Nothing
@@ -86,7 +94,13 @@ getEndpointRequestBody (UnpauseContainerEndpoint _) = Nothing
8694getEndpointRequestBody (ContainerLogsEndpoint _ _ _) = Nothing
8795getEndpointRequestBody (DeleteContainerEndpoint _ _) = Nothing
8896getEndpointRequestBody (InspectContainerEndpoint _) = Nothing
97+
8998getEndpointRequestBody (BuildImageEndpoint _ fp) = Just $ requestBodySourceChunked $ CB.sourceFile fp
99+getEndpointRequestBody (CreateImageEndpoint _ _ _) = Nothing
100+getEndpointRequestBody (DeleteImageEndpoint _ _) = Nothing
101+
102+getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
103+getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing
90104
91105getEndpointContentType :: Endpoint -> BSC.ByteString
92106getEndpointContentType (BuildImageEndpoint _ _) = BSC.pack "application/tar"
src/Docker/Client/Types.hs+215−89
@@ -11,6 +11,9 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
1518 , StatusCode(..)
1619 , Signal(..)
@@ -23,11 +26,12 @@ module Docker.Client.Types (
2326 , ContainerPortInfo(..)
2427 , Container(..)
2528 , ContainerState(..)
26− , Status(..)
29+ , State(..)
2730 , Digest
2831 , Label(..)
2932 , Tag
3033 , Image(..)
34+ , Entrypoint(..)
3135 , dropImagePrefix
3236 , CreateOpts(..)
3337 , BuildOpts(..)
@@ -36,12 +40,16 @@ module Docker.Client.Types (
3640 , DetachKeys(..)
3741 , StartOpts(..)
3842 , defaultStartOpts
39− , DeleteOpts(..)
40− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
4147 , Timestamp
4248 , TailLogOpt(..)
4349 , LogOpts(..)
4450 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4553 , VolumePermission(..)
4654 , Bind(..)
4755 , Volume(..)
@@ -67,6 +75,8 @@ module Docker.Client.Types (
6775 , UTSMode(..)
6876 , HostConfig(..)
6977 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
7080 , Ulimit(..)
7181 , ContainerResources(..)
7282 , defaultContainerResources
@@ -102,6 +112,7 @@ import Data.Scientific (floatingOrInteger)
102112import Data.Text (Text)
103113import qualified Data.Text as T
104114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
105116import GHC.Generics (Generic)
106117import Prelude hiding (all, tail)
107118import Text.Read (readMaybe)
@@ -121,9 +132,13 @@ data Endpoint =
121132 | UnpauseContainerEndpoint ContainerID
122133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
123134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
124− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
125136 | InspectContainerEndpoint ContainerID
126137 | 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)
139+ | DeleteImageEndpoint ImageDeleteOpts ImageID
140+ | CreateNetworkEndpoint CreateNetworkOpts
141+ | RemoveNetworkEndpoint NetworkID
127142 deriving (Eq, Show)
128143
129144-- | We should newtype this
@@ -198,16 +213,16 @@ data Signal = SIGHUP
198213
199214instance FromJSON Signal where
200215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
201− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
202− parseJSON (JSON.String "SIGINT") = return SIGINT
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
203218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
204219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
205220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
206− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
207222
208223instance ToJSON Signal where
209− toJSON SIGHUP = "SIGHUP"
210− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
211226 toJSON SIGQUIT = "SIGQUIT"
212227 toJSON SIGSTOP = "SIGSTOP"
213228 toJSON SIGTERM = "SIGTERM"
@@ -235,7 +250,7 @@ data ContainerDetails = ContainerDetails {
235250 , processLabel :: Text
236251 , resolveConfPath :: FilePath
237252 , restartCount :: Int
238− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
239254 , mounts :: [Mount]
240255 }
241256 deriving (Eq, Show, Generic)
@@ -243,11 +258,11 @@ data ContainerDetails = ContainerDetails {
243258-- | Data type used for parsing the mount information from a container
244259-- list.
245260data Mount = Mount {
246− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
247262 , mountSource :: FilePath
248263 , mountDestination :: FilePath
249− , mountDriver :: Text
250− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
251266 , mountRW :: Bool
252267 , mountPropogation :: Text
253268 }
@@ -255,14 +270,14 @@ data Mount = Mount {
255270
256271instance FromJSON Mount where
257272 parseJSON (JSON.Object o) = do
258− name <- o .: "Name"
273+ name <- o .:? "Name"
259274 src <- o .: "Source"
260275 dest <- o .: "Destination"
261− driver <- o .: "Driver"
262− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
263278 rw <- o .: "RW"
264279 prop <- o .: "Propagation"
265− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
266281 parseJSON _ = fail "Mount is not an object"
267282
268283-- | Data type used for parsing the container state from a list of
@@ -278,7 +293,7 @@ data ContainerState = ContainerState {
278293 , restarting :: Bool
279294 , running :: Bool
280295 , startedAt :: UTCTime
281− , status :: Status
296+ , state :: State
282297 }
283298 deriving (Eq, Show, Generic)
284299
@@ -508,7 +523,8 @@ data Container = Container
508523 , containerImageId :: ImageID
509524 , containerCommand :: Text
510525 , containerCreatedAt :: Int
511− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
512528 , containerPorts :: [ContainerPortInfo]
513529 , containerLabels :: [Label]
514530 , containerNetworks :: [Network]
@@ -516,13 +532,14 @@ data Container = Container
516532 } deriving (Show, Eq)
517533
518534instance FromJSON Container where
519− parseJSON (JSON.Object v) =
520− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
521537 <*> (v .: "Names")
522538 <*> (v .: "Image")
523− <*> (v .: "ImageID")
524− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
525541 <*> (v .: "Created")
542+ <*> (v .: "State")
526543 <*> (v .: "Status")
527544 <*> (v .: "Ports")
528545 <*> (v .: "Labels")
@@ -532,21 +549,20 @@ instance FromJSON Container where
532549 parseNetworks (JSON.Object v) =
533550 (v .: "Networks") >>= parseJSON
534551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
535−
536552 parseJSON _ = fail "Container: Not a JSON object."
537553
538−-- | Represents the status of the container life cycle.
539−data Status = Created | Restarting | Running | Paused | Exited | Dead
554+-- | Represents the state of the container life cycle.
555+data State = Created | Restarting | Running | Paused | Exited | Dead
540556 deriving (Eq, Show, Generic)
541557
542−instance FromJSON Status where
543− parseJSON (JSON.String "running") = return Running
544− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
558+instance FromJSON State where
559+ parseJSON (JSON.String "running") = return Running
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
545561 parseJSON (JSON.String "restarting") = return Restarting
546− parseJSON (JSON.String "paused") = return Paused
547− parseJSON (JSON.String "exited") = return Exited
548− parseJSON (JSON.String "dead") = return Dead
549− parseJSON _ = fail "Unknown Status"
562+ parseJSON (JSON.String "paused") = return Paused
563+ parseJSON (JSON.String "exited") = return Exited
564+ parseJSON (JSON.String "dead") = return Dead
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
550566
551567-- | Alias for representing a RepoDigest. We could newtype this and add
552568-- some validation.
@@ -607,20 +623,46 @@ instance FromJSON Image where
607623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
608624 parseJSON _ = fail "Failed to parse DockerImage."
609625
626+-- | Alias for Aliases.
627+type Alias = Text
628+
629+-- | EndpointsConfig is container configuration for a specific network
630+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
631+
632+instance ToJSON EndpointConfig where
633+ toJSON (EndpointConfig aliases) = JSON.object
634+ [ "Aliases" .= aliases
635+ ]
636+
637+-- | Alias for endpoint name
638+type EndpointName = Text
639+
640+-- | Data type for the NetworkingConfig section of the container settings
641+newtype NetworkingConfig = NetworkingConfig
642+ { endpointsConfig :: HM.HashMap EndpointName EndpointConfig
643+ } deriving (Eq, Show)
644+
645+instance ToJSON NetworkingConfig where
646+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
647+ [ "EndpointsConfig" .= endpointsConfig
648+ ]
610649
611650-- | Options used for creating a Container.
612651data CreateOpts = CreateOpts {
613− containerConfig :: ContainerConfig
614− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
615655 } deriving (Eq, Show)
616656
617657instance ToJSON CreateOpts where
618− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
619659 let ccJSON = toJSON cc
620660 let hcJSON = toJSON hc
621661 case ccJSON of
622662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
623− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665+ JSON.Object o2
624666 _ -> error "ContainerConfig is not an object." -- This should never happen.
625667
626668-- | Container configuration used for creating a container with sensible
@@ -642,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
642684 , cmd=[]
643685 , volumes=[]
644686 , workingDir=Nothing
645− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
646688 , networkDisabled=Nothing
647689 , macAddress=Nothing
648690 , labels=[]
@@ -655,7 +697,7 @@ defaultHostConfig = HostConfig {
655697 binds=[]
656698 , containerIDFile=Nothing
657699 , logConfig=LogDriverConfig JsonFile []
658− , networkMode=Bridge
700+ , networkMode=NetworkBridge
659701 , portBindings=[]
660702 , restartPolicy=RestartOff
661703 , volumeDriver=Nothing
@@ -695,14 +737,18 @@ defaultContainerResources = ContainerResources {
695737 , memory=Nothing
696738 , memoryReservation=Nothing
697739 , memorySwap=Nothing
698− , oomKillDisable=False
740+ , oomKillDisable=Just False
699741 , ulimits=[]
700742 }
701743
702744-- | Default create options when creating a container. You only need to
703745-- specify an image name and the rest is all sensible defaults.
704746defaultCreateOpts :: T.Text -> CreateOpts
705−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
747+defaultCreateOpts imageName = CreateOpts
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
751+ }
706752
707753-- | Override the key sequence for detaching a container.
708754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -716,7 +762,7 @@ defaultStartOpts :: StartOpts
716762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
717763
718764-- | Options for deleting a container.
719−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
720766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
721767 , force :: Bool -- ^ If the container is still running force deletion anyway.
722768 } deriving (Eq, Show)
@@ -746,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
746792-- | Default options for deleting a container. Most of the time we DON'T
747793-- want to delete the container's volumes or force delete it if it's
748794-- running.
749−defaultDeleteOpts :: DeleteOpts
750−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
751804
752805-- | Timestamp alias.
753806type Timestamp = Integer
@@ -775,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
775828 , tail = All
776829 }
777830
831+-- | Options for creating a network
832+data CreateNetworkOpts = CreateNetworkOpts
833+ { createNetworkName :: Text -- ^ The network's name
834+ , createNetworkCheckDuplicate :: Bool -- ^ Check for networks with duplicate names.
835+ , createNetworkDriver :: Text -- ^ Name of the network driver plugin to use.
836+ , createNetworkInternal :: Bool -- ^ Restrict external access to the network.
837+ , createNetworkEnableIPv6 :: Bool -- ^ Enable IPv6 on the network.
838+ } deriving (Eq, Show)
839+
840+-- | Sensible defalut for create network options
841+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
842+defaultCreateNetworkOpts name =
843+ CreateNetworkOpts
844+ { createNetworkName = name
845+ , createNetworkCheckDuplicate = False
846+ , createNetworkDriver = "bridge"
847+ , createNetworkInternal = True
848+ , createNetworkEnableIPv6 = False
849+ }
850+
851+instance ToJSON CreateNetworkOpts where
852+ toJSON opts =
853+ object
854+ [ "Name" .= createNetworkName opts
855+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
856+ , "Driver" .= createNetworkDriver opts
857+ , "Internal" .= createNetworkInternal opts
858+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
859+ ]
860+
778861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
779862-- | Set permissions on volumes that you mount in the container.
780863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
781864
782865instance ToJSON VolumePermission where
783866 toJSON ReadWrite = "rw"
784− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
785868
786869instance FromJSON VolumePermission where
787870 parseJSON "rw" = return ReadWrite
788871 parseJSON "ro" = return ReadOnly
789− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
790875
791876-- | Used for marking a directory in the container as "exposed" hence
792877-- taking it outside of the COW filesystem and making it mountable
@@ -808,8 +893,8 @@ instance {-# OVERLAPPING #-} ToJSON [Volume] where
808893
809894instance {-# OVERLAPPING #-} FromJSON [Volume] where
810895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
811− parseJSON (JSON.Null) = return []
812− parseJSON _ = fail "Volume is not an object"
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
813898
814899
815900data Bind = Bind { hostSrc :: Text
@@ -819,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
819904
820905instance FromJSON Bind where
821906 parseJSON (JSON.String t) = case T.split (== ':') t of
822− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
823908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
824909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
825− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
826911 parseJSON _ = fail "Bind is not a string"
827912
828913data Device = Device {
@@ -845,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
845930
846931instance FromJSON VolumeFrom where
847932 parseJSON (JSON.String t) = case T.split (== ':') t of
848− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
849934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
850935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
851− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
852937 parseJSON _ = fail "VolumeFrom is not a string"
853938
854939instance ToJSON VolumeFrom where
855940 toJSON (VolumeFrom n p) = case p of
856− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
857942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
858943
859944instance ToJSON Bind where
@@ -865,40 +950,40 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
865950
866951instance FromJSON Link where
867952 parseJSON (JSON.String t) = case T.split (== ':') t of
868− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
869954 [f,s] -> return $ Link f $ Just s
870− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
871956 parseJSON _ = fail "Link is not a string"
872957
873958instance ToJSON Link where
874959 toJSON (Link n1 n2) = toJSON $ case n2 of
875960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
876− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
877962
878963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
879964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
880965
881966instance FromJSON LogDriverType where
882967 parseJSON (JSON.String "json-file") = return JsonFile
883− parseJSON (JSON.String "syslog") = return Syslog
884− parseJSON (JSON.String "journald") = return Journald
885− parseJSON (JSON.String "gelf") = return Gelf
886− parseJSON (JSON.String "fluentd") = return Fluentd
887− parseJSON (JSON.String "awslogs") = return AwsLogs
888− parseJSON (JSON.String "splunk") = return Splunk
889− parseJSON (JSON.String "etwlogs") = return Etwlogs
890− parseJSON (JSON.String "none") = return LoggingDisabled
891− parseJSON _ = fail "Unknown LogDriverType"
968+ parseJSON (JSON.String "syslog") = return Syslog
969+ parseJSON (JSON.String "journald") = return Journald
970+ parseJSON (JSON.String "gelf") = return Gelf
971+ parseJSON (JSON.String "fluentd") = return Fluentd
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
973+ parseJSON (JSON.String "splunk") = return Splunk
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
975+ parseJSON (JSON.String "none") = return LoggingDisabled
976+ parseJSON _ = fail "Unknown LogDriverType"
892977
893978instance ToJSON LogDriverType where
894− toJSON JsonFile = JSON.String "json-file"
895− toJSON Syslog = JSON.String "syslog"
896− toJSON Journald = JSON.String "journald"
897− toJSON Gelf = JSON.String "gelf"
898− toJSON Fluentd = JSON.String "fluentd"
899− toJSON AwsLogs = JSON.String "awslogs"
900− toJSON Splunk = JSON.String "splunk"
901− toJSON Etwlogs = JSON.String "etwlogs"
979+ toJSON JsonFile = JSON.String "json-file"
980+ toJSON Syslog = JSON.String "syslog"
981+ toJSON Journald = JSON.String "journald"
982+ toJSON Gelf = JSON.String "gelf"
983+ toJSON Fluentd = JSON.String "fluentd"
984+ toJSON AwsLogs = JSON.String "awslogs"
985+ toJSON Splunk = JSON.String "splunk"
986+ toJSON Etwlogs = JSON.String "etwlogs"
902987 toJSON LoggingDisabled = JSON.String "none"
903988
904989data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
@@ -932,19 +1017,41 @@ instance FromJSON LogDriverConfig where
9321017 parseJSON _ = fail "LogDriverConfig is not an object"
9331018
9341019-- TODO: Add container:<name|id> mode
935−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
9361021 deriving (Eq, Show, Ord)
9371022
9381023instance FromJSON NetworkMode where
939− parseJSON (JSON.String "bridge") = return Bridge
940− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
941− parseJSON (JSON.String "none") = return NetworkDisabled
942− parseJSON _ = fail "Unknown NetworkMode"
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
1028+ parseJSON _ = fail "Unknown NetworkMode"
9431029
9441030instance ToJSON NetworkMode where
945− toJSON Bridge = JSON.String "bridge"
946− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
9471033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
1035+
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1038+
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
1042+
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
1046+
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1049+ nid <- o .: "Id"
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1052+
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
9481055
9491056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9501057
@@ -960,7 +1067,7 @@ instance FromJSON PortType where
9601067 parseJSON val = case val of
9611068 "tcp" -> return TCP
9621069 "udp" -> return UDP
963− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
9641071
9651072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
9661073--
@@ -1090,7 +1197,7 @@ instance FromJSON RestartPolicy where
10901197 "on-failure" -> do
10911198 retry <- o .: "MaximumRetryCount"
10921199 return $ RestartOnFailure retry
1093− "off" -> return RestartOff
1200+ "no" -> return RestartOff
10941201 _ -> fail "Could not parse RestartPolicy"
10951202 parseJSON _ = fail "RestartPolicy is not an object"
10961203
@@ -1098,7 +1205,7 @@ instance ToJSON RestartPolicy where
10981205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
10991206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
11001207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1101− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
11021209
11031210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
11041211
@@ -1276,7 +1383,7 @@ data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
12761383data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
12771384
12781385instance ToJSON MemoryConstraint where
1279− toJSON (MemoryConstraint x B) = toJSON x
1386+ toJSON (MemoryConstraint x B) = toJSON x
12801387 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
12811388 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
12821389
@@ -1307,7 +1414,7 @@ data ContainerResources = ContainerResources {
13071414 , memoryReservation :: Maybe MemoryConstraint
13081415 , memorySwap :: Maybe MemoryConstraint
13091416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1310− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
13111418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
13121419 , ulimits :: [Ulimit]
13131420 -- TODO: Missing from 1.24
@@ -1345,7 +1452,7 @@ instance FromJSON EnvVar where
13451452 parseJSON _ = fail "EnvVar is not a string"
13461453
13471454instance ToJSON EnvVar where
1348− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
13491456
13501457-- | ExposedPort represents a port (and it's type)
13511458-- that a container should expose to other containers or the host system.
@@ -1385,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
13851492 where key (ExposedPort p t) = show p <> slash <> show t
13861493 slash = T.unpack "/"
13871494
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1496+
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1500+
1501+instance FromJSON Entrypoint where
1502+ parseJSON (JSON.String e) = return $ Entrypoint [e]
1503+ parseJSON (JSON.Array ar) = do
1504+ arr <- mapM parseJSON (V.toList ar)
1505+ return $ Entrypoint arr
1506+ parseJSON JSON.Null = return $ Entrypoint []
1507+ parseJSON _ = fail "Failed to parse Entrypoint"
1508+
1509+
13881510data ContainerConfig = ContainerConfig {
13891511 hostname :: Maybe Text
13901512 , domainname :: Maybe Text
@@ -1403,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
14031525 , image :: Text
14041526 , volumes :: [Volume]
14051527 , workingDir :: Maybe FilePath
1406− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
14071529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
14081530 , macAddress :: Maybe Text
14091531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1411,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
14111533 , stopSignal :: Signal
14121534 } deriving (Eq, Show, Generic)
14131535
1536+
14141537instance ToJSON ContainerConfig where
14151538 toJSON = genericToJSON defaultOptions {
14161539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1432,7 +1555,7 @@ instance FromJSON ContainerConfig where
14321555 image <- o .: "Image"
14331556 volumes <- o .: "Volumes"
14341557 workingDir <- o .:? "WorkingDir"
1435− entrypoint <- o .:? "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
14361559 networkDisabled <- o .:? "networkDisabled"
14371560 macAddress <- o .:? "MacAddress"
14381561 labels <- o .:? "Labels" .!= []
@@ -1441,7 +1564,11 @@ instance FromJSON ContainerConfig where
14411564 macAddress labels stopSignal
14421565 parseJSON _ = fail "NetworkSettings is not an object."
14431566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14441570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14451572parseIntegerText t = case readMaybe $ T.unpack t of
14461573 Nothing ->
14471574 fail "Could not parse Integer"
@@ -1463,4 +1590,3 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
14631590-- | Helper function that return an empty dictionary "{}"
14641591emptyJsonObject :: JSON.Value
14651592emptyJsonObject = JSON.Object HM.empty
1466−
stack-7.10.yaml+5−5
@@ -1,20 +1,20 @@
11# For more information, see: https://github.com/commercialhaskell/stack/blob/release/doc/yaml_configuration.md
22
33# Specifies the GHC version and set of packages available (e.g., lts-3.5, nightly-2015-09-21, ghc-7.10.2)
4−resolver: lts-5.18
4+resolver: lts-6.30
55
66# Local packages, usually specified by relative directory name
77packages:
88- '.'
99
10−# Packages to be pulled from upstream that are not in the resolver (e.g., acme-missiles-0.3)
11−extra-deps: [directory-1.2.7.0]
12−
1310# Override default flag values for local packages and extra-deps
1411flags: {}
1512
1613# Extra package databases containing global packages
17−extra-package-dbs: []
14+extra-deps:
15+- directory-1.2.7.0
16+- unliftio-core-0.1.1.0
17+- process-1.6.5.1
1818
1919# Control whether we use the GHC we find on the path
2020# system-ghc: true
stack-8.0.2.yamlnew file+4
@@ -0,0 +1,4 @@
1+resolver: lts-9.4
2+packages:
3+- '.'
4+extra-deps: []
stack-8.0.yaml+2−1
@@ -1,4 +1,5 @@
11resolver: lts-7.12
22packages:
33- '.'
4−extra-deps: []
4+extra-deps:
5+- unliftio-core-0.1.1.0
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-7.10.yaml
1+stack-8.6.4.yaml
tests/Dockerfile+1−1
@@ -1,4 +1,4 @@
11FROM debian:jessie
22
3−CMD ["/bin/bash", "-c", "echo 123"]
3+CMD ["/bin/bash", "-c", "echo $TEST"]
44
tests/tests.hs+231−80
@@ -2,6 +2,8 @@
22
33module Main where
44
5+import Data.Either (rights)
6+import Prelude hiding (all)
57import qualified Test.QuickCheck.Monadic as QCM
68import Test.Tasty
79import Test.Tasty.HUnit
@@ -9,135 +11,284 @@ import Test.Tasty.QuickCheck (testProperty)
911
1012import Control.Concurrent (threadDelay)
1113import Control.Lens ((^.), (^?))
14+import Control.Monad (forM_)
1215import Control.Monad.IO.Class
1316import Control.Monad.Trans.Class (lift)
1417import qualified Data.Aeson as JSON
15−import Data.Aeson.Lens (key, _Object, _String, _Value)
18+import Data.Aeson ((.=))
19+import Data.Aeson.Lens (key, _Array, _Null, _Object,
20+ _String, _Value)
1621import qualified Data.ByteString as B
1722import qualified Data.ByteString.Char8 as C
1823import qualified Data.ByteString.Lazy as BL
1924import qualified Data.HashMap.Strict as HM
2025import Data.Int (Int)
2126import qualified Data.Map as M
22−import Data.Maybe (fromJust, isJust)
27+import Data.Maybe (fromJust, isJust, isNothing, listToMaybe)
2328import Data.Monoid
2429import Data.Text (Text, unpack)
30+import qualified Data.Vector as V
2531import Network.Connection (TLSSettings (..))
2632import Network.HTTP.Client (newManager)
2733import Network.HTTP.Client.TLS
2834import Network.HTTP.Types.Status
35+import System.Directory (getCurrentDirectory)
36+import System.Environment (lookupEnv)
2937import System.Process (system)
3038
3139import Docker.Client
3240
3341-- opts = defaultClientOpts
34−
35−testImageName = "docker-hs-test"
42+testImageName = "docker-hs/test"
43+imageToDeleteFullName = "hello-world:latest"
3644
3745toStrict1 = B.concat . BL.toChunks
3846
39−runDocker f = do
40− -- let opts = defaultClientOpts {baseUrl = "https://127.0.0.1:2376/"}
41− -- params' <- clientParamsWithClientAuthentication "127.0.0.1" 2376 "~/.docker/test-client-key.pem" "~/.docker/test-client-cert.pem" >>= fromRight
42− -- params <- clientParamsSetCA params' "~/.docker/test-ca.pem"
43− -- let settings = mkManagerSettings (TLSSettings params) Nothing
44− -- mgr <- newManager settings
45− h <- defaultHttpHandler
46− runDockerT (defaultClientOpts, h) f
47+runDocker f
48+ -- let opts = defaultClientOpts {baseUrl = "https://127.0.0.1:2376/"}
49+ -- params' <- clientParamsWithClientAuthentication "127.0.0.1" 2376 "~/.docker/test-client-key.pem" "~/.docker/test-client-cert.pem" >>= fromRight
50+ -- params <- clientParamsSetCA params' "~/.docker/test-ca.pem"
51+ -- let settings = mkManagerSettings (TLSSettings params) Nothing
52+ -- mgr <- newManager settings
53+ = do
54+ h <- defaultHttpHandler
55+ runDockerT (defaultClientOpts, h) f
4756
4857testDockerVersion :: IO ()
49−testDockerVersion = runDocker $ do
50− v <- getDockerVersion
51− lift $ assert $ isRight v
58+testDockerVersion =
59+ runDocker $
60+ do v <- getDockerVersion
61+ lift $ assert $ isRight v
62+
63+testStopNonexisting :: IO ()
64+testStopNonexisting = runDocker $ do
65+ res <- stopContainer DefaultTimeout $ fromJust $ toContainerID "thisshouldnotexist"
66+ lift $ assert $ isLeft res
5267
5368testFindImage :: IO ()
54−testFindImage = runDocker $ do
69+testFindImage =
70+ runDocker $
71+ do images <- listImages defaultListOpts >>= fromRight
72+ let xs = filter (elem imageFullName . imageRepoTags) images
73+ lift $ assert $ length xs == 1
74+ where
75+ imageFullName = testImageName <> ":latest"
76+
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
5587 images <- listImages defaultListOpts >>= fromRight
56− let xs = filter ((== [imageFullName]) . imageRepoTags) images
57− lift $ assert $ length xs == 1
58− where imageFullName = testImageName <> ":latest"
88+ return $ listToMaybe
89+ $ filter (elem imageToDeleteFullName . imageRepoTags) images
90+
91+testListContainers :: IO ()
92+testListContainers =
93+ runDocker $
94+ do containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing
95+ c <- fromRight containerId
96+ res <- listContainers $ ListOpts { all=True }
97+ deleteContainer (ContainerDeleteOpts True True) c
98+ lift $ assert $ isRight res
99+
100+testBuildFromDockerfile :: IO ()
101+testBuildFromDockerfile = do
102+ cur <- getCurrentDirectory
103+ let ctxDir = cur ++ "/tests"
104+ runDocker $ do
105+ r <- buildImageFromDockerfile (defaultBuildOpts "docker-hs/dockerfile-test") ctxDir
106+ lift $ assert $ isRight r
107+
59108
60109testRunAndReadLog :: IO ()
61−testRunAndReadLog = runDocker $ do
62− containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing
63− c <- fromRight containerId
64− status1 <- startContainer defaultStartOpts c
65− _ <- inspectContainer c >>= fromRight
66− lift $ threadDelay 300000 -- give 300ms for the application to finish
67− lift $ assert $ isRightUnit status1
68− status2 <- killContainer SIGTERM c
69− logs <- getContainerLogs defaultLogOpts c >>= fromRight
70− lift $ assert $ isRightUnit status2
71− lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)
72− status3 <- deleteContainer (DeleteOpts True True) c
73− lift $ assert $ isRightUnit status3
74−
75− where
76− isRightUnit (Right ()) = True
77− isRightUnit _ = False
110+testRunAndReadLog = testRunAndReadLogHelper $ NetworkingConfig HM.empty
111+
112+testRunAndReadLogWithNetworking :: IO ()
113+testRunAndReadLogWithNetworking = testRunAndReadLogHelper $ NetworkingConfig $ HM.fromList [("test-network", EndpointConfig ["cellar-door"])]
114+
115+testRunAndReadLogHelper :: NetworkingConfig -> IO ()
116+testRunAndReadLogHelper networkingConfig =
117+ runDocker $
118+ do let containerConfig = (defaultContainerConfig (testImageName <> ":latest")) {env = [EnvVar "TEST" "123"]}
119+ createdNetworks <- rights <$> mapM createNetworkWithName networkNames
120+ containerId <- createContainer (CreateOpts containerConfig defaultHostConfig networkingConfig) Nothing
121+ c <- fromRight containerId
122+ status1 <- startContainer defaultStartOpts c
123+ _ <- inspectContainer c >>= fromRight
124+ lift $ threadDelay 300000 -- give 300ms for the application to finish
125+ lift $ assertBool ("starting the container, unexpected status: " ++ show status1) $ isRightUnit status1
126+ logs <- getContainerLogs defaultLogOpts c >>= fromRight
127+ lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)
128+ status3 <- deleteContainer (ContainerDeleteOpts True True) c
129+ lift $ assertBool ("deleting container, unexpected status: " ++ show status3) $ isRightUnit status3
130+ mapM_ removeNetwork createdNetworks
131+ where
132+ isRightUnit (Right ()) = True
133+ isRightUnit _ = False
134+ networkNames = HM.keys $ endpointsConfig networkingConfig
135+ createNetworkWithName name = createNetwork $
136+ (defaultCreateNetworkOpts name) { createNetworkCheckDuplicate = True }
137+
138+testCreateRemoveNetwork :: IO ()
139+testCreateRemoveNetwork = do
140+ runDocker $ do
141+ createStatus <- createNetwork $ defaultCreateNetworkOpts "test-network"
142+ lift $ assertBool ("creating a network, unexpected status: " ++ show createStatus) $ isRight createStatus
143+ nid <- fromRight createStatus
144+ removeStatus <- removeNetwork nid
145+ lift $ assertBool ("removing a network, unexpected status: " ++ show removeStatus) $ isRight removeStatus
78146
79147testLogDriverOptionsJson :: TestTree
80−testLogDriverOptionsJson = testGroup "Testing LogDriverOptions JSON" [ test1, test2, test3 ]
81− where
82− test1 = testCase "Driver option 1" $ assert $ JSON.toJSON sample ^. key key1 . _String == val1
83− test2 = testCase "Driver option 2" $ assert $ JSON.toJSON sample ^. key key2 . _String == val2
84− test3 = testCase "Test override" $ assert $ JSON.toJSON sample2 ^. key key1 . _String == "override"
85− sample = [LogDriverOption key1 val1, LogDriverOption key2 val2]
86− sample2 = [LogDriverOption key1 val1, LogDriverOption key1 "override"]
87− key1 = "some-key"
88− val1 = "some-val"
89− key2 = "some-key2"
90− val2 = "some-key2"
148+testLogDriverOptionsJson = testGroup "Testing LogDriverOptions JSON" [test1, test2, test3]
149+ where
150+ test1 = testCase "Driver option 1" $ assert $ JSON.toJSON sample ^. key key1 . _String == val1
151+ test2 = testCase "Driver option 2" $ assert $ JSON.toJSON sample ^. key key2 . _String == val2
152+ test3 =
153+ testCase "Test override" $ assert $ JSON.toJSON sample2 ^. key key1 . _String == "override"
154+ sample = [LogDriverOption key1 val1, LogDriverOption key2 val2]
155+ sample2 = [LogDriverOption key1 val1, LogDriverOption key1 "override"]
156+ key1 = "some-key"
157+ val1 = "some-val"
158+ key2 = "some-key2"
159+ val2 = "some-key2"
91160
92161testExposedPortsJson :: TestTree
93−testExposedPortsJson = testGroup "Testing ExposedPorts JSON" [ testTCP, testUDP ]
94− where
95− testTCP = testCase "tcp port" $ assert $ JSON.toJSON sampleEP ^. key "80/tcp" . _Object == HM.empty
96− testUDP = testCase "udp port" $ assert $ JSON.toJSON sampleEP ^. key "1337/tcp" . _Object == HM.empty
97− sampleEP = [ExposedPort 80 TCP, ExposedPort 1337 UDP]
162+testExposedPortsJson = testGroup "Testing ExposedPorts JSON" [testTCP, testUDP]
163+ where
164+ testTCP = testCase "tcp port" $ assert $ JSON.toJSON sampleEP ^. key "80/tcp" . _Object == HM.empty
165+ testUDP =
166+ testCase "udp port" $ assert $ JSON.toJSON sampleEP ^. key "1337/tcp" . _Object == HM.empty
167+ sampleEP = [ExposedPort 80 TCP, ExposedPort 1337 UDP]
98168
99169testLabelsJson :: TestTree
100−testLabelsJson = testGroup "Testing Labels JSON" [ testLS1, testLS2, testOverride ]
101− where
102− testLS1 = testCase "test label key1" $ assert $ JSON.toJSON sampleLS ^. key key1 . _String == val1
103− testLS2 = testCase "test label key2" $ assert $ JSON.toJSON sampleLS ^. key key2 . _String == val2
104− testOverride = testCase "test label override" $ assert $ JSON.toJSON [Label key1 val1, Label key1 "override"] ^. key key1 . _String == "override"
105− sampleLS = [Label key1 val1, Label key2 val2]
106− key1 = "com.example.some-label"
107− val1 = "some-value"
108− key2 = "something"
109− val2 = "value"
170+testLabelsJson = testGroup "Testing Labels JSON" [testLS1, testLS2, testOverride]
171+ where
172+ testLS1 = testCase "test label key1" $ assert $ JSON.toJSON sampleLS ^. key key1 . _String == val1
173+ testLS2 = testCase "test label key2" $ assert $ JSON.toJSON sampleLS ^. key key2 . _String == val2
174+ testOverride =
175+ testCase "test label override" $ assert $ JSON.toJSON [Label key1 val1, Label key1 "override"] ^.
176+ key key1 .
177+ _String ==
178+ "override"
179+ sampleLS = [Label key1 val1, Label key2 val2]
180+ key1 = "com.example.some-label"
181+ val1 = "some-value"
182+ key2 = "something"
183+ val2 = "value"
110184
111185testVolumesJson :: TestTree
112−testVolumesJson = testGroup "Testing Volumes JSON" [ testSample1, testSample2 ]
113− where
114− testSample1 = testCase "Test exposing volume: /tmp" $ assert $ JSON.toJSON sampleVolumes ^. key "/tmp" . _Object == HM.empty
115− testSample2 = testCase "Test exposing volume: /opt" $ assert $ JSON.toJSON sampleVolumes ^. key "/opt" . _Object == HM.empty
116− sampleVolumes = [Volume "/tmp", Volume "/opt"]
186+testVolumesJson = testGroup "Testing Volumes JSON" [testSample1, testSample2]
187+ where
188+ testSample1 =
189+ testCase "Test exposing volume: /tmp" $ assert $ JSON.toJSON sampleVolumes ^. key "/tmp" . _Object ==
190+ HM.empty
191+ testSample2 =
192+ testCase "Test exposing volume: /opt" $ assert $ JSON.toJSON sampleVolumes ^. key "/opt" . _Object ==
193+ HM.empty
194+ sampleVolumes = [Volume "/tmp", Volume "/opt"]
195+
196+testEntrypointJson :: TestTree
197+testEntrypointJson = testGroup "Testing ContainerConfig JSON" [testSample1, testSample2, testSample3, testSample4, testSample5]
198+ where
199+ testSample1 =
200+ testCase "Test toJSON with empty entrypoint (null)" $ assert $ JSON.toJSON (Entrypoint []) ^. _Null == ()
201+ testSample2 =
202+ testCase "Test toJSON with entrypoint as Array" $ assert $
203+ JSON.toJSON (Entrypoint sampleEntrypointArr) ==
204+ JSON.toJSON sampleEntrypointArr
205+ testSample3 =
206+ testCase "Test decoding entrypoint as string" $ assert $ (JSON.decode "\"cmd\"") ==
207+ Just (Entrypoint ["cmd"])
208+ testSample4 =
209+ testCase "Test decoding as null" $ assert $ (JSON.decode "null" :: Maybe Entrypoint) ==
210+ Just (Entrypoint [])
211+ testSample5 =
212+ testCase "Test decoding as array" $ assert $ (JSON.decode (JSON.encode sampleEntrypointArr) :: Maybe Entrypoint) ==
213+ Just (Entrypoint sampleEntrypointArr)
214+ sampleEntrypointArr = ["cmd", "--some-flag", "--some-flag2"]
215+
216+testEnvVarJson :: TestTree
217+testEnvVarJson = testGroup "Testing EnvVar JSON" [testSampleEncode, testSampleDecode]
218+ where
219+ testSampleEncode =
220+ testCase "Test toJSON" $ assert $ JSON.toJSON (EnvVar "cellar" "door") == JSON.String "cellar=door"
221+ testSampleDecode =
222+ testCase "Test fromJSON" $ assert $ (JSON.decode "\"cellar=door\"" :: Maybe EnvVar) ==
223+ Just (EnvVar "cellar" "door")
224+
225+testNetworkingConfigJson :: TestTree
226+testNetworkingConfigJson = testGroup "Testing NetworkingConfig JSON" [testSampleEncode]
227+ where
228+ testSampleEncode =
229+ let networkingConfig = NetworkingConfig $ HM.fromList [("custom-network", EndpointConfig ["cellar", "door"])]
230+ in testCase "Test toJSON" $ assert $ JSON.toJSON networkingConfig ==
231+ JSON.object
232+ [ "EndpointsConfig" .= JSON.object
233+ [ "custom-network" .= JSON.object
234+ [ "Aliases" .= (["cellar", "door"] :: [Text])
235+ ]
236+ ]
237+ ]
117238
118239integrationTests :: TestTree
119−integrationTests = testGroup "Integration Tests" [
120− testCase "Get docker version" testDockerVersion,
121− testCase "Find image by name" testFindImage,
122− testCase "Run a dummy container and read its log" testRunAndReadLog]
240+integrationTests =
241+ testGroup
242+ "Integration Tests"
243+ [ testCase "Get docker version" testDockerVersion
244+ , testCase "Build image from Dockerfile" testBuildFromDockerfile
245+ , testCase "Find image by name" testFindImage
246+ , testCase "Delete image" testDeleteImage
247+ , testCase "List containers" testListContainers
248+ , testCase "Run a dummy container and read its log" testRunAndReadLog
249+ , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking
250+ , testCase "Try to stop a container that doesn't exist" testStopNonexisting
251+ , testCase "Create and remove a network" testCreateRemoveNetwork
252+ ]
123253
124254jsonTests :: TestTree
125−jsonTests = testGroup "JSON Tests" [testExposedPortsJson, testVolumesJson, testLabelsJson, testLogDriverOptionsJson]
255+jsonTests =
256+ testGroup
257+ "JSON Tests"
258+ [ testExposedPortsJson
259+ , testVolumesJson
260+ , testLabelsJson
261+ , testLogDriverOptionsJson
262+ , testEntrypointJson
263+ , testEnvVarJson
264+ , testNetworkingConfigJson
265+ ]
126266
127267setup :: IO ()
128−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+ ]
273+
274+isLeft = not . isRight
129275
130−isRight (Left _) = False
276+isRight (Left _) = False
131277isRight (Right _) = True
132278
133−fromRight :: (MonadIO m, Show l) => Either l r -> m r
279+fromRight
280+ :: (MonadIO m, Show l)
281+ => Either l r -> m r
134282fromRight (Left l) = do
135− liftIO $ assertFailure $ "Left: " ++ show l
136− undefined
283+ liftIO $ assertFailure $ "Left: " ++ show l
284+ undefined
137285fromRight (Right r) = return r
138286
139287main :: IO ()
140288main = do
141− setup
142− defaultMain $ testGroup "Tests" [jsonTests, integrationTests]
143−
289+ stackage <- lookupEnv "RUN_INTEGRATION_TESTS"
290+ case stackage of
291+ Nothing -> defaultMain $ testGroup "Tests" [jsonTests]
292+ Just _ -> do
293+ setup
294+ defaultMain $ testGroup "Tests" [jsonTests, integrationTests]