Merge lp:~allenap/gwacl/add-virtual-network into lp:gwacl

[Gavin Panella]

Two new methods, {Add,Remove}VirtualNetworkSite.

[lp:~allenap/gwacl/add-virtual-network]

202. By Gavin Panella on 2013-07-12

Remove early return.

[Raphaël Badin (rvb)]

Looks generally good but I've got a question (see [0]).

[0]

76 + for _, existingSite := range *networkConfig.VirtualNetworkSites {
77 + if existingSite.Name == site.Name {
78 + // Network already defined.
79 + return nil
80 + }

That's a weird behavior don't you think? Say I try adding a network with the same name but a different affinity group; the method will return with a nil error so I'll think that everything is ok and it will be a lie :). I /think/ returning an error (maybe only if the network you're trying to add has exactly the same characteristics as the one with the same name which already exists) is more appropriate here. What do you think?

[1]

102 + for _, existingSite := range *networkConfig.VirtualNetworkSites {
103 + if existingSite.Name != siteName {
104 + virtualNetworkSites = append(virtualNetworkSites, existingSite)
105 + }

We cannot just remove the network in question from networkConfig.VirtualNetworkSites can we :/

[2]

208 + virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
209 + err := api.AddVirtualNetworkSite(virtualNetwork)
210 + c.Assert(err, IsNil)
211 + c.Check(record, HasLen, 2)

It's a detail but that's something Jeroen and I have tried to do in tests, especially when the tests are long: put a empty line between the initialization code and the method you're testing, and another after that. This way, we have 3 visually well-separated blocks: initialization, method call, checks.

[3]

You could add a check in example/management/run.go to make sure that the created machine effectively has an IP in the virtual network.

review: Needs Information

[lp:~allenap/gwacl/add-virtual-network]

203. By Gavin Panella on 2013-07-12

Simplify AddVirtualNetworkSite (courtesy of jtv).

204. By Gavin Panella on 2013-07-12

Throw a wobbly when a virtual network already exists.

205. By Gavin Panella on 2013-07-12

Merge trunk, resolving one conflict.

206. By Gavin Panella on 2013-07-12

Add some whitespace.

[Gavin Panella (allenap)]

> [0]
>
> 76      +    for _, existingSite := range *networkConfig.VirtualNetworkSites {
> 77      +        if existingSite.Name == site.Name {
> 78      +            // Network already defined.
> 79      +            return nil
> 80      +        }
>
> That's a weird behavior don't you think?  Say I try adding a network with the
> same name but a different affinity group; the method will return with a nil
> error so I'll think that everything is ok and it will be a lie :).  I /think/
> returning an error (maybe only if the network you're trying to add has exactly
> the same characteristics as the one with the same name which already exists)
> is more appropriate here.  What do you think?

Good point. I've changed it to return an error when there's a
preexisting network with the same name.

>
> [1]
>
> 102     +    for _, existingSite := range *networkConfig.VirtualNetworkSites {
> 103     +        if existingSite.Name != siteName {
> 104     +            virtualNetworkSites = append(virtualNetworkSites,
> existingSite)
> 105     +        }
>
> We cannot just remove the network in question from
> networkConfig.VirtualNetworkSites can we :/

Is there a reason why we can't?

Ah, do you mean why can't we delete the entry directly from the slice?
Because Go.

Seriously, if you know how to do this nicely, please let me know.

>
> [2]
>
> 208     +    virtualNetwork := &VirtualNetworkSite{Name:
> MakeRandomVirtualNetworkName("test-")}
> 209     +    err := api.AddVirtualNetworkSite(virtualNetwork)
> 210     +    c.Assert(err, IsNil)
> 211     +    c.Check(record, HasLen, 2)
>
> It's a detail but that's something Jeroen and I have tried to do in tests,
> especially when the tests are long: put a empty line between the
> initialization code and the method you're testing, and another after that.
> This way, we have 3 visually well-separated blocks: initialization, method
> call, checks.

It's a pretty inconsistently followed pattern, but what the hell;
fixed.

Fwiw, I've been avoiding blank lines because gof*t only adds a single
line between functions instead of the two I'm used to.

>
> [3]
>
> You could add a check in example/management/run.go to make sure that the
> created machine effectively has an IP in the virtual network.

I'll give this a go.

[Gavin Panella (allenap)]

> > [3]
> >
> > You could add a check in example/management/run.go to make sure that the
> > created machine effectively has an IP in the virtual network.
>
> I'll give this a go.

I've just realised there's a good reason why it doesn't do this: VMs
are not yet deployed into the virtual network that's created. That's
something for a subsequent branch.

[Raphaël Badin (rvb)]

> > > [3]
> > >
> > > You could add a check in example/management/run.go to make sure that the
> > > created machine effectively has an IP in the virtual network.
> >
> > I'll give this a go.
>
> I've just realised there's a good reason why it doesn't do this: VMs
> are not yet deployed into the virtual network that's created. That's
> something for a subsequent branch.

Fair enough… it should be as simple as giving the name of the vnet to gwacl.NewDeploymentForCreateVMDeployment()… and maybe adding the objects with the right affinity group in a couple of places.

[Raphaël Badin (rvb)]

> > Ah, do you mean why can't we delete the entry directly from the slice?
> Because Go.

Yeah, because Go :/

> Seriously, if you know how to do this nicely, please let me know.

I don't… that's a shame.

[Raphaël Badin (rvb)]

Thanks for the fixes.

review: Approve

[Gavin Panella (allenap)]

Thanks for the review!

=== modified file 'example/management/run.go'
--- example/management/run.go	2013-07-10 16:59:00 +0000
+++ example/management/run.go	2013-07-12 13:07:30 +0000
@@ -108,33 +108,21 @@
 
     virtualNetworkName := gwacl.MakeRandomVirtualNetworkName("virtual-net-")
     fmt.Printf("Creating virtual network %s...\n", virtualNetworkName)
-    // FIXME: This clobbers *all* networking configuration instead of just
-    // adding the specific virtual network.
-    vnetRequest := &gwacl.NetworkConfiguration{
-        XMLNS: gwacl.XMLNS_NC,
-        VirtualNetworkSites: &[]gwacl.VirtualNetworkSite{
-            {
-                Name:          virtualNetworkName,
-                AffinityGroup: affinityGroupName,
-                AddressSpacePrefixes: []string{
-                    "10.0.0.0/8",
-                },
-            },
+    virtualNetwork := gwacl.VirtualNetworkSite{
+        Name:          virtualNetworkName,
+        AffinityGroup: affinityGroupName,
+        AddressSpacePrefixes: []string{
+            "10.0.0.0/8",
         },
     }
-    err = api.SetNetworkConfiguration(vnetRequest)
+    err = api.AddVirtualNetworkSite(&virtualNetwork)
     checkError(err)
     fmt.Println("Done creating virtual network")
 
     defer func() {
-        fmt.Println("Deleting virtual network...")
-        // FIXME: This destroys *all* networking configuration instead of just
-        // removing the specific network we created.
-        api.SetNetworkConfiguration(&gwacl.NetworkConfiguration{
-            XMLNS:               gwacl.XMLNS_NC,
-            VirtualNetworkSites: &[]gwacl.VirtualNetworkSite{},
-        })
-        fmt.Println("Done deleting virtual network")
+        fmt.Printf("Deleting virtual network %s...\n", virtualNetworkName)
+        api.RemoveVirtualNetworkSite(virtualNetworkName)
+        fmt.Printf("Done deleting virtual network %s\n", virtualNetworkName)
     }()
 
     networkConfig, err := api.GetNetworkConfiguration()

=== modified file 'management.go'
--- management.go	2013-07-08 07:11:29 +0000
+++ management.go	2013-07-12 13:07:30 +0000
@@ -4,6 +4,7 @@
 package gwacl
 
 import (
+    "fmt"
     "sort"
     "strings"
 )
@@ -199,3 +200,55 @@
     // Done.
     return nil
 }
+
+func (api *ManagementAPI) AddVirtualNetworkSite(site *VirtualNetworkSite) error {
+    // Obtain the current network config, which we will then modify.
+    networkConfig, err := api.GetNetworkConfiguration()
+    if err != nil {
+        return err
+    }
+    if networkConfig == nil {
+        // There's no config yet.
+        networkConfig = &NetworkConfiguration{XMLNS: XMLNS_NC}
+    }
+    if networkConfig.VirtualNetworkSites == nil {
+        networkConfig.VirtualNetworkSites = &[]VirtualNetworkSite{}
+    }
+    // Check to see if this network already exists.
+    for _, existingSite := range *networkConfig.VirtualNetworkSites {
+        if existingSite.Name == site.Name {
+            // Network already defined.
+            return fmt.Errorf("could not add virtual network: %q already exists", site.Name)
+        }
+    }
+    // Add the network to the configuration.
+    virtualNetworkSites := append(*networkConfig.VirtualNetworkSites, *site)
+    networkConfig.VirtualNetworkSites = &virtualNetworkSites
+    // Put it back up to Azure. There's a race here...
+    return api.SetNetworkConfiguration(networkConfig)
+}
+
+func (api *ManagementAPI) RemoveVirtualNetworkSite(siteName string) error {
+    // Obtain the current network config, which we will then modify.
+    networkConfig, err := api.GetNetworkConfiguration()
+    if err != nil {
+        return err
+    }
+    if networkConfig == nil || networkConfig.VirtualNetworkSites == nil {
+        // There's no config, nothing to do.
+        return nil
+    }
+    // Remove all references to the specified virtual network site name.
+    virtualNetworkSites := []VirtualNetworkSite{}
+    for _, existingSite := range *networkConfig.VirtualNetworkSites {
+        if existingSite.Name != siteName {
+            virtualNetworkSites = append(virtualNetworkSites, existingSite)
+        }
+    }
+    if len(virtualNetworkSites) < len(*networkConfig.VirtualNetworkSites) {
+        // Put it back up to Azure. There's a race here...
+        networkConfig.VirtualNetworkSites = &virtualNetworkSites
+        return api.SetNetworkConfiguration(networkConfig)
+    }
+    return nil
+}

=== modified file 'management_base_test.go'
--- management_base_test.go	2013-07-12 04:45:34 +0000
+++ management_base_test.go	2013-07-12 13:07:30 +0000
@@ -1001,6 +1001,15 @@
     assertGetNetworkConfigurationRequest(c, api, recordedRequests[0])
 }
 
+func assertSetNetworkConfigurationRequest(c *C, api *ManagementAPI, body []byte, httpRequest *X509Request) {
+    expectedURL := fmt.Sprintf(
+        "%s%s/services/networking/media", AZURE_URL,
+        api.session.subscriptionId)
+    checkRequest(c, httpRequest, expectedURL, "2012-03-01", body, "PUT")
+    // Azure chokes when the content type is text/xml or similar.
+    c.Assert(httpRequest.ContentType, Equals, "application/octet-stream")
+}
+
 func (suite *managementBaseAPISuite) TestSetNetworkConfiguration(c *C) {
     api := makeAPI(c)
     fixedResponse := x509Response{StatusCode: http.StatusOK}
@@ -1015,6 +1024,6 @@
     err = api.SetNetworkConfiguration(request)
 
     c.Assert(err, IsNil)
-    expectedURL := AZURE_URL + api.session.subscriptionId + "/services/networking/media"
-    checkOneRequest(c, &recordedRequests, expectedURL, "2012-03-01", requestPayload, "PUT")
+    c.Assert(recordedRequests, HasLen, 1)
+    assertSetNetworkConfigurationRequest(c, api, requestPayload, recordedRequests[0])
 }

=== modified file 'management_test.go'
--- management_test.go	2013-07-12 04:22:16 +0000
+++ management_test.go	2013-07-12 13:07:30 +0000
@@ -579,3 +579,267 @@
     c.Check(err, ErrorMatches, "DELETE request failed [(]500: Internal Server Error[)]")
     c.Check(record, HasLen, 4)
 }
+
+type suiteAddVirtualNetworkSite struct{}
+
+var _ = Suite(&suiteAddVirtualNetworkSite{})
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenConfigCannotBeFetched(c *C) {
+    responses := []DispatcherResponse{
+        {response: &x509Response{StatusCode: http.StatusInternalServerError}},
+    }
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+
+    err := api.AddVirtualNetworkSite(nil)
+
+    c.Assert(err, NotNil)
+    c.Check(err, ErrorMatches, "GET request failed [(]500: Internal Server Error[)]")
+    c.Check(record, HasLen, 1)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+}
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenConfigDoesNotExist(c *C) {
+    responses := []DispatcherResponse{
+        // No configuration found.
+        {response: &x509Response{StatusCode: http.StatusNotFound}},
+        // Accept upload of new configuration.
+        {response: &x509Response{StatusCode: http.StatusOK}},
+    }
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
+
+    err := api.AddVirtualNetworkSite(virtualNetwork)
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 2)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+    expected := &NetworkConfiguration{
+        XMLNS:               XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{*virtualNetwork},
+    }
+    expectedBody, err := expected.Serialize()
+    c.Assert(err, IsNil)
+    assertSetNetworkConfigurationRequest(c, api, []byte(expectedBody), record[1])
+}
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenNoPreexistingVirtualNetworkSites(c *C) {
+    // Prepare a basic, empty, configuration.
+    existingConfig := &NetworkConfiguration{XMLNS: XMLNS_NC}
+    responses := makeOKXMLResponse(c, existingConfig)
+    responses = append(responses, DispatcherResponse{
+        // Accept upload of new configuration.
+        response: &x509Response{StatusCode: http.StatusOK},
+    })
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
+
+    err := api.AddVirtualNetworkSite(virtualNetwork)
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 2)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+    expected := &NetworkConfiguration{
+        XMLNS:               XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{*virtualNetwork},
+    }
+    expectedBody, err := expected.Serialize()
+    c.Assert(err, IsNil)
+    assertSetNetworkConfigurationRequest(c, api, []byte(expectedBody), record[1])
+}
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenPreexistingVirtualNetworkSites(c *C) {
+    // Prepare a configuration with a single virtual network.
+    existingConfig := &NetworkConfiguration{
+        XMLNS: XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{
+            {Name: MakeRandomVirtualNetworkName("test-")},
+        },
+    }
+    responses := makeOKXMLResponse(c, existingConfig)
+    responses = append(responses, DispatcherResponse{
+        response: &x509Response{StatusCode: http.StatusOK},
+    })
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
+
+    err := api.AddVirtualNetworkSite(virtualNetwork)
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 2)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+    expectedSites := append(
+        *existingConfig.VirtualNetworkSites, *virtualNetwork)
+    expected := &NetworkConfiguration{
+        XMLNS:               XMLNS_NC,
+        VirtualNetworkSites: &expectedSites,
+    }
+    expectedBody, err := expected.Serialize()
+    c.Assert(err, IsNil)
+    assertSetNetworkConfigurationRequest(c, api, []byte(expectedBody), record[1])
+}
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenPreexistingVirtualNetworkSiteWithSameName(c *C) {
+    // Prepare a configuration with a single virtual network.
+    existingConfig := &NetworkConfiguration{
+        XMLNS: XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{
+            {Name: "virtual-network-bob"},
+        },
+    }
+    responses := makeOKXMLResponse(c, existingConfig)
+    rigPreparedResponseDispatcher(responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: "virtual-network-bob"}
+
+    err := api.AddVirtualNetworkSite(virtualNetwork)
+
+    c.Check(err, ErrorMatches, "could not add virtual network: \"virtual-network-bob\" already exists")
+}
+
+func (suite *suiteAddVirtualNetworkSite) TestWhenConfigCannotBePushed(c *C) {
+    responses := []DispatcherResponse{
+        // No configuration found.
+        {response: &x509Response{StatusCode: http.StatusNotFound}},
+        // Cannot accept upload of new configuration.
+        {response: &x509Response{StatusCode: http.StatusInternalServerError}},
+    }
+    rigPreparedResponseDispatcher(responses)
+    virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
+
+    err := makeAPI(c).AddVirtualNetworkSite(virtualNetwork)
+
+    c.Assert(err, NotNil)
+    c.Check(err, ErrorMatches, "PUT request failed [(]500: Internal Server Error[)]")
+}
+
+type suiteRemoveVirtualNetworkSite struct{}
+
+var _ = Suite(&suiteRemoveVirtualNetworkSite{})
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenConfigCannotBeFetched(c *C) {
+    responses := []DispatcherResponse{
+        {response: &x509Response{StatusCode: http.StatusInternalServerError}},
+    }
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+
+    err := api.RemoveVirtualNetworkSite("virtual-network-o-doom")
+
+    c.Check(err, ErrorMatches, "GET request failed [(]500: Internal Server Error[)]")
+    c.Check(record, HasLen, 1)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+}
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenConfigDoesNotExist(c *C) {
+    responses := []DispatcherResponse{
+        {response: &x509Response{StatusCode: http.StatusNotFound}},
+    }
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+
+    err := api.RemoveVirtualNetworkSite("virtual-network-in-my-eyes")
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 1)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+}
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenNoPreexistingVirtualNetworkSites(c *C) {
+    // Prepare a basic, empty, configuration.
+    existingConfig := &NetworkConfiguration{XMLNS: XMLNS_NC}
+    responses := makeOKXMLResponse(c, existingConfig)
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+
+    err := api.RemoveVirtualNetworkSite("virtual-network-on-my-shoes")
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 1)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+}
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenPreexistingVirtualNetworkSites(c *C) {
+    // Prepare a configuration with a single virtual network.
+    existingConfig := &NetworkConfiguration{
+        XMLNS: XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{
+            {Name: MakeRandomVirtualNetworkName("test-")},
+        },
+    }
+    responses := makeOKXMLResponse(c, existingConfig)
+    responses = append(responses, DispatcherResponse{
+        response: &x509Response{StatusCode: http.StatusOK},
+    })
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: MakeRandomVirtualNetworkName("test-")}
+
+    err := api.RemoveVirtualNetworkSite(virtualNetwork.Name)
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 1)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+    // It didn't do anything, so no upload.
+}
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenPreexistingVirtualNetworkSiteWithSameName(c *C) {
+    // Prepare a configuration with a single virtual network.
+    existingConfig := &NetworkConfiguration{
+        XMLNS: XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{
+            {Name: "virtual-network-bob"},
+        },
+    }
+    responses := makeOKXMLResponse(c, existingConfig)
+    responses = append(responses, DispatcherResponse{
+        response: &x509Response{StatusCode: http.StatusOK},
+    })
+    record := []*X509Request{}
+    rigRecordingPreparedResponseDispatcher(&record, responses)
+    api := makeAPI(c)
+    virtualNetwork := &VirtualNetworkSite{Name: "virtual-network-bob"}
+
+    err := api.RemoveVirtualNetworkSite(virtualNetwork.Name)
+
+    c.Assert(err, IsNil)
+    c.Check(record, HasLen, 2)
+    assertGetNetworkConfigurationRequest(c, api, record[0])
+    expected := &NetworkConfiguration{
+        XMLNS:               XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{},
+    }
+    expectedBody, err := expected.Serialize()
+    c.Assert(err, IsNil)
+    assertSetNetworkConfigurationRequest(c, api, []byte(expectedBody), record[1])
+}
+
+func (suite *suiteRemoveVirtualNetworkSite) TestWhenConfigCannotBePushed(c *C) {
+    existingConfig := &NetworkConfiguration{
+        XMLNS: XMLNS_NC,
+        VirtualNetworkSites: &[]VirtualNetworkSite{
+            {Name: "virtual-network-all-over"},
+        },
+    }
+    responses := makeOKXMLResponse(c, existingConfig)
+    responses = append(responses, DispatcherResponse{
+        response: &x509Response{StatusCode: http.StatusInternalServerError},
+    })
+    rigPreparedResponseDispatcher(responses)
+
+    err := makeAPI(c).RemoveVirtualNetworkSite("virtual-network-all-over")
+
+    c.Assert(err, NotNil)
+    c.Check(err, ErrorMatches, "PUT request failed [(]500: Internal Server Error[)]")
+}

=== modified file 'xmlobjects.go'
--- xmlobjects.go	2013-07-11 03:41:33 +0000
+++ xmlobjects.go	2013-07-12 13:07:30 +0000
@@ -626,7 +626,6 @@
 }
 
 type VirtualNetworkSite struct {
-    XMLName              string          `xml:"VirtualNetworkSite"`
     Name                 string          `xml:"name,attr"`
     AffinityGroup        string          `xml:"AffinityGroup,attr"`
     AddressSpacePrefixes []string        `xml:"AddressSpace>AddressPrefix"`