Naming.

metal-stack · Oct 9, 2023 · aca10db · aca10db
1 parent 500f1f5
commit aca10db
Show file tree

Hide file tree

Showing 19 changed files with 119 additions and 119 deletions.
diff --git a/cmd/metal-api/internal/issues/asn-uniqueness.go b/cmd/metal-api/internal/issues/asn-uniqueness.go
@@ -9,7 +9,7 @@ import (
 )
 
 const (
-	IssueTypeASNUniqueness IssueType = "asn-not-unique"
+	TypeASNUniqueness IssueType = "asn-not-unique"
 )
 
 type (
@@ -20,14 +20,14 @@ type (
 
 func (i *IssueASNUniqueness) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeASNUniqueness,
-		Severity:    IssueSeverityMinor,
+		Type:        TypeASNUniqueness,
+		Severity:    SeverityMinor,
 		Description: "The ASN is not unique (only impact on firewalls)",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#asn-not-unique",
 	}
 }
 
-func (i *IssueASNUniqueness) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueASNUniqueness) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	var (
 		machineASNs  = map[uint32]metal.Machines{}
 		overlaps     []string

diff --git a/cmd/metal-api/internal/issues/bmc-info-outdated.go b/cmd/metal-api/internal/issues/bmc-info-outdated.go
@@ -8,7 +8,7 @@ import (
 )
 
 const (
-	IssueTypeBMCInfoOutdated IssueType = "bmc-info-outdated"
+	TypeBMCInfoOutdated IssueType = "bmc-info-outdated"
 )
 
 type (
@@ -21,7 +21,7 @@ func (i *IssueBMCInfoOutdated) Details() string {
 	return i.details
 }
 
-func (i *IssueBMCInfoOutdated) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueBMCInfoOutdated) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	if m.IPMI.LastUpdated.IsZero() {
 		i.details = "machine ipmi has never been set"
 		return true
@@ -39,8 +39,8 @@ func (i *IssueBMCInfoOutdated) Evaluate(m metal.Machine, ec metal.ProvisioningEv
 
 func (*IssueBMCInfoOutdated) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeBMCInfoOutdated,
-		Severity:    IssueSeverityMajor,
+		Type:        TypeBMCInfoOutdated,
+		Severity:    SeverityMajor,
 		Description: "BMC has not been updated from either metal-hammer or metal-bmc",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#bmc-info-outdated",
 	}

diff --git a/cmd/metal-api/internal/issues/bmc-without-ip.go b/cmd/metal-api/internal/issues/bmc-without-ip.go
@@ -3,7 +3,7 @@ package issues
 import "github.com/metal-stack/metal-api/cmd/metal-api/internal/metal"
 
 const (
-	IssueTypeBMCWithoutIP IssueType = "bmc-without-ip"
+	TypeBMCWithoutIP IssueType = "bmc-without-ip"
 )
 
 type (
@@ -12,14 +12,14 @@ type (
 
 func (i *IssueBMCWithoutIP) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeBMCWithoutIP,
-		Severity:    IssueSeverityMajor,
+		Type:        TypeBMCWithoutIP,
+		Severity:    SeverityMajor,
 		Description: "BMC has no ip address",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#bmc-without-ip",
 	}
 }
 
-func (i *IssueBMCWithoutIP) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueBMCWithoutIP) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	return m.IPMI.Address == ""
 }
 

diff --git a/cmd/metal-api/internal/issues/bmc-without-mac.go b/cmd/metal-api/internal/issues/bmc-without-mac.go
@@ -3,7 +3,7 @@ package issues
 import "github.com/metal-stack/metal-api/cmd/metal-api/internal/metal"
 
 const (
-	IssueTypeBMCWithoutMAC IssueType = "bmc-without-mac"
+	TypeBMCWithoutMAC IssueType = "bmc-without-mac"
 )
 
 type (
@@ -12,14 +12,14 @@ type (
 
 func (i *IssueBMCWithoutMAC) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeBMCWithoutMAC,
-		Severity:    IssueSeverityMajor,
+		Type:        TypeBMCWithoutMAC,
+		Severity:    SeverityMajor,
 		Description: "BMC has no mac address",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#bmc-without-mac",
 	}
 }
 
-func (i *IssueBMCWithoutMAC) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueBMCWithoutMAC) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	return m.IPMI.MacAddress == ""
 }
 

diff --git a/cmd/metal-api/internal/issues/crash-loop.go b/cmd/metal-api/internal/issues/crash-loop.go
@@ -6,7 +6,7 @@ import (
 )
 
 const (
-	IssueTypeCrashLoop IssueType = "crashloop"
+	TypeCrashLoop IssueType = "crashloop"
 )
 
 type (
@@ -15,14 +15,14 @@ type (
 
 func (i *IssueCrashLoop) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeCrashLoop,
-		Severity:    IssueSeverityMajor,
+		Type:        TypeCrashLoop,
+		Severity:    SeverityMajor,
 		Description: "machine is in a provisioning crash loop (⭕)",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#crashloop",
 	}
 }
 
-func (i *IssueCrashLoop) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueCrashLoop) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	if ec.CrashLoop {
 		if pointer.FirstOrZero(ec.Events).Event == metal.ProvisioningEventWaiting {
 			// Machine which are waiting are not considered to have issues

diff --git a/cmd/metal-api/internal/issues/failed-machine-reclaim.go b/cmd/metal-api/internal/issues/failed-machine-reclaim.go
@@ -6,7 +6,7 @@ import (
 )
 
 const (
-	IssueTypeFailedMachineReclaim IssueType = "failed-machine-reclaim"
+	TypeFailedMachineReclaim IssueType = "failed-machine-reclaim"
 )
 
 type (
@@ -15,14 +15,14 @@ type (
 
 func (i *IssueFailedMachineReclaim) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeFailedMachineReclaim,
-		Severity:    IssueSeverityCritical,
+		Type:        TypeFailedMachineReclaim,
+		Severity:    SeverityCritical,
 		Description: "machine phones home but not allocated",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#failed-machine-reclaim",
 	}
 }
 
-func (i *IssueFailedMachineReclaim) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueFailedMachineReclaim) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	if ec.FailedMachineReclaim {
 		return true
 	}

diff --git a/cmd/metal-api/internal/issues/issues.go b/cmd/metal-api/internal/issues/issues.go
@@ -8,8 +8,8 @@ import (
 )
 
 type (
-	// IssueConfig contains configuration parameters for finding machine issues
-	IssueConfig struct {
+	// Config contains configuration parameters for finding machine issues
+	Config struct {
 		Machines           metal.Machines
 		EventContainers    metal.ProvisioningEventContainers
 		Severity           IssueSeverity
@@ -43,7 +43,7 @@ type (
 	issue interface {
 		// Evaluate decides whether a given machine has the machine issue.
 		// the third argument contains additional information that may be required for the issue evaluation
-		Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool
+		Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool
 		// Spec returns the issue spec of this issue.
 		Spec() *spec
 		// Details returns additional information on the issue after the evaluation.
@@ -84,7 +84,7 @@ func toIssue(i issue) Issue {
 	}
 }
 
-func FindIssues(c *IssueConfig) (MachineIssuesMap, error) {
+func FindIssues(c *Config) (MachineIssuesMap, error) {
 	if c.LastErrorThreshold == 0 {
 		c.LastErrorThreshold = DefaultLastErrorThreshold()
 	}
@@ -137,7 +137,7 @@ func (mis MachineIssues) Get(id string) *MachineWithIssues {
 	return nil
 }
 
-func (c *IssueConfig) includeIssue(t IssueType) bool {
+func (c *Config) includeIssue(t IssueType) bool {
 	issue, err := NewIssueFromType(t)
 	if err != nil {
 		return false

diff --git a/cmd/metal-api/internal/issues/issues_test.go b/cmd/metal-api/internal/issues/issues_test.go
@@ -58,7 +58,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "no partition",
-			only: []IssueType{IssueTypeNoPartition},
+			only: []IssueType{TypeNoPartition},
 			machines: func() metal.Machines {
 				noPartitionMachine := machineTemplate("no-partition")
 				noPartitionMachine.PartitionID = ""
@@ -87,7 +87,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "liveliness dead",
-			only: []IssueType{IssueTypeLivelinessDead},
+			only: []IssueType{TypeLivelinessDead},
 			machines: func() metal.Machines {
 				return metal.Machines{
 					machineTemplate("dead"),
@@ -116,7 +116,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "liveliness unknown",
-			only: []IssueType{IssueTypeLivelinessUnknown},
+			only: []IssueType{TypeLivelinessUnknown},
 			machines: func() metal.Machines {
 				return metal.Machines{
 					machineTemplate("unknown"),
@@ -145,7 +145,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "liveliness not available",
-			only: []IssueType{IssueTypeLivelinessNotAvailable},
+			only: []IssueType{TypeLivelinessNotAvailable},
 			machines: func() metal.Machines {
 				return metal.Machines{
 					machineTemplate("n/a"),
@@ -174,7 +174,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "failed machine reclaim",
-			only: []IssueType{IssueTypeFailedMachineReclaim},
+			only: []IssueType{TypeFailedMachineReclaim},
 			machines: func() metal.Machines {
 				failedOld := machineTemplate("failed-old")
 
@@ -220,7 +220,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "crashloop",
-			only: []IssueType{IssueTypeCrashLoop},
+			only: []IssueType{TypeCrashLoop},
 			machines: func() metal.Machines {
 				return metal.Machines{
 					machineTemplate("good"),
@@ -282,7 +282,7 @@ func TestFindIssues(t *testing.T) {
 		// },
 		{
 			name: "bmc without mac",
-			only: []IssueType{IssueTypeBMCWithoutMAC},
+			only: []IssueType{TypeBMCWithoutMAC},
 			machines: func() metal.Machines {
 				noMac := machineTemplate("no-mac")
 				noMac.IPMI.MacAddress = ""
@@ -314,7 +314,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "bmc without ip",
-			only: []IssueType{IssueTypeBMCWithoutIP},
+			only: []IssueType{TypeBMCWithoutIP},
 			machines: func() metal.Machines {
 				noIP := machineTemplate("no-ip")
 				noIP.IPMI.Address = ""
@@ -378,7 +378,7 @@ func TestFindIssues(t *testing.T) {
 		// },
 		{
 			name: "asn shared",
-			only: []IssueType{IssueTypeASNUniqueness},
+			only: []IssueType{TypeASNUniqueness},
 			machines: func() metal.Machines {
 				shared1 := machineTemplate("shared1")
 				shared1.Allocation = &metal.MachineAllocation{
@@ -448,7 +448,7 @@ func TestFindIssues(t *testing.T) {
 		},
 		{
 			name: "non distinct bmc ip",
-			only: []IssueType{IssueTypeNonDistinctBMCIP},
+			only: []IssueType{TypeNonDistinctBMCIP},
 			machines: func() metal.Machines {
 				bmc1 := machineTemplate("bmc1")
 				bmc1.IPMI.Address = "127.0.0.1"
@@ -496,7 +496,7 @@ func TestFindIssues(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			ms := tt.machines()
 
-			got, err := FindIssues(&IssueConfig{
+			got, err := FindIssues(&Config{
 				Machines:           ms,
 				EventContainers:    tt.eventContainers(),
 				Only:               tt.only,

diff --git a/cmd/metal-api/internal/issues/last-event-error.go b/cmd/metal-api/internal/issues/last-event-error.go
@@ -8,7 +8,7 @@ import (
 )
 
 const (
-	IssueTypeLastEventError IssueType = "last-event-error"
+	TypeLastEventError IssueType = "last-event-error"
 )
 
 type (
@@ -23,14 +23,14 @@ func DefaultLastErrorThreshold() time.Duration {
 
 func (i *IssueLastEventError) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeLastEventError,
-		Severity:    IssueSeverityMinor,
+		Type:        TypeLastEventError,
+		Severity:    SeverityMinor,
 		Description: "the machine had an error during the provisioning lifecycle",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#last-event-error",
 	}
 }
 
-func (i *IssueLastEventError) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueLastEventError) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	if c.LastErrorThreshold == 0 {
 		return false
 	}

diff --git a/cmd/metal-api/internal/issues/liveliness-dead.go b/cmd/metal-api/internal/issues/liveliness-dead.go
@@ -3,7 +3,7 @@ package issues
 import "github.com/metal-stack/metal-api/cmd/metal-api/internal/metal"
 
 const (
-	IssueTypeLivelinessDead IssueType = "liveliness-dead"
+	TypeLivelinessDead IssueType = "liveliness-dead"
 )
 
 type (
@@ -12,14 +12,14 @@ type (
 
 func (i *IssueLivelinessDead) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeLivelinessDead,
-		Severity:    IssueSeverityMajor,
+		Type:        TypeLivelinessDead,
+		Severity:    SeverityMajor,
 		Description: "the machine is not sending events anymore",
 		RefURL:      "https://docs.metal-stack.io/stable/installation/troubleshoot/#liveliness-dead",
 	}
 }
 
-func (i *IssueLivelinessDead) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueLivelinessDead) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	return ec.Liveliness.Is(string(metal.MachineLivelinessDead))
 }
 

diff --git a/cmd/metal-api/internal/issues/liveliness-not-available.go b/cmd/metal-api/internal/issues/liveliness-not-available.go
@@ -3,7 +3,7 @@ package issues
 import "github.com/metal-stack/metal-api/cmd/metal-api/internal/metal"
 
 const (
-	IssueTypeLivelinessNotAvailable IssueType = "liveliness-not-available"
+	TypeLivelinessNotAvailable IssueType = "liveliness-not-available"
 )
 
 type (
@@ -12,13 +12,13 @@ type (
 
 func (i *IssueLivelinessNotAvailable) Spec() *spec {
 	return &spec{
-		Type:        IssueTypeLivelinessNotAvailable,
-		Severity:    IssueSeverityMinor,
+		Type:        TypeLivelinessNotAvailable,
+		Severity:    SeverityMinor,
 		Description: "the machine liveliness is not available",
 	}
 }
 
-func (i *IssueLivelinessNotAvailable) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *IssueConfig) bool {
+func (i *IssueLivelinessNotAvailable) Evaluate(m metal.Machine, ec metal.ProvisioningEventContainer, c *Config) bool {
 	allowed := map[metal.MachineLiveliness]bool{
 		metal.MachineLivelinessAlive:   true,
 		metal.MachineLivelinessDead:    true,