.golangci.yaml

@@ -7,7 +7,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 run:
-  timeout: 3m # 1m by default
+  timeout: 3m0s # 1m by default
   modules-download-mode: readonly
 
 output:
@@ -23,15 +23,11 @@ issues:
     - path: _test\.go
       linters:
         - bodyclose
-        - dupl
   # '0' disables the following options.
   max-issues-per-linter: 0
   max-same-issues: 0
 
 linters-settings:
-  dupl:
-    # Tokens count to trigger issue, 150 by default.
-    threshold: 100
   errcheck:
     # Report about assignment of errors to blank identifier.
     check-blank: true
@@ -135,7 +131,6 @@ linters:
     - bodyclose
     - containedctx
     - copyloopvar
-    - dupl
     - dupword
     - durationcheck
     - errcheck

.license-scan-rules.json

@@ -4,6 +4,7 @@
     "BSD-2-Clause",
     "BSD-2-Clause-FreeBSD",
     "BSD-3-Clause",
+    "EPL-2.0",
     "ISC",
     "MIT",
     "MPL-2.0",

limes/resources/commitment.go

@@ -56,6 +56,9 @@ type Commitment struct {
 	// TransferStatus and TransferToken are only filled while the commitment is marked for transfer.
 	TransferStatus CommitmentTransferStatus `json:"transfer_status,omitempty"`
 	TransferToken  *string                  `json:"transfer_token,omitempty"`
+	// NotifyOnConfirm can only be set if ConfirmBy is filled.
+	// Used to send a mail notification at commitment confirmation.
+	NotifyOnConfirm bool `json:"notify_on_confirm,omitempty"`
 }
 
 // CommitmentRequest is the API representation of a *new* commitment as requested by a user.
@@ -66,6 +69,7 @@ type CommitmentRequest struct {
 	Amount           uint64                 `json:"amount"`
 	Duration         CommitmentDuration     `json:"duration"`
 	ConfirmBy        *limes.UnixEncodedTime `json:"confirm_by,omitempty"`
+	NotifyOnConfirm  bool                   `json:"notify_on_confirm,omitempty"`
 }
 
 // CommitmentConversionRule is the API representation of how commitments can be converted into a different resource.

liquid/info.go

@@ -63,12 +63,8 @@ type ResourceInfo struct {
 	// For example, the compute resource "cores" is countable, but the compute resource "ram" is measured, usually in MiB.
 	Unit Unit `json:"unit,omitempty"`
 
-	// How the resource reports usage (and capacity, if any).
-	//
-	// For backwards compatibility, it is currently acceptable to not provide this field.
-	// In this case, the fallback behavior is for Limes to decide between FlatResourceTopology and AZAwareResourceTopology based on actual reports.
-	// In the future, Limes will eventually reject ResourceInfo that do not specify a known ResourceTopology.
-	Topology ResourceTopology `json:"topology"`
+	// How the resource reports usage (and capacity, if any). This field is required, and must contain one of the valid enum variants defined in this package.
+	Topology Topology `json:"topology"`
 
 	// Whether the liquid reports capacity for this resource on the cluster level.
 	HasCapacity bool `json:"hasCapacity"`
@@ -89,40 +85,54 @@ type ResourceInfo struct {
 	Attributes json.RawMessage `json:"attributes,omitempty"`
 }
 
-// ResourceTopology describes how capacity and usage reported by a certain resource is structured.
+// Topology describes how capacity and usage reported by a certain resource is structured.
 // Type type appears in type ResourceInfo.
-type ResourceTopology string
+type Topology string
 
 const (
-	// FlatResourceTopology is a topology for resources that are not AZ-aware at all.
+	// FlatTopology is a topology for resources that are not AZ-aware at all.
 	// In reports for this resource, PerAZ must contain exactly one key: AvailabilityZoneAny.
 	// Any other entry, as well as the absence of AvailabilityZoneAny, will be considered an error by Limes.
 	//
 	// If the resource sets HasQuota = true, only a flat number will be given, and PerAZ will be null.
-	FlatResourceTopology ResourceTopology = "flat"
+	FlatTopology Topology = "flat"
 
-	// AZAwareResourceTopology is a topology for resources that can measure capacity and usage by AZ.
+	// AZAwareTopology is a topology for resources that can measure capacity and usage by AZ.
 	// In reports for this resource, PerAZ shall contain an entry for each AZ mentioned in the AllAZs key of the request.
 	// PerAZ may also include an entry for AvailabilityZoneUnknown as needed.
 	// Any other entry (including AvailabilityZoneAny) will be considered an error by Limes.
 	//
 	// If the resource sets "HasQuota = true", only a flat number will be given, and PerAZ will be null.
 	// This behavior matches the AZ-unawareness of quota in most OpenStack services.
-	AZAwareResourceTopology ResourceTopology = "az-aware"
+	AZAwareTopology Topology = "az-aware"
 
-	// AZSeparatedResourceTopology is like AZAwareResourceTopology, but quota is also AZ-aware.
-	// For resources with HasQuota = false, this behaves the same as AZAwareResourceTopology.
+	// AZSeparatedTopology is like AZAwareTopology, but quota is also AZ-aware.
+	// For resources with HasQuota = false, this behaves the same as AZAwareTopology.
 	//
 	// If the resource sets "HasQuota = true", quota requests will include the PerAZ breakdown.
 	// PerAZ will only contain quotas for actual AZs, not for AvailabilityZoneAny or AvailabilityZoneUnknown.
-	AZSeparatedResourceTopology ResourceTopology = "az-separated"
+	AZSeparatedTopology Topology = "az-separated"
+)
+
+// ResourceTopology is a synonym for Topology.
+//
+// Deprecated: Use Topology instead.
+type ResourceTopology = Topology
+
+const (
+	// Deprecated: Use FlatTopology instead.
+	FlatResourceTopology ResourceTopology = FlatTopology
+	// Deprecated: Use AZAwareTopology instead.
+	AZAwareResourceTopology ResourceTopology = AZAwareTopology
+	// Deprecated: Use AZSeparatedTopology instead.
+	AZSeparatedResourceTopology ResourceTopology = AZSeparatedTopology
 )
 
 // IsValid returns whether the given value is a part of the enum.
 // This can be used to check unmarshalled values.
-func (t ResourceTopology) IsValid() bool {
+func (t Topology) IsValid() bool {
 	switch t {
-	case FlatResourceTopology, AZAwareResourceTopology, AZSeparatedResourceTopology:
+	case FlatTopology, AZAwareTopology, AZSeparatedTopology:
 		return true
 	default:
 		return false
@@ -137,6 +147,9 @@ type RateInfo struct {
 	// For example, the storage rate "volume_creations" is countable, but the network rate "outbound_transfer" is measured, e.g. in bytes.
 	Unit Unit `json:"unit,omitempty"`
 
+	// How the rate reports usage. This field is required, and must contain one of the valid enum variants defined in this package.
+	Topology Topology `json:"topology"`
+
 	// Whether the liquid reports usage for this rate on the project level.
 	// This must currently be true because there is no other reason for a rate to exist.
 	// This requirement may be relaxed in the future, if LIQUID starts modelling rate limits and there are rates that have limits, but no usage tracking.

liquid/overcommit_factor_test.go

@@ -39,7 +39,7 @@ func TestOvercommitFactor(t *testing.T) {
 
 	// ApplyTo is pretty straightforward, but I'd like some more test coverage for ApplyInReverseTo
 	for _, factor := range []OvercommitFactor{0, 1, 1.1, 1.2, 1.5, 2, 2.5, 3, 4} {
-		for raw := uint64(0); raw <= 100; raw++ {
+		for raw := range uint64(100) {
 			check(factor, raw, factor.ApplyTo(raw))
 		}
 	}

liquid/quota.go

@@ -31,11 +31,11 @@ type ServiceQuotaRequest struct {
 // ResourceQuotaRequest contains new quotas for a single resource.
 // It appears in type ServiceQuotaRequest.
 type ResourceQuotaRequest struct {
-	// For FlatResourceTopology and AZAwareResourceTopology, this is the only field that is filled, and PerAZ will be nil.
-	// For AZSeparatedResourceTopology, this contains the sum of the quotas across all AZs (for compatibility purposes).
+	// For FlatTopology and AZAwareTopology, this is the only field that is filled, and PerAZ will be nil.
+	// For AZSeparatedTopology, this contains the sum of the quotas across all AZs (for compatibility purposes).
 	Quota uint64 `json:"quota"`
 
-	// PerAZ will only be filled for AZSeparatedResourceTopology.
+	// PerAZ will only be filled for AZSeparatedTopology.
 	PerAZ map[AvailabilityZone]AZResourceQuotaRequest `json:"perAZ,omitempty"`
 }
 

liquid/report_capacity.go

@@ -41,7 +41,7 @@ type ResourceDemand struct {
 	OvercommitFactor OvercommitFactor `json:"overcommitFactor,omitempty"`
 
 	// The actual demand values are AZ-aware.
-	// The keys that can be expected in this map depend on the chosen ResourceTopology.
+	// The keys that can be expected in this map depend on the chosen Topology.
 	PerAZ map[AvailabilityZone]ResourceDemandInAZ `json:"perAZ"`
 }
 
@@ -77,8 +77,8 @@ type ServiceCapacityReport struct {
 // ResourceCapacityReport contains capacity data for a resource.
 // It appears in type ServiceCapacityReport.
 type ResourceCapacityReport struct {
-	// The keys that are allowed in this map depend on the chosen ResourceTopology.
-	// See documentation on ResourceTopology enum variants for details.
+	// The keys that are allowed in this map depend on the chosen Topology.
+	// See documentation on Topology enum variants for details.
 	PerAZ map[AvailabilityZone]*AZResourceCapacityReport `json:"perAZ"`
 }
 

liquid/report_usage.go

@@ -77,12 +77,12 @@ type ResourceUsageReport struct {
 	//   - If the project has no usage in this resource, Limes will hide this resource from project reports.
 	Forbidden bool `json:"forbidden"`
 
-	// This shall be null if and only if the resource is declared with "HasQuota = false" or with AZSeparatedResourceTopology.
+	// This shall be null if and only if the resource is declared with "HasQuota = false" or with AZSeparatedTopology.
 	// A negative value, usually -1, indicates "infinite quota" (i.e., the absence of a quota).
 	Quota *int64 `json:"quota,omitempty"`
 
-	// The keys that are allowed in this map depend on the chosen ResourceTopology.
-	// See documentation on ResourceTopology enum variants for details.
+	// The keys that are allowed in this map depend on the chosen Topology.
+	// See documentation on Topology enum variants for details.
 	//
 	// Tip: When filling this by starting from a non-AZ-aware usage number that is later broken down with AZ-aware data, use func PrepareForBreakdownInto.
 	PerAZ map[AvailabilityZone]*AZResourceUsageReport `json:"perAZ"`
@@ -102,7 +102,7 @@ type AZResourceUsageReport struct {
 	// It is not allowed to report 5 GiB as Usage in this situation, since the 50 GiB value is used when judging whether the Quota fits.
 	PhysicalUsage *uint64 `json:"physicalUsage,omitempty"`
 
-	// This shall be non-null if and only if the resource is declared with AZSeparatedResourceTopology.
+	// This shall be non-null if and only if the resource is declared with AZSeparatedTopology.
 	// A negative value, usually -1, indicates "infinite quota" (i.e., the absence of a quota).
 	Quota *int64 `json:"quota,omitempty"`
 
@@ -150,8 +150,8 @@ func (r *ResourceUsageReport) AddLocalizedUsage(az AvailabilityZone, usage uint6
 // RateUsageReport contains usage data for a rate in a single project.
 // It appears in type ServiceUsageReport.
 type RateUsageReport struct {
-	// The keys that are allowed in this map depend on the chosen ResourceTopology.
-	// See documentation on ResourceTopology enum variants for details.
+	// The keys that are allowed in this map depend on the chosen Topology.
+	// See documentation on Topology enum variants for details.
 	PerAZ map[AvailabilityZone]*AZRateUsageReport `json:"perAZ"`
 }