Merge pull request #149 from Charliekenney23/feat/add-firewall-update…

…-method

add firewall update method

firewalls.go

@@ -44,25 +44,40 @@ type FirewallCreateOptions struct {
 	Devices DevicesCreationOptions `json:"devices,omitempty"`
 }
 
+// FirewallUpdateOptions is an options struct used when Updating a Firewall
+type FirewallUpdateOptions struct {
+	Label  string         `json:"label,omitempty"`
+	Status FirewallStatus `json:"status,omitempty"`
+	Tags   *[]string      `json:"tags,omitempty"`
+}
+
+// GetUpdateOptions converts a Firewall to FirewallUpdateOptions for use in Client.UpdateFirewall.
+func (f *Firewall) GetUpdateOptions() FirewallUpdateOptions {
+	return FirewallUpdateOptions{
+		Label:  f.Label,
+		Status: f.Status,
+		Tags:   &f.Tags,
+	}
+}
+
 // UnmarshalJSON for Firewall responses
-func (i *Firewall) UnmarshalJSON(b []byte) error {
+func (f *Firewall) UnmarshalJSON(b []byte) error {
 	type Mask Firewall
 
 	p := struct {
 		*Mask
 		Created *parseabletime.ParseableTime `json:"created"`
 		Updated *parseabletime.ParseableTime `json:"updated"`
 	}{
-		Mask: (*Mask)(i),
+		Mask: (*Mask)(f),
 	}
 
 	if err := json.Unmarshal(b, &p); err != nil {
 		return err
 	}
 
-	i.Created = (*time.Time)(p.Created)
-	i.Updated = (*time.Time)(p.Updated)
-
+	f.Created = (*time.Time)(p.Created)
+	f.Updated = (*time.Time)(p.Updated)
 	return nil
 }
 
@@ -141,6 +156,31 @@ func (c *Client) GetFirewall(ctx context.Context, id int) (*Firewall, error) {
 	return r.Result().(*Firewall), nil
 }
 
+// UpdateFirewall updates a Firewall with the given ID
+func (c *Client) UpdateFirewall(ctx context.Context, id int, updateOpts FirewallUpdateOptions) (*Firewall, error) {
+	e, err := c.Firewalls.Endpoint()
+	if err != nil {
+		return nil, err
+	}
+
+	req := c.R(ctx).SetResult(&Firewall{})
+
+	bodyData, err := json.Marshal(updateOpts)
+	if err != nil {
+		return nil, NewError(err)
+	}
+
+	body := string(bodyData)
+
+	e = fmt.Sprintf("%s/%d", e, id)
+	r, err := coupleAPIErrors(req.SetBody(body).Put(e))
+	if err != nil {
+		return nil, err
+	}
+
+	return r.Result().(*Firewall), nil
+}
+
 // DeleteFirewall deletes a single Firewall with the provided ID
 func (c *Client) DeleteFirewall(ctx context.Context, id int) error {
 	e, err := c.Firewalls.Endpoint()

test/integration/firewall_rules_test.go

@@ -5,7 +5,6 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/linode/linodego"
 )
 
@@ -25,10 +24,6 @@ var (
 	}
 )
 
-// ignoreNetworkAddresses negates comparing IP addresses. Because of fixture sanitization,
-// these addresses will be changed to bogus values when running tests.
-var ignoreNetworkAddresses = cmpopts.IgnoreFields(linodego.FirewallRule{}, "Addresses")
-
 func TestGetFirewallRules(t *testing.T) {
 	client, firewall, teardown, err := setupFirewall(t, []firewallModifier{func(createOpts *linodego.FirewallCreateOptions) {
 		createOpts.Rules = testFirewallRuleSet

test/integration/firewalls_test.go

@@ -5,6 +5,8 @@ import (
 	"reflect"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/linode/linodego"
 )
 
@@ -16,6 +18,14 @@ var (
 	}
 )
 
+// ignoreNetworkAddresses negates comparing IP addresses. Because of fixture sanitization,
+// these addresses will be changed to bogus values when running tests.
+var ignoreNetworkAddresses = cmpopts.IgnoreFields(linodego.FirewallRule{}, "Addresses")
+
+// ignoreFirewallTimestamps negates comparing created and updated timestamps. Because of
+// fixture sanitization, these addresses will be changed to bogus values when running tests.
+var ignoreFirewallTimestamps = cmpopts.IgnoreFields(linodego.Firewall{}, "Created", "Updated")
+
 // TestListFirewalls should return a paginated list of Firewalls
 func TestListFirewalls(t *testing.T) {
 	client, _, teardown, err := setupFirewall(t, []firewallModifier{
@@ -72,6 +82,52 @@ func TestGetFirewall(t *testing.T) {
 	}
 }
 
+func TestUpdateFirewall(t *testing.T) {
+	label := randString(12, lowerBytes, upperBytes) + "-linodego-testing"
+	rules := linodego.FirewallRuleSet{
+		Inbound: []linodego.FirewallRule{
+			{
+				Protocol: linodego.ICMP,
+				Addresses: linodego.NetworkAddresses{
+					IPv4: []string{"0.0.0.0/0"},
+				},
+			},
+		},
+	}
+
+	client, firewall, teardown, err := setupFirewall(t, []firewallModifier{
+		func(createOpts *linodego.FirewallCreateOptions) {
+			createOpts.Label = label
+			createOpts.Rules = rules
+			createOpts.Tags = []string{"test"}
+		},
+	}, "fixtures/TestUpdateFirewall")
+	if err != nil {
+		t.Error(err)
+	}
+	defer teardown()
+
+	updateOpts := firewall.GetUpdateOptions()
+	updateOpts.Status = linodego.FirewallDisabled
+	updateOpts.Label = "updatedFirewallLabel"
+	updateOpts.Tags = &[]string{}
+
+	updated, err := client.UpdateFirewall(context.Background(), firewall.ID, updateOpts)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if !cmp.Equal(updated.Tags, *updateOpts.Tags) {
+		t.Errorf("expected tags to be updated: %s", cmp.Diff(updated.Tags, *updateOpts.Tags))
+	}
+	if updated.Status != updateOpts.Status {
+		t.Errorf("expected status %s but got %s", updateOpts.Status, updated.Status)
+	}
+	if updated.Label != updateOpts.Label {
+		t.Errorf(`expected label to be "%s" but got "%s"`, updateOpts.Label, updated.Label)
+	}
+}
+
 type firewallModifier func(*linodego.FirewallCreateOptions)
 
 func createFirewall(t *testing.T, client *linodego.Client, firewallModifiers ...firewallModifier) (*linodego.Firewall, func(), error) {

test/integration/fixtures/TestUpdateFirewall.yaml

@@ -0,0 +1,204 @@
+---
+version: 1
+interactions:
+- request:
+    body: '{"label":"aSTefFgoEhTM-linodego-testing","rules":{"inbound":[{"protocol":"ICMP","addresses":{"ipv4":["10.20.30.40/0"],"ipv6":null}}]},"tags":["test"],"devices":{}}'
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      User-Agent:
+      - linodego 0.12.0 https://github.com/linode/linodego
+    url: https://api.linode.com/v4beta/networking/firewalls
+    method: POST
+  response:
+    body: '{"id": 250, "label": "aSTefFgoEhTM-linodego-testing", "created": "2018-01-02T03:04:05",
+      "updated": "2018-01-02T03:04:05", "status": "enabled", "rules": {"inbound":
+      [{"protocol": "ICMP", "addresses": {"ipv4": ["10.20.30.40/0"], "ipv6": null}}]},
+      "tags": ["test"]}'
+    headers:
+      Access-Control-Allow-Credentials:
+      - "true"
+      Access-Control-Allow-Headers:
+      - Authorization, Origin, X-Requested-With, Content-Type, Accept, X-Filter
+      Access-Control-Allow-Methods:
+      - HEAD, GET, OPTIONS, POST, PUT, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Expose-Headers:
+      - X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Status
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Content-Length:
+      - "258"
+      Content-Security-Policy:
+      - default-src 'none'
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 22 May 2020 13:35:21 GMT
+      Retry-After:
+      - "118"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Authorization, X-Filter
+      X-Accepted-Oauth-Scopes:
+      - firewall:read_write
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      - DENY
+      X-Oauth-Scopes:
+      - '*'
+      X-Ratelimit-Limit:
+      - "1600"
+      X-Ratelimit-Remaining:
+      - "1595"
+      X-Ratelimit-Reset:
+      - "1590154640"
+      X-Spec-Version:
+      - 4.65.1
+      X-Xss-Protection:
+      - 1; mode=block
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: '{"label":"updatedFirewallLabel","status":"disabled","tags":[]}'
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      User-Agent:
+      - linodego 0.12.0 https://github.com/linode/linodego
+    url: https://api.linode.com/v4beta/networking/firewalls/250
+    method: PUT
+  response:
+    body: '{"id": 250, "label": "updatedFirewallLabel", "created": "2018-01-02T03:04:05",
+      "updated": "2018-01-02T03:04:05", "status": "disabled", "rules": {"inbound":
+      [{"protocol": "ICMP", "addresses": {"ipv4": ["10.20.30.40/0"], "ipv6": null}}]},
+      "tags": []}'
+    headers:
+      Access-Control-Allow-Credentials:
+      - "true"
+      Access-Control-Allow-Headers:
+      - Authorization, Origin, X-Requested-With, Content-Type, Accept, X-Filter
+      Access-Control-Allow-Methods:
+      - HEAD, GET, OPTIONS, POST, PUT, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Expose-Headers:
+      - X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Status
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Content-Length:
+      - "244"
+      Content-Security-Policy:
+      - default-src 'none'
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 22 May 2020 13:35:22 GMT
+      Retry-After:
+      - "118"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Authorization, X-Filter
+      X-Accepted-Oauth-Scopes:
+      - firewall:read_write
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      - DENY
+      X-Oauth-Scopes:
+      - '*'
+      X-Ratelimit-Limit:
+      - "1600"
+      X-Ratelimit-Remaining:
+      - "1594"
+      X-Ratelimit-Reset:
+      - "1590154641"
+      X-Spec-Version:
+      - 4.65.1
+      X-Xss-Protection:
+      - 1; mode=block
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      User-Agent:
+      - linodego 0.12.0 https://github.com/linode/linodego
+    url: https://api.linode.com/v4beta/networking/firewalls/250
+    method: DELETE
+  response:
+    body: '{}'
+    headers:
+      Access-Control-Allow-Credentials:
+      - "true"
+      Access-Control-Allow-Headers:
+      - Authorization, Origin, X-Requested-With, Content-Type, Accept, X-Filter
+      Access-Control-Allow-Methods:
+      - HEAD, GET, OPTIONS, POST, PUT, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Expose-Headers:
+      - X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Status
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Content-Length:
+      - "2"
+      Content-Security-Policy:
+      - default-src 'none'
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 22 May 2020 13:35:22 GMT
+      Retry-After:
+      - "118"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Authorization, X-Filter
+      X-Accepted-Oauth-Scopes:
+      - firewall:read_write
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      - DENY
+      X-Oauth-Scopes:
+      - '*'
+      X-Ratelimit-Limit:
+      - "1600"
+      X-Ratelimit-Remaining:
+      - "1593"
+      X-Ratelimit-Reset:
+      - "1590154641"
+      X-Spec-Version:
+      - 4.65.1
+      X-Xss-Protection:
+      - 1; mode=block
+    status: 200 OK
+    code: 200
+    duration: ""