Improve readability of Resources helper functions

Signed-off-by: tylerslaton <[email protected]>

Author: tylerslaton

pkg/apis/internal.admin.acorn.io/v1/resources.go

@@ -43,19 +43,28 @@ func (current *Resources) Add(incoming Resources) {
 
 // Remove will remove the resources of another Resources struct from the current one.
 func (current *Resources) Remove(incoming Resources, all bool) {
-	current.Apps -= incoming.Apps
-	current.Containers -= incoming.Containers
-	current.Jobs -= incoming.Jobs
-	current.Volumes -= incoming.Volumes
-	current.Images -= incoming.Images
-	current.Projects -= incoming.Projects
+	// Do not allow resources to go below 0
+	nonNegativeSubtract := func(currentVal, incomingVal int) int {
+		difference := currentVal - incomingVal
+		if difference < 0 {
+			difference = 0
+		}
+		return difference
+	}
+
+	current.Apps = nonNegativeSubtract(current.Apps, incoming.Apps)
+	current.Containers = nonNegativeSubtract(current.Containers, incoming.Containers)
+	current.Jobs = nonNegativeSubtract(current.Jobs, incoming.Jobs)
+	current.Volumes = nonNegativeSubtract(current.Volumes, incoming.Volumes)
+	current.Images = nonNegativeSubtract(current.Images, incoming.Images)
+	current.Projects = nonNegativeSubtract(current.Projects, incoming.Projects)
 
 	current.Memory.Sub(incoming.Memory)
 	current.CPU.Sub(incoming.CPU)
 
 	// Only remove persistent resources if all is true.
 	if all {
-		current.Secrets -= incoming.Secrets
+		current.Secrets = nonNegativeSubtract(current.Secrets, incoming.Secrets)
 		current.VolumeStorage.Sub(incoming.VolumeStorage)
 	}
 }
@@ -65,38 +74,33 @@ func (current *Resources) Remove(incoming Resources, all bool) {
 // an aggregated error will be returned with all exceeded resources.
 func (current *Resources) Fits(incoming Resources) error {
 	exceededResources := []string{}
-	if current.Apps <= incoming.Apps {
-		exceededResources = append(exceededResources, "Apps")
-	}
-	if current.Containers <= incoming.Containers {
-		exceededResources = append(exceededResources, "Containers")
-	}
-	if current.Jobs <= incoming.Jobs {
-		exceededResources = append(exceededResources, "Jobs")
-	}
-	if current.Volumes <= incoming.Volumes {
-		exceededResources = append(exceededResources, "Volumes")
-	}
-	if current.Secrets <= incoming.Secrets {
-		exceededResources = append(exceededResources, "Secrets")
-	}
-	if current.Images <= incoming.Images {
-		exceededResources = append(exceededResources, "Images")
-	}
-	if current.Projects <= incoming.Projects {
-		exceededResources = append(exceededResources, "Projects")
-	}
 
-	if current.VolumeStorage.Cmp(incoming.VolumeStorage) <= 0 {
-		exceededResources = append(exceededResources, "VolumeStorage")
-	}
-	if current.Memory.Cmp(incoming.Memory) <= 0 {
-		exceededResources = append(exceededResources, "Memory")
+	// Define function for checking int resources to keep code DRY
+	checkResource := func(resource string, currentVal, incomingVal int) {
+		if currentVal <= incomingVal {
+			exceededResources = append(exceededResources, resource)
+		}
 	}
-	if current.CPU.Cmp(incoming.CPU) <= 0 {
-		exceededResources = append(exceededResources, "Cpu")
+
+	// Define function for checking quantity resources to keep code DRY
+	checkQuantityResource := func(resource string, currentVal, incomingVal resource.Quantity) {
+		if currentVal.Cmp(incomingVal) <= 0 {
+			exceededResources = append(exceededResources, resource)
+		}
 	}
 
+	checkResource("Apps", current.Apps, incoming.Apps)
+	checkResource("Containers", current.Containers, incoming.Containers)
+	checkResource("Jobs", current.Jobs, incoming.Jobs)
+	checkResource("Volumes", current.Volumes, incoming.Volumes)
+	checkResource("Secrets", current.Secrets, incoming.Secrets)
+	checkResource("Images", current.Images, incoming.Images)
+	checkResource("Projects", current.Projects, incoming.Projects)
+
+	checkQuantityResource("VolumeStorage", current.VolumeStorage, incoming.VolumeStorage)
+	checkQuantityResource("Memory", current.Memory, incoming.Memory)
+	checkQuantityResource("Cpu", current.CPU, incoming.CPU)
+
 	// Build an aggregated error message for the exceeded resources
 	if len(exceededResources) > 0 {
 		return fmt.Errorf("quota would be exceeded for resources: %s", strings.Join(exceededResources, ", "))
@@ -105,41 +109,37 @@ func (current *Resources) Fits(incoming Resources) error {
 	return nil
 }
 
-// ToString will return a string representation of the Resources struct.
+// NonEmptyString will return a string representation of the non-empty
+// Resources within the struct.
 func (current *Resources) NonEmptyString() string {
-	resources := []string{}
-	if current.Apps > 0 {
-		resources = append(resources, "Apps")
-	}
-	if current.Containers > 0 {
-		resources = append(resources, "Containers")
-	}
-	if current.Jobs > 0 {
-		resources = append(resources, "Jobs")
-	}
-	if current.Volumes > 0 {
-		resources = append(resources, "Volumes")
-	}
-	if current.Secrets > 0 {
-		resources = append(resources, "Secrets")
-	}
-	if current.Images > 0 {
-		resources = append(resources, "Images")
-	}
-	if current.Projects > 0 {
-		resources = append(resources, "Images")
-	}
+	var resources []string
 
-	if !current.VolumeStorage.IsZero() {
-		resources = append(resources, "VolumeStorage")
-	}
-	if !current.Memory.IsZero() {
-		resources = append(resources, "Memory")
+	// Define function for checking int resources to keep code DRY
+	checkResource := func(resource string, value int) {
+		if value > 0 {
+			resources = append(resources, resource)
+		}
 	}
-	if !current.CPU.IsZero() {
-		resources = append(resources, "CPU")
+
+	// Define function for checking quantity resources to keep code DRY
+	checkQuantityResource := func(resource string, currentVal resource.Quantity) {
+		if !currentVal.IsZero() {
+			resources = append(resources, resource)
+		}
 	}
 
+	checkResource("Apps", current.Apps)
+	checkResource("Containers", current.Containers)
+	checkResource("Jobs", current.Jobs)
+	checkResource("Volumes", current.Volumes)
+	checkResource("Secrets", current.Secrets)
+	checkResource("Images", current.Images)
+	checkResource("Projects", current.Projects)
+
+	checkQuantityResource("VolumeStorage", current.VolumeStorage)
+	checkQuantityResource("Memory", current.Memory)
+	checkQuantityResource("Cpu", current.CPU)
+
 	return strings.Join(resources, ", ")
 }