Set up environment and logging infrastructure (#142)

Author: pepicrft

.github/workflows/virtualos.yml

@@ -16,7 +16,7 @@ env:
 jobs:
   build:
     name: "Build"
-    runs-on: "macos-135
+    runs-on: "macos-13"
     steps:
       - uses: actions/checkout@v4
       - uses: jdx/mise-action@v2
@@ -31,7 +31,7 @@ jobs:
 
   bundle:
     name: "Bundle"
-    runs-on: "macos-135
+    runs-on: "macos-13"
     steps:
       - uses: actions/checkout@v4
       - uses: jdx/mise-action@v2
@@ -49,7 +49,7 @@ jobs:
 
   test:
     name: "Test"
-    runs-on: "macos-135
+    runs-on: "macos-13"
     steps:
       - uses: actions/checkout@v4
       - uses: jdx/mise-action@v2
@@ -73,6 +73,16 @@ jobs:
       - name: Run
         run: mise run lint
 
+  implicit-imports:
+    name: Implicit imports
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+        with:
+          experimental: true
+      - run: tuist inspect implicit-imports
+
   cache:
     name: Cache
     runs-on: macos-15

Package.swift

@@ -8,6 +8,7 @@
 
     let packageSettings = PackageSettings(baseSettings: .settings(base: [
         "SWIFT_STRICT_CONCURRENCY": "complete",
+        "GENERATE_MASTER_OBJECT_FILE": "YES",
     ]))
 #endif
 

Sources/VirtualOSEnvironment/Environment.swift

@@ -39,7 +39,7 @@ public struct Environment: Environmenting {
 
     /// It returns the current environment.
     /// - Returns: It should not be used directly, but dependency-injected down from the root of the program.
-    static func current() async throws -> Environment {
+    public static func current() async throws -> Environment {
         let variables = ProcessInfo.processInfo.environment
         let fileSystem = FileSystem()
         let homeDirectory = try variables["HOME"].map { try AbsolutePath(validating: $0) }

Sources/VirtualOSEnvironmentInterface/ServiceContext+Environment.swift

@@ -5,7 +5,7 @@ enum EnvironmentKey: Sendable, ServiceContextKey {
 }
 
 extension ServiceContext {
-    public internal(set) var environment: Environmenting? {
+    public var environment: Environmenting? {
         get {
             self[EnvironmentKey.self]
         }

Sources/VirtualOSLogging/Logger.swift

@@ -10,7 +10,7 @@ enum LoggerKey: ServiceContextKey {
 }
 
 extension ServiceContext {
-    public internal(set) var logger: Logger? {
+    public var logger: Logger? {
         get {
             self[LoggerKey.self]
         }
@@ -24,7 +24,7 @@ extension Logger {
     /// Creates an instance of the default logger.
     /// - Parameter logFilePath: The file where file logs should be stored.
     /// - Returns: An instance of `Logger`.
-    static func makeDefaultLogger(logFilePath: AbsolutePath) -> Logger {
+    public static func makeDefaultLogger(logFilePath: AbsolutePath) -> Logger {
         Logger(label: "dev.tuist.virtualos") { label in
             MultiplexLogHandler([
                 try! FileLogHandler(label: label, localFile: URL(fileURLWithPath: logFilePath.pathString)),

Sources/VirtualOSPull/PullCommand.swift

@@ -1,4 +1,7 @@
 import ArgumentParser
+import Logging
+import ServiceContextModule
+import VirtualOSLogging
 
 /**
  This command is responsible from pulling images from remote registries.
@@ -18,5 +21,7 @@ public struct PullCommand: AsyncParsableCommand {
 
     public init() {}
 
-    public func run() async throws {}
+    public func run() async throws {
+        ServiceContext.current?.logger?.info("Pulling images")
+    }
 }

Sources/virtualos/VirtualOS.swift

@@ -0,0 +1,49 @@
+import ArgumentParser
+import FileSystem
+import Foundation
+import Logging
+import Path
+import ServiceContextModule
+import VirtualOSEnvironment
+import VirtualOSEnvironmentInterface
+import VirtualOSLogging
+
+@main
+private enum VirtualOS {
+    static func main() async throws {
+        let fileSystem = FileSystem()
+        let environment = try await Environment.current()
+        let logFilePath = environment.cacheDirectory.appending(components: ["logs", "\(UUID().uuidString).log"])
+        if try await !fileSystem.exists(logFilePath.parentDirectory) {
+            try await fileSystem.makeDirectory(at: logFilePath.parentDirectory)
+        }
+        let logger = Logger.makeDefaultLogger(logFilePath: logFilePath)
+        var serviceContext = ServiceContext.topLevel
+        serviceContext.logger = logger
+        serviceContext.environment = environment
+
+        await ServiceContext.$current.withValue(serviceContext) {
+            defer {
+                showCompletion(logFilePath: logFilePath)
+            }
+
+            do {
+                var command = try VirtualOSCommand.parseAsRoot()
+                if var asyncCommand = command as? AsyncParsableCommand {
+                    try await asyncCommand.run()
+                } else {
+                    try command.run()
+                }
+            } catch {
+                showCompletion(logFilePath: logFilePath)
+                VirtualOSCommand.exit(withError: error)
+            }
+        }
+    }
+
+    private static func showCompletion(logFilePath: AbsolutePath) {
+        if !CommandLine.arguments.contains("--help"), !CommandLine.arguments.contains("-h") {
+            print("Logs available at: \(logFilePath.pathString)")
+        }
+    }
+}

Sources/virtualos/VirtualOSCommand.swift

@@ -3,7 +3,6 @@ import Foundation
 import VirtualOSPull
 import VirtualOSRun
 
-@main
 struct VirtualOSCommand: AsyncParsableCommand {
     static let configuration = CommandConfiguration(
         commandName: "virtualos",

Tuist/ProjectDescriptionHelpers/Module.swift

@@ -50,11 +50,20 @@ public enum Module: CaseIterable {
         case .virtualos: return [
                 .target(name: Module.pull.targetName),
                 .target(name: Module.run.targetName),
+                .target(name: Module.logging.targetName),
+                .target(name: Module.environment.targetName),
+                .target(name: Module.environment.interfaceTargetName!),
+                .external(name: "ServiceContextModule"),
                 .external(name: "ArgumentParser"),
+                .external(name: "Logging"),
+                .external(name: "Path"),
             ]
         case .pull: return [
+                .target(name: Module.logging.targetName),
                 .external(name: "ArgumentParser"),
                 .external(name: "Path"),
+                .external(name: "ServiceContextModule"),
+                .external(name: "Logging"),
             ]
         case .run: return [
                 .external(name: "ArgumentParser"),