-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #146 from Charliekenney23/feat/firewall-devices
add firewall device operations
- Loading branch information
Showing
11 changed files
with
1,486 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
package linodego | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"time" | ||
|
||
"github.com/linode/linodego/internal/parseabletime" | ||
) | ||
|
||
// FirewallDeviceType represents the different kinds of devices governable by a Firewall | ||
type FirewallDeviceType string | ||
|
||
// FirewallDeviceType constants start with FirewallDevice | ||
const ( | ||
FirewallDeviceLinode FirewallDeviceType = "linode" | ||
FirewallDeviceNodeBalancer FirewallDeviceType = "nodebalancer" | ||
) | ||
|
||
// FirewallDevice represents a device governed by a Firewall | ||
type FirewallDevice struct { | ||
ID int `json:"id"` | ||
Entity FirewallDeviceEntity `json:"entity"` | ||
Created *time.Time `json:"-"` | ||
Updated *time.Time `json:"-"` | ||
} | ||
|
||
// FirewallDeviceCreateOptions fields are those accepted by CreateFirewallDevice | ||
type FirewallDeviceCreateOptions struct { | ||
ID int `json:"id"` | ||
Type FirewallDeviceType `json:"type"` | ||
} | ||
|
||
// UnmarshalJSON implements the json.Unmarshaler interface | ||
func (device *FirewallDevice) UnmarshalJSON(b []byte) error { | ||
type Mask FirewallDevice | ||
|
||
p := struct { | ||
*Mask | ||
Created *parseabletime.ParseableTime `json:"created"` | ||
Updated *parseabletime.ParseableTime `json:"updated"` | ||
}{ | ||
Mask: (*Mask)(device), | ||
} | ||
|
||
if err := json.Unmarshal(b, &p); err != nil { | ||
return err | ||
} | ||
|
||
device.Created = (*time.Time)(p.Created) | ||
device.Updated = (*time.Time)(p.Updated) | ||
return nil | ||
} | ||
|
||
// FirewallDeviceEntity contains information about a device associated with a Firewall | ||
type FirewallDeviceEntity struct { | ||
ID int `json:"id"` | ||
Type FirewallDeviceType `json:"type"` | ||
Label string `json:"label"` | ||
URL string `json:"url"` | ||
} | ||
|
||
// FirewallDevicesPagedResponse represents a Linode API response for FirewallDevices | ||
type FirewallDevicesPagedResponse struct { | ||
*PageOptions | ||
Data []FirewallDevice `json:"data"` | ||
} | ||
|
||
// endpointWithID gets the endpoint URL for FirewallDevices of a given Firewall | ||
func (FirewallDevicesPagedResponse) endpointWithID(c *Client, id int) string { | ||
endpoint, err := c.FirewallDevices.endpointWithID(id) | ||
if err != nil { | ||
panic(err) | ||
} | ||
return endpoint | ||
} | ||
|
||
func (resp *FirewallDevicesPagedResponse) appendData(r *FirewallDevicesPagedResponse) { | ||
resp.Data = append(resp.Data, r.Data...) | ||
} | ||
|
||
// ListFirewallDevices get devices associated with a given Firewall | ||
func (c *Client) ListFirewallDevices(ctx context.Context, firewallID int, opts *ListOptions) ([]FirewallDevice, error) { | ||
response := FirewallDevicesPagedResponse{} | ||
err := c.listHelperWithID(ctx, &response, firewallID, opts) | ||
|
||
if err != nil { | ||
return nil, err | ||
} | ||
return response.Data, nil | ||
} | ||
|
||
// GetFirewallDevice gets a FirewallDevice given an ID | ||
func (c *Client) GetFirewallDevice(ctx context.Context, firewallID, deviceID int) (*FirewallDevice, error) { | ||
e, err := c.FirewallDevices.endpointWithID(firewallID) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
e = fmt.Sprintf("%s/%d", e, deviceID) | ||
r, err := coupleAPIErrors(c.R(ctx).SetResult(&FirewallDevice{}).Get(e)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
return r.Result().(*FirewallDevice), nil | ||
} | ||
|
||
// AddFirewallDevice associates a Device with a given Firewall | ||
func (c *Client) CreateFirewallDevice(ctx context.Context, firewallID int, createOpts FirewallDeviceCreateOptions) (*FirewallDevice, error) { | ||
var body string | ||
e, err := c.FirewallDevices.endpointWithID(firewallID) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
req := c.R(ctx).SetResult(&FirewallDevice{}) | ||
if bodyData, err := json.Marshal(createOpts); err == nil { | ||
body = string(bodyData) | ||
} else { | ||
return nil, NewError(err) | ||
} | ||
|
||
r, err := coupleAPIErrors(req.SetBody(body).Post(e)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
return r.Result().(*FirewallDevice), nil | ||
} | ||
|
||
// DeleteFirewallDevice disassociates a Device with a given Firewall | ||
func (c *Client) DeleteFirewallDevice(ctx context.Context, firewallID, deviceID int) error { | ||
e, err := c.FirewallDevices.endpointWithID(firewallID) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
e = fmt.Sprintf("%s/%d", e, deviceID) | ||
_, err = coupleAPIErrors(c.R(ctx).Delete(e)) | ||
return err | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
package integration | ||
|
||
import ( | ||
"context" | ||
"net/http" | ||
"testing" | ||
|
||
"github.com/google/go-cmp/cmp" | ||
"github.com/linode/linodego" | ||
) | ||
|
||
func TestListFirewallDevices(t *testing.T) { | ||
client, instance, teardown, err := setupInstance(t, "fixtures/TestListFirewallDevices") | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardown() | ||
|
||
firewall, teardownFirewall, err := createFirewall(t, client, func(opts *linodego.FirewallCreateOptions) { | ||
opts.Devices.Linodes = []int{instance.ID} | ||
}) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardownFirewall() | ||
|
||
firewallDevices, err := client.ListFirewallDevices(context.Background(), firewall.ID, nil) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
|
||
if len(firewallDevices) != 1 { | ||
t.Errorf("expected 1 firewall device but got %d", len(firewallDevices)) | ||
} | ||
} | ||
|
||
func TestGetFirewallDevice(t *testing.T) { | ||
client, instance, teardown, err := setupInstance(t, "fixtures/TestGetFirewallDevice") | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardown() | ||
|
||
firewall, teardownFirewall, err := createFirewall(t, client) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardownFirewall() | ||
|
||
firewallDevice, err := client.CreateFirewallDevice(context.Background(), firewall.ID, linodego.FirewallDeviceCreateOptions{ | ||
Type: linodego.FirewallDeviceLinode, | ||
ID: instance.ID, | ||
}) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
|
||
if device, err := client.GetFirewallDevice(context.Background(), firewall.ID, firewallDevice.ID); err != nil { | ||
t.Error(err) | ||
} else if !cmp.Equal(device, firewallDevice) { | ||
t.Errorf("expected device to match create result but got diffs: %s", cmp.Diff(device, firewallDevice)) | ||
} | ||
} | ||
|
||
func TestDeleteFirewallDevice(t *testing.T) { | ||
client, instance, teardown, err := setupInstance(t, "fixtures/TestDeleteFirewallDevice") | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardown() | ||
|
||
firewall, teardownFirewall, err := createFirewall(t, client) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
defer teardownFirewall() | ||
|
||
firewallDevice, err := client.CreateFirewallDevice(context.Background(), firewall.ID, linodego.FirewallDeviceCreateOptions{ | ||
Type: linodego.FirewallDeviceLinode, | ||
ID: instance.ID, | ||
}) | ||
if err != nil { | ||
t.Error(err) | ||
} | ||
|
||
assertDateSet(t, firewallDevice.Created) | ||
assertDateSet(t, firewallDevice.Updated) | ||
|
||
if err := client.DeleteFirewallDevice(context.Background(), firewall.ID, firewallDevice.ID); err != nil { | ||
t.Error(err) | ||
} | ||
|
||
if _, getErr := client.GetFirewallDevice(context.Background(), firewall.ID, firewallDevice.ID); err != nil { | ||
t.Error("expected fetching firewall device to fail") | ||
} else if apiError, ok := getErr.(*linodego.Error); !ok || apiError.Code != http.StatusNotFound { | ||
t.Errorf("expected fetching firewall device to throw Not Found but got: %s", getErr) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.