Feat: customize console output with env variable (apple#952)

Fixes apple#915

Added a new feature to support the passing of buildkit colors for
customizing console output.

Author: karenheckel

Sources/ContainerCommands/Builder/BuilderStart.swift

@@ -88,10 +88,26 @@ extension Application {
 
  let builderPlatform = ContainerizationOCI.Platform(arch: "arm64", os: "linux", variant: "v8")
 
+ var targetEnvVars: [String] = []
+ if let buildkitColors = ProcessInfo.processInfo.environment["BUILDKIT_COLORS"] {
+                targetEnvVars.append("BUILDKIT_COLORS=\(buildkitColors)")
+ }
+ if ProcessInfo.processInfo.environment["NO_COLOR"] != nil {
+                targetEnvVars.append("NO_COLOR=true")
+ }
+            targetEnvVars.sort()
+
  let existingContainer = try? await ClientContainer.get(id: "buildkit")
  if let existingContainer {
  let existingImage = existingContainer.configuration.image.reference
  let existingResources = existingContainer.configuration.resources
+ let existingEnv = existingContainer.configuration.initProcess.environment
+
+ let existingManagedEnv = existingEnv.filter { envVar in
+                    envVar.hasPrefix("BUILDKIT_COLORS=") || envVar.hasPrefix("NO_COLOR=")
+ }.sorted()
+
+ let envChanged = existingManagedEnv != targetEnvVars
 
                 // Check if we need to recreate the builder due to different image
  let imageChanged = existingImage != builderImage
@@ -115,7 +131,7 @@ extension Application {
 
  switch existingContainer.status {
  case .running:
- guard imageChanged || cpuChanged || memChanged else {
+ guard imageChanged || cpuChanged || memChanged || envChanged else {
                         // If image, mem and cpu are the same, continue using the existing builder
  return
  }
@@ -125,7 +141,7 @@ extension Application {
  case .stopped:
                     // If the builder is stopped and matches our requirements, start it
                     // Otherwise, delete it and create a new one
- guard imageChanged || cpuChanged || memChanged else {
+ guard imageChanged || cpuChanged || memChanged || envChanged else {
  try await existingContainer.startBuildKit(progressUpdate, nil)
  return
  }
@@ -173,10 +189,13 @@ extension Application {
  )
 
  let imageConfig = try await image.config(for: builderPlatform).config
+ var environment = imageConfig?.env ?? []
+            environment.append(contentsOf: targetEnvVars)
+
  let processConfig = ProcessConfiguration(
                 executable: "/usr/local/bin/container-builder-shim",
                 arguments: shimArguments,
-                environment: imageConfig?.env ?? [],
+                environment: environment,
                 workingDirectory: "/",
                 terminal: false,
                 user: .id(uid: 0, gid: 0)

Tests/CLITests/Subcommands/Build/CLIBuilderLifecycleTest.swift

@@ -33,5 +33,52 @@ extension TestCLIBuildBase {
                 #expect(status == "stopped", "BuildKit container is not stopped")
  }
  }
+
+ @Test func testBuilderEnvironmentColors() throws {
+ let testColors = "run=green:warning=yellow:error=red:cancel=cyan"
+ let testNoColor = "true"
+
+ let originalColors = ProcessInfo.processInfo.environment["BUILDKIT_COLORS"]
+ let originalNoColor = ProcessInfo.processInfo.environment["NO_COLOR"]
+
+ defer {
+ if let originalColors {
+ setenv("BUILDKIT_COLORS", originalColors, 1)
+ } else {
+ unsetenv("BUILDKIT_COLORS")
+ }
+ if let originalNoColor {
+ setenv("NO_COLOR", originalNoColor, 1)
+ } else {
+ unsetenv("NO_COLOR")
+ }
+
+ try? builderStop()
+ try? builderDelete(force: true)
+ }
+
+ setenv("BUILDKIT_COLORS", testColors, 1)
+ setenv("NO_COLOR", testNoColor, 1)
+
+ try? builderStop()
+ try? builderDelete(force: true)
+
+ let (_, _, err, status) = try run(arguments: ["builder", "start"])
+ try #require(status == 0, "builder start failed: \(err)")
+
+ try waitForBuilderRunning()
+
+ let container = try inspectContainer("buildkit")
+ let envVars = container.configuration.initProcess.environment
+
+            #expect(
+                envVars.contains("BUILDKIT_COLORS=\(testColors)"),
+ "Expected BUILDKIT_COLORS to be passed to container, but it was missing from env: \(envVars)"
+ )
+            #expect(
+                envVars.contains("NO_COLOR=\(testNoColor)"),
+ "Expected NO_COLOR to be passed to container, but it was missing from env: \(envVars)"
+ )
+ }
  }
 }