Merge pull request #86 from sapcc/enable_revive

majewsky · web-flow · commit b2da5d83efdf · 2026-03-20T15:49:29.000+01:00
enable revive, run gomm, fix dostring lints
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -63,6 +63,7 @@ linters:
     - perfsprint
     - predeclared
     - rowserrcheck
+    - revive
     - sqlclosecheck
     - staticcheck
     - unconvert
@@ -159,6 +160,12 @@ linters:
     perfsprint:
       # modernize generates nicer fix code
       concat-loop: false
+    revive:
+      rules:
+        - name: exported
+          arguments:
+            - checkPrivateReceivers
+            - disableChecksOnConstants
     staticcheck:
       dot-import-whitelist:
         - github.com/majewsky/gg/option
diff --git a/Makefile.maker.yaml b/Makefile.maker.yaml
@@ -5,6 +5,11 @@ metadata:
 
 golangciLint:
   createConfig: true
+  reviveRules:
+    - name: exported
+      arguments:
+        - checkPrivateReceivers
+        - disableChecksOnConstants
 
 githubWorkflow:
   ci:
diff --git a/castellum/assets.go b/castellum/assets.go
@@ -33,7 +33,7 @@ type StandaloneOperation struct {
 	AssetID     string `json:"asset_id,omitempty"`
 }
 
-// StandaloneOperation is the API representation for a pending or finished
+// Operation is the API representation for a pending or finished
 // resize operation when the operation appears within its respective asset.
 type Operation struct {
 	State     OperationState                `json:"state"`
diff --git a/deployevent/deployevent.go b/deployevent/deployevent.go
@@ -85,7 +85,7 @@ type HelmRelease struct {
 	DurationSeconds *uint64    `json:"duration,omitempty"`
 }
 
-// ActiveDirectory appears in type Event. It describes a deployment of Active
+// ActiveDirectoryDeployment appears in type Event. It describes a deployment of Active
 // Directory to one of our Windows servers.
 type ActiveDirectoryDeployment struct {
 	Landscape string  `json:"landscape"` // e.g. "dev" or "prod"
diff --git a/internal/clone/clone.go b/internal/clone/clone.go
@@ -4,6 +4,7 @@
 // Package clone contains helper functions for implementing deep clones.
 package clone
 
+// Cloneable is an interface for types that can be cloned by implementing a Clone() method.
 type Cloneable[Self any] interface {
 	Clone() Self
 }
diff --git a/internal/testhelper/testhelper.go b/internal/testhelper/testhelper.go
@@ -11,13 +11,15 @@ import (
 	"testing"
 )
 
+// AssertNoErr fails the test if the provided error is not nil.
 func AssertNoErr(t *testing.T, err error) {
 	t.Helper()
 	if err != nil {
 		t.Errorf("unexpected error: %s", err.Error())
 	}
 }
 
+// AssertErr fails the test if the provided error is nil.
 func AssertErr(t *testing.T, expected string, actual error) {
 	t.Helper()
 	switch {
@@ -29,6 +31,7 @@ func AssertErr(t *testing.T, expected string, actual error) {
 	}
 }
 
+// CheckEquals fails the test if a simple equal check between expected and actual fails.
 func CheckEquals[V comparable](t *testing.T, expected, actual V) {
 	t.Helper()
 	if expected != actual {
@@ -37,6 +40,7 @@ func CheckEquals[V comparable](t *testing.T, expected, actual V) {
 	}
 }
 
+// CheckDeepEquals fails the test if a reflect.DeepEqual check between expected and actual fails.
 func CheckDeepEquals(t *testing.T, expected, actual any) {
 	t.Helper()
 	if !reflect.DeepEqual(expected, actual) {
@@ -45,6 +49,8 @@ func CheckDeepEquals(t *testing.T, expected, actual any) {
 	}
 }
 
+// CheckJSONEquals fails the test if a reflect.DeepEqual check between the marshalled actual value
+// and the expectedJSON fails.
 func CheckJSONEquals(t *testing.T, expectedJSON string, actual any) {
 	t.Helper()
 	actualJSON, err := json.Marshal(actual)
@@ -58,6 +64,7 @@ func CheckJSONEquals(t *testing.T, expectedJSON string, actual any) {
 	}
 }
 
+// decodeJSON is a convenience wrapper around json.Marshal and fails the test if an error occurs.
 func decodeJSON(t *testing.T, buf []byte) (data any) {
 	t.Helper()
 	err := json.Unmarshal(buf, &data)
diff --git a/limes/rates/input.go b/limes/rates/input.go
@@ -14,7 +14,7 @@ import (
 // This type is used to serialize JSON request bodies in PUT requests on projects.
 type RateRequest map[limes.ServiceType]ServiceRequest
 
-// ServiceQuotaRequest contains new rate limit values for rates in a single
+// ServiceRequest contains new rate limit values for rates in a single
 // service. This type appears in type RateRequest.
 type ServiceRequest map[RateName]RateLimitRequest
 
diff --git a/limes/rates/marshal.go b/limes/rates/marshal.go
@@ -8,26 +8,40 @@ import (
 	"github.com/sapcc/go-api-declarations/limes"
 )
 
-func (r ClusterRateReports) MarshalJSON() ([]byte, error)    { return marshal.MapAsList(r) }
+// MarshalJSON implements the json.Marshaler interface.
+func (r ClusterRateReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
 func (s ClusterServiceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(s) }
-func (r ProjectRateReports) MarshalJSON() ([]byte, error)    { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (r ProjectRateReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
 func (s ProjectServiceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(s) }
 
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *ClusterRateReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *ClusterRateReport) RateName { return r.Name })
 	*r = ClusterRateReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (s *ClusterServiceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(s *ClusterServiceReport) limes.ServiceType { return s.Type })
 	*s = ClusterServiceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *ProjectRateReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *ProjectRateReport) RateName { return r.Name })
 	*r = ProjectRateReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (s *ProjectServiceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(s *ProjectServiceReport) limes.ServiceType { return s.Type })
 	*s = ProjectServiceReports(m)
diff --git a/limes/resources/marshal.go b/limes/resources/marshal.go
@@ -8,44 +8,70 @@ import (
 	"github.com/sapcc/go-api-declarations/limes"
 )
 
+// MarshalJSON implements the json.Marshaler interface.
 func (r ClusterAvailabilityZoneReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
-func (r ClusterResourceReports) MarshalJSON() ([]byte, error)         { return marshal.MapAsList(r) }
-func (s ClusterServiceReports) MarshalJSON() ([]byte, error)          { return marshal.MapAsList(s) }
-func (r DomainResourceReports) MarshalJSON() ([]byte, error)          { return marshal.MapAsList(r) }
-func (s DomainServiceReports) MarshalJSON() ([]byte, error)           { return marshal.MapAsList(s) }
-func (r ProjectResourceReports) MarshalJSON() ([]byte, error)         { return marshal.MapAsList(r) }
-func (s ProjectServiceReports) MarshalJSON() ([]byte, error)          { return marshal.MapAsList(s) }
 
+// MarshalJSON implements the json.Marshaler interface.
+func (r ClusterResourceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (s ClusterServiceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(s) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (r DomainResourceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (s DomainServiceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(s) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (r ProjectResourceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(r) }
+
+// MarshalJSON implements the json.Marshaler interface.
+func (s ProjectServiceReports) MarshalJSON() ([]byte, error) { return marshal.MapAsList(s) }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *ClusterAvailabilityZoneReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *ClusterAvailabilityZoneReport) limes.AvailabilityZone { return r.Name })
 	*r = ClusterAvailabilityZoneReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *ClusterResourceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *ClusterResourceReport) ResourceName { return r.Name })
 	*r = ClusterResourceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (s *ClusterServiceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(s *ClusterServiceReport) limes.ServiceType { return s.Type })
 	*s = ClusterServiceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *DomainResourceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *DomainResourceReport) ResourceName { return r.Name })
 	*r = DomainResourceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (s *DomainServiceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(s *DomainServiceReport) limes.ServiceType { return s.Type })
 	*s = DomainServiceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (r *ProjectResourceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(r *ProjectResourceReport) ResourceName { return r.Name })
 	*r = ProjectResourceReports(m)
 	return err
 }
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
 func (s *ProjectServiceReports) UnmarshalJSON(buf []byte) error {
 	m, err := marshal.MapFromList(buf, func(s *ProjectServiceReport) limes.ServiceType { return s.Type })
 	*s = ProjectServiceReports(m)
diff --git a/limes/resources/report_cluster.go b/limes/resources/report_cluster.go
@@ -95,6 +95,6 @@ type ClusterResourceReports map[ResourceName]*ClusterResourceReport
 // using a map, but serializes to JSON as a list.
 type ClusterAvailabilityZoneReports map[limes.AvailabilityZone]*ClusterAvailabilityZoneReport
 
-// ClusterAZResourceReport is a substructure of ClusterResourceReport that breaks
+// ClusterAZResourceReports is a substructure of ClusterResourceReport that breaks
 // down capacity and usage data for a single resource by availability zone.
 type ClusterAZResourceReports map[limes.AvailabilityZone]*ClusterAZResourceReport
diff --git a/limes/resources/report_domain.go b/limes/resources/report_domain.go
@@ -65,6 +65,6 @@ type DomainServiceReports map[limes.ServiceType]*DomainServiceReport
 // to JSON as a list.
 type DomainResourceReports map[ResourceName]*DomainResourceReport
 
-// DomainAZResourceReport is a substructure of DomainResourceReport that breaks
+// DomainAZResourceReports is a substructure of DomainResourceReport that breaks
 // down quota and usage data for a single resource by availability zone.
 type DomainAZResourceReports map[limes.AvailabilityZone]*DomainAZResourceReport
diff --git a/limes/resources/report_project.go b/limes/resources/report_project.go
@@ -60,6 +60,8 @@ type ProjectAZResourceReport struct {
 	Subresources       json.RawMessage   `json:"subresources,omitempty"`
 }
 
+// HistoricalReport provides information about historical data and
+// appears in type ProjectAZResourceReport.
 type HistoricalReport struct {
 	MinUsage uint64             `json:"min_usage,omitempty"`
 	MaxUsage uint64             `json:"max_usage,omitempty"`
@@ -74,6 +76,6 @@ type ProjectServiceReports map[limes.ServiceType]*ProjectServiceReport
 // to JSON as a list.
 type ProjectResourceReports map[ResourceName]*ProjectResourceReport
 
-// ProjectAZResourceReport is a substructure of ProjectResourceReport that breaks
+// ProjectAZResourceReports is a substructure of ProjectResourceReport that breaks
 // down quota and usage data for a single resource by availability zone.
 type ProjectAZResourceReports map[limes.AvailabilityZone]*ProjectAZResourceReport

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ type StandaloneOperation struct {`
`33`	`33`	AssetID string `json:"asset_id,omitempty"`
`34`	`34`	`}`
`35`	`35`
`36`		`-// StandaloneOperation is the API representation for a pending or finished`
	`36`	`+// Operation is the API representation for a pending or finished`
`37`	`37`	`// resize operation when the operation appears within its respective asset.`
`38`	`38`	`type Operation struct {`
`39`	`39`	State OperationState `json:"state"`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ type HelmRelease struct {`
`85`	`85`	DurationSeconds *uint64 `json:"duration,omitempty"`
`86`	`86`	`}`
`87`	`87`
`88`		`-// ActiveDirectory appears in type Event. It describes a deployment of Active`
	`88`	`+// ActiveDirectoryDeployment appears in type Event. It describes a deployment of Active`
`89`	`89`	`// Directory to one of our Windows servers.`
`90`	`90`	`type ActiveDirectoryDeployment struct {`
`91`	`91`	Landscape string `json:"landscape"` // e.g. "dev" or "prod"
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`// Package clone contains helper functions for implementing deep clones.`
`5`	`5`	`package clone`
`6`	`6`
	`7`	`+// Cloneable is an interface for types that can be cloned by implementing a Clone() method.`
`7`	`8`	`type Cloneable[Self any] interface {`
`8`	`9`	`Clone() Self`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,15 @@ import (`
`11`	`11`	`"testing"`
`12`	`12`	`)`
`13`	`13`
	`14`	`+// AssertNoErr fails the test if the provided error is not nil.`
`14`	`15`	`func AssertNoErr(t *testing.T, err error) {`
`15`	`16`	`t.Helper()`
`16`	`17`	`if err != nil {`
`17`	`18`	`t.Errorf("unexpected error: %s", err.Error())`
`18`	`19`	`}`
`19`	`20`	`}`
`20`	`21`
	`22`	`+// AssertErr fails the test if the provided error is nil.`
`21`	`23`	`func AssertErr(t *testing.T, expected string, actual error) {`
`22`	`24`	`t.Helper()`
`23`	`25`	`switch {`
`@@ -29,6 +31,7 @@ func AssertErr(t *testing.T, expected string, actual error) {`
`29`	`31`	`}`
`30`	`32`	`}`
`31`	`33`
	`34`	`+// CheckEquals fails the test if a simple equal check between expected and actual fails.`
`32`	`35`	`func CheckEquals[V comparable](t *testing.T, expected, actual V) {`
`33`	`36`	`t.Helper()`
`34`	`37`	`if expected != actual {`
`@@ -37,6 +40,7 @@ func CheckEquals[V comparable](t *testing.T, expected, actual V) {`
`37`	`40`	`}`
`38`	`41`	`}`
`39`	`42`
	`43`	`+// CheckDeepEquals fails the test if a reflect.DeepEqual check between expected and actual fails.`
`40`	`44`	`func CheckDeepEquals(t *testing.T, expected, actual any) {`
`41`	`45`	`t.Helper()`
`42`	`46`	`if !reflect.DeepEqual(expected, actual) {`
`@@ -45,6 +49,8 @@ func CheckDeepEquals(t *testing.T, expected, actual any) {`
`45`	`49`	`}`
`46`	`50`	`}`
`47`	`51`
	`52`	`+// CheckJSONEquals fails the test if a reflect.DeepEqual check between the marshalled actual value`
	`53`	`+// and the expectedJSON fails.`
`48`	`54`	`func CheckJSONEquals(t *testing.T, expectedJSON string, actual any) {`
`49`	`55`	`t.Helper()`
`50`	`56`	`actualJSON, err := json.Marshal(actual)`
`@@ -58,6 +64,7 @@ func CheckJSONEquals(t *testing.T, expectedJSON string, actual any) {`
`58`	`64`	`}`
`59`	`65`	`}`
`60`	`66`
	`67`	`+// decodeJSON is a convenience wrapper around json.Marshal and fails the test if an error occurs.`
`61`	`68`	`func decodeJSON(t *testing.T, buf []byte) (data any) {`
`62`	`69`	`t.Helper()`
`63`	`70`	`err := json.Unmarshal(buf, &data)`