Merge pull request #214 from flanksource/config-class-rename

feat: rename config_type to config_class

Author: yashmehrotra

Makefile

@@ -40,7 +40,6 @@ generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and
 resources: fmt manifests
 
 test: manifests generate fmt vet envtest ## Run tests.
-	go test ./... -coverprofile cover.out
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
 
 fmt:

api/v1/interface.go

@@ -53,7 +53,7 @@ const (
 // +kubebuilder:object:generate=false
 type AnalysisResult struct {
 	ExternalID    string
-	ExternalType  string
+	ConfigType    string
 	Summary       string         // Summary of the analysis
 	Analysis      map[string]any // Detailed metadata of the analysis
 	AnalysisType  AnalysisType   // Type of analysis, e.g. availability, compliance, cost, security, performance.
@@ -72,7 +72,7 @@ type AnalysisResult struct {
 func (t *AnalysisResult) ToConfigAnalysis() models.ConfigAnalysis {
 	return models.ConfigAnalysis{
 		ExternalID:    t.ExternalID,
-		ExternalType:  t.ExternalType,
+		ConfigType:    t.ConfigType,
 		Analyzer:      t.Analyzer,
 		Message:       strings.Join(t.Messages, ";"),
 		Severity:      string(t.Severity),
@@ -89,7 +89,7 @@ func (t *AnalysisResult) ToConfigAnalysis() models.ConfigAnalysis {
 // +kubebuilder:object:generate=false
 type ChangeResult struct {
 	ExternalID       string
-	ExternalType     string
+	ConfigType       string
 	ExternalChangeID string
 	Action           ChangeAction
 	ChangeType       string
@@ -102,7 +102,7 @@ type ChangeResult struct {
 }
 
 func (c ChangeResult) String() string {
-	return fmt.Sprintf("%s/%s: %s", c.ExternalType, c.ExternalID, c.ChangeType)
+	return fmt.Sprintf("%s/%s: %s", c.ConfigType, c.ExternalID, c.ChangeType)
 }
 
 func (result AnalysisResult) String() string {
@@ -163,11 +163,11 @@ func (s *ScrapeResults) AddChange(change ChangeResult) *ScrapeResults {
 	return s
 }
 
-func (s *ScrapeResults) Analysis(analyzer string, externalType string, id string) *AnalysisResult {
+func (s *ScrapeResults) Analysis(analyzer string, configType string, id string) *AnalysisResult {
 	result := AnalysisResult{
-		Analyzer:     analyzer,
-		ExternalType: externalType,
-		ExternalID:   id,
+		Analyzer:   analyzer,
+		ConfigType: configType,
+		ExternalID: id,
 	}
 	*s = append(*s, ScrapeResult{
 		AnalysisResult: &result,
@@ -187,13 +187,8 @@ type ScrapeResult struct {
 	CreatedAt           *time.Time          `json:"created_at,omitempty"`
 	DeletedAt           *time.Time          `json:"deleted_at,omitempty"`
 	LastModified        time.Time           `json:"last_modified,omitempty"`
-	Type                string              `json:"type,omitempty"`
-	ExternalType        string              `json:"external_type,omitempty"`
-	Account             string              `json:"account,omitempty"`
-	Network             string              `json:"network,omitempty"`
-	Subnet              string              `json:"subnet,omitempty"`
-	Region              string              `json:"region,omitempty"`
-	Zone                string              `json:"zone,omitempty"`
+	ConfigClass         string              `json:"config_class,omitempty"`
+	Type                string              `json:"config_type,omitempty"`
 	Name                string              `json:"name,omitempty"`
 	Namespace           string              `json:"namespace,omitempty"`
 	ID                  string              `json:"id,omitempty"`
@@ -211,7 +206,7 @@ type ScrapeResult struct {
 	Ignore              []string            `json:"-"`
 	Action              string              `json:",omitempty"`
 	ParentExternalID    string              `json:"-"`
-	ParentExternalType  string              `json:"-"`
+	ParentType          string              `json:"-"`
 }
 
 func NewScrapeResult(base BaseScraper) *ScrapeResult {
@@ -236,12 +231,7 @@ func (s ScrapeResult) Clone(config interface{}) ScrapeResult {
 	clone := ScrapeResult{
 		LastModified: s.LastModified,
 		Aliases:      s.Aliases,
-		Type:         s.Type,
-		Account:      s.Account,
-		Network:      s.Network,
-		Subnet:       s.Subnet,
-		Region:       s.Region,
-		Zone:         s.Zone,
+		ConfigClass:  s.ConfigClass,
 		Name:         s.Name,
 		Namespace:    s.Namespace,
 		ID:           s.ID,
@@ -256,7 +246,7 @@ func (s ScrapeResult) Clone(config interface{}) ScrapeResult {
 }
 
 func (r ScrapeResult) String() string {
-	s := fmt.Sprintf("%s/%s (%s)", r.Type, r.Name, r.ID)
+	s := fmt.Sprintf("%s/%s (%s)", r.ConfigClass, r.Name, r.ID)
 
 	if len(r.Changes) > 0 {
 		s += fmt.Sprintf(" changes=%d", len(r.Changes))

api/v1/types.go

@@ -47,22 +47,22 @@ func (c ConfigScraper) IsDebug() bool {
 }
 
 type ExternalID struct {
-	ExternalType string
-	ExternalID   []string
+	ConfigType string
+	ExternalID []string
 }
 
 func (e ExternalID) String() string {
-	return fmt.Sprintf("%s/%s", e.ExternalType, strings.Join(e.ExternalID, ","))
+	return fmt.Sprintf("%s/%s", e.ConfigType, strings.Join(e.ExternalID, ","))
 }
 
 func (e ExternalID) IsEmpty() bool {
-	return e.ExternalType == "" && len(e.ExternalID) == 0
+	return e.ConfigType == "" && len(e.ExternalID) == 0
 }
 
 func (e ExternalID) CacheKey() string {
-	return fmt.Sprintf("external_id:%s:%s", e.ExternalType, strings.Join(e.ExternalID, ","))
+	return fmt.Sprintf("external_id:%s:%s", e.ConfigType, strings.Join(e.ExternalID, ","))
 }
 
 func (e ExternalID) WhereClause(db *gorm.DB) *gorm.DB {
-	return db.Where("external_type = ? AND external_id  @> ?", e.ExternalType, pq.StringArray(e.ExternalID))
+	return db.Where("type = ? AND external_id  @> ?", e.ConfigType, pq.StringArray(e.ExternalID))
 }

cmd/analyze.go

@@ -36,7 +36,7 @@ var Analyze = &cobra.Command{
 				logger.Fatalf("Could not unmarshall %s: %v", path, err)
 			}
 
-			if obj.Type == "EC2Instance" {
+			if obj.ConfigClass == "EC2Instance" {
 				nested, _ := json.Marshal(obj.Config)
 				instance := aws.Instance{}
 				if err := json.Unmarshal(nested, &instance); err != nil {

cmd/run.go

@@ -60,10 +60,10 @@ var Run = &cobra.Command{
 
 func exportResource(resource v1.ScrapeResult, filename, outputDir string) error {
 	if resource.Config == nil && resource.AnalysisResult != nil {
-		logger.Debugf("%s/%s => %s", resource.ExternalType, resource.ID, *resource.AnalysisResult)
+		logger.Debugf("%s/%s => %s", resource.Type, resource.ID, *resource.AnalysisResult)
 		return nil
 	}
-	outputPath := path.Join(outputDir, resource.Type, resource.Name+".json")
+	outputPath := path.Join(outputDir, resource.ConfigClass, resource.Name+".json")
 	_ = os.MkdirAll(path.Dir(outputPath), 0755)
 	data, err := json.MarshalIndent(resource, "", "  ")
 	if err != nil {

db/config.go

@@ -19,7 +19,7 @@ import (
 // GetConfigItem returns a single config item result
 func GetConfigItem(extType, extID string) (*models.ConfigItem, error) {
 	ci := models.ConfigItem{}
-	tx := db.Limit(1).Find(&ci, "external_type = ? and external_id  @> ?", extType, pq.StringArray{extID})
+	tx := db.Limit(1).Find(&ci, "type = ? and external_id  @> ?", extType, pq.StringArray{extID})
 	if tx.RowsAffected == 0 {
 		return nil, nil
 	}
@@ -59,7 +59,7 @@ func FindConfigItemID(externalID v1.ExternalID) (*string, error) {
 
 func FindConfigItemFromType(configType string) ([]models.ConfigItem, error) {
 	var ci []models.ConfigItem
-	err := db.Find(&ci, "external_type = @type OR config_type = @type", sql.Named("type", configType)).Error
+	err := db.Find(&ci, "type = @type OR config_class = @type", sql.Named("type", configType)).Error
 	return ci, err
 }
 
@@ -143,19 +143,14 @@ func NewConfigItemFromResult(result v1.ScrapeResult) (*models.ConfigItem, error)
 	}
 
 	ci := &models.ConfigItem{
-		ExternalID:   append(result.Aliases, result.ID),
-		ID:           result.ID,
-		ConfigType:   result.Type,
-		ExternalType: &result.ExternalType,
-		Account:      &result.Account,
-		Region:       &result.Region,
-		Zone:         &result.Zone,
-		Network:      &result.Network,
-		Subnet:       &result.Subnet,
-		Name:         &result.Name,
-		Source:       &result.Source,
-		Tags:         &result.Tags,
-		Config:       &dataStr,
+		ExternalID:  append(result.Aliases, result.ID),
+		ID:          result.ID,
+		ConfigClass: result.ConfigClass,
+		Type:        &result.Type,
+		Name:        &result.Name,
+		Source:      &result.Source,
+		Tags:        &result.Tags,
+		Config:      &dataStr,
 	}
 
 	if result.CreatedAt != nil {
@@ -166,10 +161,10 @@ func NewConfigItemFromResult(result v1.ScrapeResult) (*models.ConfigItem, error)
 		ci.DeletedAt = result.DeletedAt
 	}
 
-	if result.ParentExternalID != "" && result.ParentExternalType != "" {
+	if result.ParentExternalID != "" && result.ParentType != "" {
 		parentExternalID := v1.ExternalID{
-			ExternalType: result.ParentExternalType,
-			ExternalID:   []string{result.ParentExternalID},
+			ConfigType: result.ParentType,
+			ExternalID: []string{result.ParentExternalID},
 		}
 
 		var err error

db/models/config_change.go

@@ -13,7 +13,7 @@ import (
 // ConfigChange represents the config change database table
 type ConfigChange struct {
 	ExternalID       string     `gorm:"-"`
-	ExternalType     string     `gorm:"-"`
+	ConfigType       string     `gorm:"-"`
 	ExternalChangeId string     `gorm:"column:external_change_id" json:"external_change_id"`
 	ID               string     `gorm:"primaryKey;unique_index;not null;column:id" json:"id"`
 	ConfigID         string     `gorm:"column:config_id;default:''" json:"config_id"`
@@ -28,19 +28,19 @@ type ConfigChange struct {
 
 func (c ConfigChange) GetExternalID() v1.ExternalID {
 	return v1.ExternalID{
-		ExternalID:   []string{c.ExternalID},
-		ExternalType: c.ExternalType,
+		ExternalID: []string{c.ExternalID},
+		ConfigType: c.ConfigType,
 	}
 }
 
 func (c ConfigChange) String() string {
-	return fmt.Sprintf("[%s/%s] %s", c.ExternalType, c.ExternalID, c.ChangeType)
+	return fmt.Sprintf("[%s/%s] %s", c.ConfigType, c.ExternalID, c.ChangeType)
 }
 
 func NewConfigChangeFromV1(result v1.ScrapeResult, change v1.ChangeResult) *ConfigChange {
 	_change := ConfigChange{
 		ExternalID:       change.ExternalID,
-		ExternalType:     change.ExternalType,
+		ConfigType:       change.ConfigType,
 		ExternalChangeId: change.ExternalChangeID,
 		ChangeType:       change.ChangeType,
 		Source:           change.Source,
@@ -53,8 +53,8 @@ func NewConfigChangeFromV1(result v1.ScrapeResult, change v1.ChangeResult) *Conf
 	if _change.ExternalID == "" {
 		_change.ExternalID = result.ID
 	}
-	if _change.ExternalType == "" {
-		_change.ExternalType = result.ExternalType
+	if _change.ConfigType == "" {
+		_change.ConfigType = result.Type
 	}
 
 	return &_change

db/models/config_item.go

@@ -14,17 +14,13 @@ import (
 type ConfigItem struct {
 	ID            string            `gorm:"primaryKey;unique_index;not null;column:id" json:"id"  `
 	ScraperID     *uuid.UUID        `gorm:"column:scraper_id;default:null" json:"scraper_id,omitempty"`
-	ConfigType    string            `gorm:"column:config_type;default:''" json:"config_type"  `
+	ConfigClass   string            `gorm:"column:config_class;default:''" json:"config_class"  `
 	ExternalID    pq.StringArray    `gorm:"column:external_id;type:[]text" json:"external_id,omitempty"  `
-	ExternalType  *string           `gorm:"column:external_type;default:null" json:"external_type,omitempty"  `
+	Type          *string           `gorm:"column:type;default:null" json:"type,omitempty"  `
 	Name          *string           `gorm:"column:name;default:null" json:"name,omitempty"  `
 	Namespace     *string           `gorm:"column:namespace;default:null" json:"namespace,omitempty"  `
 	Description   *string           `gorm:"column:description;default:null" json:"description,omitempty"  `
 	Account       *string           `gorm:"column:account;default:null" json:"account,omitempty"  `
-	Region        *string           `gorm:"-" json:"region,omitempty"  `
-	Zone          *string           `gorm:"-" json:"zone,omitempty"  `
-	Network       *string           `gorm:"-" json:"network,omitempty"  `
-	Subnet        *string           `gorm:"-" json:"subnet,omitempty"  `
 	Config        *string           `gorm:"column:config;default:null" json:"config,omitempty"  `
 	Source        *string           `gorm:"column:source;default:null" json:"source,omitempty"  `
 	ParentID      *string           `gorm:"column:parent_id;default:null" json:"parent_id,omitempty"`
@@ -40,7 +36,7 @@ type ConfigItem struct {
 }
 
 func (ci ConfigItem) String() string {
-	return fmt.Sprintf("%s/%s", ci.ConfigType, ci.ID)
+	return fmt.Sprintf("%s/%s", ci.ConfigClass, ci.ID)
 }
 
 func (ci ConfigItem) ConfigJSONStringMap() (map[string]interface{}, error) {

db/update.go

@@ -31,14 +31,14 @@ func deleteChangeHandler(ctx *v1.ScrapeContext, change v1.ChangeResult) error {
 	configs := []models.ConfigItem{}
 	tx := db.Model(&configs).
 		Clauses(clause.Returning{Columns: []clause.Column{{Name: "id"}}}).
-		Where("external_type = ? and external_id  @> ?", change.ExternalType, pq.StringArray{change.ExternalID}).
+		Where("type = ? and external_id  @> ?", change.ConfigType, pq.StringArray{change.ExternalID}).
 		Update("deleted_at", deletedAt)
 
 	if tx.Error != nil {
-		return errors.Wrapf(tx.Error, "unable to delete config item %s/%s", change.ExternalType, change.ExternalID)
+		return errors.Wrapf(tx.Error, "unable to delete config item %s/%s", change.ConfigType, change.ExternalID)
 	}
 	if tx.RowsAffected == 0 || len(configs) == 0 {
-		logger.Warnf("Attempt to delete non-existent config item %s/%s", change.ExternalType, change.ExternalID)
+		logger.Warnf("Attempt to delete non-existent config item %s/%s", change.ConfigType, change.ExternalID)
 		return nil
 	}
 
@@ -84,7 +84,7 @@ func getParentPath(parentExternalUID v1.ExternalID) string {
 }
 
 func updateCI(ctx *v1.ScrapeContext, ci models.ConfigItem) error {
-	existing, err := GetConfigItem(*ci.ExternalType, ci.ID)
+	existing, err := GetConfigItem(*ci.Type, ci.ID)
 	if err != nil && err != gorm.ErrRecordNotFound {
 		return errors.Wrapf(err, "unable to lookup existing config: %s", ci)
 	}
@@ -113,7 +113,7 @@ func updateCI(ctx *v1.ScrapeContext, ci models.ConfigItem) error {
 	if changes != nil {
 		err := db.Create(changes).Error
 		if nil == err {
-			logger.Infof("[%s/%s] detected changes", ci.ConfigType, ci.ExternalID[0])
+			logger.Infof("[%s/%s] detected changes", ci.ConfigClass, ci.ExternalID[0])
 		} else {
 			if IsUniqueConstraintPGErr(err) {
 				logger.Debugf("[%s] changes not stored. Another row with the same config_id & external_change_id exists.", ci)
@@ -143,7 +143,7 @@ func updateChange(ctx *v1.ScrapeContext, result *v1.ScrapeResult) error {
 
 		id, err := FindConfigItemID(change.GetExternalID())
 		if id == nil {
-			logger.Warnf("[%s/%s] unable to find config item for change: %v", change.ExternalType, change.ExternalID, change.ChangeType)
+			logger.Warnf("[%s/%s] unable to find config item for change: %v", change.ConfigType, change.ExternalID, change.ChangeType)
 			return nil
 		} else if err != nil {
 			return err
@@ -161,15 +161,15 @@ func updateChange(ctx *v1.ScrapeContext, result *v1.ScrapeResult) error {
 
 func updateAnalysis(ctx *v1.ScrapeContext, result *v1.ScrapeResult) error {
 	analysis := result.AnalysisResult.ToConfigAnalysis()
-	ci, err := GetConfigItem(analysis.ExternalType, analysis.ExternalID)
+	ci, err := GetConfigItem(analysis.ConfigType, analysis.ExternalID)
 	if ci == nil {
-		logger.Warnf("[%s/%s] unable to find config item for analysis: %+v", analysis.ExternalType, analysis.ExternalID, analysis)
+		logger.Warnf("[%s/%s] unable to find config item for analysis: %+v", analysis.ConfigType, analysis.ExternalID, analysis)
 		return nil
 	} else if err != nil {
 		return err
 	}
 
-	logger.Tracef("[%s/%s] ==> %s", analysis.ExternalType, analysis.ExternalID, analysis)
+	logger.Tracef("[%s/%s] ==> %s", analysis.ConfigType, analysis.ExternalID, analysis)
 	analysis.ConfigID = uuid.MustParse(ci.ID)
 	analysis.ID = uuid.MustParse(ulid.MustNew().AsUUID())
 

fixtures/expected/file-git.json

@@ -2,7 +2,7 @@
   "last_modified": "0001-01-01T00:00:00Z",
   "source": "github.com/flanksource/canary-checker/fixtures/minimal/http_pass_single.yaml",
   "id": "http-pass-single",
-  "type": "Canary",
+  "config_class": "Canary",
   "config": {
     "apiVersion": "canaries.flanksource.com/v1",
     "kind": "Canary",