on master help sign in
Merge pull request #62 from flskif/create-network

Implement create/remove network API and fix PRs #57 and #59

commit940eb34fe2a2bbc8b223d0b9e361e274c6296c2b authorJP <jprider63@users.noreply.github.com> dateThu 21 Jun 2018, 18:23 (8 years ago) parent53a0a4421dd26c
5 files changed+161−7
src/Docker/Client/Api.hs+11 src/Docker/Client/Http.hs+10 src/Docker/Client/Internal.hs+4 src/Docker/Client/Types.hs+94−5 tests/tests.hs+42−2
src/Docker/Client/Api.hs+11
@@ -20,6 +20,9 @@ module Docker.Client.Api (
2020 , listImages
2121 , buildImageFromDockerfile
2222 , pullImage
23+ -- * Network
24+ , createNetwork
25+ , removeNetwork
2326 -- * Other
2427 , getDockerVersion
2528 ) where
@@ -207,3 +210,11 @@ buildImageFromDockerfile opts base = do
207210pullImage :: forall m b . (MonadIO m, MonadMask m) => T.Text -> Tag -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)
208211pullImage name tag = requestHelper' POST (CreateImageEndpoint name tag Nothing)
209212
213+-- | Creates network
214+createNetwork :: forall m. (MonadIO m, MonadMask m) => CreateNetworkOpts -> DockerT m (Either DockerError NetworkID)
215+createNetwork opts = requestHelper POST (CreateNetworkEndpoint opts) >>= parseResponse
216+
217+-- | Removes a network
218+removeNetwork :: forall m. (MonadIO m, MonadMask m) => NetworkID -> DockerT m (Either DockerError ())
219+removeNetwork nid = requestUnit DELETE $ RemoveNetworkEndpoint nid
220+
src/Docker/Client/Http.hs+10
@@ -273,4 +273,14 @@ statusCodeToError (CreateImageEndpoint _ _ _) st =
273273 Nothing
274274 else
275275 Just $ DockerInvalidStatusCode st
276+statusCodeToError (CreateNetworkEndpoint _) st =
277+ if st == status201 then
278+ Nothing
279+ else
280+ Just $ DockerInvalidStatusCode st
281+statusCodeToError (RemoveNetworkEndpoint _) st =
282+ if st == status204 then
283+ Nothing
284+ else
285+ Just $ DockerInvalidStatusCode st
276286
src/Docker/Client/Internal.hs+4
@@ -75,6 +75,8 @@ getEndpoint v (CreateImageEndpoint name tag _) = encodeURLWithQuery [v, "images"
7575 where query = [("fromImage", Just n), ("tag", Just t)]
7676 n = encodeQ $ T.unpack name
7777 t = encodeQ $ T.unpack tag
78+getEndpoint v (CreateNetworkEndpoint _) = encodeURL [v, "networks", "create"]
79+getEndpoint v (RemoveNetworkEndpoint nid) = encodeURL [v, "networks", fromNetworkID nid]
7880
7981getEndpointRequestBody :: Endpoint -> Maybe HTTP.RequestBody
8082getEndpointRequestBody VersionEndpoint = Nothing
@@ -94,6 +96,8 @@ getEndpointRequestBody (InspectContainerEndpoint _) = Nothing
9496
9597getEndpointRequestBody (BuildImageEndpoint _ fp) = Just $ requestBodySourceChunked $ CB.sourceFile fp
9698getEndpointRequestBody (CreateImageEndpoint _ _ _) = Nothing
99+getEndpointRequestBody (CreateNetworkEndpoint opts) = Just $ HTTP.RequestBodyLBS (JSON.encode opts)
100+getEndpointRequestBody (RemoveNetworkEndpoint _) = Nothing
97101
98102getEndpointContentType :: Endpoint -> BSC.ByteString
99103getEndpointContentType (BuildImageEndpoint _ _) = BSC.pack "application/tar"
src/Docker/Client/Types.hs+94−5
@@ -11,6 +11,9 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
1518 , StatusCode(..)
1619 , Signal(..)
@@ -43,6 +46,8 @@ module Docker.Client.Types (
4346 , TailLogOpt(..)
4447 , LogOpts(..)
4548 , defaultLogOpts
49+ , CreateNetworkOpts(..)
50+ , defaultCreateNetworkOpts
4651 , VolumePermission(..)
4752 , Bind(..)
4853 , Volume(..)
@@ -68,6 +73,8 @@ module Docker.Client.Types (
6873 , UTSMode(..)
6974 , HostConfig(..)
7075 , defaultHostConfig
76+ , NetworkingConfig(..)
77+ , EndpointConfig(..)
7178 , Ulimit(..)
7279 , ContainerResources(..)
7380 , defaultContainerResources
@@ -127,6 +134,8 @@ data Endpoint =
127134 | InspectContainerEndpoint ContainerID
128135 | BuildImageEndpoint BuildOpts FilePath
129136 | CreateImageEndpoint T.Text Tag (Maybe T.Text) -- ^ Either pull an image from docker hub or imports an image from a tarball (or URL)
137+ | CreateNetworkEndpoint CreateNetworkOpts
138+ | RemoveNetworkEndpoint NetworkID
130139 deriving (Eq, Show)
131140
132141-- | We should newtype this
@@ -611,20 +620,46 @@ instance FromJSON Image where
611620 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
612621 parseJSON _ = fail "Failed to parse DockerImage."
613622
623+-- | Alias for Aliases.
624+type Alias = Text
625+
626+-- | EndpointsConfig is container configuration for a specific network
627+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
628+
629+instance ToJSON EndpointConfig where
630+ toJSON (EndpointConfig aliases) = JSON.object
631+ [ "Aliases" .= aliases
632+ ]
633+
634+-- | Alias for endpoint name
635+type EndpointName = Text
636+
637+-- | Data type for the NetworkingConfig section of the container settings
638+newtype NetworkingConfig = NetworkingConfig
639+ { endpointsConfig :: HM.HashMap EndpointName EndpointConfig
640+ } deriving (Eq, Show)
641+
642+instance ToJSON NetworkingConfig where
643+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
644+ [ "EndpointsConfig" .= endpointsConfig
645+ ]
614646
615647-- | Options used for creating a Container.
616648data CreateOpts = CreateOpts {
617− containerConfig :: ContainerConfig
618− , hostConfig :: HostConfig
649+ containerConfig :: ContainerConfig
650+ , hostConfig :: HostConfig
651+ , networkingConfig :: NetworkingConfig
619652 } deriving (Eq, Show)
620653
621654instance ToJSON CreateOpts where
622− toJSON (CreateOpts cc hc) = do
655+ toJSON (CreateOpts cc hc nc) = do
623656 let ccJSON = toJSON cc
624657 let hcJSON = toJSON hc
625658 case ccJSON of
626659 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
627− JSON.Object $ HM.insert "HostConfig" hcJSON o
660+ let o1 = HM.insert "HostConfig" hcJSON o
661+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
662+ JSON.Object o2
628663 _ -> error "ContainerConfig is not an object." -- This should never happen.
629664
630665-- | Container configuration used for creating a container with sensible
@@ -706,7 +741,11 @@ defaultContainerResources = ContainerResources {
706741-- | Default create options when creating a container. You only need to
707742-- specify an image name and the rest is all sensible defaults.
708743defaultCreateOpts :: T.Text -> CreateOpts
709−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
744+defaultCreateOpts imageName = CreateOpts
745+ { containerConfig = defaultContainerConfig imageName
746+ , hostConfig = defaultHostConfig
747+ , networkingConfig = NetworkingConfig HM.empty
748+ }
710749
711750-- | Override the key sequence for detaching a container.
712751-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -779,6 +818,36 @@ defaultLogOpts = LogOpts { stdout = True
779818 , tail = All
780819 }
781820
821+-- | Options for creating a network
822+data CreateNetworkOpts = CreateNetworkOpts
823+ { createNetworkName :: Text -- ^ The network's name
824+ , createNetworkCheckDuplicate :: Bool -- ^ Check for networks with duplicate names.
825+ , createNetworkDriver :: Text -- ^ Name of the network driver plugin to use.
826+ , createNetworkInternal :: Bool -- ^ Restrict external access to the network.
827+ , createNetworkEnableIPv6 :: Bool -- ^ Enable IPv6 on the network.
828+ } deriving (Eq, Show)
829+
830+-- | Sensible defalut for create network options
831+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
832+defaultCreateNetworkOpts name =
833+ CreateNetworkOpts
834+ { createNetworkName = name
835+ , createNetworkCheckDuplicate = False
836+ , createNetworkDriver = "bridge"
837+ , createNetworkInternal = True
838+ , createNetworkEnableIPv6 = False
839+ }
840+
841+instance ToJSON CreateNetworkOpts where
842+ toJSON opts =
843+ object
844+ [ "Name" .= createNetworkName opts
845+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
846+ , "Driver" .= createNetworkDriver opts
847+ , "Internal" .= createNetworkInternal opts
848+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
849+ ]
850+
782851-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
783852-- | Set permissions on volumes that you mount in the container.
784853data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -954,6 +1023,26 @@ instance ToJSON NetworkMode where
9541023 toJSON NetworkDisabled = JSON.String "none"
9551024 toJSON (NetworkNamed n) = JSON.String n
9561025
1026+newtype NetworkID = NetworkID Text
1027+ deriving (Eq, Show)
1028+
1029+-- | Used for extracting the id of the container from the newtype
1030+fromNetworkID :: NetworkID -> Text
1031+fromNetworkID (NetworkID t) = t
1032+
1033+-- | Used for parsing a Text value into a NetworkID.
1034+toNetworkID :: Text -> Maybe NetworkID
1035+toNetworkID t = Just $ NetworkID t
1036+
1037+instance FromJSON NetworkID where
1038+ parseJSON (JSON.Object o) = do
1039+ nid <- o .: "Id"
1040+ return $ NetworkID nid
1041+ parseJSON _ = fail "NetworkID is not an object."
1042+
1043+instance ToJSON NetworkID where
1044+ toJSON (NetworkID nid) = object ["Id" .= nid]
1045+
9571046data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9581047
9591048instance Show PortType where
tests/tests.hs+42−2
@@ -2,6 +2,7 @@
22
33module Main where
44
5+import Data.Either (rights)
56import Prelude hiding (all)
67import qualified Test.QuickCheck.Monadic as QCM
78import Test.Tasty
@@ -14,6 +15,7 @@ import Control.Monad (forM_)
1415import Control.Monad.IO.Class
1516import Control.Monad.Trans.Class (lift)
1617import qualified Data.Aeson as JSON
18+import Data.Aeson ((.=))
1719import Data.Aeson.Lens (key, _Array, _Null, _Object,
1820 _String, _Value)
1921import qualified Data.ByteString as B
@@ -88,11 +90,19 @@ testBuildFromDockerfile = do
8890 r <- buildImageFromDockerfile (defaultBuildOpts "docker-hs/dockerfile-test") ctxDir
8991 lift $ assert $ isRight r
9092
93+
9194testRunAndReadLog :: IO ()
92−testRunAndReadLog =
95+testRunAndReadLog = testRunAndReadLogHelper $ NetworkingConfig HM.empty
96+
97+testRunAndReadLogWithNetworking :: IO ()
98+testRunAndReadLogWithNetworking = testRunAndReadLogHelper $ NetworkingConfig $ HM.fromList [("test-network", EndpointConfig ["cellar-door"])]
99+
100+testRunAndReadLogHelper :: NetworkingConfig -> IO ()
101+testRunAndReadLogHelper networkingConfig =
93102 runDocker $
94103 do let containerConfig = (defaultContainerConfig (testImageName <> ":latest")) {env = [EnvVar "TEST" "123"]}
95− containerId <- createContainer (CreateOpts containerConfig defaultHostConfig) Nothing
104+ createdNetworks <- rights <$> mapM createNetworkWithName networkNames
105+ containerId <- createContainer (CreateOpts containerConfig defaultHostConfig networkingConfig) Nothing
96106 c <- fromRight containerId
97107 status1 <- startContainer defaultStartOpts c
98108 _ <- inspectContainer c >>= fromRight
@@ -102,9 +112,22 @@ testRunAndReadLog =
102112 lift $ assert $ (C.pack "123") `C.isInfixOf` (toStrict1 logs)
103113 status3 <- deleteContainer (DeleteOpts True True) c
104114 lift $ assertBool ("deleting container, unexpected status: " ++ show status3) $ isRightUnit status3
115+ mapM_ removeNetwork createdNetworks
105116 where
106117 isRightUnit (Right ()) = True
107118 isRightUnit _ = False
119+ networkNames = HM.keys $ endpointsConfig networkingConfig
120+ createNetworkWithName name = createNetwork $
121+ (defaultCreateNetworkOpts name) { createNetworkCheckDuplicate = True }
122+
123+testCreateRemoveNetwork :: IO ()
124+testCreateRemoveNetwork = do
125+ runDocker $ do
126+ createStatus <- createNetwork $ defaultCreateNetworkOpts "test-network"
127+ lift $ assertBool ("creating a network, unexpected status: " ++ show createStatus) $ isRight createStatus
128+ nid <- fromRight createStatus
129+ removeStatus <- removeNetwork nid
130+ lift $ assertBool ("removing a network, unexpected status: " ++ show removeStatus) $ isRight removeStatus
108131
109132testLogDriverOptionsJson :: TestTree
110133testLogDriverOptionsJson = testGroup "Testing LogDriverOptions JSON" [test1, test2, test3]
@@ -184,6 +207,20 @@ testEnvVarJson = testGroup "Testing EnvVar JSON" [testSampleEncode, testSampleDe
184207 testCase "Test fromJSON" $ assert $ (JSON.decode "\"cellar=door\"" :: Maybe EnvVar) ==
185208 Just (EnvVar "cellar" "door")
186209
210+testNetworkingConfigJson :: TestTree
211+testNetworkingConfigJson = testGroup "Testing NetworkingConfig JSON" [testSampleEncode]
212+ where
213+ testSampleEncode =
214+ let networkingConfig = NetworkingConfig $ HM.fromList [("custom-network", EndpointConfig ["cellar", "door"])]
215+ in testCase "Test toJSON" $ assert $ JSON.toJSON networkingConfig ==
216+ JSON.object
217+ [ "EndpointsConfig" .= JSON.object
218+ [ "custom-network" .= JSON.object
219+ [ "Aliases" .= (["cellar", "door"] :: [Text])
220+ ]
221+ ]
222+ ]
223+
187224integrationTests :: TestTree
188225integrationTests =
189226 testGroup
@@ -193,7 +230,9 @@ integrationTests =
193230 , testCase "Find image by name" testFindImage
194231 , testCase "List containers" testListContainers
195232 , testCase "Run a dummy container and read its log" testRunAndReadLog
233+ , testCase "Run a dummy container with networking and read its log" testRunAndReadLogWithNetworking
196234 , testCase "Try to stop a container that doesn't exist" testStopNonexisting
235+ , testCase "Create and remove a network" testCreateRemoveNetwork
197236 ]
198237
199238jsonTests :: TestTree
@@ -206,6 +245,7 @@ jsonTests =
206245 , testLogDriverOptionsJson
207246 , testEntrypointJson
208247 , testEnvVarJson
248+ , testNetworkingConfigJson
209249 ]
210250
211251setup :: IO ()