feat(installer): Add support for MacOS to the Device Agent Installer

.gitignore

@@ -1,3 +1,3 @@
 /node_modules/
 var/
-/out/
+/installer/go/out/

installer/go/cmd/install.go

@@ -105,6 +105,9 @@ func Install(nodeVersion, agentVersion, installerDir string, url string, otc str
 
 	logger.Info("FlowFuse Device Agent installation completed successfully!")
 	logger.Info("The service is now running and will start automatically on system boot.")
+	logger.Info("You can now return to the FlowFuse platform and start creating Node-RED flows on your device")
+	logger.Info("For information on how to manage the FlowFuse Device Agent,")
+	logger.Info("  please refer to the documentation at https://github.com/FlowFuse/device-agent/installer/go/README.md")
 
 	logger.LogFunctionExit("Install", "success", nil)
 	return nil

installer/go/makefile

@@ -10,6 +10,8 @@ build: ## builds the application for all platforms
 	GOARCH=arm64 GOOS=linux go build -ldflags "-X main.version=${VERSION}" -o ./out/linux/${APP_NAME}-linux-arm64 main.go
 	GOARCH=arm GOOS=linux go build -ldflags "-X main.version=${VERSION}" -o ./out/linux/${APP_NAME}-linux-arm main.go
 	GOARCH=amd64 GOOS=windows go build -ldflags "-X main.version=${VERSION}" -o ./out/windows/${APP_NAME}-windows-amd64.exe main.go
+	GOOS=darwin GOARCH=amd64 go build -ldflags "-X main.version=${VERSION}" -o ./out/macos/${APP_NAME}-macos-amd64 main.go
+	GOOS=darwin GOARCH=arm64 go build -ldflags "-X main.version=${VERSION}" -o ./out/macos/${APP_NAME}-macos-arm64 main.go
 
 clean: ## cleans the build artifacts
 	go clean

installer/go/pkg/nodejs/deviceagent.go

@@ -52,8 +52,8 @@ func InstallDeviceAgent(version string, baseDir string) error {
 	var installCmd *exec.Cmd
 	npmPrefix := fmt.Sprintf("npm_config_prefix=%s", nodeBaseDir)
 	switch runtime.GOOS {
-	case "linux":
-		installCmd = exec.Command("sudo", "--preserve-env=PATH", "-u", serviceUser, npmBinPath, "install", "-g", packageName)
+	case "linux", "darwin":
+		installCmd = exec.Command("sudo", "--preserve-env=PATH", "-u", serviceUser, npmBinPath, "install", "-g", "--cache", filepath.Join(nodeBaseDir, ".npm-cache"), packageName)
 		env := os.Environ()
 		installCmd.Env = append(env, npmPrefix, newPath)
 	case "windows":
@@ -100,7 +100,7 @@ func UninstallDeviceAgent(baseDir string) error {
 	var uninstallCmd *exec.Cmd
 	npmPrefix := fmt.Sprintf("npm_config_prefix=%s", nodeBaseDir)
 	switch runtime.GOOS {
-	case "linux":
+	case "linux", "darwin":
 		uninstallCmd = exec.Command("sudo", "--preserve-env=PATH", "-u", serviceUser, npmBinPath, "uninstall", "-g", packageName)
 		env := os.Environ()
 		uninstallCmd.Env = append(env, npmPrefix, newPath)
@@ -170,7 +170,7 @@ func ConfigureDeviceAgent(url string, token string, baseDir string) error {
 	}
 
 	// Getting full path to flowfuse-device-agent binary
-	if runtime.GOOS == "linux" {
+	if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
 		deviceAgentPath = filepath.Join(nodeBinDirPath, "flowfuse-device-agent")
 	} else {
 		deviceAgentPath = filepath.Join(nodeBinDirPath, "flowfuse-device-agent.cmd")
@@ -179,7 +179,7 @@ func ConfigureDeviceAgent(url string, token string, baseDir string) error {
 	// Create configure command
 	var configureCmd *exec.Cmd
 	switch runtime.GOOS {
-	case "linux":
+	case "linux", "darwin":
 		configureCmd = exec.Command("sudo", "--preserve-env=PATH", deviceAgentPath, "-o", token, "-u", url, "--otc-no-start")
 		env := os.Environ()
 		configureCmd.Env = append(env, newPath)

installer/go/pkg/nodejs/nodejs.go

@@ -182,7 +182,7 @@ func GetNodeBinDir() string {
 // installNodeJs installs the specified version of Node.js.
 // It creates the necessary installation directory with appropriate permissions,
 // downloads the Node.js binary from the official source, and extracts it.
-// On Linux, it uses sudo to create the installation directory and set permissions.
+// On Linux and MacOS, it uses sudo to create the installation directory and set permissions.
 //
 // Parameters:
 //   - version: The Node.js version to install (e.g., "16.14.2")
@@ -193,7 +193,7 @@ func installNodeJs(version string) error {
 	logger.Info("Installing Node.js %s...", version)
 
 	// Create the installation directory
-	if runtime.GOOS == "linux" {
+	if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
 		logger.Debug("Creating directory %s (requires sudo)...", nodeBaseDir)
 		mkdirCmd := exec.Command("sudo", "mkdir", "-p", nodeBaseDir)
 		if output, err := mkdirCmd.CombinedOutput(); err != nil {
@@ -270,6 +270,8 @@ func getNodeDownloadURL(version string) (string, error) {
 		return fmt.Sprintf("%s/node-v%s-linux-%s.tar.gz", baseUrl, version, arch), nil
 	case "windows":
 		return fmt.Sprintf("%s/node-v%s-win-%s.zip", baseUrl, version, arch), nil
+	case "darwin":
+		return fmt.Sprintf("%s/node-v%s-darwin-%s.tar.gz", baseUrl, version, arch), nil
 	default:
 		return "", fmt.Errorf("unsupported operating system: %s", runtime.GOOS)
 	}
@@ -335,7 +337,7 @@ func downloadAndExtractNode(url, version string) error {
 	}
 
 	// Set the correct permissions for executable files
-	if runtime.GOOS == "linux" {
+	if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
 		logger.Debug("Setting execute permissions for Node.js binaries...")
 
 		chownCmd := exec.Command("sudo", "chown", "-R", utils.ServiceUsername, nodeBaseDir)

installer/go/pkg/service/darwin.go

@@ -0,0 +1,251 @@
+package service
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"text/template"
+
+	"github.com/flowfuse/device-agent-installer/pkg/logger"
+	"github.com/flowfuse/device-agent-installer/pkg/nodejs"
+	"github.com/flowfuse/device-agent-installer/pkg/utils"
+)
+
+// LaunchdConfig holds the data for the launchd template
+type LaunchdConfig struct {
+	Label   	string
+	WorkDir 	string
+	LogFile  	string
+	ErrorFile string
+	User 			string
+	NodeBinDir string
+}
+
+// newsyslogConfig holds the data for the newsyslog configuration
+type newsyslogConfig struct {
+	LogFile 	string
+	ErrorFile string
+	User 			string
+}
+
+// Global variables
+const serviceLabel = "com.flowfuse.device-agent"
+const serviceFilePath = "/Library/LaunchDaemons/" + serviceLabel + ".plist"
+
+// InstallDarwin installs the service on macOS using launchd
+// It creates a plist file in the LaunchDaemons directory and sets the necessary permissions
+// It also creates a log directory for the service
+// 
+// Parameters:
+//   - workDir: The working directory where the service will operate
+//
+// Returns:
+//   - error: nil if successful, otherwise an error explaining what went wrong
+func InstallDarwin(workDir string) error {
+	serviceUser := utils.ServiceUsername
+
+	// Create the log directory
+	logDir := filepath.Join(workDir, "logs")
+	mkdirCmd := exec.Command("sudo", "mkdir", "-p", logDir)
+	if output, err := mkdirCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to create directory %s: %w\nOutput: %s", logDir, err, output)
+	}
+	logger.Debug("Setting ownership of %s to %s...", logDir, serviceUser)
+	chownCmd := exec.Command("sudo", "chown", "-R", serviceUser, logDir)
+	if output, err := chownCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to set logs directory ownership: %w\nOutput: %s", err, output)
+	}
+
+	logFilePath := filepath.Join(logDir, "flowfuse-device-agent.log")
+	errorLogFilePath := filepath.Join(logDir, "flowfuse-device-agent-error.log")
+
+	config := LaunchdConfig{
+		Label:   		serviceLabel,
+		WorkDir: 		workDir,
+		LogFile:  	logFilePath,
+		ErrorFile: 	errorLogFilePath,
+		User:    		serviceUser,
+		NodeBinDir: nodejs.GetNodeBinDir(),
+	}
+
+	tmpl, err := template.New("launchd").Parse(launchdTemplate)
+	if err != nil {
+		return fmt.Errorf("failed to parse launchd template: %w", err)
+	}
+
+	tmpFile, err := os.CreateTemp("", "flowfuse-service-")
+	if err != nil {
+		return fmt.Errorf("failed to create temp file: %w", err)
+	}
+	defer os.Remove(tmpFile.Name())
+
+	if err := tmpl.Execute(tmpFile, config); err != nil {
+		return fmt.Errorf("failed to execute service template: %w", err)
+	}
+	tmpFile.Close()
+
+	copyCmd := exec.Command("sudo", "cp","-X", tmpFile.Name(), serviceFilePath)
+	if output, err := copyCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to copy service file: %w\nOutput: %s", err, output)
+	}
+
+	chownCmd = exec.Command("sudo", "chown", "root:wheel", serviceFilePath)
+	if output, err := chownCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to set service file ownership: %w\nOutput: %s", err, output)
+	}
+
+	chmodCmd := exec.Command("sudo", "chmod", "644", serviceFilePath)
+	if err := chmodCmd.Run(); err != nil {
+		return fmt.Errorf("failed to set service file permissions: %w", err)
+	}
+
+	loadCmd := exec.Command("sudo", "launchctl", "load", "-w", serviceFilePath)
+	if output, err := loadCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to load launchd service: %w\nOutput: %s", err, output)
+	}
+
+	createNewsyslogConfig(serviceUser, logFilePath, errorLogFilePath)
+
+	return nil
+}
+
+// StartDarwin starts the service on macOS
+// It uses launchctl to start the service and checks its status
+//
+// Returns:
+//   - error: nil if successful, otherwise an error explaining what went wrong
+func StartDarwin() error {
+	startCmd := exec.Command("sudo", "launchctl", "start", serviceLabel)
+	if output, err := startCmd.CombinedOutput(); err != nil {
+		logger.Error("Failed to start service: %s", err)
+		return fmt.Errorf("failed to start service: %w\nOutput: %s", err, output)
+	}
+
+	listCmd := exec.Command("launchctl", "list", serviceLabel)
+	listOutput, _ := listCmd.CombinedOutput()
+	logger.Debug("Service status:\n%s", listOutput)
+
+	return nil
+}
+
+// StopDarwin stops the service on macOS
+// It uses launchctl to stop the service
+//
+// Returns:
+//   - error: nil if successful, otherwise an error explaining what went wrong
+func StopDarwin() error {
+	stopCmd := exec.Command("sudo", "launchctl", "stop", serviceLabel)
+	if output, err := stopCmd.CombinedOutput(); err != nil {
+		logger.Error("Failed to stop service: %s", err)
+		return fmt.Errorf("failed to stop service: %w\nOutput: %s", err, output)
+	}
+	return nil
+}
+
+// UninstallDarwin removes the service on macOS
+// It stops and unloads the service using launchctl and removes the plist file
+//
+// Returns:
+//   - error: nil if successful, otherwise an error explaining what went wrong
+func UninstallDarwin() error {
+	if IsInstalledDarwin() {
+		StopDarwin()
+		// Unload the service
+		unloadCmd := exec.Command("sudo", "launchctl", "unload", "-w", serviceFilePath)
+		_ = unloadCmd.Run() // Ignore errors
+		// Remove the service file
+		removeCmd := exec.Command("sudo", "rm", "-f", serviceFilePath)
+		if output, err := removeCmd.CombinedOutput(); err != nil {
+			return fmt.Errorf("failed to remove service file: %w\nOutput: %s", err, output)
+		}
+		// Remove the newsyslog configuration file
+		nsConfFilePath := filepath.Join("/etc/newsyslog.d/", fmt.Sprintf("%s.conf", serviceLabel))
+		removeCmd = exec.Command("sudo", "rm", "-rf", nsConfFilePath)
+		if output, err := removeCmd.CombinedOutput(); err != nil {
+			return fmt.Errorf("failed to remove newsyslog configuration file: %w\nOutput: %s", err, output)
+		}
+	}
+
+	return nil
+}
+
+// IsInstalledDarwin checks if the service is installed on macOS
+// It checks if the service is running and if the plist file exists
+//
+// Returns:
+//   - bool: true if the service is installed, false otherwise
+func IsInstalledDarwin() bool {
+	listCmd := exec.Command("sudo", "launchctl", "list", serviceLabel)
+	// Check if service is running
+	serviceRunning := listCmd.Run() == nil
+
+	// Check if service file exists
+	_, err := os.Stat(serviceFilePath)
+	fileExists := err == nil
+
+	return serviceRunning && fileExists
+}
+
+// createNewsyslogConfig creates a configuration file for the newsyslog service
+// to manage log rotation for the FlowFuse Device Agent. It generates the configuration
+// based on the provided service user, log file, and error file paths, then installs it
+// in /etc/newsyslog.d/ with appropriate permissions.
+//
+// Parameters:
+//   - serviceUser: The user under which the service runs
+//   - logFile: Path to the main log file that needs rotation
+//   - errorFile: Path to the error log file that needs rotation
+//
+// Returns:
+//   - error: An error if any step in the process fails, nil on success
+func createNewsyslogConfig(serviceUser, logFile, errorFile string) error {
+	logger.Debug("Creating log files rotation configuration for FlowFuse Device Agent...")
+
+	nsDir := "/etc/newsyslog.d/"
+	if _, err := os.Stat(nsDir); os.IsNotExist(err) {
+		return fmt.Errorf("%s directory does not exist", nsDir)
+	}
+
+	confFilePath := filepath.Join(nsDir, fmt.Sprintf("%s.conf", serviceLabel))
+	logger.Debug("Configuration file path: %s", confFilePath)
+	config := newsyslogConfig{
+		LogFile: 		logFile,
+		ErrorFile: 	errorFile,
+		User: 			serviceUser,
+	}
+
+	tmpl, err := template.New("newsyslog").Parse(newsyslogTemplate)
+	if err != nil {
+		return fmt.Errorf("failed to parse newsyslog template: %w", err)
+	}
+
+	tmpFile, err := os.CreateTemp("", "flowfuse-device-agent-ns-conf-")
+	if err != nil {
+		return fmt.Errorf("failed to create temp file: %w", err)
+	}
+	defer os.Remove(tmpFile.Name())
+
+	if err := tmpl.Execute(tmpFile, config); err != nil {
+		return fmt.Errorf("failed to execute nsconf template: %w", err)
+	}
+	tmpFile.Close()
+
+	copyCmd := exec.Command("sudo", "cp", "-X", tmpFile.Name(), confFilePath)
+	if output, err := copyCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to copy nsconf file: %w\nOutput: %s", err, output)
+	}
+
+	chownCmd := exec.Command("sudo", "chown", "root:wheel", confFilePath)
+	if output, err := chownCmd.CombinedOutput(); err != nil {
+		return fmt.Errorf("failed to set nsconf file ownership: %w\nOutput: %s", err, output)
+	}
+
+	chmodCmd := exec.Command("sudo", "chmod", "644", confFilePath)
+	if err := chmodCmd.Run(); err != nil {
+		return fmt.Errorf("failed to set nsconf file permissions: %w", err)
+	}
+
+	logger.Debug("Log files rotation configuration created successfully at %s", confFilePath)
+	return nil
+}