Merge pull request #97 from OpsLevel/kr/cull_api_calls

Don't send an API call if there is nothing to actually update.

Author: rocktavious

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.16
+
+    - name: Test
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      run: |-
+        cd ./src
+        go test -race -coverprofile=coverage.txt -covermode=atomic -v ./...
+        bash <(curl -s https://codecov.io/bash)

changes/unreleased/Refactor-20220114-163722.yaml

@@ -0,0 +1,3 @@
+kind: Refactor
+body: Do not send a ServiceUpdate mutation if nothing changed about the data
+time: 2022-01-14T16:37:22.080214-06:00

src/common/client.go

@@ -50,6 +50,34 @@ func findService(client *opslevel.Client, registration ServiceRegistration) (*op
 	return nil, false
 }
 
+func serviceNeedsUpdate(input opslevel.ServiceUpdateInput, service *opslevel.Service) bool {
+	if input.Name != "" && input.Name != service.Name {
+		return true
+	}
+	if input.Product != "" && input.Product != service.Product {
+		return true
+	}
+	if input.Description != "" && input.Description != service.Description {
+		return true
+	}
+	if input.Language != "" && input.Language != service.Language {
+		return true
+	}
+	if input.Framework != "" && input.Framework != service.Framework {
+		return true
+	}
+	if input.Tier != "" && input.Tier != service.Tier.Alias {
+		return true
+	}
+	if input.Lifecycle != "" && input.Lifecycle != service.Lifecycle.Alias {
+		return true
+	}
+	if input.Owner != "" && input.Owner != service.Owner.Alias {
+		return true
+	}
+	return false
+}
+
 func createService(client *opslevel.Client, registration ServiceRegistration) (*opslevel.Service, error) {
 	serviceCreateInput := opslevel.ServiceCreateInput{
 		Name:        registration.Name,
@@ -105,13 +133,17 @@ func updateService(client *opslevel.Client, registration ServiceRegistration, se
 	} else if registration.Owner != "" {
 		log.Warn().Msgf("[%s] Unable to find 'Team' with alias '%s'", service.Name, registration.Owner)
 	}
-	updatedService, updateServiceErr := client.UpdateService(updateServiceInput)
-	if updateServiceErr != nil {
-		log.Error().Msgf("[%s] Failed updating service\n\tREASON: %v", service.Name, updateServiceErr.Error())
-	} else {
-		if diff := cmp.Diff(service, updatedService); diff != "" {
-			log.Info().Msgf("[%s] Updated Service - Diff:\n%s", service.Name, diff)
+	if serviceNeedsUpdate(updateServiceInput, service) {
+		updatedService, updateServiceErr := client.UpdateService(updateServiceInput)
+		if updateServiceErr != nil {
+			log.Error().Msgf("[%s] Failed updating service\n\tREASON: %v", service.Name, updateServiceErr.Error())
+		} else {
+			if diff := cmp.Diff(service, updatedService); diff != "" {
+				log.Info().Msgf("[%s] Updated Service - Diff:\n%s", service.Name, diff)
+			}
 		}
+	} else {
+		log.Info().Msgf("[%s] No changes detected to fields - skipping update", service.Name)
 	}
 }
 
@@ -219,7 +251,7 @@ func handleRepositories(client *opslevel.Client, registration ServiceRegistratio
 		repositoryCreate.Service = opslevel.IdentifierInput{Id: service.Id}
 		_, err := client.CreateServiceRepository(repositoryCreate)
 		if err != nil {
-			log.Error().Msgf("[%s] Failed assigning repository '$s'\n\tREASON: %v", service.Name, repositoryAsString, err.Error())
+			log.Error().Msgf("[%s] Failed assigning repository '%s'\n\tREASON: %v", service.Name, repositoryAsString, err.Error())
 		} else {
 			log.Info().Msgf("[%s] Attached repository '%s'", service.Name, repositoryAsString)
 		}

src/common/client_test.go

@@ -0,0 +1,78 @@
+package common
+
+import (
+	"testing"
+
+	"github.com/opslevel/opslevel-go"
+	"github.com/rocktavious/autopilot"
+)
+
+func Test_ServiceNeedsUpdate_IsTrue_WhenInputDiffers(t *testing.T) {
+	// Arrange
+	service := opslevel.Service{
+		ServiceId: opslevel.ServiceId{
+			Id: opslevel.NewID("XXX"),
+		},
+		Name:        "Test",
+		Description: "Hello World",
+		Language:    "Python",
+		Tier: opslevel.Tier{
+			Alias: "tier_1",
+		},
+	}
+	input1 := opslevel.ServiceUpdateInput{
+		Name: "Test1",
+	}
+	input2 := opslevel.ServiceUpdateInput{
+		Name:     "Test",
+		Language: "Python",
+		Tier:     "tier_2",
+	}
+	input3 := opslevel.ServiceUpdateInput{
+		Name:     "Test",
+		Language: "Python",
+		Owner:    "platform",
+	}
+	// Act
+	result1 := serviceNeedsUpdate(input1, &service)
+	result2 := serviceNeedsUpdate(input2, &service)
+	result3 := serviceNeedsUpdate(input3, &service)
+	// Assert
+	autopilot.Equals(t, true, result1)
+	autopilot.Equals(t, true, result2)
+	autopilot.Equals(t, true, result3)
+}
+
+func Test_ServiceNeedsUpdate_IsFalse_WhenInputMatches(t *testing.T) {
+	// Arrange
+	service := opslevel.Service{
+		ServiceId: opslevel.ServiceId{
+			Id: opslevel.NewID("XXX"),
+		},
+		Name:        "Test",
+		Description: "Hello World",
+		Language:    "Python",
+		Tier: opslevel.Tier{
+			Alias: "tier_1",
+		},
+	}
+	input1 := opslevel.ServiceUpdateInput{
+		Id: "XXX",
+	}
+	input2 := opslevel.ServiceUpdateInput{
+		Name: "Test",
+	}
+	input3 := opslevel.ServiceUpdateInput{
+		Name:     "Test",
+		Language: "Python",
+		Tier:     "tier_1",
+	}
+	// Act
+	result1 := serviceNeedsUpdate(input1, &service)
+	result2 := serviceNeedsUpdate(input2, &service)
+	result3 := serviceNeedsUpdate(input3, &service)
+	// Assert
+	autopilot.Equals(t, false, result1)
+	autopilot.Equals(t, false, result2)
+	autopilot.Equals(t, false, result3)
+}

src/go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/google/go-cmp v0.5.5
 	github.com/imdario/mergo v0.3.10 // indirect
 	github.com/opslevel/opslevel-go v0.4.2
+	github.com/rocktavious/autopilot v0.1.5 // indirect
 	github.com/rs/zerolog v1.26.0
 	github.com/spf13/cobra v1.2.1
 	github.com/spf13/viper v1.8.1