Improvements to config handling

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/gdamore/tcell/v2 v2.6.0
 	github.com/golang/mock v1.6.0
 	github.com/google/gopacket v1.1.19
+	github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e
 	github.com/jackpal/gateway v1.0.10
 	github.com/projectdiscovery/mapcidr v1.1.2
 	github.com/rivo/tview v0.0.0-20230621164836-6cc0565babaf

go.sum

@@ -173,6 +173,8 @@ github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg=
 github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk=
 github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8/go.mod h1:dvDLG8qkwmyD9a/MJJN3XJcT3xFxOKAvTZGvuZmac9g=
+github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e h1:XmA6L9IPRdUr28a+SK/oMchGgQy159wvzXA5tJ7l+40=
+github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e/go.mod h1:AFIo+02s+12CEg8Gzz9kzhCbmbq6JcKNrhHffCGA9z4=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY=
 github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c=

internal/config/interface.go

@@ -1,8 +1,6 @@
 package config
 
 import (
-	"time"
-
 	"gorm.io/datatypes"
 )
 
@@ -25,11 +23,10 @@ type SSHConfig struct {
 
 // Config represents the data structure of our user provided json configuration
 type Config struct {
-	ID      int
-	Name    string
-	SSH     SSHConfig
-	Targets []string `json:"targets"`
-	Loaded  time.Time
+	ID   int
+	Name string
+	SSH  SSHConfig
+	CIDR string
 }
 
 // SSHConfigModel represents the ssh config stored in the database
@@ -41,31 +38,28 @@ type SSHConfigModel struct {
 
 // ConfigModel represents the config stored in the database
 type ConfigModel struct {
-	ID      int            `gorm:"primaryKey"`
-	Name    string         `gorm:"uniqueIndex"`
-	SSH     SSHConfigModel `gorm:"embedded"`
-	Targets datatypes.JSON
-	Loaded  time.Time `gorm:"index:,sort:desc"`
+	ID   int            `gorm:"primaryKey"`
+	Name string         `gorm:"uniqueIndex"`
+	SSH  SSHConfigModel `gorm:"embedded"`
+	CIDR string         `gorm:"column:cidr"`
 }
 
 // Repo interface representing access to stored configs
 type Repo interface {
 	Get(id int) (*Config, error)
 	GetAll() ([]*Config, error)
+	GetByCIDR(cidr string) (*Config, error)
 	Create(conf *Config) (*Config, error)
 	Update(conf *Config) (*Config, error)
 	Delete(id int) error
-	SetLastLoaded(id int) error
-	LastLoaded() (*Config, error)
 }
 
 // Service interface for manipulating configurations
 type Service interface {
 	Get(id int) (*Config, error)
 	GetAll() ([]*Config, error)
+	GetByCIDR(cidr string) (*Config, error)
 	Create(conf *Config) (*Config, error)
 	Update(conf *Config) (*Config, error)
 	Delete(id int) error
-	SetLastLoaded(id int) error
-	LastLoaded() (*Config, error)
 }

internal/config/repo.go

@@ -3,7 +3,6 @@ package config
 import (
 	"encoding/json"
 	"errors"
-	"time"
 
 	"github.com/robgonnella/ops/internal/exception"
 	"gorm.io/datatypes"
@@ -38,10 +37,6 @@ func (r *SqliteRepo) Get(id int) (*Config, error) {
 		return nil, result.Error
 	}
 
-	if result := r.db.Save(&confModel); result.Error != nil {
-		return nil, result.Error
-	}
-
 	return modelToConfig(&confModel)
 }
 
@@ -122,24 +117,11 @@ func (r *SqliteRepo) Delete(id int) error {
 	return r.db.Delete(&ConfigModel{ID: id}).Error
 }
 
-// SetLastLoaded updates a configs "loaded" field to the current timestamp
-func (r *SqliteRepo) SetLastLoaded(id int) error {
-	confModel := ConfigModel{ID: id}
-
-	if result := r.db.First(&confModel); result.Error != nil {
-		return result.Error
-	}
-
-	confModel.Loaded = time.Now()
-
-	return r.db.Save(&confModel).Error
-}
-
 // LastLoaded returns the most recently loaded config
-func (r *SqliteRepo) LastLoaded() (*Config, error) {
+func (r *SqliteRepo) GetByCIDR(cidr string) (*Config, error) {
 	confModel := ConfigModel{}
 
-	if result := r.db.Order("loaded desc").First(&confModel); result.Error != nil {
+	if result := r.db.First(&confModel, "cidr = ?", cidr); result.Error != nil {
 		if errors.Is(result.Error, gorm.ErrRecordNotFound) {
 			return nil, exception.ErrRecordNotFound
 		}
@@ -158,12 +140,6 @@ func modelToConfig(model *ConfigModel) (*Config, error) {
 		return nil, err
 	}
 
-	targets := []string{}
-
-	if err := json.Unmarshal([]byte(model.Targets.String()), &targets); err != nil {
-		return nil, err
-	}
-
 	return &Config{
 		ID:   model.ID,
 		Name: model.Name,
@@ -172,8 +148,7 @@ func modelToConfig(model *ConfigModel) (*Config, error) {
 			Identity:  model.SSH.Identity,
 			Overrides: overrides,
 		},
-		Targets: targets,
-		Loaded:  model.Loaded,
+		CIDR: model.CIDR,
 	}, nil
 }
 
@@ -184,12 +159,6 @@ func configToModel(conf *Config) (*ConfigModel, error) {
 		return nil, err
 	}
 
-	targetsBytes, err := json.Marshal(conf.Targets)
-
-	if err != nil {
-		return nil, err
-	}
-
 	return &ConfigModel{
 		ID:   conf.ID,
 		Name: conf.Name,
@@ -198,6 +167,6 @@ func configToModel(conf *Config) (*ConfigModel, error) {
 			Identity:  conf.SSH.Identity,
 			Overrides: datatypes.JSON(overridesBytes),
 		},
-		Targets: datatypes.JSON(targetsBytes),
+		CIDR: conf.CIDR,
 	}, nil
 }

internal/config/repo_test.go

@@ -64,7 +64,7 @@ func TestConfigSqliteRepo(t *testing.T) {
 					},
 				},
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.1/32",
 		}
 
 		newConf, err := repo.Create(conf)
@@ -84,7 +84,7 @@ func TestConfigSqliteRepo(t *testing.T) {
 				Identity:  newConf.SSH.Identity,
 				Overrides: newConf.SSH.Overrides,
 			},
-			Targets: newConf.Targets,
+			CIDR: newConf.CIDR,
 		}
 
 		updatedConf, err := repo.Update(toUpdate)
@@ -107,19 +107,19 @@ func TestConfigSqliteRepo(t *testing.T) {
 		conf1 := &config.Config{
 			Name: "test2",
 			SSH: config.SSHConfig{
-				User:     "test-user1",
-				Identity: "test-identity1",
+				User:     "test-user2",
+				Identity: "test-identity2",
 			},
-			Targets: []string{"target1"},
+			CIDR: "172.2.2.2/32",
 		}
 
 		conf2 := &config.Config{
 			Name: "test3",
 			SSH: config.SSHConfig{
-				User:     "test-user2",
-				Identity: "test-identity2",
+				User:     "test-user3",
+				Identity: "test-identity3",
 			},
-			Targets: []string{"target2"},
+			CIDR: "172.2.2.3/32",
 		}
 
 		_, err := repo.Create(conf1)
@@ -144,40 +144,36 @@ func TestConfigSqliteRepo(t *testing.T) {
 
 	})
 
-	t.Run("gets last loaded", func(st *testing.T) {
+	t.Run("gets by cidr", func(st *testing.T) {
 		conf1 := &config.Config{
 			Name: "test4",
 			SSH: config.SSHConfig{
-				User:     "test-user1",
-				Identity: "test-identity1",
+				User:     "test-user4",
+				Identity: "test-identity4",
 			},
-			Targets: []string{"target1"},
+			CIDR: "172.2.2.4/32",
 		}
 
 		conf2 := &config.Config{
 			Name: "test5",
 			SSH: config.SSHConfig{
-				User:     "test-user2",
-				Identity: "test-identity2",
+				User:     "test-user5",
+				Identity: "test-identity5",
 			},
-			Targets: []string{"target2"},
+			CIDR: "172.2.2.5/32",
 		}
 
-		newConf1, err := repo.Create(conf1)
-
-		assert.NoError(st, err)
-
-		_, err = repo.Create(conf2)
+		_, err := repo.Create(conf1)
 
 		assert.NoError(st, err)
 
-		err = repo.SetLastLoaded(newConf1.ID)
+		newConf2, err := repo.Create(conf2)
 
 		assert.NoError(st, err)
 
-		lastLoaded, err := repo.LastLoaded()
+		foundConf, err := repo.GetByCIDR("172.2.2.5/32")
 
 		assert.NoError(st, err)
-		assertEqualConf(st, newConf1, lastLoaded)
+		assertEqualConf(st, newConf2, foundConf)
 	})
 }

internal/config/service.go

@@ -20,6 +20,10 @@ func (s *ConfigService) GetAll() ([]*Config, error) {
 	return s.repo.GetAll()
 }
 
+func (s *ConfigService) GetByCIDR(cidr string) (*Config, error) {
+	return s.repo.GetByCIDR(cidr)
+}
+
 // Create creates a new config
 func (s *ConfigService) Create(conf *Config) (*Config, error) {
 	return s.repo.Create(conf)
@@ -34,13 +38,3 @@ func (s *ConfigService) Update(conf *Config) (*Config, error) {
 func (s *ConfigService) Delete(id int) error {
 	return s.repo.Delete(id)
 }
-
-// SetLasLoaded sets the "loaded" field for a config to current timestamp
-func (s *ConfigService) SetLastLoaded(id int) error {
-	return s.repo.SetLastLoaded(id)
-}
-
-// LastLoaded retrieves the most recently loaded config
-func (s *ConfigService) LastLoaded() (*Config, error) {
-	return s.repo.LastLoaded()
-}

internal/config/service_test.go

@@ -26,7 +26,7 @@ func TestConfigService(t *testing.T) {
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.2/32",
 		}
 
 		mockRepo.EXPECT().Get(expectedConfig.ID).Return(expectedConfig, nil)
@@ -44,7 +44,7 @@ func TestConfigService(t *testing.T) {
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.2/32",
 		}
 
 		conf2 := &config.Config{
@@ -53,7 +53,7 @@ func TestConfigService(t *testing.T) {
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.3/32",
 		}
 
 		expectedConfs := []*config.Config{conf1, conf2}
@@ -73,7 +73,7 @@ func TestConfigService(t *testing.T) {
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.2/32",
 		}
 
 		mockRepo.EXPECT().Create(conf).Return(conf, nil)
@@ -91,7 +91,7 @@ func TestConfigService(t *testing.T) {
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: "172.2.2.2/32",
 		}
 
 		mockRepo.EXPECT().Update(conf).Return(conf, nil)
@@ -112,19 +112,21 @@ func TestConfigService(t *testing.T) {
 		assert.NoError(st, err)
 	})
 
-	t.Run("gets last loaded config", func(st *testing.T) {
+	t.Run("gets last config by cidr", func(st *testing.T) {
+		cidr := "172.2.2.2/32"
+
 		expectedConfig := &config.Config{
 			Name: "test",
 			SSH: config.SSHConfig{
 				User:     "user",
 				Identity: "identity",
 			},
-			Targets: []string{"target"},
+			CIDR: cidr,
 		}
 
-		mockRepo.EXPECT().LastLoaded().Return(expectedConfig, nil)
+		mockRepo.EXPECT().GetByCIDR(cidr).Return(expectedConfig, nil)
 
-		foundConf, err := service.LastLoaded()
+		foundConf, err := service.GetByCIDR(cidr)
 
 		assert.NoError(st, err)
 		assert.Equal(st, expectedConfig, foundConf)

internal/core/core.go

@@ -111,10 +111,6 @@ func (c *Core) UpdateConfig(conf config.Config) error {
 		return err
 	}
 
-	if err := c.configService.SetLastLoaded(updated.ID); err != nil {
-		return err
-	}
-
 	c.conf = updated
 
 	return nil
@@ -128,10 +124,6 @@ func (c *Core) SetConfig(id int) error {
 		return err
 	}
 
-	if err := c.configService.SetLastLoaded(conf.ID); err != nil {
-		return err
-	}
-
 	c.conf = conf
 
 	return nil