Followup - prevent handleRepositories from crashing | Stop using pointers in logs | Fix fetching service from repo

.changes/unreleased/Bugfix-20240221-191652.yaml

@@ -0,0 +1,3 @@
+kind: Bugfix
+body: Fix bug where service repos were never renamed if base dir was /
+time: 2024-02-21T19:16:52.351803-05:00

.gitignore

@@ -5,3 +5,4 @@ src/dist
 **/coverage.txt
 **/go.work*
 **/opslevel-k8s.yaml
+**/kubectl-opslevel

Readme.md

@@ -127,7 +127,7 @@ service:
           # find annotations with format: opslevel.com/tools.<category>.<displayname>: <url>
           - '.metadata.annotations | to_entries |  map(select(.key | startswith("opslevel.com/tools"))) | map({"category": .key | split(".")[2], "displayName": .key | split(".")[3], "url": .value})'
         repositories: # attach repositories to the service using the opslevel repo alias - IE github.com:hashicorp/vault
-          - '{"name": "My Cool Repo", "directory": "/", "repo": .metadata.annotations.repo} | if .repo then . else empty end'
+          - '{"name": "My Cool Repo", "directory": "", "repo": .metadata.annotations.repo} | if .repo then . else empty end'
           # if just the alias is returned as a single string we'll build the name for you and set the directory to "/"
           - .metadata.annotations.repo
           # find annotations with format: opslevel.com/repo.<displayname>.<repo.subpath.dots.turned.to.forwardslash>: <opslevel repo alias>

src/common/config.go

@@ -90,7 +90,7 @@ service:
           # OR find annotations with format: opslevel.com/tools.<category>.<environment>.<displayname>: <url>
           # - '.metadata.annotations | to_entries |  map(select(.key | startswith("opslevel.com/tools"))) | map({"category": .key | split(".")[2], "environment": .key | split(".")[3], "displayName": .key | split(".")[4], "url": .value})'
         repositories: # attach repositories to the service using the opslevel repo alias - IE github.com:hashicorp/vault
-          - '{"name": "My Cool Repo", "directory": "/", "repo": .metadata.annotations.repo} | if .repo then . else empty end'
+          - '{"name": "My Cool Repo", "directory": "", "repo": .metadata.annotations.repo} | if .repo then . else empty end'
           # if just the alias is returned as a single string we'll build the name for you and set the directory to "/"
           - .metadata.annotations.repo
           # find annotations with format: opslevel.com/repo.<displayname>.<repo.subpath.dots.turned.to.forwardslash>: <opslevel repo alias>

src/common/reconciler.go

@@ -363,15 +363,26 @@ func (r *ServiceReconciler) handleTools(service *opslevel.Service, registration
 
 func (r *ServiceReconciler) handleRepositories(service *opslevel.Service, registration opslevel_jq_parser.ServiceRegistration) {
 	for _, repositoryCreate := range registration.Repositories {
+		if repositoryCreate.Repository.Alias == nil || *repositoryCreate.Repository.Alias == "null" {
+			continue
+		}
+		repoCreateString := "repoCreate{}"
+		b, err := json.Marshal(repositoryCreate)
+		if err == nil {
+			repoCreateString = string(b)
+		}
 		foundRepository, foundRepositoryErr := r.client.GetRepositoryWithAlias(*repositoryCreate.Repository.Alias)
 		if foundRepositoryErr != nil {
-			log.Warn().Msgf("[%s] Repository with alias: '%+v' not found so it cannot be attached to service ... skipping", service.Name, repositoryCreate)
+			log.Warn().Msgf("[%s] Repository with alias: '%s' not found so it cannot be attached to service ... skipping", service.Name, repoCreateString)
 			continue
 		} else if foundRepository == nil {
-			log.Warn().Msgf("[%s] Repository with alias: '%+v' call to GetRepositoryWithAlias unexpectedly returned nil - please submit a bug report ... skipping", service.Name, repositoryCreate)
+			log.Warn().Msgf("[%s] Repository with alias: '%s' call to GetRepositoryWithAlias unexpectedly returned nil - please submit a bug report ... skipping", service.Name, repoCreateString)
 			continue
 		}
-		serviceRepository := foundRepository.GetService(service.Id, *repositoryCreate.BaseDirectory)
+		var serviceRepository *opslevel.ServiceRepository
+		if repositoryCreate.BaseDirectory != nil {
+			serviceRepository = foundRepository.GetService(service.Id, *repositoryCreate.BaseDirectory)
+		}
 		if serviceRepository != nil {
 			if repositoryCreate.DisplayName != nil && serviceRepository.DisplayName != *repositoryCreate.DisplayName {
 				repositoryUpdate := opslevel.ServiceRepositoryUpdateInput{
@@ -380,22 +391,22 @@ func (r *ServiceReconciler) handleRepositories(service *opslevel.Service, regist
 				}
 				err := r.client.UpdateServiceRepository(repositoryUpdate)
 				if err != nil {
-					log.Error().Msgf("[%s] Failed updating repository '%+v'\n\tREASON: %v", service.Name, repositoryCreate, err.Error())
+					log.Error().Msgf("[%s] Failed updating repository '%s'\n\tREASON: %v", service.Name, repoCreateString, err.Error())
 					continue
 				} else {
-					log.Info().Msgf("[%s] Updated repository '%+v'", service.Name, repositoryCreate)
+					log.Info().Msgf("[%s] Updated repository '%s'", service.Name, repoCreateString)
 					continue
 				}
 			}
-			log.Debug().Msgf("[%s] Repository '%+v' already attached to service ... skipping", service.Name, repositoryCreate)
+			log.Debug().Msgf("[%s] Repository '%s' already attached to service ... skipping", service.Name, repoCreateString)
 			continue
 		}
 		repositoryCreate.Service = opslevel.IdentifierInput{Id: &service.Id}
-		err := r.client.CreateServiceRepository(repositoryCreate)
+		err = r.client.CreateServiceRepository(repositoryCreate)
 		if err != nil {
-			log.Error().Msgf("[%s] Failed assigning repository '%+v'\n\tREASON: %v", service.Name, repositoryCreate, err.Error())
+			log.Error().Msgf("[%s] Failed assigning repository '%s'\n\tREASON: %v", service.Name, repoCreateString, err.Error())
 		} else {
-			log.Info().Msgf("[%s] Attached repository '%+v'", service.Name, repositoryCreate)
+			log.Info().Msgf("[%s] Attached repository '%s'", service.Name, repoCreateString)
 		}
 	}
 }

src/go.mod

@@ -91,7 +91,7 @@ require (
 	k8s.io/apimachinery v0.29.2 // indirect
 	k8s.io/client-go v0.29.2 // indirect
 	k8s.io/klog/v2 v2.120.1 // indirect
-	k8s.io/kube-openapi v0.0.0-20240220201932-37d671a357a5 // indirect
+	k8s.io/kube-openapi v0.0.0-20240221221325-2ac9dc51f3f1 // indirect
 	k8s.io/utils v0.0.0-20240102154912-e7106e64919e // indirect
 	nhooyr.io/websocket v1.8.10 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect

src/go.sum

@@ -321,8 +321,8 @@ k8s.io/client-go v0.29.2 h1:FEg85el1TeZp+/vYJM7hkDlSTFZ+c5nnK44DJ4FyoRg=
 k8s.io/client-go v0.29.2/go.mod h1:knlvFZE58VpqbQpJNbCbctTVXcd35mMyAAwBdpt4jrA=
 k8s.io/klog/v2 v2.120.1 h1:QXU6cPEOIslTGvZaXvFWiP9VKyeet3sawzTOvdXb4Vw=
 k8s.io/klog/v2 v2.120.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE=
-k8s.io/kube-openapi v0.0.0-20240220201932-37d671a357a5 h1:QSpdNrZ9uRlV0VkqLvVO0Rqg8ioKi3oSw7O5P7pJV8M=
-k8s.io/kube-openapi v0.0.0-20240220201932-37d671a357a5/go.mod h1:Pa1PvrP7ACSkuX6I7KYomY6cmMA0Tx86waBhDUgoKPw=
+k8s.io/kube-openapi v0.0.0-20240221221325-2ac9dc51f3f1 h1:rtdnaWfP40MTKv7izH81gkWpZB45pZrwIxyZdPSn1mI=
+k8s.io/kube-openapi v0.0.0-20240221221325-2ac9dc51f3f1/go.mod h1:Pa1PvrP7ACSkuX6I7KYomY6cmMA0Tx86waBhDUgoKPw=
 k8s.io/utils v0.0.0-20240102154912-e7106e64919e h1:eQ/4ljkx21sObifjzXwlPKpdGLrCfRziVtos3ofG/sQ=
 k8s.io/utils v0.0.0-20240102154912-e7106e64919e/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
 nhooyr.io/websocket v1.8.10 h1:mv4p+MnGrLDcPlBoWsvPP7XCzTYMXP9F9eIGoKbgx7Q=