Move UpdateRegistrySettings to config

canonical · Oct 24, 2023 · 252495f · 252495f
1 parent 256df54
commit 252495f
Show file tree

Hide file tree

Showing 2 changed files with 158 additions and 158 deletions.
diff --git a/windows-agent/internal/config/config.go b/windows-agent/internal/config/config.go
@@ -4,16 +4,22 @@ package config
 
 import (
 	"context"
+	"crypto/sha512"
 	"errors"
 	"fmt"
+	"io/fs"
+	"os"
+	"path/filepath"
 	"sync"
 
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/config/registry"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/contracts"
+	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/distros/database"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/distros/task"
 	log "github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/grpc/logstreamer"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/tasks"
 	"github.com/ubuntu/decorate"
+	"golang.org/x/exp/slices"
 )
 
 const (
@@ -410,3 +416,154 @@ func (c *Config) FetchMicrosoftStoreSubscription(ctx context.Context) (err error
 
 	return nil
 }
+
+// UpdateRegistrySettings checks if any of the registry settings have changed since this function was last called.
+// If so, new settings are pushed to the distros.
+func (c *Config) UpdateRegistrySettings(ctx context.Context, cacheDir string, db *database.DistroDB) error {
+	type getTask = func(*Config, context.Context, string, *database.DistroDB) (task.Task, error)
+
+	// Collect tasks for updated settings
+	var acc error
+	var taskList []task.Task
+	for _, f := range []getTask{(*Config).getTaskOnNewSubscription, (*Config).getTaskOnNewLandscape} {
+		task, err := f(c, ctx, cacheDir, db)
+		if err != nil {
+			errors.Join(acc, err)
+			continue
+		}
+		if task != nil {
+			taskList = append(taskList, task)
+		}
+	}
+
+	if acc != nil {
+		log.Warningf(ctx, "Could not obtain some updated registry settings: %v", acc)
+	}
+
+	// Apply tasks for updated settings
+	acc = nil
+	for _, d := range db.GetAll() {
+		acc = errors.Join(acc, d.SubmitDeferredTasks(taskList...))
+	}
+
+	if acc != nil {
+		return fmt.Errorf("could not submit new token to certain distros: %v", acc)
+	}
+
+	return nil
+}
+
+// getTaskOnNewSubscription checks if the subscription has changed since the last time it was called. If so, the new subscription
+// is returned in the form of a task.
+func (c *Config) getTaskOnNewSubscription(ctx context.Context, cacheDir string, db *database.DistroDB) (task.Task, error) {
+	proToken, _, err := c.Subscription(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("could not retrieve current subscription: %v", err)
+	}
+
+	isNew, err := valueIsNew(filepath.Join(cacheDir, "subscription.csum"), []byte(proToken))
+	if err != nil {
+		log.Warningf(ctx, "could not update checksum for Ubuntu Pro subscription: %v", err)
+	}
+	if isNew {
+		return nil, nil
+	}
+
+	log.Debug(ctx, "New Ubuntu Pro subscription settings detected in registry")
+	return tasks.ProAttachment{Token: proToken}, nil
+}
+
+// getTaskOnNewLandscape checks if the Landscape settings has changed since the last time it was called. If so, the
+// new Landscape settings are returned in the form of a task.
+func (c *Config) getTaskOnNewLandscape(ctx context.Context, cacheDir string, db *database.DistroDB) (task.Task, error) {
+	landscapeConf, err := c.LandscapeClientConfig(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("could not retrieve current landscape config: %v", err)
+	}
+
+	landscapeUID, err := c.LandscapeAgentUID(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("could not retrieve current landscape UID: %v", err)
+	}
+
+	// We append them just so we can compute a combined checksum
+	serialized := fmt.Sprintf("%s\n%s", landscapeUID, landscapeConf)
+
+	isNew, err := valueIsNew(filepath.Join(cacheDir, "landscape.csum"), []byte(serialized))
+	if err != nil {
+		log.Warningf(ctx, "could not update checksum for Landscape configuration: %v", err)
+	}
+
+	if isNew {
+		return nil, nil
+	}
+
+	log.Debug(ctx, "New Landscape settings detected in registry")
+
+	// We must not register to landscape if we have no Landscape UID
+	if landscapeConf != "" && landscapeUID == "" {
+		log.Debug(ctx, "Ignoring new landscape settings: no Landscape agent UID")
+		return nil, nil
+	}
+
+	return tasks.LandscapeConfigure{Config: landscapeConf, HostagentUID: landscapeUID}, nil
+}
+
+// valueIsNew detects if the current value is different from the last time it was used.
+// The return value is usable even if error is returned.
+func valueIsNew(cachePath string, newValue []byte) (new bool, err error) {
+	var newCheckSum []byte
+	if len(newValue) != 0 {
+		tmp := sha512.Sum512(newValue)
+		newCheckSum = tmp[:]
+	}
+
+	defer decorateUpdateCache(&new, &err, cachePath, newCheckSum)
+
+	oldChecksum, err := os.ReadFile(cachePath)
+	if errors.Is(err, fs.ErrNotExist) {
+		// File not found: there was no value before
+		oldChecksum = nil
+	} else if err != nil {
+		return true, fmt.Errorf("could not read old value: %v", err)
+	}
+
+	if slices.Equal(oldChecksum, newCheckSum) {
+		return false, nil
+	}
+
+	return true, nil
+}
+
+// decorateUpdateCache acts depending on caller's return values (hence decorate).
+// It stores the new checksum to the cachefile. Any errors are joined to *err.
+func decorateUpdateCache(new *bool, err *error, cachePath string, newCheckSum []byte) {
+	writeCacheErr := func() error {
+		// If the value is empty, we remove the file.
+		// This preserves this function's idempotency.
+		if len(newCheckSum) == 0 {
+			err := os.Remove(cachePath)
+			if errors.Is(err, fs.ErrNotExist) {
+				return nil
+			}
+			if err != nil {
+				return fmt.Errorf("could not remove old checksum: %v", err)
+			}
+			return nil
+		}
+
+		// Value is unchanged: don't write to file
+		if !*new {
+			return nil
+		}
+
+		// Update to file
+		if err := os.WriteFile(cachePath, newCheckSum[:], 0600); err != nil {
+			return fmt.Errorf("could not write checksum to cache: %v", err)
+		}
+
+		return nil
+	}()
+
+	*err = errors.Join(*err, writeCacheErr)
+}
diff --git a/windows-agent/internal/proservices/proservices.go b/windows-agent/internal/proservices/proservices.go
@@ -3,25 +3,19 @@ package proservices
 
 import (
 	"context"
-	"crypto/sha512"
 	"errors"
-	"fmt"
-	"io/fs"
 	"os"
 	"path/filepath"
 
 	agent_api "github.com/canonical/ubuntu-pro-for-windows/agentapi/go"
 	"github.com/canonical/ubuntu-pro-for-windows/common"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/config"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/distros/database"
-	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/distros/task"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/grpc/interceptorschain"
 	log "github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/grpc/logstreamer"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/proservices/landscape"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/proservices/ui"
 	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/proservices/wslinstance"
-	"github.com/canonical/ubuntu-pro-for-windows/windows-agent/internal/tasks"
-	"golang.org/x/exp/slices"
 	"google.golang.org/grpc"
 )
 
@@ -103,7 +97,7 @@ func New(ctx context.Context, args ...Option) (s Manager, err error) {
 	}()
 
 	go func() {
-		err := updateRegistrySettings(ctx, opts.cacheDir, conf, db)
+		err := conf.UpdateRegistrySettings(ctx, opts.cacheDir, db)
 		if err != nil {
 			log.Warningf(ctx, "Could not update subscriptions: %v", err)
 		}
@@ -154,154 +148,3 @@ func (m Manager) RegisterGRPCServices(ctx context.Context) *grpc.Server {
 
 	return grpcServer
 }
-
-// updateRegistrySettings checks if any of the registry settings have changed since this function was last called.
-// If so, updated settings are pushed to the distros.
-func updateRegistrySettings(ctx context.Context, cacheDir string, conf *config.Config, db *database.DistroDB) error {
-	type getTask = func(context.Context, string, *config.Config, *database.DistroDB) (task.Task, error)
-
-	// Collect tasks for updated settings
-	var acc error
-	var taskList []task.Task
-	for _, f := range []getTask{getNewSubscription, getNewLandscape} {
-		task, err := f(ctx, cacheDir, conf, db)
-		if err != nil {
-			errors.Join(acc, err)
-			continue
-		}
-		if task != nil {
-			taskList = append(taskList, task)
-		}
-	}
-
-	if acc != nil {
-		log.Warningf(ctx, "Could not obtain some updated registry settings: %v", acc)
-	}
-
-	// Apply tasks for updated settings
-	acc = nil
-	for _, d := range db.GetAll() {
-		acc = errors.Join(acc, d.SubmitDeferredTasks(taskList...))
-	}
-
-	if acc != nil {
-		return fmt.Errorf("could not submit new token to certain distros: %v", acc)
-	}
-
-	return nil
-}
-
-// getNewSubscription checks if the subscription has changed since the last time it was called. If so, the new subscription
-// is returned in the form of a task.
-func getNewSubscription(ctx context.Context, cacheDir string, conf *config.Config, db *database.DistroDB) (task.Task, error) {
-	proToken, _, err := conf.Subscription(ctx)
-	if err != nil {
-		return nil, fmt.Errorf("could not retrieve current subscription: %v", err)
-	}
-
-	isNew, err := valueIsNew(filepath.Join(cacheDir, "subscription.csum"), []byte(proToken))
-	if err != nil {
-		log.Warningf(ctx, "could not update checksum for Ubuntu Pro subscription: %v", err)
-	}
-	if isNew {
-		return nil, nil
-	}
-
-	log.Debug(ctx, "New Ubuntu Pro subscription settings detected in registry")
-	return tasks.ProAttachment{Token: proToken}, nil
-}
-
-// getNewLandscape checks if the Landscape settings has changed since the last time it was called. If so, the
-// new Landscape settings are returned in the form of a task.
-func getNewLandscape(ctx context.Context, cacheDir string, conf *config.Config, db *database.DistroDB) (task.Task, error) {
-	landscapeConf, err := conf.LandscapeClientConfig(ctx)
-	if err != nil {
-		return nil, fmt.Errorf("could not retrieve current landscape config: %v", err)
-	}
-
-	landscapeUID, err := conf.LandscapeAgentUID(ctx)
-	if err != nil {
-		return nil, fmt.Errorf("could not retrieve current landscape UID: %v", err)
-	}
-
-	// We append them just so we can compute a combined checksum
-	serialized := fmt.Sprintf("%s\n%s", landscapeUID, landscapeConf)
-
-	isNew, err := valueIsNew(filepath.Join(cacheDir, "landscape.csum"), []byte(serialized))
-	if err != nil {
-		log.Warningf(ctx, "could not update checksum for Landscape configuration: %v", err)
-	}
-
-	if isNew {
-		return nil, nil
-	}
-
-	log.Debug(ctx, "New Landscape settings detected in registry")
-
-	// We must not register to landscape if we have no Landscape UID
-	if landscapeConf != "" && landscapeUID == "" {
-		log.Debug(ctx, "Ignoring new landscape settings: no Landscape agent UID")
-		return nil, nil
-	}
-
-	return tasks.LandscapeConfigure{Config: landscapeConf, HostagentUID: landscapeUID}, nil
-}
-
-// valueIsNew detects if the current value is different from the last time it was used.
-// The return value is usable even if error is returned.
-func valueIsNew(cachePath string, newValue []byte) (new bool, err error) {
-	var newCheckSum []byte
-	if len(newValue) != 0 {
-		tmp := sha512.Sum512(newValue)
-		newCheckSum = tmp[:]
-	}
-
-	defer decorateUpdateCache(&new, &err, cachePath, newCheckSum)
-
-	oldChecksum, err := os.ReadFile(cachePath)
-	if errors.Is(err, fs.ErrNotExist) {
-		// File not found: there was no value before
-		oldChecksum = nil
-	} else if err != nil {
-		return true, fmt.Errorf("could not read old value: %v", err)
-	}
-
-	if slices.Equal(oldChecksum, newCheckSum) {
-		return false, nil
-	}
-
-	return true, nil
-}
-
-// decorateUpdateCache acts depending on caller's return values (hence decorate).
-// It stores the new checksum to the cachefile. Any errors are joined to *err.
-func decorateUpdateCache(new *bool, err *error, cachePath string, newCheckSum []byte) {
-	writeCacheErr := func() error {
-		// If the value is empty, we remove the file.
-		// This preserves this function's idempotency.
-		if len(newCheckSum) == 0 {
-			err := os.Remove(cachePath)
-			if errors.Is(err, fs.ErrNotExist) {
-				return nil
-			}
-			if err != nil {
-				return fmt.Errorf("could not remove old checksum: %v", err)
-			}
-			return nil
-		}
-
-		// Value is unchanged: don't write to file
-		if !*new {
-			return nil
-		}
-
-		// Update to file
-		if err := os.WriteFile(cachePath, newCheckSum[:], 0600); err != nil {
-			return fmt.Errorf("could not write checksum to cache: %v", err)
-		}
-
-		return nil
-	}()
-
-	*err = errors.Join(*err, writeCacheErr)
-}