update logging and output routines so error and debug are sent to std…

…err instead of stdout
macadmins · Sep 5, 2023 · f03950b · f03950b
1 parent e3cd80a
commit f03950b
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 11 deletions.
diff --git a/Outset/Outset.swift b/Outset/Outset.swift
@@ -133,7 +133,7 @@ struct Outset: ParsableCommand {
         }
 
         if version {
-            print(outsetVersion)
+            printStdOut("\(outsetVersion)")
             if debugMode {
                 writeSysReport()
             }
@@ -331,7 +331,7 @@ struct Outset: ParsableCommand {
                 for fileToHash in checksum {
                     let url = URL(fileURLWithPath: fileToHash)
                     if let hash = sha256(for: url) {
-                        print("Checksum for file \(fileToHash): \(hash)")
+                        printStdOut("Checksum for file \(fileToHash): \(hash)")
                     }
                 }
             }

diff --git a/Outset/Utils/Checksum.swift b/Outset/Utils/Checksum.swift
@@ -75,11 +75,14 @@ func checksumAllFiles() {
                 let fileAttributes = try fileURL.resourceValues(forKeys: [.isRegularFileKey])
                 if fileAttributes.isRegularFile! && fileURL.pathExtension != "plist" && fileURL.lastPathComponent != "outset" {
                     if let shasum = sha256(for: fileURL) {
-                        print("\(fileURL.relativePath) : \(shasum)")
+                        printStdOut("\(fileURL.relativePath) : \(shasum)")
                         shasumPlist.sha256sum[fileURL.relativePath] = shasum
                     }
                 }
-            } catch { print(error, fileURL) }
+            } catch {
+                printStdErr(error.localizedDescription)
+                printStdErr(fileURL.absoluteString)
+            }
         }
 
         writeLog("PLIST", logLevel: .info)
@@ -90,7 +93,7 @@ func checksumAllFiles() {
             if let plist = try PropertyListSerialization.propertyList(from: data, options: [], format: nil) as? [String: Any] {
                 let formatted = try PropertyListSerialization.data(fromPropertyList: plist, format: .xml, options: 0)
                 if let string = String(data: formatted, encoding: .utf8) {
-                    print(string)
+                    printStdOut(string)
                 }
             }
         } catch {

diff --git a/Outset/Utils/Logging.swift b/Outset/Utils/Logging.swift
@@ -8,6 +8,21 @@
 import Foundation
 import OSLog
 
+// swiftlint:disable force_try
+class StandardError: TextOutputStream {
+    func write(_ string: String) {
+      if #available(macOS 10.15.4, *) {
+          try! FileHandle.standardError.write(contentsOf: Data(string.utf8))
+      } else {
+          // Fallback on earlier versions
+          if let data = string.data(using: .utf8) {
+              FileHandle.standardError.write(data)
+          }
+      }
+    }
+}
+// swiftlint:enable force_try
+
 func oslogTypeToString(_ type: OSLogType) -> String {
     switch type {
     case OSLogType.default: return "default"
@@ -19,18 +34,34 @@ func oslogTypeToString(_ type: OSLogType) -> String {
     }
 }
 
+func printStdErr(_ errorMessage: String) {
+    var standardError = StandardError()
+    print(errorMessage, to: &standardError)
+}
+
+func printStdOut(_ message: String) {
+    print(message)
+}
+
 func writeLog(_ message: String, logLevel: OSLogType = .info, log: OSLog = osLog) {
     // write to the system logs
+
+    // let logger = Logger()  // 'Logger' is only available in macOS 11.0 or newer so we use os_log
+
     os_log("%{public}@", log: log, type: logLevel, message)
-    if logLevel == .error || logLevel == .info || (debugMode && logLevel == .debug) {
-        // print info, errors and debug to stdout
-        print("\(oslogTypeToString(logLevel).uppercased()): \(message)")
+    switch logLevel {
+    case .error, .debug, .fault:
+        printStdErr("\(oslogTypeToString(logLevel).uppercased()): \(message)")
+    default:
+        printStdOut("\(oslogTypeToString(logLevel).uppercased()): \(message)")
     }
-    // also write to a log file for accessability of those that don't want to manage the system log
+
+    // also write to a log file
     writeFileLog(message: message, logLevel: logLevel)
 }
 
 func writeFileLog(message: String, logLevel: OSLogType) {
+    // write to a log file for accessability of those that don't want to manage the system log
     if logLevel == .debug && !debugMode {
         return
     }
@@ -41,7 +72,8 @@ func writeFileLog(message: String, logLevel: OSLogType) {
         do {
             try FileManager.default.setAttributes(attributes, ofItemAtPath: logFileURL.path)
         } catch {
-            print("\(oslogTypeToString(.error).uppercased()): Unable to create log file at \(logFile)")
+            printStdErr("\(oslogTypeToString(.error).uppercased()): Unable to create log file at \(logFile)")
+            printStdErr(error.localizedDescription)
             return
         }
     }
@@ -58,7 +90,8 @@ func writeFileLog(message: String, logLevel: OSLogType) {
         fileHandle.seekToEndOfFile()
         fileHandle.write(logEntry.data(using: .utf8)!)
     } catch {
-        print("\(oslogTypeToString(.error).uppercased()): Unable to read log file at \(logFile)")
+        printStdErr("\(oslogTypeToString(.error).uppercased()): Unable to read log file at \(logFile)")
+        printStdErr(error.localizedDescription)
         return
     }
 }