Merge pull request #1056 from ninjarobot/route-server-depends-on

Route Servers: Support 'depends_on' for routeServerBGPConnection

Author: ninjarobot

RELEASE_NOTES.md

@@ -3,6 +3,7 @@ Release Notes
 
 ## 1.7.26
 * Container Apps: Add support for Dapr components
+* Route Servers: Support 'depends_on' for routeServerBGPConnection.
 * WebApps: When creating keyvault secrets for web app appsettings replace characters unsupported in keyvault secret names with `-`
 
 ## 1.7.25

docs/content/api-overview/resources/route-server.md

@@ -24,6 +24,7 @@ The `routeServer` builder creates a route server to simplify dynamic routing bet
 | routeServerBGPConnection | name                           | Name of the BGP connection                                                 |
 | routeServerBGPConnection | peer_ip                         | The peer IP of the BGP connection                                          |
 | routeServerBGPConnection | peer_asn                        | The peer Asn of the BGP connection                                         |
+| routeServerBGPConnection | depends_on                      | Depend on another resource before deploying this bgp connection            |
 
 #### Example
 

src/Farmer/Arm/Network.fs

@@ -230,6 +230,7 @@ type RouteServerBGPConnection =
         PeerIp: string
         PeerAsn: int
         IpConfig: LinkedResource
+        Dependencies: Set<ResourceId>
     }
 
     interface IArmResource with
@@ -246,6 +247,7 @@ type RouteServerBGPConnection =
                     this.RouteServer.ResourceId
                 }
                 |> Set.ofSeq
+                |> Set.union this.Dependencies
 
             {| routeServerBGPConnections.Create(this.RouteServer.Name / this.Name, dependsOn = dependencies) with
                 properties =

src/Farmer/Builders/Builders.RouteServer.fs

@@ -11,10 +11,17 @@ type RSBGPConnectionConfig =
         Name: string
         PeerIp: string
         PeerAsn: int
+        Dependencies: Set<ResourceId>
     }
 
 type RSBGPConnectionBuilder() =
-    member _.Yield _ = { Name = ""; PeerIp = ""; PeerAsn = 0 }
+    member _.Yield _ =
+        {
+            Name = ""
+            PeerIp = ""
+            PeerAsn = 0
+            Dependencies = Set.empty
+        }
 
     [<CustomOperation "name">]
     member _.ConnectionName(state: RSBGPConnectionConfig, name) = { state with Name = name }
@@ -25,6 +32,13 @@ type RSBGPConnectionBuilder() =
     [<CustomOperation "peer_asn">]
     member _.PeerAsn(state: RSBGPConnectionConfig, peerAsn) = { state with PeerAsn = peerAsn }
 
+    interface IDependable<RSBGPConnectionConfig> with
+        /// Adds an explicit dependency to this Container App Environment.
+        member _.Add state newDeps =
+            { state with
+                Dependencies = state.Dependencies + newDeps
+            }
+
 let routeServerBGPConnection = RSBGPConnectionBuilder()
 
 type RouteServerConfig =
@@ -111,6 +125,7 @@ type RouteServerConfig =
                                     ResourceName $"{this.Name.Value}-ipconfig"
                                 )
                             )
+                        Dependencies = connection.Dependencies
                     }
             ]
 

src/Tests/Network.fs

@@ -854,6 +854,19 @@ let tests =
                                                 peer_ip "10.0.1.85"
                                                 peer_asn 65000
                                             }
+                                            routeServerBGPConnection {
+                                                name "my-bgp-conn-2"
+                                                peer_ip "10.0.1.86"
+                                                peer_asn 65000
+
+                                                depends_on (
+                                                    ResourceId.create (
+                                                        routeServerBGPConnections,
+                                                        ResourceName "my-route-server",
+                                                        ResourceName "my-bgp-conn"
+                                                    )
+                                                )
+                                            }
                                         ]
                                 }
                             ]
@@ -982,8 +995,7 @@ let tests =
                 Expect.equal sku "Standard" "Incorrect default value for sku"
 
                 //validate bgp connection generated
-                let bgpConn =
-                    jobj.SelectToken "resources[?(@.type=='Microsoft.Network/virtualHubs/bgpConnections')]"
+                let bgpConn = jobj.SelectToken "resources[?(@.name=='my-route-server/my-bgp-conn')]"
 
                 Expect.isNotNull bgpConn "bgp connection should be generated"
 
@@ -994,9 +1006,7 @@ let tests =
                     (JToken.op_Implicit "my-route-server/my-bgp-conn")
                     "Incorrect default value for bgp connection name"
 
-                let bgpConnDependencies =
-                    jobj.SelectToken "resources[?(@.type=='Microsoft.Network/virtualHubs/bgpConnections')].dependsOn"
-                    :?> JArray
+                let bgpConnDependencies = bgpConn.SelectToken "dependsOn" :?> JArray
 
                 Expect.isNotNull bgpConnDependencies "Missing dependency for bgp connection"
                 Expect.hasLength bgpConnDependencies 2 "Incorrect number of dependencies for bgp connection"
@@ -1016,6 +1026,37 @@ let tests =
                 Expect.equal peerAsn 65000 "Incorrect peer Asn for bgp connection"
                 let peerIp: string = JToken.op_Explicit bgpConnProps.["peerIp"]
                 Expect.equal peerIp "10.0.1.85" "Incorrect peer ip for bgp connection"
+
+                //validate bgp connection generated
+                let bgpConnWithDep =
+                    jobj.SelectToken "resources[?(@.name=='my-route-server/my-bgp-conn-2')]"
+
+                Expect.isNotNull bgpConnWithDep "bgp connection with dependency should be generated"
+
+                let bgpConnWithDepName = bgpConnWithDep.["name"]
+
+                Expect.equal
+                    bgpConnWithDepName
+                    (JToken.op_Implicit "my-route-server/my-bgp-conn-2")
+                    "Incorrect default value for bgp connection with dependency name"
+
+                let bgpConnWithDepDependencies = bgpConnWithDep.SelectToken "dependsOn" :?> JArray
+
+                Expect.isNotNull
+                    bgpConnWithDepDependencies
+                    "Missing dependency for bgp connection with explicit dependency"
+
+                Expect.hasLength
+                    bgpConnWithDepDependencies
+                    3
+                    "Incorrect number of dependencies for bgp connection with explicit 'depends_on'"
+
+                Expect.contains
+                    (bgpConnWithDepDependencies)
+                    (JValue
+                        "[resourceId('Microsoft.Network/virtualHubs/bgpConnections', 'my-route-server', 'my-bgp-conn')]")
+                    "Incorrect bgp connection dependencies with explicit 'depends_on'"
+
             }
 
             test "Creates basic network interface with static ip" {