fromExistingNetwork

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 * Introduce `withWorkingDirectory` to set the working directory inside a container (@alexbiehl, https://github.com/testcontainers/testcontainers-hs/pull/37)
 
+* Add `fromExistingNetwork` to allow connecting containers to existing, unmanaged networks (@alexbiehl, https://github.com/testcontainers/testcontainers-hs/pull/41)
+
 ## 0.5.0.0 -- 2023-02-20
 
 * BREAKING: Refined lifecycle management. testcontainers is now using testcontainers/ryuk resource reaper to cleanup containers, networks and volumes. Release keys for containers are deprecated. (@alexbiehl, https://github.com/testcontainers/testcontainers-hs/pull/33)

src/TestContainers.hs

@@ -46,6 +46,7 @@ module TestContainers
     M.Network,
     M.NetworkId,
     M.createNetwork,
+    M.fromExistingNetwork,
 
     -- * Port
     M.Port (..),

src/TestContainers/Docker.hs

@@ -104,6 +104,7 @@ module TestContainers.Docker
     networkId,
     networkRequest,
     createNetwork,
+    fromExistingNetwork,
     withIpv6,
     withDriver,
 
@@ -227,6 +228,7 @@ import TestContainers.Docker.Network
     NetworkId,
     NetworkRequest,
     createNetwork,
+    fromExistingNetwork,
     networkId,
     networkRequest,
     withDriver,

src/TestContainers/Docker/Network.hs

@@ -10,6 +10,7 @@ module TestContainers.Docker.Network
     networkId,
 
     -- * Creating networks
+    fromExistingNetwork,
     createNetwork,
     NetworkRequest,
     networkRequest,
@@ -74,6 +75,15 @@ withDriver :: Text -> NetworkRequest -> NetworkRequest
 withDriver driver request =
   request {driver = Just driver}
 
+-- | Creates a 'Network' from an existing 'NetworkId'. Note that the 'Network' is
+-- not managed by the 'TestContainer' monad and as such is not being cleaned up
+-- afterwards.
+--
+-- @since x.x.x
+fromExistingNetwork :: NetworkId -> TestContainer Network
+fromExistingNetwork id =
+  pure Network {id}
+
 -- | Creates a new 'Network' from a 'NetworkRequest'.
 --
 -- @since 0.5.0.0