on ff9b7ac help sign in
23 files changed+355−1196
since splitsnapshots
unifiedsplit
.gitignore−1 .travis.yml+4−32 CHANGELOG.md−71 CONTRIBUTING.md+2−12 LICENSE+1−1 Makefile+2−21 README.md+10−37 docker.cabal+12−42 examples/Example.hs+43−52 src/Docker/Client.hs+5−12 src/Docker/Client/Api.hs+48−129 src/Docker/Client/Http.hs+29−86 src/Docker/Client/Internal.hs+27−60 src/Docker/Client/Types.hs+89−256 src/Docker/Client/Utils.hs−131 stack-7.10.yaml+5−5 stack-8.0.2.yaml−4 stack-8.0.yaml+1−2 stack-8.6.4.yaml−4 stack-8.8.2.yaml−5 stack.yaml+1−1 tests/Dockerfile+1−1 tests/tests.hs+75−231
.gitignore−1
@@ -4,4 +4,3 @@
44*~
55.stack-work/
66dist-newstyle
7−/cabal.project.local
.travis.yml+4−32
@@ -1,12 +1,6 @@
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−
104# Choose a lightweight base image; we provide our own build tools.
115language:
126 c
@@ -22,30 +16,9 @@ services:
2216 - docker
2317
2418env:
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
19+ - STACK_ARGS=""
20+ - GHCVER=7.10
21+ - GHCVER=8.0
4922
5023addons:
5124 apt:
@@ -57,8 +30,7 @@ before_install:
5730 - sudo sh -c 'echo "deb https://apt.dockerproject.org/repo ubuntu-trusty main" > /etc/apt/sources.list.d/docker.list'
5831 - sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
5932 - sudo apt-get update
60− - sudo apt-get -qqy -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install docker-engine=$DOCKER_VERSION
61−
33+ - sudo apt-get -qqy -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install docker-engine=1.12.3-0~trusty
6234install:
6335 - mkdir -p "$HOME"/.local/bin
6436 - export PATH=$HOME/.local/bin:$PATH
CHANGELOG.md−71
@@ -1,76 +1,5 @@
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−
743## 0.3.0.1 (2016-09-07)
754
765- Small cosmetic changes and marking OVERLAPPING instance
CONTRIBUTING.md+2−12
@@ -1,14 +1,4 @@
1−# Contributing
1+# TODO
22
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.
3+Add basic guidelines here, things like style guide (using .configuration files from the repo) etc etc.
94
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) 2014, Deni Bertovic
1+Copyright (c) 2016, Deni Bertovic
22
33All rights reserved.
44
Makefile+2−21
@@ -1,6 +1,4 @@
1−.PHONY: build repl test release help
2−
3−.DEFAULT_GOAL = help
1+.PHONY: build repl test release
42
53PROJECT_NAME ?= $(shell grep "^name" docker.cabal | cut -d " " -f17)
64VERSION ?= $(shell grep "^version:" docker.cabal | cut -d " " -f14)
@@ -8,35 +6,18 @@ RESOLVER ?= $(shell grep "^resolver:" stack.yaml | cut -d " " -f2)
86GHC_VERSION ?= $(shell stack ghc -- --version | cut -d " " -f8)
97ARCH=$(shell uname -m)
108
11−## Run build
129build:
1310 @stack build
1411
15−## Run repl
1612repl:
1713 @stack repl
1814
19−## Run tests. Example RUN_INTEGRATION_TESTS=1 make test
2015test:
21− @RUN_INTEGRATION_TESTS=1 stack test
16+ @stack test
2217
23−## Cut new release
2418release:
2519 @stack build --haddock
2620 @stack sdist
2721 @echo "\n\nDone. Now run: \n\nstack upload <path_to_tarball>\n"
2822 @echo "\nAnd: \n\ngit tag ${VERSION} && git push --tags\n"
2923
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+10−37
@@ -1,48 +1,21 @@
11# An API client for docker written in Haskell
22
3−| Master |
4−| -------|
5−| [![master](https://travis-ci.org/denibertovic/docker-hs.svg?branch=master)](https://travis-ci.org/denibertovic/docker-hs) |
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) |
66
77
88## Current state
99
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).
10+**API is still no stable.**
11+We're looking to stabilize the API after the next release (0.4.0.0)
2112
2213## Contributing
2314
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`.
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.
4417
45−## IRC
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.
4621
47−If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
48−on freenode.
docker.cabal+12−42
@@ -1,5 +1,5 @@
11name: docker
2−version: 0.6.0.3
2+version: 0.3.0.1
33synopsis: An API client for docker written in Haskell
44description: See API documentation below.
55homepage: https://github.com/denibertovic/docker-hs
@@ -14,57 +14,29 @@ extra-source-files: README.md
1414cabal-version: >=1.10
1515stability: experimental
1616
17−-- Flag small-http-conduit
18−-- Description: Resolve whether http-conduit < 2.3.0.
19−-- Manual: False
20−-- Default: True
21−
2217library
23− default-extensions: DeriveGeneric, OverloadedStrings, ScopedTypeVariables, ExplicitForAll, MultiParamTypeClasses, FlexibleContexts, GeneralizedNewtypeDeriving, RankNTypes, DeriveFunctor, FlexibleInstances, CPP
18+ default-extensions: DeriveGeneric, OverloadedStrings, ScopedTypeVariables, ExplicitForAll, MultiParamTypeClasses, FlexibleContexts, GeneralizedNewtypeDeriving, RankNTypes, DeriveFunctor, FlexibleInstances
2419 hs-source-dirs: src
25− exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http, Docker.Client.Utils
20+ exposed-modules: Docker.Client, Docker.Client.Api, Docker.Client.Types, Docker.Client.Internal, Docker.Client.Http
2621 -- other-modules: Docker.Internal
2722 build-depends: base >= 4.7 && < 5
28− , aeson >= 0.9.0 && < 2.0.0
23+ , aeson >= 0.9.0 && < 1.1.0
2924 , blaze-builder >= 0.4.0 && < 0.5.0
3025 , bytestring >= 0.10.0 && < 0.11.0
31− , containers >= 0.5.0 && < 0.7.0
26+ , containers >= 0.5.0 && < 0.6.0
3227 , data-default-class >= 0.0.1 && < 0.2.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
28+ , http-client >= 0.4.0 && < 0.5.0
29+ , http-types >= 0.9 && < 0.10.0
5130 , mtl >= 2.0.0 && < 3.0.0
5231 , network >= 2.6.0
5332 , text >= 1.0.0 && < 2.0.0
54− , time >= 1.5.0 && < 2.0.0
33+ , time >= 1.5.0 && < 1.7.0
5534 , scientific >= 0.3.0 && < 0.4.0
56− , tls >= 1.3.7 && < 1.6.0
35+ , tls >= 1.3.7 && < 1.4.0
5736 , unordered-containers >= 0.2.0 && < 0.3.0
58− , x509 >= 1.6.0 && < 1.8.0
59− , x509-store >= 1.6.0 && < 1.8.0
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
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
6840 default-language: Haskell2010
6941 ghc-options: -Wall -fno-warn-name-shadowing
7042
@@ -73,7 +45,6 @@ test-suite docker-hs-tests
7345 , bytestring
7446 , connection
7547 , docker
76− , directory
7748 , aeson
7849 , containers
7950 , unordered-containers
@@ -89,7 +60,6 @@ test-suite docker-hs-tests
8960 , transformers
9061 , QuickCheck
9162 , process
92− , vector
9363 type: exitcode-stdio-1.0
9464 main-is: tests.hs
9565 hs-source-dirs: tests
examples/Example.hs+43−52
@@ -1,64 +1,55 @@
11import Docker.Client
22
33runNginxContainer :: IO ContainerID
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
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
1513
1614stopNginxContainer :: ContainerID -> IO ()
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 ()
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 ()
2420
2521runPostgresContainer :: IO ContainerID
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
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
3832
3933-- | Example of how we can start a database container while hosting it's
4034-- data in a data volume living inside another container.
4135runPostgresWithDataContainer :: IO ContainerID
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
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
6455
src/Docker/Client.hs+5−12
@@ -3,7 +3,7 @@
33
44{-|
55Module : Docker.Client
6−Copyright : (c) Deni Bertovic, 2014
6+Copyright : (c) Deni Bertovic, 2016
77License : BSD3
88Maintainer : deni@denibertovic.com
99Stability : experimental
@@ -20,9 +20,7 @@ the host.
2020import Docker.Client
2121
2222runNginxContainer :: IO ContainerID
23−runNginxContainer = do
24− h <- defaultHttpHandler
25− runDockerT (defaultClientOpts, h) $ do
23+runNginxContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
2624 let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
2725 let myCreateOpts = addPortBinding pb $ defaultCreateOpts "nginx:latest"
2826 cid <- createContainer myCreateOpts
@@ -44,9 +42,7 @@ Let's stop the container now:
4442
4543@
4644stopNginxContainer :: ContainerID -> IO ()
47−stopNginxContainer cid = do
48− h <- defaultHttpHandler
49− runDockerT (defaultClientOpts, h) $ do
45+stopNginxContainer cid = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
5046 r <- stopContainer DefaultTimeout cid
5147 case r of
5248 Left err -> error "I failed to stop the container"
@@ -61,9 +57,7 @@ persist on the host file system.
6157
6258@
6359runPostgresContainer :: IO ContainerID
64−runPostgresContainer = do
65− h <- defaultHttpHandler
66− runDockerT (defaultClientOpts, h) $ do
60+runPostgresContainer = runDockerT (defaultClientOpts, defaultHttpHandler) $ do
6761 let pb = PortBinding 5432 TCP [HostPort "0.0.0.0" 5432]
6862 let myCreateOpts = addBinds [Bind "\/tmp" "\/tmp" Nothing] $ addPortBinding pb $ defaultCreateOpts "postgres:9.5"
6963 cid <- createContainer myCreateOpts
@@ -76,8 +70,7 @@ runPostgresContainer = do
7670
7771= Get Docker API Version
7872
79−>>> h <- defaultHttpHandler
80−>>> runDockerT (defaultClientOpts, h) $ getDockerVersion
73+>>> runDockerT (defaultClientOpts, defaultHttpHandler) $ getDockerVersion
8174Right (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"})
8275
8376= Setup SSL Authentication
src/Docker/Client/Api.hs+48−129
@@ -7,7 +7,6 @@ module Docker.Client.Api (
77 , createContainer
88 , startContainer
99 , stopContainer
10− , waitContainer
1110 , killContainer
1211 , restartContainer
1312 , pauseContainer
@@ -15,143 +14,110 @@ module Docker.Client.Api (
1514 , deleteContainer
1615 , inspectContainer
1716 , getContainerLogs
18− , getContainerLogsStream
1917 -- * Images
2018 , listImages
21− , deleteImage
22− , buildImageFromDockerfile
23− , pullImage
24− -- * Network
25− , createNetwork
26− , removeNetwork
2719 -- * Other
2820 , getDockerVersion
2921 ) where
3022
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 (..))
23+import Control.Monad.Except (ExceptT (..), runExceptT, throwError)
24+import Control.Monad.Reader (ask, lift)
25+import Data.Aeson (FromJSON, eitherDecode')
26+import qualified Data.ByteString.Lazy as BSL
27+import qualified Data.Text as Text
28+import Network.HTTP.Client (responseBody, responseStatus)
29+import Network.HTTP.Types (StdMethod (..))
4430
4531import Docker.Client.Http
4632import Docker.Client.Types
47−import Docker.Client.Utils
4833
49−requestUnit :: (MonadIO m, MonadMask m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError ())
50−requestUnit verb endpoint = fmap (const ()) <$> requestHelper verb endpoint
34+requestUnit :: (Monad m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError ())
35+requestUnit verb endpoint = const (Right ()) <$> requestHelper verb endpoint
5136
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
37+requestHelper :: (Monad m) => HttpVerb -> Endpoint -> DockerT m (Either DockerError Response)
38+requestHelper verb endpoint = runExceptT $ do
39+ (opts, httpHandler) <- lift ask
5840 case mkHttpRequest verb endpoint opts of
5941 Nothing ->
60− return $ Left $ DockerInvalidRequest endpoint
42+ throwError $ DockerInvalidRequest endpoint
6143 Just request -> do
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)
44+ response <- ExceptT $ lift $ httpHandler request
45+
46+ -- Check status code.
47+ let status = responseStatus response
48+ maybe (return ()) throwError $
49+ statusCodeToError endpoint status
50+
51+ return response
52+
53+parseResponse :: (FromJSON a, Monad m) => Either DockerError Response -> DockerT m (Either DockerError a)
7454parseResponse (Left err) =
7555 return $ Left err
7656parseResponse (Right response) =
7757 -- Parse request body.
78− case eitherDecode' response of
58+ case eitherDecode' $ responseBody response of
7959 Left err ->
8060 return $ Left $ DockerClientDecodeError $ Text.pack err
8161 Right r ->
8262 return $ Right r
8363
8464-- | Gets the version of the docker engine remote API.
85−getDockerVersion :: forall m. (MonadIO m, MonadMask m) => DockerT m (Either DockerError DockerVersion)
65+getDockerVersion :: forall m. Monad m => DockerT m (Either DockerError DockerVersion)
8666getDockerVersion = requestHelper GET VersionEndpoint >>= parseResponse
8767
8868-- | Lists all running docker containers. Pass in @'defaultListOpts' {all
8969-- = True}@ to get a list of stopped containers as well.
90−listContainers :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Container])
70+listContainers :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Container])
9171listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseResponse
9272
9373-- | Lists all docker images.
94−listImages :: forall m. (MonadIO m, MonadMask m) => ListOpts -> DockerT m (Either DockerError [Image])
74+listImages :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Image])
9575listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
9676
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−
10377-- | Creates a docker container but does __not__ start it. See
10478-- 'CreateOpts' for a list of options and you can use 'defaultCreateOpts'
10579-- for some sane defaults.
106−createContainer :: forall m. (MonadIO m, MonadMask m) => CreateOpts -> Maybe ContainerName -> DockerT m (Either DockerError ContainerID)
80+createContainer :: forall m. Monad m => CreateOpts -> Maybe ContainerName -> DockerT m (Either DockerError ContainerID)
10781createContainer opts cn = requestHelper POST (CreateContainerEndpoint opts cn) >>= parseResponse
10882
10983-- | Start a container from a given 'ContainerID' that we get from
11084-- 'createContainer'. See 'StartOpts' for a list of configuration options
11185-- for starting a container. Use 'defaultStartOpts' for sane defaults.
112−startContainer :: forall m. (MonadIO m, MonadMask m) => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
86+startContainer :: forall m. Monad m => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
11387startContainer sopts cid = requestUnit POST $ StartContainerEndpoint sopts cid
11488
11589-- | Attempts to stop a container with the given 'ContainerID' gracefully
11690-- (SIGTERM).
11791-- The docker daemon will wait for the given 'Timeout' and then send
11892-- a SIGKILL killing the container.
119−stopContainer :: forall m. (MonadIO m, MonadMask m) => Timeout -> ContainerID -> DockerT m (Either DockerError ())
93+stopContainer :: forall m. Monad m => Timeout -> ContainerID -> DockerT m (Either DockerError ())
12094stopContainer t cid = requestUnit POST $ StopContainerEndpoint t cid
12195
122−-- | Blocks until a container with the given 'ContainerID' stops,
123−-- then returns the exit code
124−waitContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ExitCode)
125−waitContainer cid = fmap (fmap statusCodeToExitCode) (requestHelper POST (WaitContainerEndpoint cid) >>= parseResponse)
126− where
127− statusCodeToExitCode (StatusCode 0) = ExitSuccess
128− statusCodeToExitCode (StatusCode x) = ExitFailure x
129−
13096-- | Sends a 'Signal' to the container with the given 'ContainerID'. Same
13197-- as 'stopContainer' but you choose the signal directly.
132−killContainer :: forall m. (MonadIO m, MonadMask m) => Signal -> ContainerID -> DockerT m (Either DockerError ())
98+killContainer :: forall m. Monad m => Signal -> ContainerID -> DockerT m (Either DockerError ())
13399killContainer s cid = requestUnit POST $ KillContainerEndpoint s cid
134100
135101-- | Restarts a container with the given 'ContainerID'.
136−restartContainer :: forall m. (MonadIO m, MonadMask m) => Timeout -> ContainerID -> DockerT m (Either DockerError ())
102+restartContainer :: forall m. Monad m => Timeout -> ContainerID -> DockerT m (Either DockerError ())
137103restartContainer t cid = requestUnit POST $ RestartContainerEndpoint t cid
138104
139105-- | Pauses a container with the given 'ContainerID'.
140−pauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ())
106+pauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either DockerError ())
141107pauseContainer cid = requestUnit POST $ PauseContainerEndpoint cid
142108
143109-- | Unpauses a container with the given 'ContainerID'.
144−unpauseContainer :: forall m. (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ())
110+unpauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either DockerError ())
145111unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
146112
147113-- | Deletes a container with the given 'ContainerID'.
148−-- See "ContainerDeleteOpts" for options and use 'defaultContainerDeleteOpts' for sane
114+-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane
149115-- defaults.
150−deleteContainer :: forall m. (MonadIO m, MonadMask m) => ContainerDeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
116+deleteContainer :: forall m. Monad m => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
151117deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
152118
153119-- | Gets 'ContainerDetails' for a given 'ContainerID'.
154−inspectContainer :: forall m . (MonadIO m, MonadMask m) => ContainerID -> DockerT m (Either DockerError ContainerDetails)
120+inspectContainer :: forall m . Monad m => ContainerID -> DockerT m (Either DockerError ContainerDetails)
155121inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= parseResponse
156122
157123-- | Get's container's logs for a given 'ContainerID'.
@@ -161,67 +127,20 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars
161127-- See 'LogOpts' for options that you can pass and
162128-- 'defaultLogOpts' for sane defaults.
163129--
164−-- __NOTE__: his function will fetch the entire log that the
130+-- __NOTE__: Currently streaming logs is
131+-- not supported and this function will fetch the entire log that the
165132-- container produced in the json-file on disk. Depending on the logging
166133-- setup of the process in your container this can be a significant amount
167134-- which might block your application...so use with caution.
168135--
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
136+-- The recommended method is to use one of the other 'LogDriverType's available (like
173137-- syslog) for creating your containers.
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
138+getContainerLogs :: forall m. Monad m => LogOpts -> ContainerID -> DockerT m (Either DockerError BSL.ByteString)
139+getContainerLogs logopts cid = fmap responseBody <$> requestHelper GET (ContainerLogsEndpoint logopts False cid)
140+
141+-- TODO: Use http-conduit to output to a sink.
142+-- getContainerLogsStream :: forall m. Monad m => Sink BSL.ByteString m b -> LogOpts -> ContainerID -> DockerT m (Either DockerError b)
143+-- getContainerLogsStream sink logopts cid = runResourceT $ do
144+-- response <- http request manager
145+-- responseBody response C.$$+- sink
227146
src/Docker/Client/Http.hs+29−86
@@ -3,28 +3,21 @@
33
44module Docker.Client.Http where
55
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)
6+import Control.Monad.Reader (ReaderT, runReaderT)
127import qualified Data.ByteString.Char8 as BSC
138import qualified Data.ByteString.Lazy as BL
14−import Data.Conduit (Sink)
159import Data.Default.Class (def)
1610import Data.Monoid ((<>))
1711import Data.Text.Encoding (encodeUtf8)
1812import Data.X509 (CertificateChain (..))
1913import Data.X509.CertificateStore (makeCertificateStore)
2014import Data.X509.File (readKeyFile, readSignedObject)
21−import Network.HTTP.Client (defaultManagerSettings,
15+import Network.HTTP.Client (defaultManagerSettings, httpLbs,
2216 managerRawConnection, method,
23− newManager, parseRequest,
17+ newManager, parseUrl,
2418 requestBody, requestHeaders)
2519import qualified Network.HTTP.Client as HTTP
2620import Network.HTTP.Client.Internal (makeConnection)
27−import qualified Network.HTTP.Simple as NHS
2821import Network.HTTP.Types (StdMethod, status101, status200,
2922 status201, status204)
3023import Network.TLS (ClientHooks (..),
@@ -34,7 +27,7 @@ import Network.TLS (ClientHooks (..),
3427import Network.TLS.Extra (ciphersuite_strong)
3528import System.X509 (getSystemCertificateStore)
3629
37−import Control.Monad.Catch (try)
30+import Control.Exception (try)
3831import Control.Monad.Except
3932import Control.Monad.Reader.Class
4033import Data.Text as T
@@ -45,22 +38,20 @@ import qualified Network.Socket.ByteString as SBS
4538
4639
4740import Docker.Client.Internal (getEndpoint,
48− getEndpointContentType,
4941 getEndpointRequestBody)
5042import Docker.Client.Types (DockerClientOpts, Endpoint (..),
51− apiVer, baseUrl)
43+ baseUrl)
5244
5345type Request = HTTP.Request
5446type Response = HTTP.Response BL.ByteString
5547type HttpVerb = StdMethod
56−newtype HttpHandler m = HttpHandler (forall a . Request -> (HTTP.Response () -> Sink BSC.ByteString m (Either DockerError a)) -> m (Either DockerError a))
48+type HttpHandler m = Request -> m (Either DockerError Response)
5749
58−data DockerError = DockerConnectionError NHS.HttpException
50+data DockerError = DockerConnectionError
5951 | DockerInvalidRequest Endpoint
60− | DockerClientError Text
6152 | DockerClientDecodeError Text -- ^ Could not parse the response from the Docker endpoint.
6253 | DockerInvalidStatusCode HTTP.Status -- ^ Invalid exit code received from Docker endpoint.
63− | GenericDockerError Text deriving (Show, Typeable)
54+ | GenericDockerError Text deriving (Eq, Show, Typeable)
6455
6556newtype DockerT m a = DockerT {
6657 unDockerT :: Monad m => ReaderT (DockerClientOpts, HttpHandler m) m a
@@ -84,9 +75,6 @@ instance MonadTrans DockerT where
8475instance MonadIO m => MonadIO (DockerT m) where
8576 liftIO = lift . liftIO
8677
87−-- instance MonadBase IO m => MonadBase IO (DockerT m) where
88−-- liftBase = liftBaseDefault
89−
9078runDockerT :: Monad m => (DockerClientOpts, HttpHandler m) -> DockerT m a -> m a
9179runDockerT (opts, h) r = runReaderT (unDockerT r) (opts, h)
9280
@@ -96,41 +84,28 @@ runDockerT (opts, h) r = runReaderT (unDockerT r) (opts, h)
9684-- benefit from testing that on all of our Endpoints
9785mkHttpRequest :: HttpVerb -> Endpoint -> DockerClientOpts -> Maybe Request
9886mkHttpRequest verb e opts = request
99− where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint (apiVer opts) e)
100− initialR = parseRequest fullE
87+ where fullE = T.unpack (baseUrl opts) ++ T.unpack (getEndpoint e)
88+ initialR = parseUrl fullE
10189 request' = case initialR of
10290 Just ir ->
10391 return $ ir {method = (encodeUtf8 . T.pack $ show verb),
104− requestHeaders = [("Content-Type", (getEndpointContentType e))]}
92+ requestHeaders = [("Content-Type", "application/json; charset=utf-8")]}
10593 Nothing -> Nothing
106− request = (\r -> maybe r (\body -> r {requestBody = body, -- This will either be a HTTP.RequestBodyLBS or HTTP.RequestBodySourceChunked for the build endpoint
94+ request = (\r -> maybe r (\body -> r {requestBody = HTTP.RequestBodyLBS body,
10795 requestHeaders = [("Content-Type", "application/json; charset=utf-8")]}) $ getEndpointRequestBody e) <$> request'
10896 -- Note: Do we need to set length header?
10997
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
98+defaultHttpHandler :: MonadIO m => HttpHandler m
99+defaultHttpHandler request = do
116100 manager <- liftIO $ newManager defaultManagerSettings
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
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
134109 Left e -> return $ Left $ GenericDockerError (T.pack $ show e)
135110
136111-- | Connect to a unix domain socket (the default docker socket is
@@ -138,17 +113,13 @@ httpHandler manager = HttpHandler $ \request' sink -> do -- runResourceT ..
138113--
139114-- Docker seems to ignore the hostname in requests sent over unix domain
140115-- sockets (and the port obviously doesn't matter either)
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
116+unixHttpHandler :: MonadIO m => FilePath -- ^ The socket to connect to
117+ -> HttpHandler m
118+unixHttpHandler fp request = do
148119 let mSettings = defaultManagerSettings
149120 { managerRawConnection = return $ openUnixSocket fp}
150121 manager <- liftIO $ newManager mSettings
151− return $ httpHandler manager
122+ httpHandler manager request
152123
153124 where
154125 openUnixSocket filePath _ _ _ = do
@@ -156,7 +127,7 @@ unixHttpHandler fp = do
156127 S.connect s (S.SockAddrUnix filePath)
157128 makeConnection (SBS.recv s 8096)
158129 (SBS.sendAll s)
159− (S.close s)
130+ (S.sClose s)
160131
161132-- TODO:
162133-- Move this to http-client-tls or network?
@@ -223,11 +194,6 @@ statusCodeToError (StopContainerEndpoint _ _) st =
223194 Nothing
224195 else
225196 Just $ DockerInvalidStatusCode st
226−statusCodeToError (WaitContainerEndpoint _) st =
227− if st == status200 then
228− Nothing
229− else
230− Just $ DockerInvalidStatusCode st
231197statusCodeToError (KillContainerEndpoint _ _) st =
232198 if st == status204 then
233199 Nothing
@@ -263,28 +229,5 @@ statusCodeToError (InspectContainerEndpoint _) st =
263229 Nothing
264230 else
265231 Just $ DockerInvalidStatusCode st
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
232+
233+
src/Docker/Client/Internal.hs+27−60
@@ -1,17 +1,14 @@
11module Docker.Client.Internal where
22
3+
34import Blaze.ByteString.Builder (toByteString)
45import qualified Data.Aeson as JSON
56import Data.ByteString (ByteString)
6−import qualified Data.ByteString.Char8 as BSC
7−import qualified Data.Conduit.Binary as CB
8−import qualified Data.Text as T
7+import qualified Data.ByteString.Lazy as BSL
8+import Data.Text as T
99import Data.Text.Encoding (decodeUtf8, encodeUtf8)
10−import qualified Network.HTTP.Client as HTTP
11−import Network.HTTP.Conduit (requestBodySourceChunked)
1210import Network.HTTP.Types (Query, encodePath,
1311 encodePathSegments)
14−import Prelude hiding (all)
1512
1613import Docker.Client.Types
1714
@@ -25,68 +22,50 @@ encodeURLWithQuery ps q = decodeUtf8 $ toByteString $ encodePath ps q
2522encodeQ :: String -> ByteString
2623encodeQ = encodeUtf8 . T.pack
2724
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
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
3633 where query = case (detachKeys startOpts) of
3734 WithCtrl c -> [("detachKeys", Just (encodeQ $ ctrl ++ [c]))]
3835 WithoutCtrl c -> [("detachKeys", Just (encodeQ [c]))]
3936 DefaultDetachKey -> []
4037 ctrl = ['c', 't', 'r', 'l', '-']
41−getEndpoint v (StopContainerEndpoint t cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "stop"] query
38+getEndpoint (StopContainerEndpoint t cid) = encodeURLWithQuery ["containers", fromContainerID cid, "stop"] query
4239 where query = case t of
43− Timeout x -> [("t", Just (encodeQ $ show x))]
40+ Timeout x -> [("t", Just (encodeQ $ show x))]
4441 DefaultTimeout -> []
45−getEndpoint v (WaitContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "wait"]
46−getEndpoint v (KillContainerEndpoint s cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "kill"] query
42+getEndpoint (KillContainerEndpoint s cid) = encodeURLWithQuery ["containers", fromContainerID cid, "kill"] query
4743 where query = case s of
4844 SIG x -> [("signal", Just (encodeQ $ show x))]
49− _ -> [("signal", Just (encodeQ $ show s))]
50−getEndpoint v (RestartContainerEndpoint t cid) = encodeURLWithQuery [v, "containers", fromContainerID cid, "restart"] query
45+ _ -> [("signal", Just (encodeQ $ show s))]
46+getEndpoint (RestartContainerEndpoint t cid) = encodeURLWithQuery ["containers", fromContainerID cid, "restart"] query
5147 where query = case t of
52− Timeout x -> [("t", Just (encodeQ $ show x))]
48+ Timeout x -> [("t", Just (encodeQ $ show x))]
5349 DefaultTimeout -> []
54−getEndpoint v (PauseContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "pause"]
55−getEndpoint v (UnpauseContainerEndpoint cid) = encodeURL [v, "containers", fromContainerID cid, "unpause"]
50+getEndpoint (PauseContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "pause"]
51+getEndpoint (UnpauseContainerEndpoint cid) = encodeURL ["containers", fromContainerID cid, "unpause"]
5652-- Make use of since/timestamps/tail logopts here instead of ignoreing them
57−getEndpoint v (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
58− encodeURLWithQuery [v, "containers", fromContainerID cid, "logs"] query
53+getEndpoint (ContainerLogsEndpoint (LogOpts stdout stderr _ _ _) follow cid) =
54+ encodeURLWithQuery ["containers", fromContainerID cid, "logs"] query
5955 where query = [("stdout", Just (encodeQ $ show stdout)), ("stderr", Just (encodeQ $ show stderr)), ("follow", Just (encodeQ $ show follow))]
60−getEndpoint v (DeleteContainerEndpoint (ContainerDeleteOpts removeVolumes force) cid) =
61− encodeURLWithQuery [v, "containers", fromContainerID cid] query
56+getEndpoint (DeleteContainerEndpoint (DeleteOpts removeVolumes force) cid) =
57+ encodeURLWithQuery ["containers", fromContainerID cid] query
6258 where query = [("v", Just (encodeQ $ show removeVolumes)), ("force", Just (encodeQ $ show force))]
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]
59+getEndpoint (InspectContainerEndpoint cid) =
60+ encodeURLWithQuery ["containers", fromContainerID cid, "json"] []
8161
82−getEndpointRequestBody :: Endpoint -> Maybe HTTP.RequestBody
62+getEndpointRequestBody :: Endpoint -> Maybe BSL.ByteString
8363getEndpointRequestBody VersionEndpoint = Nothing
8464getEndpointRequestBody (ListContainersEndpoint _) = Nothing
8565getEndpointRequestBody (ListImagesEndpoint _) = Nothing
86−getEndpointRequestBody (CreateContainerEndpoint opts _) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
66+getEndpointRequestBody (CreateContainerEndpoint opts _) = Just $ JSON.encode opts
8767getEndpointRequestBody (StartContainerEndpoint _ _) = Nothing
8868getEndpointRequestBody (StopContainerEndpoint _ _) = Nothing
89−getEndpointRequestBody (WaitContainerEndpoint _) = Nothing
9069getEndpointRequestBody (KillContainerEndpoint _ _) = Nothing
9170getEndpointRequestBody (RestartContainerEndpoint _ _) = Nothing
9271getEndpointRequestBody (PauseContainerEndpoint _) = Nothing
@@ -94,15 +73,3 @@ getEndpointRequestBody (UnpauseContainerEndpoint _) = Nothing
9473getEndpointRequestBody (ContainerLogsEndpoint _ _ _) = Nothing
9574getEndpointRequestBody (DeleteContainerEndpoint _ _) = Nothing
9675getEndpointRequestBody (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+89−256
@@ -11,11 +11,7 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14− , NetworkID
15− , fromNetworkID
16− , toNetworkID
1714 , Timeout(..)
18− , StatusCode(..)
1915 , Signal(..)
2016 , ContainerDetails(..)
2117 , DockerClientOpts(..)
@@ -26,30 +22,23 @@ module Docker.Client.Types (
2622 , ContainerPortInfo(..)
2723 , Container(..)
2824 , ContainerState(..)
29− , State(..)
25+ , Status(..)
3026 , Digest
3127 , Label(..)
3228 , Tag
3329 , Image(..)
34− , Entrypoint(..)
3530 , dropImagePrefix
3631 , CreateOpts(..)
37− , BuildOpts(..)
38− , defaultBuildOpts
3932 , defaultCreateOpts
4033 , DetachKeys(..)
4134 , StartOpts(..)
4235 , defaultStartOpts
43− , ContainerDeleteOpts(..)
44− , defaultContainerDeleteOpts
45− , ImageDeleteOpts(..)
46− , defaultImageDeleteOpts
36+ , DeleteOpts(..)
37+ , defaultDeleteOpts
4738 , Timestamp
4839 , TailLogOpt(..)
4940 , LogOpts(..)
5041 , defaultLogOpts
51− , CreateNetworkOpts(..)
52− , defaultCreateNetworkOpts
5342 , VolumePermission(..)
5443 , Bind(..)
5544 , Volume(..)
@@ -75,8 +64,6 @@ module Docker.Client.Types (
7564 , UTSMode(..)
7665 , HostConfig(..)
7766 , defaultHostConfig
78− , NetworkingConfig(..)
79− , EndpointConfig(..)
8067 , Ulimit(..)
8168 , ContainerResources(..)
8269 , defaultContainerResources
@@ -112,7 +99,6 @@ import Data.Scientific (floatingOrInteger)
11299import Data.Text (Text)
113100import qualified Data.Text as T
114101import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
116102import GHC.Generics (Generic)
117103import Prelude hiding (all, tail)
118104import Text.Read (readMaybe)
@@ -125,20 +111,14 @@ data Endpoint =
125111 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
126112 | StartContainerEndpoint StartOpts ContainerID
127113 | StopContainerEndpoint Timeout ContainerID
128− | WaitContainerEndpoint ContainerID
129114 | KillContainerEndpoint Signal ContainerID
130115 | RestartContainerEndpoint Timeout ContainerID
131116 | PauseContainerEndpoint ContainerID
132117 | UnpauseContainerEndpoint ContainerID
133118 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134119 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
120+ | DeleteContainerEndpoint DeleteOpts ContainerID
136121 | 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
142122 deriving (Eq, Show)
143123
144124-- | We should newtype this
@@ -185,20 +165,6 @@ toImageID t =
185165-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
186166data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
187167
188−data StatusCode = StatusCode Int
189−
190−instance ToJSON StatusCode where
191− toJSON (StatusCode c) = object ["StatusCode" .= c]
192−
193−instance FromJSON StatusCode where
194− parseJSON (JSON.Object o) = do
195− c <- o .: "StatusCode"
196− if c >= 0 && c <= 255 then
197− return (StatusCode c)
198− else
199− fail "Unknown exit code"
200− parseJSON _ = fail "Unknown exit code"
201−
202168-- TODO: Add more Signals or use an existing lib
203169-- | Signal used for sending to the process running in the container.
204170-- The default signal is SIGTERM.
@@ -213,16 +179,16 @@ data Signal = SIGHUP
213179
214180instance FromJSON Signal where
215181 parseJSON (JSON.String "SIGTERM") = return SIGTERM
216− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217− parseJSON (JSON.String "SIGINT") = return SIGINT
182+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
183+ parseJSON (JSON.String "SIGINT") = return SIGINT
218184 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
219185 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
220186 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
221− parseJSON _ = fail "Unknown Signal"
187+ parseJSON _ = fail "Unknown Signal"
222188
223189instance ToJSON Signal where
224− toJSON SIGHUP = "SIGHUP"
225− toJSON SIGINT = "SIGINT"
190+ toJSON SIGHUP = "SIGHUP"
191+ toJSON SIGINT = "SIGINT"
226192 toJSON SIGQUIT = "SIGQUIT"
227193 toJSON SIGSTOP = "SIGSTOP"
228194 toJSON SIGTERM = "SIGTERM"
@@ -250,7 +216,7 @@ data ContainerDetails = ContainerDetails {
250216 , processLabel :: Text
251217 , resolveConfPath :: FilePath
252218 , restartCount :: Int
253− , containerDetailsState :: ContainerState
219+ , state :: ContainerState
254220 , mounts :: [Mount]
255221 }
256222 deriving (Eq, Show, Generic)
@@ -258,11 +224,11 @@ data ContainerDetails = ContainerDetails {
258224-- | Data type used for parsing the mount information from a container
259225-- list.
260226data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
227+ mountName :: Text
262228 , mountSource :: FilePath
263229 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
230+ , mountDriver :: Text
231+ , mountMode :: Maybe VolumePermission -- apparently this can be null
266232 , mountRW :: Bool
267233 , mountPropogation :: Text
268234 }
@@ -270,14 +236,14 @@ data Mount = Mount {
270236
271237instance FromJSON Mount where
272238 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
239+ name <- o .: "Name"
274240 src <- o .: "Source"
275241 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
242+ driver <- o .: "Driver"
243+ mode <- o .: "Mode"
278244 rw <- o .: "RW"
279245 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
246+ return $ Mount name src dest driver mode rw prop
281247 parseJSON _ = fail "Mount is not an object"
282248
283249-- | Data type used for parsing the container state from a list of
@@ -293,7 +259,7 @@ data ContainerState = ContainerState {
293259 , restarting :: Bool
294260 , running :: Bool
295261 , startedAt :: UTCTime
296− , state :: State
262+ , status :: Status
297263 }
298264 deriving (Eq, Show, Generic)
299265
@@ -523,8 +489,7 @@ data Container = Container
523489 , containerImageId :: ImageID
524490 , containerCommand :: Text
525491 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
492+ , containerStatus :: Status
528493 , containerPorts :: [ContainerPortInfo]
529494 , containerLabels :: [Label]
530495 , containerNetworks :: [Network]
@@ -532,14 +497,13 @@ data Container = Container
532497 } deriving (Show, Eq)
533498
534499instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
500+ parseJSON (JSON.Object v) =
501+ Container <$> (v .: "Id")
537502 <*> (v .: "Names")
538503 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
504+ <*> (v .: "ImageID")
505+ <*> (v .: "Command")
541506 <*> (v .: "Created")
542− <*> (v .: "State")
543507 <*> (v .: "Status")
544508 <*> (v .: "Ports")
545509 <*> (v .: "Labels")
@@ -549,20 +513,21 @@ instance FromJSON Container where
549513 parseNetworks (JSON.Object v) =
550514 (v .: "Networks") >>= parseJSON
551515 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
516+
552517 parseJSON _ = fail "Container: Not a JSON object."
553518
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
519+-- | Represents the status of the container life cycle.
520+data Status = Created | Restarting | Running | Paused | Exited | Dead
556521 deriving (Eq, Show, Generic)
557522
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.
523+instance FromJSON Status where
524+ parseJSON (JSON.String "running") = return Running
525+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
561526 parseJSON (JSON.String "restarting") = return Restarting
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
527+ parseJSON (JSON.String "paused") = return Paused
528+ parseJSON (JSON.String "exited") = return Exited
529+ parseJSON (JSON.String "dead") = return Dead
530+ parseJSON _ = fail "Unknown Status"
566531
567532-- | Alias for representing a RepoDigest. We could newtype this and add
568533-- some validation.
@@ -623,46 +588,20 @@ instance FromJSON Image where
623588 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
624589 parseJSON _ = fail "Failed to parse DockerImage."
625590
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− ]
649591
650592-- | Options used for creating a Container.
651593data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
594+ containerConfig :: ContainerConfig
595+ , hostConfig :: HostConfig
655596 } deriving (Eq, Show)
656597
657598instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
599+ toJSON (CreateOpts cc hc) = do
659600 let ccJSON = toJSON cc
660601 let hcJSON = toJSON hc
661602 case ccJSON of
662603 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
663− let o1 = HM.insert "HostConfig" hcJSON o
664− let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665− JSON.Object o2
604+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666605 _ -> error "ContainerConfig is not an object." -- This should never happen.
667606
668607-- | Container configuration used for creating a container with sensible
@@ -684,7 +623,7 @@ defaultContainerConfig imageName = ContainerConfig {
684623 , cmd=[]
685624 , volumes=[]
686625 , workingDir=Nothing
687− , entrypoint=Entrypoint []
626+ , entrypoint=Nothing
688627 , networkDisabled=Nothing
689628 , macAddress=Nothing
690629 , labels=[]
@@ -697,7 +636,7 @@ defaultHostConfig = HostConfig {
697636 binds=[]
698637 , containerIDFile=Nothing
699638 , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
639+ , networkMode=Bridge
701640 , portBindings=[]
702641 , restartPolicy=RestartOff
703642 , volumeDriver=Nothing
@@ -737,18 +676,14 @@ defaultContainerResources = ContainerResources {
737676 , memory=Nothing
738677 , memoryReservation=Nothing
739678 , memorySwap=Nothing
740− , oomKillDisable=Just False
679+ , oomKillDisable=False
741680 , ulimits=[]
742681 }
743682
744683-- | Default create options when creating a container. You only need to
745684-- specify an image name and the rest is all sensible defaults.
746685defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
686+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752687
753688-- | Override the key sequence for detaching a container.
754689-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -762,45 +697,16 @@ defaultStartOpts :: StartOpts
762697defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763698
764699-- | Options for deleting a container.
765−data ContainerDeleteOpts = ContainerDeleteOpts {
700+data DeleteOpts = DeleteOpts {
766701 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767702 , force :: Bool -- ^ If the container is still running force deletion anyway.
768703 } deriving (Eq, Show)
769704
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−
792705-- | Default options for deleting a container. Most of the time we DON'T
793706-- want to delete the container's volumes or force delete it if it's
794707-- running.
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
708+defaultDeleteOpts :: DeleteOpts
709+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
804710
805711-- | Timestamp alias.
806712type Timestamp = Integer
@@ -828,50 +734,18 @@ defaultLogOpts = LogOpts { stdout = True
828734 , tail = All
829735 }
830736
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−
861737-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862738-- | Set permissions on volumes that you mount in the container.
863739data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
864740
865741instance ToJSON VolumePermission where
866742 toJSON ReadWrite = "rw"
867− toJSON ReadOnly = "ro"
743+ toJSON ReadOnly = "ro"
868744
869745instance FromJSON VolumePermission where
870746 parseJSON "rw" = return ReadWrite
871747 parseJSON "ro" = return ReadOnly
872− parseJSON "RW" = return ReadWrite
873− parseJSON "RO" = return ReadOnly
874− parseJSON _ = fail "Failed to parse VolumePermission"
748+ parseJSON _ = fail "Failed to parse VolumePermission"
875749
876750-- | Used for marking a directory in the container as "exposed" hence
877751-- taking it outside of the COW filesystem and making it mountable
@@ -893,8 +767,8 @@ instance {-# OVERLAPPING #-} ToJSON [Volume] where
893767
894768instance {-# OVERLAPPING #-} FromJSON [Volume] where
895769 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896− parseJSON (JSON.Null) = return []
897− parseJSON _ = fail "Volume is not an object"
770+ parseJSON (JSON.Null) = return []
771+ parseJSON _ = fail "Volume is not an object"
898772
899773
900774data Bind = Bind { hostSrc :: Text
@@ -904,10 +778,10 @@ data Bind = Bind { hostSrc :: Text
904778
905779instance FromJSON Bind where
906780 parseJSON (JSON.String t) = case T.split (== ':') t of
907− [src, dest] -> return $ Bind src dest Nothing
781+ [src, dest] -> return $ Bind src dest Nothing
908782 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
909783 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
910− _ -> fail "Could not parse Bind"
784+ _ -> fail "Could not parse Bind"
911785 parseJSON _ = fail "Bind is not a string"
912786
913787data Device = Device {
@@ -930,15 +804,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
930804
931805instance FromJSON VolumeFrom where
932806 parseJSON (JSON.String t) = case T.split (== ':') t of
933− [vol] -> return $ VolumeFrom vol Nothing
807+ [vol] -> return $ VolumeFrom vol Nothing
934808 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
935809 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
936− _ -> fail "Could not parse VolumeFrom"
810+ _ -> fail "Could not parse VolumeFrom"
937811 parseJSON _ = fail "VolumeFrom is not a string"
938812
939813instance ToJSON VolumeFrom where
940814 toJSON (VolumeFrom n p) = case p of
941− Nothing -> toJSON $ n <> ":" <> "rw"
815+ Nothing -> toJSON $ n <> ":" <> "rw"
942816 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
943817
944818instance ToJSON Bind where
@@ -950,40 +824,40 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
950824
951825instance FromJSON Link where
952826 parseJSON (JSON.String t) = case T.split (== ':') t of
953− [f] -> return $ Link f Nothing
827+ [f] -> return $ Link f Nothing
954828 [f,s] -> return $ Link f $ Just s
955− _ -> fail "Could not parse Link"
829+ _ -> fail "Could not parse Link"
956830 parseJSON _ = fail "Link is not a string"
957831
958832instance ToJSON Link where
959833 toJSON (Link n1 n2) = toJSON $ case n2 of
960834 Nothing -> T.concat[n1, ":", n1] -- use same name in container
961− Just n -> T.concat[n1, ":", n] -- used specified name in container
835+ Just n -> T.concat[n1, ":", n] -- used specified name in container
962836
963837-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
964838data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
965839
966840instance FromJSON LogDriverType where
967841 parseJSON (JSON.String "json-file") = return JsonFile
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"
842+ parseJSON (JSON.String "syslog") = return Syslog
843+ parseJSON (JSON.String "journald") = return Journald
844+ parseJSON (JSON.String "gelf") = return Gelf
845+ parseJSON (JSON.String "fluentd") = return Fluentd
846+ parseJSON (JSON.String "awslogs") = return AwsLogs
847+ parseJSON (JSON.String "splunk") = return Splunk
848+ parseJSON (JSON.String "etwlogs") = return Etwlogs
849+ parseJSON (JSON.String "none") = return LoggingDisabled
850+ parseJSON _ = fail "Unknown LogDriverType"
977851
978852instance ToJSON LogDriverType where
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"
853+ toJSON JsonFile = JSON.String "json-file"
854+ toJSON Syslog = JSON.String "syslog"
855+ toJSON Journald = JSON.String "journald"
856+ toJSON Gelf = JSON.String "gelf"
857+ toJSON Fluentd = JSON.String "fluentd"
858+ toJSON AwsLogs = JSON.String "awslogs"
859+ toJSON Splunk = JSON.String "splunk"
860+ toJSON Etwlogs = JSON.String "etwlogs"
987861 toJSON LoggingDisabled = JSON.String "none"
988862
989863data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
@@ -1017,41 +891,19 @@ instance FromJSON LogDriverConfig where
1017891 parseJSON _ = fail "LogDriverConfig is not an object"
1018892
1019893-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
894+data NetworkMode = Bridge | Host | NetworkDisabled
1021895 deriving (Eq, Show, Ord)
1022896
1023897instance FromJSON NetworkMode where
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"
898+ parseJSON (JSON.String "bridge") = return Bridge
899+ parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
900+ parseJSON (JSON.String "none") = return NetworkDisabled
901+ parseJSON _ = fail "Unknown NetworkMode"
1029902
1030903instance ToJSON NetworkMode where
1031− toJSON NetworkBridge = JSON.String "bridge"
1032− toJSON NetworkHost = JSON.String "host"
904+ toJSON Bridge = JSON.String "bridge"
905+ toJSON Host = JSON.String "host"
1033906 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]
1055907
1056908data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057909
@@ -1067,7 +919,7 @@ instance FromJSON PortType where
1067919 parseJSON val = case val of
1068920 "tcp" -> return TCP
1069921 "udp" -> return UDP
1070− _ -> fail "PortType: Invalid port type."
922+ _ -> fail "PortType: Invalid port type."
1071923
1072924-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1073925--
@@ -1197,7 +1049,7 @@ instance FromJSON RestartPolicy where
11971049 "on-failure" -> do
11981050 retry <- o .: "MaximumRetryCount"
11991051 return $ RestartOnFailure retry
1200− "no" -> return RestartOff
1052+ "off" -> return RestartOff
12011053 _ -> fail "Could not parse RestartPolicy"
12021054 parseJSON _ = fail "RestartPolicy is not an object"
12031055
@@ -1205,7 +1057,7 @@ instance ToJSON RestartPolicy where
12051057 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
12061058 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
12071059 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1208− toJSON RestartOff = object ["Name" .= JSON.String "no"]
1060+ toJSON RestartOff = object ["Name" .= JSON.String "off"]
12091061
12101062data Isolation = Default | Process | Hyperv deriving (Eq, Show)
12111063
@@ -1383,7 +1235,7 @@ data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
13831235data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
13841236
13851237instance ToJSON MemoryConstraint where
1386− toJSON (MemoryConstraint x B) = toJSON x
1238+ toJSON (MemoryConstraint x B) = toJSON x
13871239 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
13881240 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
13891241
@@ -1414,7 +1266,7 @@ data ContainerResources = ContainerResources {
14141266 , memoryReservation :: Maybe MemoryConstraint
14151267 , memorySwap :: Maybe MemoryConstraint
14161268 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1269+ , oomKillDisable :: Bool
14181270 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191271 , ulimits :: [Ulimit]
14201272 -- TODO: Missing from 1.24
@@ -1452,7 +1304,7 @@ instance FromJSON EnvVar where
14521304 parseJSON _ = fail "EnvVar is not a string"
14531305
14541306instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1307+ toJSON (EnvVar n v) = object [n .= v]
14561308
14571309-- | ExposedPort represents a port (and it's type)
14581310-- that a container should expose to other containers or the host system.
@@ -1492,21 +1344,6 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
14921344 where key (ExposedPort p t) = show p <> slash <> show t
14931345 slash = T.unpack "/"
14941346
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−
15101347data ContainerConfig = ContainerConfig {
15111348 hostname :: Maybe Text
15121349 , domainname :: Maybe Text
@@ -1525,7 +1362,7 @@ data ContainerConfig = ContainerConfig {
15251362 , image :: Text
15261363 , volumes :: [Volume]
15271364 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1365+ , entrypoint :: Maybe Text -- Can be null?
15291366 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301367 , macAddress :: Maybe Text
15311368 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1533,7 +1370,6 @@ data ContainerConfig = ContainerConfig {
15331370 , stopSignal :: Signal
15341371 } deriving (Eq, Show, Generic)
15351372
1536−
15371373instance ToJSON ContainerConfig where
15381374 toJSON = genericToJSON defaultOptions {
15391375 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1555,7 +1391,7 @@ instance FromJSON ContainerConfig where
15551391 image <- o .: "Image"
15561392 volumes <- o .: "Volumes"
15571393 workingDir <- o .:? "WorkingDir"
1558− entrypoint <- o .: "Entrypoint"
1394+ entrypoint <- o .:? "Entrypoint"
15591395 networkDisabled <- o .:? "networkDisabled"
15601396 macAddress <- o .:? "MacAddress"
15611397 labels <- o .:? "Labels" .!= []
@@ -1564,11 +1400,7 @@ instance FromJSON ContainerConfig where
15641400 macAddress labels stopSignal
15651401 parseJSON _ = fail "NetworkSettings is not an object."
15661402
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701403parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721404parseIntegerText t = case readMaybe $ T.unpack t of
15731405 Nothing ->
15741406 fail "Could not parse Integer"
@@ -1590,3 +1422,4 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
15901422-- | Helper function that return an empty dictionary "{}"
15911423emptyJsonObject :: JSON.Value
15921424emptyJsonObject = JSON.Object HM.empty
1425+
src/Docker/Client/Utils.hsdeleted−131
@@ -1,131 +0,0 @@
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-6.30
4+resolver: lts-5.18
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+
1013# Override default flag values for local packages and extra-deps
1114flags: {}
1215
1316# Extra package databases containing global packages
14−extra-deps:
15−- directory-1.2.7.0
16−- unliftio-core-0.1.1.0
17−- process-1.6.5.1
17+extra-package-dbs: []
1818
1919# Control whether we use the GHC we find on the path
2020# system-ghc: true
stack-8.0.2.yamldeleted−4
@@ -1,4 +0,0 @@
1−resolver: lts-9.4
2−packages:
3−- '.'
4−extra-deps: []
stack-8.0.yaml+1−2
@@ -1,5 +1,4 @@
11resolver: lts-7.12
22packages:
33- '.'
4−extra-deps:
5−- unliftio-core-0.1.1.0
4+extra-deps: []
stack-8.6.4.yamldeleted−4
@@ -1,4 +0,0 @@
1−resolver: lts-13.19
2−packages:
3−- '.'
4−extra-deps: []
stack-8.8.2.yamldeleted−5
@@ -1,5 +0,0 @@
1−resolver: lts-15.0
2−packages:
3−- '.'
4−extra-deps: []
5−
stack.yaml+1−1
@@ -1 +1 @@
1−stack-8.6.4.yaml
1+stack-7.10.yaml
tests/Dockerfile+1−1
@@ -1,4 +1,4 @@
11FROM debian:jessie
22
3−CMD ["/bin/bash", "-c", "echo $TEST"]
3+CMD ["/bin/bash", "-c", "echo 123"]
44
tests/tests.hs+75−231
@@ -2,8 +2,6 @@
22
33module Main where
44
5−import Data.Either (rights)
6−import Prelude hiding (all)
75import qualified Test.QuickCheck.Monadic as QCM
86import Test.Tasty
97import Test.Tasty.HUnit
@@ -11,284 +9,130 @@ import Test.Tasty.QuickCheck (testProperty)
119
1210import Control.Concurrent (threadDelay)
1311import Control.Lens ((^.), (^?))
14−import Control.Monad (forM_)
1512import Control.Monad.IO.Class
1613import Control.Monad.Trans.Class (lift)
1714import qualified Data.Aeson as JSON
18−import Data.Aeson ((.=))
19−import Data.Aeson.Lens (key, _Array, _Null, _Object,
20− _String, _Value)
15+import Data.Aeson.Lens (key, _Object, _String, _Value)
2116import qualified Data.ByteString as B
2217import qualified Data.ByteString.Char8 as C
2318import qualified Data.ByteString.Lazy as BL
2419import qualified Data.HashMap.Strict as HM
2520import Data.Int (Int)
2621import qualified Data.Map as M
27−import Data.Maybe (fromJust, isJust, isNothing, listToMaybe)
22+import Data.Maybe (fromJust, isJust)
2823import Data.Monoid
2924import Data.Text (Text, unpack)
30−import qualified Data.Vector as V
3125import Network.Connection (TLSSettings (..))
3226import Network.HTTP.Client (newManager)
3327import Network.HTTP.Client.TLS
3428import Network.HTTP.Types.Status
35−import System.Directory (getCurrentDirectory)
36−import System.Environment (lookupEnv)
3729import System.Process (system)
3830
3931import Docker.Client
4032
4133-- opts = defaultClientOpts
42−testImageName = "docker-hs/test"
43−imageToDeleteFullName = "hello-world:latest"
34+
35+testImageName = "docker-hs-test"
4436
4537toStrict1 = B.concat . BL.toChunks
4638
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
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
5646
5747testDockerVersion :: IO ()
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
48+testDockerVersion = runDocker $ do
49+ v <- getDockerVersion
50+ lift $ assert $ isRight v
6751
6852testFindImage :: IO ()
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
53+testFindImage = runDocker $ do
8754 images <- listImages defaultListOpts >>= fromRight
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−
55+ let xs = filter ((== [imageFullName]) . imageRepoTags) images
56+ lift $ assert $ length xs == 1
57+ where imageFullName = testImageName <> ":latest"
10858
10959testRunAndReadLog :: IO ()
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
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 ()
14673
14774testLogDriverOptionsJson :: TestTree
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"
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"
16086
16187testExposedPortsJson :: TestTree
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]
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]
16893
16994testLabelsJson :: TestTree
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"
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"
184105
185106testVolumesJson :: TestTree
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− ]
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"]
238112
239113integrationTests :: TestTree
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− ]
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]
253118
254119jsonTests :: TestTree
255−jsonTests =
256− testGroup
257− "JSON Tests"
258− [ testExposedPortsJson
259− , testVolumesJson
260− , testLabelsJson
261− , testLogDriverOptionsJson
262− , testEntrypointJson
263− , testEnvVarJson
264− , testNetworkingConfigJson
265− ]
120+jsonTests = testGroup "JSON Tests" [testExposedPortsJson, testVolumesJson, testLabelsJson, testLogDriverOptionsJson]
266121
267122setup :: IO ()
268−setup =
269− mapM_ system
270− [ "docker pull " ++ unpack imageToDeleteFullName
271− , "docker build -t " ++ unpack testImageName ++ " tests"
272− ]
273−
274−isLeft = not . isRight
123+setup = system ("docker build -t "++unpack testImageName++" tests") >> return ()
275124
276−isRight (Left _) = False
125+isRight (Left _) = False
277126isRight (Right _) = True
278127
279−fromRight
280− :: (MonadIO m, Show l)
281− => Either l r -> m r
128+fromRight :: (MonadIO m, Show l) => Either l r -> m r
282129fromRight (Left l) = do
283− liftIO $ assertFailure $ "Left: " ++ show l
284− undefined
130+ liftIO $ assertFailure $ "Left: " ++ show l
131+ undefined
285132fromRight (Right r) = return r
286133
287134main :: IO ()
288135main = do
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]
136+ setup
137+ defaultMain $ testGroup "Tests" [jsonTests, integrationTests]
138+