on master help sign in
23 files changed+1165−357
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+42−12 examples/Example.hs+52−43 src/Docker/Client.hs+12−5 src/Docker/Client/Api.hs+121−50 src/Docker/Client/Http.hs+81−29 src/Docker/Client/Internal.hs+59−28 src/Docker/Client/Types.hs+240−89 src/Docker/Client/Utils.hs+131 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−75
.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 no 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+42−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,29 +14,57 @@ 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
20− exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http
25+ 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
36+ , conduit
37+ , conduit-combinators
38+ , conduit-extra
39+ , exceptions
40+ , monad-control
41+ , resourcet
42+ , transformers
43+ , transformers-base
44+ , tar
45+ , zlib
46+ , uuid
47+ , temporary
48+ , directory >= 1.2.5.0
49+ , filemanip
50+ , filepath
3051 , mtl >= 2.0.0 && < 3.0.0
3152 , network >= 2.6.0
3253 , text >= 1.0.0 && < 2.0.0
33− , time >= 1.5.0 && < 1.7.0
54+ , time >= 1.5.0 && < 2.0.0
3455 , scientific >= 0.3.0 && < 0.4.0
35− , tls >= 1.3.7 && < 1.4.0
56+ , tls >= 1.3.7 && < 1.6.0
3657 , unordered-containers >= 0.2.0 && < 0.3.0
37− , x509 >= 1.6.0 && < 1.7.0
38− , x509-store >= 1.6.0 && < 1.7.0
39− , 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
4068 default-language: Haskell2010
4169 ghc-options: -Wall -fno-warn-name-shadowing
4270
@@ -45,6 +73,7 @@ test-suite docker-hs-tests
4573 , bytestring
4674 , connection
4775 , docker
76+ , directory
4877 , aeson
4978 , containers
5079 , unordered-containers
@@ -60,6 +89,7 @@ test-suite docker-hs-tests
6089 , transformers
6190 , QuickCheck
6291 , process
92+ , vector
6393 type: exitcode-stdio-1.0
6494 main-is: tests.hs
6595 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+121−50
@@ -15,89 +15,113 @@ module Docker.Client.Api (
1515 , deleteContainer
1616 , inspectContainer
1717 , getContainerLogs
18+ , getContainerLogsStream
1819 -- * Images
1920 , listImages
21+ , deleteImage
22+ , buildImageFromDockerfile
23+ , pullImage
24+ -- * Network
25+ , createNetwork
26+ , removeNetwork
2027 -- * Other
2128 , getDockerVersion
2229 ) where
2330
24−import Control.Monad.Except (ExceptT (..), runExceptT, throwError)
25−import Control.Monad.Reader (ask, lift)
26−import Data.Aeson (FromJSON, eitherDecode')
27−import qualified Data.ByteString.Lazy as BSL
28−import qualified Data.Text as Text
29−import Network.HTTP.Client (responseBody, responseStatus)
30−import Network.HTTP.Types (StdMethod (..))
31−import System.Exit (ExitCode(..))
31+import Control.Monad.Catch (MonadMask (..))
32+import Control.Monad.IO.Class
33+import Control.Monad.Reader (ask, lift)
34+import Data.Aeson (FromJSON, eitherDecode')
35+import qualified Data.ByteString as BS
36+import qualified Data.ByteString.Lazy as BSL
37+import Data.Conduit (Sink)
38+import qualified Data.Conduit.Binary as Conduit
39+import qualified Data.Text as T
40+import qualified Data.Text as Text
41+import Network.HTTP.Client (responseStatus)
42+import Network.HTTP.Types (StdMethod (..))
43+import System.Exit (ExitCode (..))
3244
3345import Docker.Client.Http
3446import Docker.Client.Types
47+import Docker.Client.Utils
3548
36−requestUnit :: (Monad m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError ())
37−requestUnit verb endpoint = const (Right ()) <$> requestHelper verb endpoint
49+requestUnit :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError ())
50+requestUnit verb endpoint = fmap (const ()) <$> requestHelper verb endpoint
3851
39−requestHelper :: (Monad m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError Response)
40−requestHelper verb endpoint = runExceptT $ do
41− (opts, httpHandler) <- lift ask
52+requestHelper :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError BSL.ByteString)
53+requestHelper verb endpoint = requestHelper' verb endpoint Conduit.sinkLbs
54+
55+requestHelper' :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> Sink BS.ByteString m a -> DockerT m (Either DockerError a)
56+requestHelper' verb endpoint sink = do
57+ (opts, HttpHandler httpHandler) <- ask
4258 case mkHttpRequest verb endpoint opts of
4359 Nothing ->
44− throwError $ DockerInvalidRequest endpoint
60+ return $ Left $ DockerInvalidRequest endpoint
4561 Just request -> do
46− response <- ExceptT $ lift $ httpHandler request
47−
48− -- Check status code.
49− let status = responseStatus response
50− maybe (return ()) throwError $
51− statusCodeToError endpoint status
52−
53− return response
54−
55−parseResponse :: (FromJSON a, Monad m) => Either DockerError Response -> DockerT m (Either DockerError a)
62+ -- JP: Do we need runResourceT?
63+ -- lift $ NHS.httpSink request $ \response ->
64+ lift $ httpHandler request $ \response ->
65+ -- Check status code.
66+ let status = responseStatus response in
67+ case statusCodeToError endpoint status of
68+ Just err ->
69+ return $ Left err
70+ Nothing ->
71+ fmap Right sink
72+
73+parseResponse :: (FromJSON a, Monad m) => Either DockerError BSL.ByteString -> DockerT m (Either DockerError a)
5674parseResponse (Left err) =
5775 return $ Left err
5876parseResponse (Right response) =
5977 -- Parse request body.
60− case eitherDecode' $ responseBody response of
78+ case eitherDecode' response of
6179 Left err ->
6280 return $ Left $ DockerClientDecodeError $ Text.pack err
6381 Right r ->
6482 return $ Right r
6583
6684-- | Gets the version of the docker engine remote API.
67−getDockerVersion :: forall m. Monad m => DockerT m (Either DockerError DockerVersion)
85+getDockerVersion :: forall m. (MonadIO m, MonadMask m) => DockerT m (Either DockerError DockerVersion)
6886getDockerVersion = requestHelper GET VersionEndpoint >>= parseResponse
6987
7088-- | Lists all running docker containers. Pass in @'defaultListOpts' {all
7189-- = True}@ to get a list of stopped containers as well.
72−listContainers :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Container])
90+listContainers :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Container])
7391listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseResponse
7492
7593-- | Lists all docker images.
76−listImages :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Image])
94+listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])
7795listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
7896
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+
79103-- | Creates a docker container but does __not__ start it. See
80104-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'
81105-- for some sane defaults.
82−createContainer :: forall m. Monad m => CreateOpts -> Maybe ContainerName -> DockerT m (Either DockerError ContainerID)
106+createContainer :: forall m. (MonadIO m, MonadMask m) => CreateOpts -> Maybe ContainerName -> DockerT m (Either DockerError ContainerID)
83107createContainer opts cn = requestHelper POST (CreateContainerEndpoint opts cn) >>= parseResponse
84108
85109-- | Start a container from a given 'ContainerID' that we get from
86110-- 'createContainer'. See 'StartOpts' for a list of configuration options
87111-- for starting a container. Use 'defaultStartOpts' for sane defaults.
88−startContainer :: forall m. Monad m => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
112+startContainer :: forall m. (MonadIO m, MonadMask m) => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
89113startContainer sopts cid = requestUnit POST $ StartContainerEndpoint sopts cid
90114
91115-- | Attempts to stop a container with the given 'ContainerID' gracefully
92116-- (SIGTERM).
93117-- The docker daemon will wait for the given 'Timeout' and then send
94118-- a SIGKILL killing the container.
95−stopContainer :: forall m. Monad m => Timeout -> ContainerID -> DockerT m (Either DockerError ())
119+stopContainer :: forall m. (MonadIO m, MonadMask m) => Timeout -> ContainerID -> DockerT m (Either DockerError ())
96120stopContainer t cid = requestUnit POST $ StopContainerEndpoint t cid
97121
98122-- | Blocks until a container with the given 'ContainerID' stops,
99123-- then returns the exit code
100−waitContainer :: forall m. Monad m => ContainerID -> DockerT m (Either DockerError ExitCode)
124+waitContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ExitCode)
101125waitContainer cid = fmap (fmap statusCodeToExitCode) (requestHelper POST (WaitContainerEndpoint cid) >>= parseResponse)
102126 where
103127 statusCodeToExitCode (StatusCode 0) = ExitSuccess
@@ -105,29 +129,29 @@ waitContainer cid = fmap (fmap statusCodeToExitCode) (requestHelper POST (WaitCo
105129
106130-- | Sends a 'Signal' to the container with the given 'ContainerID'. Same
107131-- as 'stopContainer' but you choose the signal directly.
108−killContainer :: forall m. Monad m => Signal -> ContainerID -> DockerT m (Either DockerError ())
132+killContainer :: forall m. (MonadIO m, MonadMask m) => Signal -> ContainerID -> DockerT m (Either DockerError ())
109133killContainer s cid = requestUnit POST $ KillContainerEndpoint s cid
110134
111135-- | Restarts a container with the given 'ContainerID'.
112−restartContainer :: forall m. Monad m => Timeout -> ContainerID -> DockerT m (Either DockerError ())
136+restartContainer :: forall m. (MonadIO m, MonadMask m) => Timeout -> ContainerID -> DockerT m (Either DockerError ())
113137restartContainer t cid = requestUnit POST $ RestartContainerEndpoint t cid
114138
115139-- | Pauses a container with the given 'ContainerID'.
116−pauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either DockerError ())
140+pauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ())
117141pauseContainer cid = requestUnit POST $ PauseContainerEndpoint cid
118142
119143-- | Unpauses a container with the given 'ContainerID'.
120−unpauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either DockerError ())
144+unpauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ())
121145unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
122146
123147-- | Deletes a container with the given 'ContainerID'.
124−-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane
148+-- See "ContainerDeleteOpts" for options and use 'defaultContainerDeleteOpts' for sane
125149-- defaults.
126−deleteContainer :: forall m. Monad m => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
150+deleteContainer :: forall m. (MonadIO m, MonadMask m) => ContainerDeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
127151deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
128152
129153-- | Gets 'ContainerDetails' for a given 'ContainerID'.
130−inspectContainer :: forall m . Monad m => ContainerID -> DockerT m (Either DockerError ContainerDetails)
154+inspectContainer :: forall m . (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ContainerDetails)
131155inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= parseResponse
132156
133157-- | Get's container's logs for a given 'ContainerID'.
@@ -137,20 +161,67 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars
137161-- See 'LogOpts' for options that you can pass and
138162-- 'defaultLogOpts' for sane defaults.
139163--
140−-- __NOTE__: Currently streaming logs is
141−-- not supported and this function will fetch the entire log that the
164+-- __NOTE__: his function will fetch the entire log that the
142165-- container produced in the json-file on disk. Depending on the logging
143166-- setup of the process in your container this can be a significant amount
144167-- which might block your application...so use with caution.
145168--
146−-- 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
147173-- syslog) for creating your containers.
148−getContainerLogs :: forall m. Monad m => LogOpts -> ContainerID -> DockerT m (Either DockerError BSL.ByteString)
149−getContainerLogs logopts cid = fmap responseBody <$> requestHelper GET (ContainerLogsEndpoint logopts False cid)
150−
151−-- TODO: Use http-conduit to output to a sink.
152−-- getContainerLogsStream :: forall m. Monad m => Sink BSL.ByteString m b -> LogOpts -> ContainerID -> DockerT m (Either DockerError b)
153−-- getContainerLogsStream sink logopts cid = runResourceT $ do
154−-- response <- http request manager
155−-- responseBody response C.$$+- sink
174+getContainerLogs :: forall m. (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> DockerT m (Either DockerError BSL.ByteString)
175+getContainerLogs logopts cid = requestHelper GET (ContainerLogsEndpoint logopts False cid)
176+
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+-}
191+getContainerLogsStream :: forall m b . (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)
192+getContainerLogsStream logopts cid = requestHelper' GET (ContainerLogsEndpoint logopts True cid)
193+-- JP: Should the second (follow) argument be True? XXX
194+
195+-- | Build an Image from a Dockerfile
196+--
197+-- TODO: Add X-Registry-Config
198+--
199+-- TODO: Add support for remote URLs to a Dockerfile
200+--
201+-- TODO: Clean up temp tar.gz file after the image is built
202+buildImageFromDockerfile :: forall m. (MonadIO m, MonadMask m) => BuildOpts -> FilePath -> DockerT m (Either DockerError ())
203+buildImageFromDockerfile opts base = do
204+ ctx <- makeBuildContext $ BuildContextRootDir base
205+ case ctx of
206+ Left e -> return $ Left e
207+ 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
156227
src/Docker/Client/Http.hs+81−29
@@ -3,21 +3,28 @@
33
44module Docker.Client.Http where
55
6−import Control.Monad.Reader (ReaderT, runReaderT)
6+-- import Control.Monad.Base (MonadBase(..), liftBaseDefault)
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)
712import qualified Data.ByteString.Char8 as BSC
813import qualified Data.ByteString.Lazy as BL
14+import Data.Conduit (Sink)
915import Data.Default.Class (def)
1016import Data.Monoid ((<>))
1117import Data.Text.Encoding (encodeUtf8)
1218import Data.X509 (CertificateChain (..))
1319import Data.X509.CertificateStore (makeCertificateStore)
1420import Data.X509.File (readKeyFile, readSignedObject)
15−import Network.HTTP.Client (defaultManagerSettings, httpLbs,
21+import Network.HTTP.Client (defaultManagerSettings,
1622 managerRawConnection, method,
17− newManager, parseUrl,
23+ newManager, parseRequest,
1824 requestBody, requestHeaders)
1925import qualified Network.HTTP.Client as HTTP
2026import Network.HTTP.Client.Internal (makeConnection)
27+import qualified Network.HTTP.Simple as NHS
2128import Network.HTTP.Types (StdMethod, status101, status200,
2229 status201, status204)
2330import Network.TLS (ClientHooks (..),
@@ -27,7 +34,7 @@ import Network.TLS (ClientHooks (..),
2734import Network.TLS.Extra (ciphersuite_strong)
2835import System.X509 (getSystemCertificateStore)
2936
30−import Control.Exception (try)
37+import Control.Monad.Catch (try)
3138import Control.Monad.Except
3239import Control.Monad.Reader.Class
3340import Data.Text as T
@@ -38,20 +45,22 @@ import qualified Network.Socket.ByteString as SBS
3845
3946
4047import Docker.Client.Internal (getEndpoint,
48+ getEndpointContentType,
4149 getEndpointRequestBody)
4250import Docker.Client.Types (DockerClientOpts, Endpoint (..),
43− baseUrl)
51+ apiVer, baseUrl)
4452
4553type Request = HTTP.Request
4654type Response = HTTP.Response BL.ByteString
4755type HttpVerb = StdMethod
48−type HttpHandler m = Request -> m (Either DockerError Response)
56+newtype HttpHandler m = HttpHandler (forall a . Request -> (HTTP.Response () -> Sink BSC.ByteString m (Either DockerError a)) -> m (Either DockerError a))
4957
50−data DockerError = DockerConnectionError
58+data DockerError = DockerConnectionError NHS.HttpException
5159 | DockerInvalidRequest Endpoint
60+ | DockerClientError Text
5261 | DockerClientDecodeError Text -- ^ Could not parse the response from the Docker endpoint.
5362 | DockerInvalidStatusCode HTTP.Status -- ^ Invalid exit code received from Docker endpoint.
54− | GenericDockerError Text deriving (Eq, Show, Typeable)
63+ | GenericDockerError Text deriving (Show, Typeable)
5564
5665newtype DockerT m a = DockerT {
5766 unDockerT :: Monad m => ReaderT (DockerClientOpts, HttpHandler m) m a
@@ -75,6 +84,9 @@ instance MonadTrans DockerT where
7584instance MonadIO m => MonadIO (DockerT m) where
7685 liftIO = lift . liftIO
7786
87+-- instance MonadBase IO m => MonadBase IO (DockerT m) where
88+-- liftBase = liftBaseDefault
89+
7890runDockerT :: Monad m => (DockerClientOpts, HttpHandler m) -> DockerT m a -> m a
7991runDockerT (opts, h) r = runReaderT (unDockerT r) (opts, h)
8092
@@ -84,28 +96,41 @@ runDockerT (opts, h) r = runReaderT (unDockerT r) (opts, h)
8496-- benefit from testing that on all of our Endpoints
8597mkHttpRequest :: HttpVerb -> Endpoint -> DockerClientOpts -> Maybe Request
8698mkHttpRequest verb e opts = request
87− where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint e)
88− initialR = parseUrl fullE
99+ where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint (apiVer opts) e)
100+ initialR = parseRequest fullE
89101 request' = case initialR of
90102 Just ir ->
91103 return $ ir {method = (encodeUtf8 . T.pack $ show verb),
92− requestHeaders = [("Content-Type", "application/json; charset=utf-8")]}
104+ requestHeaders = [("Content-Type", (getEndpointContentType e))]}
93105 Nothing -> Nothing
94− request = (\r -> maybe r (\body -> r {requestBody = HTTP.RequestBodyLBS body,
106+ request = (\r -> maybe r (\body -> r {requestBody = body, -- This will either be a HTTP.RequestBodyLBS or HTTP.RequestBodySourceChunked for the build endpoint
95107 requestHeaders = [("Content-Type", "application/json; charset=utf-8")]}) $ getEndpointRequestBody e) <$> request'
96108 -- Note: Do we need to set length header?
97109
98−defaultHttpHandler :: MonadIO m => HttpHandler m
99−defaultHttpHandler request = do
110+defaultHttpHandler :: (
111+#if MIN_VERSION_http_conduit(2,3,0)
112+ MonadUnliftIO m,
113+#endif
114+ MonadIO m, MonadMask m) => m (HttpHandler m)
115+defaultHttpHandler = do
100116 manager <- liftIO $ newManager defaultManagerSettings
101− httpHandler manager request
102−
103−httpHandler :: MonadIO m => HTTP.Manager -> HttpHandler m
104−httpHandler manager request = liftIO $ do
105− try (httpLbs request manager) >>= \res -> case res of
106− Right res -> return $ Right res
107− Left HTTP.FailedConnectionException{} -> return $ Left DockerConnectionError
108− Left HTTP.FailedConnectionException2{} -> return $ Left DockerConnectionError
117+ return $ httpHandler manager
118+
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 ..
125+ let request = NHS.setRequestManager manager request'
126+ try (NHS.httpSink request sink) >>= \res -> case res of
127+ 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
131+ Left e@HTTP.FailedConnectionException{} -> return $ Left $ DockerConnectionError e
132+ Left e@HTTP.FailedConnectionException2{} -> return $ Left $ DockerConnectionError e
133+#endif
109134 Left e -> return $ Left $ GenericDockerError (T.pack $ show e)
110135
111136-- | Connect to a unix domain socket (the default docker socket is
@@ -113,13 +138,17 @@ httpHandler manager request = liftIO $ do
113138--
114139-- Docker seems to ignore the hostname in requests sent over unix domain
115140-- sockets (and the port obviously doesn't matter either)
116−unixHttpHandler :: MonadIO m => FilePath -- ^ The socket to connect to
117− -> HttpHandler m
118−unixHttpHandler fp request = do
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
146+ -> m (HttpHandler m)
147+unixHttpHandler fp = do
119148 let mSettings = defaultManagerSettings
120149 { managerRawConnection = return $ openUnixSocket fp}
121150 manager <- liftIO $ newManager mSettings
122− httpHandler manager request
151+ return $ httpHandler manager
123152
124153 where
125154 openUnixSocket filePath _ _ _ = do
@@ -127,7 +156,7 @@ unixHttpHandler fp request = do
127156 S.connect s (S.SockAddrUnix filePath)
128157 makeConnection (SBS.recv s 8096)
129158 (SBS.sendAll s)
130− (S.sClose s)
159+ (S.close s)
131160
132161-- TODO:
133162-- Move this to http-client-tls or network?
@@ -234,5 +263,28 @@ statusCodeToError (InspectContainerEndpoint _) st =
234263 Nothing
235264 else
236265 Just $ DockerInvalidStatusCode st
237−
238−
266+statusCodeToError (BuildImageEndpoint _ _) st =
267+ if st == status200 then
268+ Nothing
269+ else
270+ Just $ DockerInvalidStatusCode st
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+59−28
@@ -1,14 +1,17 @@
11module Docker.Client.Internal where
22
3−
43import Blaze.ByteString.Builder (toByteString)
54import qualified Data.Aeson as JSON
65import Data.ByteString (ByteString)
7−import qualified Data.ByteString.Lazy as BSL
8−import Data.Text as T
6+import qualified Data.ByteString.Char8 as BSC
7+import qualified Data.Conduit.Binary as CB
8+import qualified Data.Text as T
99import Data.Text.Encoding (decodeUtf8, encodeUtf8)
10+import qualified Network.HTTP.Client as HTTP
11+import Network.HTTP.Conduit (requestBodySourceChunked)
1012import Network.HTTP.Types (Query, encodePath,
1113 encodePathSegments)
14+import Prelude hiding (all)
1215
1316import Docker.Client.Types
1417
@@ -22,49 +25,65 @@ encodeURLWithQuery ps q = decodeUtf8 $ toByteString $ encodePath ps q
2225encodeQ :: String -> ByteString
2326encodeQ = encodeUtf8 . T.pack
2427
25−getEndpoint :: Endpoint -> T.Text
26−getEndpoint VersionEndpoint = encodeURL ["version"]
27−getEndpoint (ListContainersEndpoint _) = encodeURL ["containers", "json"] -- Make use of lsOpts here
28−getEndpoint (ListImagesEndpoint _) = encodeURL ["images", "json"] -- Make use of lsOpts here
29−getEndpoint (CreateContainerEndpoint _ cn) = case cn of
30− Just cn -> encodeURLWithQuery ["containers", "create"] [("name", Just (encodeQ $ T.unpack cn))]
31− Nothing -> encodeURL ["containers", "create"]
32−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
3336 where query = case (detachKeys startOpts) of
3437 WithCtrl c -> [("detachKeys", Just (encodeQ $ ctrl ++ [c]))]
3538 WithoutCtrl c -> [("detachKeys", Just (encodeQ [c]))]
3639 DefaultDetachKey -> []
3740 ctrl = ['c', 't', 'r', 'l', '-']
38−getEndpoint (StopContainerEndpoint t cid) = encodeURLWithQuery ["containers", fromContainerID cid, "stop"] query
41+getEndpoint v (StopContainerEndpoint t cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "stop"] query
3942 where query = case t of
40− Timeout x -> [("t", Just (encodeQ $ show x))]
43+ Timeout x -> [("t", Just (encodeQ $ show x))]
4144 DefaultTimeout -> []
42−getEndpoint (WaitContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "wait"]
43−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
4447 where query = case s of
4548 SIG x -> [("signal", Just (encodeQ $ show x))]
46− _ -> [("signal", Just (encodeQ $ show s))]
47−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
4851 where query = case t of
49− Timeout x -> [("t", Just (encodeQ $ show x))]
52+ Timeout x -> [("t", Just (encodeQ $ show x))]
5053 DefaultTimeout -> []
51−getEndpoint (PauseContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "pause"]
52−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"]
5356-- Make use of since/timestamps/tail logopts here instead of ignoreing them
54−getEndpoint (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
55− encodeURLWithQuery ["containers", fromContainerID cid, "logs"] query
57+getEndpoint v (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
58+ encodeURLWithQuery [v, "containers", fromContainerID cid, "logs"] query
5659 where query = [("stdout", Just (encodeQ $ show stdout)), ("stderr", Just (encodeQ $ show stderr)), ("follow", Just (encodeQ $ show follow))]
57−getEndpoint (DeleteContainerEndpoint (DeleteOpts removeVolumes force) cid) =
58− encodeURLWithQuery ["containers", fromContainerID cid] query
60+getEndpoint v (DeleteContainerEndpoint (ContainerDeleteOpts removeVolumes force) cid) =
61+ encodeURLWithQuery [v, "containers", fromContainerID cid] query
5962 where query = [("v", Just (encodeQ $ show removeVolumes)), ("force", Just (encodeQ $ show force))]
60−getEndpoint (InspectContainerEndpoint cid) =
61− encodeURLWithQuery ["containers", fromContainerID cid, "json"] []
63+getEndpoint v (InspectContainerEndpoint cid) =
64+ encodeURLWithQuery [v, "containers", fromContainerID cid, "json"] []
65+getEndpoint v (BuildImageEndpoint o _) = encodeURLWithQuery [v, "build"] query
66+ where query = [("t", Just t), ("dockerfile", Just dockerfile), ("q", Just q), ("nocache", Just nocache), ("rm", Just rm), ("forcerm", Just forcerm), ("pull", Just pull)]
67+ t = encodeQ $ T.unpack $ buildImageName o
68+ dockerfile = encodeQ $ T.unpack $ buildDockerfileName o
69+ q = encodeQ $ show $ buildQuiet o
70+ nocache = encodeQ $ show $ buildNoCache o
71+ rm = encodeQ $ show $ buildRemoveItermediate o
72+ forcerm = encodeQ $ show $ buildForceRemoveIntermediate o
73+ 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]
6281
63−getEndpointRequestBody :: Endpoint -> Maybe BSL.ByteString
82+getEndpointRequestBody :: Endpoint -> Maybe HTTP.RequestBody
6483getEndpointRequestBody VersionEndpoint = Nothing
6584getEndpointRequestBody (ListContainersEndpoint _) = Nothing
6685getEndpointRequestBody (ListImagesEndpoint _) = Nothing
67−getEndpointRequestBody (CreateContainerEndpoint opts _) = Just $ JSON.encode opts
86+getEndpointRequestBody (CreateContainerEndpoint opts _) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
6887getEndpointRequestBody (StartContainerEndpoint _ _) = Nothing
6988getEndpointRequestBody (StopContainerEndpoint _ _) = Nothing
7089getEndpointRequestBody (WaitContainerEndpoint _) = Nothing
@@ -75,3 +94,15 @@ getEndpointRequestBody (UnpauseContainerEndpoint _) = Nothing
7594getEndpointRequestBody (ContainerLogsEndpoint _ _ _) = Nothing
7695getEndpointRequestBody (DeleteContainerEndpoint _ _) = Nothing
7796getEndpointRequestBody (InspectContainerEndpoint _) = Nothing
97+
98+getEndpointRequestBody (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
104+
105+getEndpointContentType :: Endpoint -> BSC.ByteString
106+getEndpointContentType (BuildImageEndpoint _ _) = BSC.pack "application/tar"
107+getEndpointContentType _ = BSC.pack "application/json; charset=utf-8"
108+
src/Docker/Client/Types.hs+240−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,23 +26,30 @@ 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(..)
37+ , BuildOpts(..)
38+ , defaultBuildOpts
3339 , defaultCreateOpts
3440 , DetachKeys(..)
3541 , StartOpts(..)
3642 , defaultStartOpts
37− , DeleteOpts(..)
38− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3947 , Timestamp
4048 , TailLogOpt(..)
4149 , LogOpts(..)
4250 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4353 , VolumePermission(..)
4454 , Bind(..)
4555 , Volume(..)
@@ -65,6 +75,8 @@ module Docker.Client.Types (
6575 , UTSMode(..)
6676 , HostConfig(..)
6777 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6880 , Ulimit(..)
6981 , ContainerResources(..)
7082 , defaultContainerResources
@@ -100,6 +112,7 @@ import Data.Scientific (floatingOrInteger)
100112import Data.Text (Text)
101113import qualified Data.Text as T
102114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
103116import GHC.Generics (Generic)
104117import Prelude hiding (all, tail)
105118import Text.Read (readMaybe)
@@ -119,8 +132,13 @@ data Endpoint =
119132 | UnpauseContainerEndpoint ContainerID
120133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
121134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
122− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
123136 | InspectContainerEndpoint ContainerID
137+ | 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
124142 deriving (Eq, Show)
125143
126144-- | We should newtype this
@@ -195,16 +213,16 @@ data Signal = SIGHUP
195213
196214instance FromJSON Signal where
197215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
198− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
199− 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
200218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
201219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
202220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
203− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
204222
205223instance ToJSON Signal where
206− toJSON SIGHUP = "SIGHUP"
207− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
208226 toJSON SIGQUIT = "SIGQUIT"
209227 toJSON SIGSTOP = "SIGSTOP"
210228 toJSON SIGTERM = "SIGTERM"
@@ -232,7 +250,7 @@ data ContainerDetails = ContainerDetails {
232250 , processLabel :: Text
233251 , resolveConfPath :: FilePath
234252 , restartCount :: Int
235− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
236254 , mounts :: [Mount]
237255 }
238256 deriving (Eq, Show, Generic)
@@ -240,11 +258,11 @@ data ContainerDetails = ContainerDetails {
240258-- | Data type used for parsing the mount information from a container
241259-- list.
242260data Mount = Mount {
243− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
244262 , mountSource :: FilePath
245263 , mountDestination :: FilePath
246− , mountDriver :: Text
247− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
248266 , mountRW :: Bool
249267 , mountPropogation :: Text
250268 }
@@ -252,14 +270,14 @@ data Mount = Mount {
252270
253271instance FromJSON Mount where
254272 parseJSON (JSON.Object o) = do
255− name <- o .: "Name"
273+ name <- o .:? "Name"
256274 src <- o .: "Source"
257275 dest <- o .: "Destination"
258− driver <- o .: "Driver"
259− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
260278 rw <- o .: "RW"
261279 prop <- o .: "Propagation"
262− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
263281 parseJSON _ = fail "Mount is not an object"
264282
265283-- | Data type used for parsing the container state from a list of
@@ -275,7 +293,7 @@ data ContainerState = ContainerState {
275293 , restarting :: Bool
276294 , running :: Bool
277295 , startedAt :: UTCTime
278− , status :: Status
296+ , state :: State
279297 }
280298 deriving (Eq, Show, Generic)
281299
@@ -505,7 +523,8 @@ data Container = Container
505523 , containerImageId :: ImageID
506524 , containerCommand :: Text
507525 , containerCreatedAt :: Int
508− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
509528 , containerPorts :: [ContainerPortInfo]
510529 , containerLabels :: [Label]
511530 , containerNetworks :: [Network]
@@ -513,13 +532,14 @@ data Container = Container
513532 } deriving (Show, Eq)
514533
515534instance FromJSON Container where
516− parseJSON (JSON.Object v) =
517− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
518537 <*> (v .: "Names")
519538 <*> (v .: "Image")
520− <*> (v .: "ImageID")
521− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
522541 <*> (v .: "Created")
542+ <*> (v .: "State")
523543 <*> (v .: "Status")
524544 <*> (v .: "Ports")
525545 <*> (v .: "Labels")
@@ -529,21 +549,20 @@ instance FromJSON Container where
529549 parseNetworks (JSON.Object v) =
530550 (v .: "Networks") >>= parseJSON
531551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
532−
533552 parseJSON _ = fail "Container: Not a JSON object."
534553
535−-- | Represents the status of the container life cycle.
536−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
537556 deriving (Eq, Show, Generic)
538557
539−instance FromJSON Status where
540− parseJSON (JSON.String "running") = return Running
541− 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.
542561 parseJSON (JSON.String "restarting") = return Restarting
543− parseJSON (JSON.String "paused") = return Paused
544− parseJSON (JSON.String "exited") = return Exited
545− parseJSON (JSON.String "dead") = return Dead
546− 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
547566
548567-- | Alias for representing a RepoDigest. We could newtype this and add
549568-- some validation.
@@ -604,20 +623,46 @@ instance FromJSON Image where
604623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
605624 parseJSON _ = fail "Failed to parse DockerImage."
606625
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+ ]
607649
608650-- | Options used for creating a Container.
609651data CreateOpts = CreateOpts {
610− containerConfig :: ContainerConfig
611− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
612655 } deriving (Eq, Show)
613656
614657instance ToJSON CreateOpts where
615− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
616659 let ccJSON = toJSON cc
617660 let hcJSON = toJSON hc
618661 case ccJSON of
619662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
620− 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
621666 _ -> error "ContainerConfig is not an object." -- This should never happen.
622667
623668-- | Container configuration used for creating a container with sensible
@@ -639,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
639684 , cmd=[]
640685 , volumes=[]
641686 , workingDir=Nothing
642− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
643688 , networkDisabled=Nothing
644689 , macAddress=Nothing
645690 , labels=[]
@@ -652,7 +697,7 @@ defaultHostConfig = HostConfig {
652697 binds=[]
653698 , containerIDFile=Nothing
654699 , logConfig=LogDriverConfig JsonFile []
655− , networkMode=Bridge
700+ , networkMode=NetworkBridge
656701 , portBindings=[]
657702 , restartPolicy=RestartOff
658703 , volumeDriver=Nothing
@@ -692,14 +737,18 @@ defaultContainerResources = ContainerResources {
692737 , memory=Nothing
693738 , memoryReservation=Nothing
694739 , memorySwap=Nothing
695− , oomKillDisable=False
740+ , oomKillDisable=Just False
696741 , ulimits=[]
697742 }
698743
699744-- | Default create options when creating a container. You only need to
700745-- specify an image name and the rest is all sensible defaults.
701746defaultCreateOpts :: T.Text -> CreateOpts
702−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+ }
703752
704753-- | Override the key sequence for detaching a container.
705754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -713,16 +762,45 @@ defaultStartOpts :: StartOpts
713762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
714763
715764-- | Options for deleting a container.
716−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
717766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
718767 , force :: Bool -- ^ If the container is still running force deletion anyway.
719768 } deriving (Eq, Show)
720769
770+-- TODO: Add support for container build constraints
771+-- | Options for when building images from a Dockerfile
772+data BuildOpts = BuildOpts {
773+ buildImageName :: Text -- ^ Image name in the form of name:tag; ie. myimage:latest.:w
774+ , buildDockerfileName :: Text -- ^ Name of dockerfile (default: Dockerfile)
775+ , buildQuiet :: Bool
776+ , buildNoCache :: Bool -- ^ Do not use cache when building the image.
777+ , buildRemoveItermediate :: Bool -- ^ Remove intermediate containers after a successful build (default true).
778+ , buildForceRemoveIntermediate :: Bool -- ^ Always remove intermediate containers.
779+ , buildPullParent :: Bool -- ^ Always attempt to pull a newer version of the *parent* image (ie. FROM debian:jessie).
780+ } deriving (Eq, Show)
781+
782+defaultBuildOpts :: Text -> BuildOpts
783+defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
784+ , buildDockerfileName = "Dockerfile"
785+ , buildQuiet = False
786+ , buildNoCache = False
787+ , buildRemoveItermediate = True
788+ , buildForceRemoveIntermediate = False
789+ , buildPullParent = False
790+ }
791+
721792-- | Default options for deleting a container. Most of the time we DON'T
722793-- want to delete the container's volumes or force delete it if it's
723794-- running.
724−defaultDeleteOpts :: DeleteOpts
725−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
726804
727805-- | Timestamp alias.
728806type Timestamp = Integer
@@ -750,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
750828 , tail = All
751829 }
752830
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+
753861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
754862-- | Set permissions on volumes that you mount in the container.
755863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
756864
757865instance ToJSON VolumePermission where
758866 toJSON ReadWrite = "rw"
759− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
760868
761869instance FromJSON VolumePermission where
762870 parseJSON "rw" = return ReadWrite
763871 parseJSON "ro" = return ReadOnly
764− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
765875
766876-- | Used for marking a directory in the container as "exposed" hence
767877-- taking it outside of the COW filesystem and making it mountable
@@ -783,8 +893,8 @@ instance {-# OVERLAPPING #-} ToJSON [Volume] where
783893
784894instance {-# OVERLAPPING #-} FromJSON [Volume] where
785895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
786− parseJSON (JSON.Null) = return []
787− parseJSON _ = fail "Volume is not an object"
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
788898
789899
790900data Bind = Bind { hostSrc :: Text
@@ -794,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
794904
795905instance FromJSON Bind where
796906 parseJSON (JSON.String t) = case T.split (== ':') t of
797− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
798908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
799909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
800− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
801911 parseJSON _ = fail "Bind is not a string"
802912
803913data Device = Device {
@@ -820,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
820930
821931instance FromJSON VolumeFrom where
822932 parseJSON (JSON.String t) = case T.split (== ':') t of
823− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
824934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
825935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
826− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
827937 parseJSON _ = fail "VolumeFrom is not a string"
828938
829939instance ToJSON VolumeFrom where
830940 toJSON (VolumeFrom n p) = case p of
831− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
832942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
833943
834944instance ToJSON Bind where
@@ -840,40 +950,40 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
840950
841951instance FromJSON Link where
842952 parseJSON (JSON.String t) = case T.split (== ':') t of
843− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
844954 [f,s] -> return $ Link f $ Just s
845− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
846956 parseJSON _ = fail "Link is not a string"
847957
848958instance ToJSON Link where
849959 toJSON (Link n1 n2) = toJSON $ case n2 of
850960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
851− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
852962
853963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
854964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
855965
856966instance FromJSON LogDriverType where
857967 parseJSON (JSON.String "json-file") = return JsonFile
858− parseJSON (JSON.String "syslog") = return Syslog
859− parseJSON (JSON.String "journald") = return Journald
860− parseJSON (JSON.String "gelf") = return Gelf
861− parseJSON (JSON.String "fluentd") = return Fluentd
862− parseJSON (JSON.String "awslogs") = return AwsLogs
863− parseJSON (JSON.String "splunk") = return Splunk
864− parseJSON (JSON.String "etwlogs") = return Etwlogs
865− parseJSON (JSON.String "none") = return LoggingDisabled
866− 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"
867977
868978instance ToJSON LogDriverType where
869− toJSON JsonFile = JSON.String "json-file"
870− toJSON Syslog = JSON.String "syslog"
871− toJSON Journald = JSON.String "journald"
872− toJSON Gelf = JSON.String "gelf"
873− toJSON Fluentd = JSON.String "fluentd"
874− toJSON AwsLogs = JSON.String "awslogs"
875− toJSON Splunk = JSON.String "splunk"
876− 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"
877987 toJSON LoggingDisabled = JSON.String "none"
878988
879989data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
@@ -907,19 +1017,41 @@ instance FromJSON LogDriverConfig where
9071017 parseJSON _ = fail "LogDriverConfig is not an object"
9081018
9091019-- TODO: Add container:<name|id> mode
910−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
9111021 deriving (Eq, Show, Ord)
9121022
9131023instance FromJSON NetworkMode where
914− parseJSON (JSON.String "bridge") = return Bridge
915− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
916− parseJSON (JSON.String "none") = return NetworkDisabled
917− 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"
9181029
9191030instance ToJSON NetworkMode where
920− toJSON Bridge = JSON.String "bridge"
921− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
9221033 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]
9231055
9241056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9251057
@@ -935,7 +1067,7 @@ instance FromJSON PortType where
9351067 parseJSON val = case val of
9361068 "tcp" -> return TCP
9371069 "udp" -> return UDP
938− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
9391071
9401072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
9411073--
@@ -1065,7 +1197,7 @@ instance FromJSON RestartPolicy where
10651197 "on-failure" -> do
10661198 retry <- o .: "MaximumRetryCount"
10671199 return $ RestartOnFailure retry
1068− "off" -> return RestartOff
1200+ "no" -> return RestartOff
10691201 _ -> fail "Could not parse RestartPolicy"
10701202 parseJSON _ = fail "RestartPolicy is not an object"
10711203
@@ -1073,7 +1205,7 @@ instance ToJSON RestartPolicy where
10731205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
10741206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
10751207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1076− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
10771209
10781210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
10791211
@@ -1251,7 +1383,7 @@ data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
12511383data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
12521384
12531385instance ToJSON MemoryConstraint where
1254− toJSON (MemoryConstraint x B) = toJSON x
1386+ toJSON (MemoryConstraint x B) = toJSON x
12551387 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
12561388 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
12571389
@@ -1282,7 +1414,7 @@ data ContainerResources = ContainerResources {
12821414 , memoryReservation :: Maybe MemoryConstraint
12831415 , memorySwap :: Maybe MemoryConstraint
12841416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1285− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
12861418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
12871419 , ulimits :: [Ulimit]
12881420 -- TODO: Missing from 1.24
@@ -1320,7 +1452,7 @@ instance FromJSON EnvVar where
13201452 parseJSON _ = fail "EnvVar is not a string"
13211453
13221454instance ToJSON EnvVar where
1323− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
13241456
13251457-- | ExposedPort represents a port (and it's type)
13261458-- that a container should expose to other containers or the host system.
@@ -1360,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
13601492 where key (ExposedPort p t) = show p <> slash <> show t
13611493 slash = T.unpack "/"
13621494
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+
13631510data ContainerConfig = ContainerConfig {
13641511 hostname :: Maybe Text
13651512 , domainname :: Maybe Text
@@ -1378,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
13781525 , image :: Text
13791526 , volumes :: [Volume]
13801527 , workingDir :: Maybe FilePath
1381− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
13821529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
13831530 , macAddress :: Maybe Text
13841531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1386,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
13861533 , stopSignal :: Signal
13871534 } deriving (Eq, Show, Generic)
13881535
1536+
13891537instance ToJSON ContainerConfig where
13901538 toJSON = genericToJSON defaultOptions {
13911539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1407,7 +1555,7 @@ instance FromJSON ContainerConfig where
14071555 image <- o .: "Image"
14081556 volumes <- o .: "Volumes"
14091557 workingDir <- o .:? "WorkingDir"
1410− entrypoint <- o .:? "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
14111559 networkDisabled <- o .:? "networkDisabled"
14121560 macAddress <- o .:? "MacAddress"
14131561 labels <- o .:? "Labels" .!= []
@@ -1416,7 +1564,11 @@ instance FromJSON ContainerConfig where
14161564 macAddress labels stopSignal
14171565 parseJSON _ = fail "NetworkSettings is not an object."
14181566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14191570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14201572parseIntegerText t = case readMaybe $ T.unpack t of
14211573 Nothing ->
14221574 fail "Could not parse Integer"
@@ -1438,4 +1590,3 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
14381590-- | Helper function that return an empty dictionary "{}"
14391591emptyJsonObject :: JSON.Value
14401592emptyJsonObject = JSON.Object HM.empty
1441−
src/Docker/Client/Utils.hsnew file+131
@@ -0,0 +1,131 @@
1+{-# LANGUAGE ExplicitForAll #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+
6+module Docker.Client.Utils where
7+
8+import qualified Codec.Archive.Tar as Tar
9+import qualified Codec.Compression.GZip as GZip
10+import Control.Monad (filterM, liftM, unless)
11+import Control.Monad.IO.Class
12+import qualified Data.ByteString.Lazy as BS
13+import Data.Monoid ((<>))
14+import qualified Data.Text as T
15+import qualified Data.Text.IO as TIO
16+import qualified Data.UUID as UUID
17+import qualified Data.UUID.V4 as UUID
18+import System.Directory (doesDirectoryExist, doesFileExist,
19+ getTemporaryDirectory)
20+import System.FilePath (isAbsolute, makeRelative, (</>))
21+import System.FilePath.Find (FilterPredicate,
22+ RecursionPredicate, always,
23+ fileName, find, (==?))
24+import System.FilePath.GlobPattern ((~~))
25+import System.IO.Error (tryIOError)
26+-- import System.IO.Temp (withSystemTempDirectory)
27+--
28+import Docker.Client.Http
29+
30+type File = FilePath
31+data DirTree = DirTree [File] [DirTree]
32+
33+
34+newtype ExclusionPattern = ExclusionPattern T.Text deriving (Eq, Show)
35+newtype InclusionPattern = InclusionPattern T.Text deriving (Eq, Show)
36+
37+data DockerIgnore = DockerIgnore { exclusionPatterns :: [ExclusionPattern]
38+ , inclusionPatterns :: [InclusionPattern]
39+ } deriving (Eq, Show)
40+
41+newtype BuildContextRootDir = BuildContextRootDir FilePath deriving (Eq, Show)
42+
43+makeBuildContext :: forall m. MonadIO m => BuildContextRootDir -> m (Either DockerError FilePath)
44+makeBuildContext base = liftIO $ tryIOError (makeBuildContext' base) >>= \res -> case res of
45+ Left e -> return $ Left $ DockerClientError (T.pack $ show e)
46+ Right c -> return $ Right c
47+
48+makeBuildContext' :: forall m. MonadIO m => BuildContextRootDir -> m FilePath
49+makeBuildContext' (BuildContextRootDir base) = do
50+ uuid <- liftIO UUID.nextRandom
51+ fs <- liftIO $ getBuildContext $ BuildContextRootDir base
52+ let relFs = map (makeRelative base) fs
53+ tmpDir <- liftIO getTemporaryDirectory
54+ let tmpF = tmpDir </> "docker.context-" <> UUID.toString uuid <> ".tar.gz"
55+ liftIO $ BS.writeFile tmpF . GZip.compress . Tar.write =<< Tar.pack base relFs
56+ return tmpF
57+
58+parseDockerIgnoreFile :: T.Text -> DockerIgnore
59+parseDockerIgnoreFile c = DockerIgnore{ exclusionPatterns=parseExclusions
60+ , inclusionPatterns=parseInclusions}
61+ where lines = filter (not . T.isPrefixOf "#") (T.lines c) -- Ignore comments
62+ parseExclusions = map ExclusionPattern $ filter (\l -> not (T.isPrefixOf "!" l) && (l /= "")) lines
63+ parseInclusions = map (InclusionPattern . T.drop 1) $ filter (\l -> T.isPrefixOf "!" l && (l /= "")) lines
64+
65+getBuildContext :: BuildContextRootDir -> IO [FilePath]
66+getBuildContext (BuildContextRootDir base) = do
67+ -- The base dir needs to be a path to a directory and not a path to
68+ -- a file
69+ exists <- doesDirectoryExist base
70+ let abs = isAbsolute base
71+ unless (exists && abs) $ fail "Path to context needs to be a directory that: exists, is readable, and is an absolute path."
72+ di <- find always (fileName ==? ".dockerignore") base
73+ dockerignore <- case di of
74+ [] -> return $ DockerIgnore [] []
75+ -- This should not return more than one result though
76+ (x:_) -> do
77+ c <- TIO.readFile x
78+ return $ parseDockerIgnoreFile c
79+ -- This will traverse the directory recursively
80+ fs <- find (shouldRecurse dockerignore) (shouldInclude dockerignore) base
81+ -- fs is a list of directories *and* files in those directories. So
82+ -- an example result would look like ["/tmp/project/files",
83+ -- "/tmp/project/files/file1.txt"] and we want just the individual
84+ -- files otherwise tar duplicates them when making the archive.
85+ fs' <- filterM doesFileExist fs
86+ -- For some reason base is in there as well and we don't need that
87+ return $ filter (not . (==) base) fs'
88+
89+shouldInclude :: DockerIgnore -> FilterPredicate
90+shouldInclude d = check `liftM` fileName
91+ where check f = dockerIgnoreDecision (exclusionCheck f (exclusionPatterns d), inclusionCheck f (inclusionPatterns d))
92+
93+shouldRecurse :: DockerIgnore -> RecursionPredicate
94+shouldRecurse d = check `liftM` fileName
95+ where check f = dockerIgnoreDecision (exclusionCheck f (exclusionPatterns d), inclusionCheck f (inclusionPatterns d))
96+
97+-- TODO: We don't handle precedence rules. For instance a dockerignore file
98+-- like this:
99+--
100+-- *.md
101+-- !README*.md
102+-- README-secret.md
103+--
104+-- Should result in no markdown files being included in the context except README files other
105+-- than README-secret.md. FIXME: OUR implementation would in fact include
106+-- README-secret.md as well!!!
107+--
108+-- Whereas this:
109+--
110+-- *.md
111+-- README-secret.md
112+-- !README*.md
113+--
114+-- Should result in all of the README files being included. The middle line has no effect
115+-- because !README*.md matches README-secret.md and comes last. Our
116+-- implementation will result in the same thing.
117+dockerIgnoreDecision :: (Bool, Bool) -> Bool
118+dockerIgnoreDecision p = case p of
119+ -- If it's in any of the exclusion patterns but also
120+ -- in any of the inclusion patterns then laeave it
121+ (True, True) -> True
122+ (True, False) -> False
123+ (False, True) -> True
124+ (False, False) -> True
125+
126+exclusionCheck :: FilePath -> [ExclusionPattern] -> Bool
127+exclusionCheck f ps = any id (map (\(ExclusionPattern p) -> f ~~ T.unpack p) ps)
128+
129+inclusionCheck :: FilePath -> [InclusionPattern] -> Bool
130+inclusionCheck f ps = any id (map (\(InclusionPattern p) -> f ~~ T.unpack p) ps)
131+
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: []
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−75
@@ -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,130 +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− runDockerT (defaultClientOpts, defaultHttpHandler) 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
4656
4757testDockerVersion :: IO ()
48−testDockerVersion = runDocker $ do
49− v <- getDockerVersion
50− 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
5167
5268testFindImage :: IO ()
53−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
5487 images <- listImages defaultListOpts >>= fromRight
55− let xs = filter ((== [imageFullName]) . imageRepoTags) images
56− lift $ assert $ length xs == 1
57− 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+
58108
59109testRunAndReadLog :: IO ()
60−testRunAndReadLog = runDocker $ do
61− containerId <- createContainer (defaultCreateOpts (testImageName <> ":latest")) Nothing
62− c <- fromRight containerId
63− status1 <- startContainer defaultStartOpts c
64− _ <- inspectContainer c >>= fromRight
65− lift $ threadDelay 300000 -- give 300ms for the application to finish
66− lift $ assert $ status1 == Right ()
67− status2 <- killContainer SIGTERM c
68− logs <- getContainerLogs defaultLogOpts c >>= fromRight
69− lift $ assert $ status2 == Right ()
70− lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)
71− status3 <- deleteContainer (DeleteOpts True True) c
72− lift $ assert $ status3 == Right ()
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
73146
74147testLogDriverOptionsJson :: TestTree
75−testLogDriverOptionsJson = testGroup "Testing LogDriverOptions JSON" [ test1, test2, test3 ]
76− where
77− test1 = testCase "Driver option 1" $ assert $ JSON.toJSON sample ^. key key1 . _String == val1
78− test2 = testCase "Driver option 2" $ assert $ JSON.toJSON sample ^. key key2 . _String == val2
79− test3 = testCase "Test override" $ assert $ JSON.toJSON sample2 ^. key key1 . _String == "override"
80− sample = [LogDriverOption key1 val1, LogDriverOption key2 val2]
81− sample2 = [LogDriverOption key1 val1, LogDriverOption key1 "override"]
82− key1 = "some-key"
83− val1 = "some-val"
84− key2 = "some-key2"
85− 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"
86160
87161testExposedPortsJson :: TestTree
88−testExposedPortsJson = testGroup "Testing ExposedPorts JSON" [ testTCP, testUDP ]
89− where
90− testTCP = testCase "tcp port" $ assert $ JSON.toJSON sampleEP ^. key "80/tcp" . _Object == HM.empty
91− testUDP = testCase "udp port" $ assert $ JSON.toJSON sampleEP ^. key "1337/tcp" . _Object == HM.empty
92− 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]
93168
94169testLabelsJson :: TestTree
95−testLabelsJson = testGroup "Testing Labels JSON" [ testLS1, testLS2, testOverride ]
96− where
97− testLS1 = testCase "test label key1" $ assert $ JSON.toJSON sampleLS ^. key key1 . _String == val1
98− testLS2 = testCase "test label key2" $ assert $ JSON.toJSON sampleLS ^. key key2 . _String == val2
99− testOverride = testCase "test label override" $ assert $ JSON.toJSON [Label key1 val1, Label key1 "override"] ^. key key1 . _String == "override"
100− sampleLS = [Label key1 val1, Label key2 val2]
101− key1 = "com.example.some-label"
102− val1 = "some-value"
103− key2 = "something"
104− 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"
105184
106185testVolumesJson :: TestTree
107−testVolumesJson = testGroup "Testing Volumes JSON" [ testSample1, testSample2 ]
108− where
109− testSample1 = testCase "Test exposing volume: /tmp" $ assert $ JSON.toJSON sampleVolumes ^. key "/tmp" . _Object == HM.empty
110− testSample2 = testCase "Test exposing volume: /opt" $ assert $ JSON.toJSON sampleVolumes ^. key "/opt" . _Object == HM.empty
111− 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+ ]
112238
113239integrationTests :: TestTree
114−integrationTests = testGroup "Integration Tests" [
115− testCase "Get docker version" testDockerVersion,
116− testCase "Find image by name" testFindImage,
117− 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+ ]
118253
119254jsonTests :: TestTree
120−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+ ]
121266
122267setup :: IO ()
123−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
124275
125−isRight (Left _) = False
276+isRight (Left _) = False
126277isRight (Right _) = True
127278
128−fromRight :: (MonadIO m, Show l) => Either l r -> m r
279+fromRight
280+ :: (MonadIO m, Show l)
281+ => Either l r -> m r
129282fromRight (Left l) = do
130− liftIO $ assertFailure $ "Left: " ++ show l
131− undefined
283+ liftIO $ assertFailure $ "Left: " ++ show l
284+ undefined
132285fromRight (Right r) = return r
133286
134287main :: IO ()
135288main = do
136− setup
137− defaultMain $ testGroup "Tests" [jsonTests, integrationTests]
138−
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]