on 5406510 help sign in
10 files changed+202−40
since splitsnapshots
unifiedsplit
.travis.yml−4 CHANGELOG.md−6 docker.cabal+4−4 src/Docker/Client/Api.hs+4 src/Docker/Client/Http.hs+5 src/Docker/Client/Internal.hs+15−12 src/Docker/Client/Types.hs+165−8 stack-7.10.yaml−1 stack-8.8.2.yaml−5 tests/tests.hs+9
.travis.yml−4
@@ -43,10 +43,6 @@ env:
4343 - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.6.4
4444 - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.6.4
4545
46− - DOCKER_VERSION="1.12.3-0~trusty" GHCVER=8.8.2
47− - DOCKER_VERSION="1.13.1-0~ubuntu-trusty" GHCVER=8.8.2
48− - DOCKER_VERSION="17.05.0~ce-0~ubuntu-trusty" GHCVER=8.8.2
49−
5046addons:
5147 apt:
5248 packages:
CHANGELOG.md−6
@@ -1,11 +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−
93## 0.6.0.1 (2019-05-23)
104
115- Support ghc 8.6.4.
docker.cabal+4−4
@@ -1,5 +1,5 @@
11name: docker
2−version: 0.6.0.3
2+version: 0.6.0.2
33synopsis: An API client for docker written in Haskell
44description: See API documentation below.
55homepage: https://github.com/denibertovic/docker-hs
@@ -30,7 +30,7 @@ library
3030 , bytestring >= 0.10.0 && < 0.11.0
3131 , containers >= 0.5.0 && < 0.7.0
3232 , data-default-class >= 0.0.1 && < 0.2.0
33− , http-client >= 0.4.0 && < 0.7.0
33+ , http-client >= 0.4.0 && < 0.6.0
3434 , http-types >= 0.9 && < 0.13
3535 , vector
3636 , conduit
@@ -51,9 +51,9 @@ library
5151 , mtl >= 2.0.0 && < 3.0.0
5252 , network >= 2.6.0
5353 , text >= 1.0.0 && < 2.0.0
54− , time >= 1.5.0 && < 2.0.0
54+ , time >= 1.5.0 && < 1.9.0
5555 , scientific >= 0.3.0 && < 0.4.0
56− , tls >= 1.3.7 && < 1.6.0
56+ , tls >= 1.3.7 && < 1.5.0
5757 , unordered-containers >= 0.2.0 && < 0.3.0
5858 , x509 >= 1.6.0 && < 1.8.0
5959 , x509-store >= 1.6.0 && < 1.8.0
src/Docker/Client/Api.hs+4
@@ -24,6 +24,7 @@ module Docker.Client.Api (
2424 -- * Network
2525 , createNetwork
2626 , removeNetwork
27+ , listNetworks
2728 -- * Other
2829 , getDockerVersion
2930 ) where
@@ -225,3 +226,6 @@ createNetwork opts = requestHelper POST (CreateNetworkEndpoint opts) >>= parseR
225226removeNetwork :: forall m. (MonadIO m, MonadMask m) => NetworkID -> DockerT m (Either DockerError ())
226227removeNetwork nid = requestUnit DELETE $ RemoveNetworkEndpoint nid
227228
229+-- | Lists networks optionally matching a list of 'Filter's
230+listNetworks :: forall m . (MonadIO m, MonadMask m) => [NetworkFilter] -> DockerT m (Either DockerError [NetworkDetails])
231+listNetworks nfs = requestHelper GET (ListNetworksEndpoint nfs) >>= parseResponse
src/Docker/Client/Http.hs+5
@@ -288,3 +288,8 @@ statusCodeToError (RemoveNetworkEndpoint _) st =
288288 Nothing
289289 else
290290 Just $ DockerInvalidStatusCode st
291+statusCodeToError (ListNetworksEndpoint _) st =
292+ if st == status200 then
293+ Nothing
294+ else
295+ Just $ DockerInvalidStatusCode st
src/Docker/Client/Internal.hs+15−12
@@ -1,17 +1,18 @@
11module Docker.Client.Internal where
22
3−import Blaze.ByteString.Builder (toByteString)
4−import qualified Data.Aeson as JSON
5−import 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
9−import Data.Text.Encoding (decodeUtf8, encodeUtf8)
10−import qualified Network.HTTP.Client as HTTP
11−import Network.HTTP.Conduit (requestBodySourceChunked)
12−import Network.HTTP.Types (Query, encodePath,
13− encodePathSegments)
14−import Prelude hiding (all)
3+import Blaze.ByteString.Builder (toByteString)
4+import qualified Data.Aeson as JSON
5+import Data.ByteString (ByteString)
6+import qualified Data.ByteString.Char8 as BSC
7+import qualified Data.ByteString.Lazy.Char8 as BSLC
8+import qualified Data.Conduit.Binary as CB
9+import qualified Data.Text as T
10+import Data.Text.Encoding (decodeUtf8, encodeUtf8)
11+import qualified Network.HTTP.Client as HTTP
12+import Network.HTTP.Conduit (requestBodySourceChunked)
13+import Network.HTTP.Types (Query, encodePath,
14+ encodePathSegments)
15+import Prelude hiding (all)
1516
1617import Docker.Client.Types
1718
@@ -78,6 +79,7 @@ getEndpoint v (CreateImageEndpoint name tag _) = encodeURLWithQuery [v, "images"
7879getEndpoint v (DeleteImageEndpoint _ cid) = encodeURL [v, "images", fromImageID cid]
7980getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]
8081getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]
82+getEndpoint v (ListNetworksEndpoint nfs) = encodeURLWithQuery [v, "networks"] [("filters", Just . BSLC.toStrict $ JSON.encode nfs)]
8183
8284getEndpointRequestBody :: Endpoint -> Maybe HTTP.RequestBody
8385getEndpointRequestBody VersionEndpoint = Nothing
@@ -101,6 +103,7 @@ getEndpointRequestBody (DeleteImageEndpoint _ _) = Nothing
101103
102104getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
103105getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing
106+getEndpointRequestBody (ListNetworksEndpoint _) = Nothing
104107
105108getEndpointContentType :: Endpoint -> BSC.ByteString
106109getEndpointContentType (BuildImageEndpoint _ _) = BSC.pack "application/tar"
src/Docker/Client/Types.hs+165−8
@@ -76,6 +76,15 @@ module Docker.Client.Types (
7676 , HostConfig(..)
7777 , defaultHostConfig
7878 , NetworkingConfig(..)
79+ , NetworkScope(..)
80+ , CIDR(..)
81+ , IPAMDriver(..)
82+ , IPAMConfig(..)
83+ , IPAM(..)
84+ , NetworkContainer(..)
85+ , NetworkDetails(..)
86+ , NetworkType(..)
87+ , NetworkFilter(..)
7988 , EndpointConfig(..)
8089 , Ulimit(..)
8190 , ContainerResources(..)
@@ -114,6 +123,7 @@ import qualified Data.Text as T
114123import Data.Time.Clock (UTCTime)
115124import qualified Data.Vector as V
116125import GHC.Generics (Generic)
126+import Numeric (readDec)
117127import Prelude hiding (all, tail)
118128import Text.Read (readMaybe)
119129
@@ -139,6 +149,7 @@ data Endpoint =
139149 | DeleteImageEndpoint ImageDeleteOpts ImageID
140150 | CreateNetworkEndpoint CreateNetworkOpts
141151 | RemoveNetworkEndpoint NetworkID
152+ | ListNetworksEndpoint [NetworkFilter]
142153 deriving (Eq, Show)
143154
144155-- | We should newtype this
@@ -858,6 +869,153 @@ instance ToJSON CreateNetworkOpts where
858869 , "EnableIPv6" .= createNetworkEnableIPv6 opts
859870 ]
860871
872+data NetworkScope = LocalScope | GlobalScope | SwarmScope deriving (Eq, Show)
873+
874+fromNetworkScope :: NetworkScope -> Text
875+fromNetworkScope LocalScope = "local"
876+fromNetworkScope GlobalScope = "global"
877+fromNetworkScope SwarmScope = "swarm"
878+
879+instance ToJSON NetworkScope where
880+ toJSON = JSON.String . fromNetworkScope
881+
882+instance FromJSON NetworkScope where
883+ parseJSON "local" = return LocalScope
884+ parseJSON "global" = return GlobalScope
885+ parseJSON "swarm" = return SwarmScope
886+ parseJSON _ = fail "Failed to parse NetworkScope"
887+
888+data CIDR = CIDR Text Int deriving (Eq, Show)
889+
890+instance FromJSON CIDR where
891+ parseJSON (JSON.String t) = case T.splitOn "/" t of
892+ [a,p] -> CIDR a <$> parsePrefixLen p
893+ _ -> fail "Failed to parse CIDR"
894+ where
895+ parsePrefixLen p = case readDec (T.unpack p) of
896+ (n,""):_ -> return n
897+ _ -> fail "Failed to parse CIDR prefix length"
898+ parseJSON _ = fail "Failed to parse CIDR"
899+
900+data IPAMDriver = DefaultIPAMDriver | NamedIPAMDriver Text deriving (Eq, Show)
901+
902+instance FromJSON IPAMDriver where
903+ parseJSON (JSON.String "default") = return DefaultIPAMDriver
904+ parseJSON (JSON.String t) = return $ NamedIPAMDriver t
905+ parseJSON _ = fail "IPAMDriver is not a string"
906+
907+data IPAMConfig = IPAMConfig
908+ { ipamConfigSubnet :: CIDR
909+ , ipamConfigIPRange :: Maybe CIDR
910+ , ipamSubnetGateway :: Maybe Text
911+ , ipamConfigAuxAddress :: Maybe Text
912+ } deriving (Eq, Show)
913+
914+instance FromJSON IPAMConfig where
915+ parseJSON (JSON.Object o) = IPAMConfig
916+ <$> o .: "Subnet"
917+ <*> o .:? "IPRange"
918+ <*> o .:? "Gateway"
919+ <*> o .:? "AuxAddress"
920+ parseJSON _ = fail "IPAMConfig is not an object"
921+
922+data IPAM = IPAM
923+ { ipamDriver :: IPAMDriver
924+ , ipamConfig :: [IPAMConfig]
925+ , ipamOptions :: HM.HashMap Text Text
926+ } deriving (Eq, Show)
927+
928+instance FromJSON IPAM where
929+ parseJSON (JSON.Object o) = IPAM
930+ <$> o .:? "Driver" .!= DefaultIPAMDriver
931+ <*> o .:? "Config" .!= []
932+ <*> o .:? "Options" .!= HM.empty
933+ parseJSON _ = fail "IPAM is not an object"
934+
935+data NetworkContainer = NetworkContainer
936+ { networkContainerName :: Text
937+ , networkContainerEndpointID :: Text
938+ , networkContainerMacAddress :: Text
939+ , networkContainerIPv4Address :: Text
940+ , networkContainerIPv6Address :: Text
941+ } deriving (Eq, Show)
942+
943+instance FromJSON NetworkContainer where
944+ parseJSON (JSON.Object o) = NetworkContainer
945+ <$> o .: "Name"
946+ <*> o .: "EndpointID"
947+ <*> o .: "MacAddress"
948+ <*> o .: "IPv4Address"
949+ <*> o .: "IPv6Address"
950+ parseJSON _ = fail "NetworkContainer is not an object"
951+
952+data NetworkDetails = NetworkDetails
953+ { networkDetailsName :: Text
954+ , networkDetailsID :: NetworkID
955+ , networkDetailsCreated :: UTCTime
956+ , networkDetailsScope :: NetworkScope
957+ , networkDetailsDriver :: NetworkMode
958+ , networkDetailsEnableIPv6 :: Bool
959+ , networkDetailsInternal :: Bool
960+ , networkDetailsAttachable :: Bool
961+ , networkDetailsIngress :: Bool
962+ , networkDetailsIPAM :: IPAM
963+ , networkDetailsOptions :: HM.HashMap Text Text
964+ , networkDetailsLabels :: HM.HashMap Text Text
965+ , networkDetailsContainers :: HM.HashMap Text NetworkContainer
966+ } deriving (Eq, Show)
967+
968+instance FromJSON NetworkDetails where
969+ parseJSON v@(JSON.Object o) = NetworkDetails
970+ <$> o .: "Name"
971+ <*> parseJSON v
972+ <*> o .: "Created"
973+ <*> o .: "Scope"
974+ <*> o .: "Driver"
975+ <*> o .: "EnableIPv6"
976+ <*> o .: "Internal"
977+ <*> o .: "Attachable"
978+ <*> o .: "Ingress"
979+ <*> o .: "IPAM"
980+ <*> o .:? "Options" .!= HM.empty
981+ <*> o .:? "Labels" .!= HM.empty
982+ <*> o .:? "Containers" .!= HM.empty
983+ parseJSON _ = fail "NetworkDetails is not an object"
984+
985+data NetworkType = BuiltinNetwork | CustomNetwork deriving (Eq, Show)
986+
987+fromNetworkType :: NetworkType -> Text
988+fromNetworkType BuiltinNetwork = "builtin"
989+fromNetworkType CustomNetwork = "custom"
990+
991+instance ToJSON NetworkType where
992+ toJSON = JSON.String . fromNetworkType
993+
994+instance FromJSON NetworkType where
995+ parseJSON (JSON.String "builtin") = return BuiltinNetwork
996+ parseJSON (JSON.String "custom") = return CustomNetwork
997+ parseJSON _ = fail "Failed to parse NetworkType"
998+
999+data NetworkFilter
1000+ = NetworkFilterName Text
1001+ | NetworkFilterID NetworkID
1002+ | NetworkFilterLabel Text
1003+ | NetworkFilterDriver NetworkMode
1004+ | NetworkFilterScope NetworkScope
1005+ | NetworkFilterType NetworkType
1006+ deriving (Eq, Show)
1007+
1008+
1009+instance {-# OVERLAPPING #-} ToJSON [NetworkFilter] where
1010+ toJSON = object . fmap toKV
1011+ where
1012+ toKV (NetworkFilterName n) = "name" .= [n]
1013+ toKV (NetworkFilterID i) = "id" .= [fromNetworkID i]
1014+ toKV (NetworkFilterLabel l) = "label" .= [l]
1015+ toKV (NetworkFilterDriver d) = "driver" .= [fromNetworkMode d]
1016+ toKV (NetworkFilterScope s) = "scope" .= [fromNetworkScope s]
1017+ toKV (NetworkFilterType t) = "type" .= [fromNetworkType t]
1018+
8611019-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
8621020-- | Set permissions on volumes that you mount in the container.
8631021data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -1027,11 +1185,14 @@ instance FromJSON NetworkMode where
10271185 parseJSON (JSON.String n) = return $ NetworkNamed n
10281186 parseJSON _ = fail "Unknown NetworkMode"
10291187
1188+fromNetworkMode :: NetworkMode -> Text
1189+fromNetworkMode NetworkBridge = "bridge"
1190+fromNetworkMode NetworkHost = "host"
1191+fromNetworkMode NetworkDisabled = "none"
1192+fromNetworkMode (NetworkNamed n) = n
1193+
10301194instance ToJSON NetworkMode where
1031− toJSON NetworkBridge = JSON.String "bridge"
1032− toJSON NetworkHost = JSON.String "host"
1033− toJSON NetworkDisabled = JSON.String "none"
1034− toJSON (NetworkNamed n) = JSON.String n
1195+ toJSON = JSON.String . fromNetworkMode
10351196
10361197newtype NetworkID = NetworkID Text
10371198 deriving (Eq, Show)
@@ -1564,11 +1725,7 @@ instance FromJSON ContainerConfig where
15641725 macAddress labels stopSignal
15651726 parseJSON _ = fail "NetworkSettings is not an object."
15661727
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701728parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721729parseIntegerText t = case readMaybe $ T.unpack t of
15731730 Nothing ->
15741731 fail "Could not parse Integer"
stack-7.10.yaml−1
@@ -14,7 +14,6 @@ flags: {}
1414extra-deps:
1515- directory-1.2.7.0
1616- unliftio-core-0.1.1.0
17−- process-1.6.5.1
1817
1918# Control whether we use the GHC we find on the path
2019# system-ghc: true
stack-8.8.2.yamldeleted−5
@@ -1,5 +0,0 @@
1−resolver: lts-15.0
2−packages:
3−- '.'
4−extra-deps: []
5−
tests/tests.hs+9
@@ -144,6 +144,14 @@ testCreateRemoveNetwork = do
144144 removeStatus <- removeNetwork nid
145145 lift $ assertBool ("removing a network, unexpected status: " ++ show removeStatus) $ isRight removeStatus
146146
147+testListNetworks :: IO ()
148+testListNetworks =
149+ runDocker $ do
150+ res <- listNetworks [NetworkFilterName "bridge"]
151+ lift $ case res of
152+ Left _ -> assertFailure $ "listing networks, unexpected status: " ++ show res
153+ Right ns -> assertBool "listing networks, bridge network missing" $ length ns == 1
154+
147155testLogDriverOptionsJson :: TestTree
148156testLogDriverOptionsJson = testGroup "Testing LogDriverOptions JSON" [test1, test2, test3]
149157 where
@@ -249,6 +257,7 @@ integrationTests =
249257 , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking
250258 , testCase "Try to stop a container that doesn't exist" testStopNonexisting
251259 , testCase "Create and remove a network" testCreateRemoveNetwork
260+ , testCase "List networks" testListNetworks
252261 ]
253262
254263jsonTests :: TestTree