clients/netbox: add config file clientclients/netbox/v3.2.0

4 files changed, 349 insertions, 0 deletions

diff --git a/clients/netbox/config_file_client.go b/clients/netbox/config_file_client.go
new file mode 100644
index 0000000..6023916
--- /dev/null
+++ b/clients/netbox/config_file_client.go
@@ -0,0 +1,151 @@
+package netbox
+
+import (
+        "context"
+        "encoding/json"
+        "fmt"
+        "io/fs"
+        "net"
+        "path/filepath"
+
+        "github.com/mitchellh/mapstructure"
+        "gopkg.in/yaml.v2"
+)
+
+type ConfigFileNetboxClient struct {
+        cfg map[string]any
+}
+
+var _ NetboxClient = (*ConfigFileNetboxClient)(nil)
+
+// NewConfigFileClient creates a new ConfigFileNetboxClient by loading a
+// named config file from a filesystem and unmarshalling it. The config
+// file can be in JSON or YAML format, determined by a .json, .yaml, or
+// .yml extension. The configuration must be nested within a key in that
+// file to support sharing the file with other subsystems.
+//
+// See method docs for the extected format of this file.
+func NewConfigFileClient(filesystem fs.FS, name, key string) (NetboxClient, error) {
+        fp, err := filesystem.Open(name)
+        if err != nil {
+                return nil, err
+        }
+        defer fp.Close()
+
+        fc := map[string]any{}
+
+        switch e := filepath.Ext(name); e {
+        case ".yaml", ".yml":
+                if err := yaml.NewDecoder(fp).Decode(&fc); err != nil {
+                        return nil, err
+                }
+        case ".json":
+                if err := json.NewDecoder(fp).Decode(&fc); err != nil {
+                        return nil, err
+                }
+        default:
+                return nil, fmt.Errorf("Config files with extension %s are not supported", e)
+        }
+
+        ck, ok := fc[key]
+        if !ok {
+                return nil, fmt.Errorf("Key %s does not exist in config file", key)
+        }
+
+        cfg := map[string]any{}
+        if err := mapstructure.Decode(ck, &cfg); err != nil {
+                return nil, fmt.Errorf("Config file key was not of correct type: %w", err)
+        }
+
+        return &ConfigFileNetboxClient{
+                cfg: cfg,
+        }, nil
+}
+
+// GetSitePrefixesWithTag gets a list of IP prefixes for a site based on
+// some tag.
+//
+// The data format of the config file should be, under the key "sites":
+//
+//  map[string]map[string][]string{
+//      "site_name": map[string][]string{
+//              "tag_name": []string{
+//                      "127.0.0.1/24",
+//              },
+//      },
+//  }
+//
+// In JSON format:
+//
+// { "sites": {
+//     "site": {
+//       "tag_name": [ "127.0.0.1/24" ]
+//     }
+// }
+func (c *ConfigFileNetboxClient) GetSitePrefixesWithTag(ctx context.Context, site string, tag string) ([]*net.IPNet, error) {
+        s, ok := c.cfg["sites"]
+        if !ok {
+                return nil, fmt.Errorf("No key 'sites' in config file")
+        }
+
+        sites := map[string]map[string][]string{}
+        if err := mapstructure.Decode(s, &sites); err != nil {
+                return nil, fmt.Errorf("Key 'sites' not in correct format: %w", err)
+        }
+
+        tags, ok := sites[site]
+        if !ok {
+                return nil, fmt.Errorf("Site %s not in sites", site)
+        }
+
+        values, ok := tags[tag]
+        if !ok {
+                return nil, fmt.Errorf("Tag %s not in tags", tag)
+        }
+
+        return parseValues(values)
+}
+
+// GetPrefixesWithTag gets a list fo IP prefixes based on some tag.
+//
+// The data format of the config file should be, under the key "tags":
+//
+//  map[string][]string{
+//      "tag_name": []string{
+//          "127.0.0.1/24",
+//      },
+//  }
+//
+// In JSON format:
+//
+// { "tags": { "tag_name": [ "127.0.0.1/24" ] } }
+func (c *ConfigFileNetboxClient) GetPrefixesWithTag(ctx context.Context, tag string) ([]*net.IPNet, error) {
+        t, ok := c.cfg["tags"]
+        if !ok {
+                return nil, fmt.Errorf("No key 'tags' in config file")
+        }
+
+        tags := map[string][]string{}
+        if err := mapstructure.Decode(t, &tags); err != nil {
+                return nil, fmt.Errorf("Key 'tags' not in correct format: %w", err)
+        }
+
+        values, ok := tags[tag]
+        if !ok {
+                return nil, fmt.Errorf("Tag %s not in tags", tag)
+        }
+
+        return parseValues(values)
+}
+
+func parseValues(v []string) ([]*net.IPNet, error) {
+        out := make([]*net.IPNet, len(v))
+        for i, n := range v {
+                _, in, err := net.ParseCIDR(n)
+                if err != nil {
+                        return nil, err
+                }
+                out[i] = in
+        }
+        return out, nil
+}
diff --git a/clients/netbox/config_file_client_test.go b/clients/netbox/config_file_client_test.go
new file mode 100644
index 0000000..bce5165
--- /dev/null
+++ b/clients/netbox/config_file_client_test.go
@@ -0,0 +1,165 @@
+package netbox
+
+import (
+        "context"
+        "net"
+        "testing"
+        "testing/fstest"
+
+        "github.com/stretchr/testify/assert"
+        "github.com/stretchr/testify/suite"
+)
+
+var (
+        ipNet1 *net.IPNet
+        ipNet2 *net.IPNet
+)
+
+func init() {
+        _, ipNet1, _ = net.ParseCIDR("127.0.0.1/8")
+        _, ipNet2, _ = net.ParseCIDR("10.0.10.0/24")
+}
+
+var testFs fstest.MapFS
+
+var jsonMissingTopSiteTags = []byte(`{
+        "netbox": { }
+}`)
+
+var jsonInvalidFormat = []byte(`{
+        "netbox": {
+                "sites": {
+                        "site1": {
+                                "invalid-tag": { "foo": "bar" }
+                        }
+                },
+                "tags": {
+                        "invalid-tag": { "foo": "bar" }
+                }
+        }
+}`)
+
+var jsonTestConfig = []byte(`{
+        "netbox": {
+                "sites": {
+                        "site1": {
+                                "tag1": [ "127.0.0.1/8", "10.0.10.0/24" ]
+                        }
+                },
+                "tags": {
+                        "tag1": [ "127.0.0.1/8", "10.0.10.0/24" ]
+                }
+        }
+}`)
+
+var yamlTestConfig = []byte(`
+netbox:
+  sites:
+    site1:
+      tag1: [ "127.0.0.1/8", "10.0.10.0/24" ]
+  tags:
+    tag1: [ "127.0.0.1/8", "10.0.10.0/24" ]
+`)
+
+func init() {
+        testFs = fstest.MapFS{}
+        testFs["netbox.foo"] = &fstest.MapFile{Data: jsonTestConfig}
+        testFs["netbox.json"] = &fstest.MapFile{Data: jsonTestConfig}
+        testFs["netbox.yaml"] = &fstest.MapFile{Data: yamlTestConfig}
+        testFs["netbox.yml"] = &fstest.MapFile{Data: yamlTestConfig}
+        testFs["no-site-tags.json"] = &fstest.MapFile{Data: jsonMissingTopSiteTags}
+        testFs["invalid-format.json"] = &fstest.MapFile{Data: jsonInvalidFormat}
+}
+
+type ConfigFileNetboxClientSuite struct {
+        suite.Suite
+        c   NetboxClient
+        nst NetboxClient
+        inv NetboxClient
+}
+
+func (s *ConfigFileNetboxClientSuite) SetupTest() {
+        var err error
+        s.c, err = NewConfigFileClient(testFs, "netbox.yaml", "netbox")
+        assert.NoError(s.T(), err)
+
+        s.nst, err = NewConfigFileClient(testFs, "no-site-tags.json", "netbox")
+        assert.NoError(s.T(), err)
+
+        s.inv, err = NewConfigFileClient(testFs, "invalid-format.json", "netbox")
+        assert.NoError(s.T(), err)
+}
+
+func (s *ConfigFileNetboxClientSuite) TestFromJSON() {
+        _, err := NewConfigFileClient(testFs, "netbox.json", "netbox")
+        assert.NoError(s.T(), err)
+}
+
+func (s *ConfigFileNetboxClientSuite) TestFromYAML() {
+        _, err := NewConfigFileClient(testFs, "netbox.yaml", "netbox")
+        assert.NoError(s.T(), err)
+        _, err = NewConfigFileClient(testFs, "netbox.yml", "netbox")
+        assert.NoError(s.T(), err)
+}
+
+func (s *ConfigFileNetboxClientSuite) TestFromInvalidExtension() {
+        _, err := NewConfigFileClient(testFs, "netbox.foo", "netbox")
+        assert.ErrorContains(s.T(), err, "extension .foo are not supported")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestFromInvalidFile() {
+        _, err := NewConfigFileClient(testFs, "netbox.foo-", "netbox")
+        assert.ErrorContains(s.T(), err, "file does not exist")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestFromInvalidKey() {
+        _, err := NewConfigFileClient(testFs, "netbox.json", "netboks")
+        assert.ErrorContains(s.T(), err, "Key netboks does not exist")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetSitePrefixesWithTag() {
+        ips, err := s.c.GetSitePrefixesWithTag(context.TODO(), "site1", "tag1")
+        assert.NoError(s.T(), err)
+        assert.Equal(s.T(), ipNet1, ips[0])
+        assert.Equal(s.T(), ipNet2, ips[1])
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetSitePrefixesWithTagMissing() {
+        _, err := s.nst.GetSitePrefixesWithTag(context.TODO(), "site1", "tag1")
+        assert.ErrorContains(s.T(), err, "No key 'sites'")
+
+        _, err = s.c.GetSitePrefixesWithTag(context.TODO(), "site2", "tag1")
+        assert.ErrorContains(s.T(), err, "Site site2 not in sites")
+
+        _, err = s.c.GetSitePrefixesWithTag(context.TODO(), "site1", "tag2")
+        assert.ErrorContains(s.T(), err, "Tag tag2 not in tags")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetSitePrefixesWithTagInvalid() {
+        _, err := s.inv.GetSitePrefixesWithTag(context.TODO(), "site1", "invalid-tag")
+        assert.ErrorContains(s.T(), err, "Key 'sites' not in correct format")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetPrefixesWithTag() {
+        ips, err := s.c.GetPrefixesWithTag(context.TODO(), "tag1")
+        assert.NoError(s.T(), err)
+        assert.Equal(s.T(), ipNet1, ips[0])
+        assert.Equal(s.T(), ipNet2, ips[1])
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetPrefixesWithTagMissingTags() {
+        _, err := s.nst.GetPrefixesWithTag(context.TODO(), "tag1")
+        assert.ErrorContains(s.T(), err, "No key 'tags'")
+
+        _, err = s.c.GetPrefixesWithTag(context.TODO(), "tag2")
+        assert.ErrorContains(s.T(), err, "Tag tag2 not in tags")
+}
+
+func (s *ConfigFileNetboxClientSuite) TestGetPrefixesWithTagMissingInvalid() {
+        _, err := s.inv.GetPrefixesWithTag(context.TODO(), "invalid-tag")
+        assert.ErrorContains(s.T(), err, "Key 'tags' not in correct format")
+}
+
+func TestConfigFileNetboxClientSuite(t *testing.T) {
+        suite.Run(t, &ConfigFileNetboxClientSuite{})
+}
diff --git a/clients/netbox/go.mod b/clients/netbox/go.mod
index b1a9bf4..1a3ea97 100644
--- a/clients/netbox/go.mod
+++ b/clients/netbox/go.mod
@@ -1,3 +1,15 @@
 module code.crute.us/mcrute/golib/clients/netbox/v3
 
 go 1.18
+
+require (
+        github.com/mitchellh/mapstructure v1.5.0
+        github.com/stretchr/testify v1.8.1
+        gopkg.in/yaml.v2 v2.4.0
+)
+
+require (
+        github.com/davecgh/go-spew v1.1.1 // indirect
+        github.com/pmezard/go-difflib v1.0.0 // indirect
+        gopkg.in/yaml.v3 v3.0.1 // indirect
+)
diff --git a/clients/netbox/go.sum b/clients/netbox/go.sum
index e69de29..0468562 100644
--- a/clients/netbox/go.sum
+++ b/clients/netbox/go.sum
@@ -0,0 +1,21 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
+github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=