feat: ACI-4180 Add to GITHUB_PATH, add --timestamps option (#174)

Author: zsolt-marta-bitrise

cmd/xcode/activate_xcode.go

@@ -1,6 +1,7 @@
 package xcode
 
 import (
+	"bufio"
 	"cmp"
 	"context"
 	"fmt"
@@ -105,6 +106,10 @@ Useful if there are multiple Xcode versions installed and you want to use a spec
 		"silent",
 		activateXcodeParams.Silent,
 		"Removes all stdout/err logging from the wrapper and proxy. Only xcodebuild logs will be logged.")
+	activateXcodeCmd.Flags().BoolVar(&activateXcodeParams.XcodebuildTimestampsEnabled,
+		"timestamps",
+		activateXcodeParams.XcodebuildTimestampsEnabled,
+		"Enable xcodebuild timestamps. This will add timestamps to the xcodebuild output.")
 }
 
 func ActivateXcodeCommandFn(
@@ -283,6 +288,9 @@ func addXcelerateCommandToPathWithScriptWrapper(
 	pathContent := fmt.Sprintf("export PATH=%s:$PATH", binPath)
 
 	addPathToEnvman(ctx, commandFunc, binPath, envs, logger)
+	if err = addPathToGithubPathFile(osProxy, binPath, envs, logger); err != nil {
+		logger.Errorf("failed to add path to github path file: %s", err)
+	}
 
 	logger.Debugf("Adding xcelerate command to PATH in ~/.bashrc: %s", binPath)
 	err = utils.AddContentOrCreateFile(logger,
@@ -307,6 +315,30 @@ func addXcelerateCommandToPathWithScriptWrapper(
 	return nil
 }
 
+func addPathToGithubPathFile(osProxy utils.OsProxy, binPath string, envs map[string]string, logger log.Logger) error {
+	filePath := envs["GITHUB_PATH"]
+	if filePath == "" {
+		return nil
+	}
+
+	logger.Infof("Adding path to %s", filePath)
+	f, err := osProxy.OpenFile(filePath, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0o644)
+	if err != nil {
+		return fmt.Errorf("failed to open GITHUB_PATH file: %w", err)
+	}
+	defer f.Close()
+
+	writer := bufio.NewWriter(f)
+	if _, err := writer.WriteString(binPath); err != nil {
+		return fmt.Errorf("failed to write to GITHUB_PATH file: %w", err)
+	}
+	if err := writer.Flush(); err != nil {
+		return fmt.Errorf("failed to flush GITHUB_PATH file: %w", err)
+	}
+
+	return nil
+}
+
 func addPathToEnvman(
 	ctx context.Context,
 	commandFunc utils.CommandFunc,

cmd/xcode/activate_xcode_test.go

@@ -23,6 +23,7 @@ func TestActivateXcode_activateXcodeCmdFn(t *testing.T) {
 	envs := map[string]string{
 		"BITRISE_BUILD_CACHE_AUTH_TOKEN":   "token",
 		"BITRISE_BUILD_CACHE_WORKSPACE_ID": "abc123",
+		"GITHUB_PATH":                      filepath.Join(home, ".github_path"),
 	}
 
 	t.Run("success", func(t *testing.T) {
@@ -61,6 +62,7 @@ func TestActivateXcode_activateXcodeCmdFn(t *testing.T) {
 		// make sure files were created
 		assert.FileExists(t, filepath.Join(home, ".bashrc"))
 		assert.FileExists(t, filepath.Join(home, ".zshrc"))
+		assert.FileExists(t, filepath.Join(home, ".github_path"))
 		assert.FileExists(t, xcelerate.PathFor(osProxy, filepath.Join(xcelerate.BinDir, "bitrise-build-cache-cli")))
 		assert.FileExists(t, xcelerate.PathFor(osProxy, filepath.Join(xcelerate.BinDir, "xcodebuild")))
 

internal/config/xcelerate/config.go

@@ -24,13 +24,14 @@ const (
 )
 
 type Params struct {
-	BuildCacheEnabled       bool
-	BuildCacheEndpoint      string
-	DebugLogging            bool
-	Silent                  bool
-	XcodePathOverride       string
-	ProxySocketPathOverride string
-	PushEnabled             bool
+	BuildCacheEnabled           bool
+	BuildCacheEndpoint          string
+	DebugLogging                bool
+	Silent                      bool
+	XcodePathOverride           string
+	ProxySocketPathOverride     string
+	PushEnabled                 bool
+	XcodebuildTimestampsEnabled bool
 }
 
 type Config struct {
@@ -44,6 +45,7 @@ type Config struct {
 	PushEnabled            bool                   `json:"pushEnabled"`
 	DebugLogging           bool                   `json:"debugLogging,omitempty"`
 	Silent                 bool                   `json:"silent,omitempty"`
+	XcodebuildTimestamps   bool                   `json:"xcodebuildTimestamps,omitempty"`
 	AuthConfig             common.CacheAuthConfig `json:"authConfig,omitempty"`
 }
 
@@ -67,13 +69,14 @@ func ReadConfig(osProxy utils.OsProxy, decoderFactory utils.DecoderFactory) (Con
 
 func DefaultParams() Params {
 	return Params{
-		BuildCacheEnabled:       true,
-		BuildCacheEndpoint:      "",
-		Silent:                  false,
-		DebugLogging:            false,
-		XcodePathOverride:       "",
-		ProxySocketPathOverride: "",
-		PushEnabled:             true,
+		BuildCacheEnabled:           true,
+		BuildCacheEndpoint:          "",
+		Silent:                      false,
+		DebugLogging:                false,
+		XcodePathOverride:           "",
+		ProxySocketPathOverride:     "",
+		PushEnabled:                 true,
+		XcodebuildTimestampsEnabled: false,
 	}
 }
 
@@ -125,6 +128,10 @@ func NewConfig(ctx context.Context,
 		logger.Warnf("Both debug and silent logging specified, silent will take precedence.")
 		params.DebugLogging = false
 	}
+	if params.XcodebuildTimestampsEnabled && params.Silent {
+		logger.Warnf("Both timestamps and silent logging specified, silent will take precedence.")
+		params.XcodebuildTimestampsEnabled = false
+	}
 
 	return Config{
 		ProxyVersion:           envs["BITRISE_XCELERATE_PROXY_VERSION"],
@@ -137,6 +144,7 @@ func NewConfig(ctx context.Context,
 		PushEnabled:            params.PushEnabled,
 		DebugLogging:           params.DebugLogging,
 		Silent:                 params.Silent,
+		XcodebuildTimestamps:   params.XcodebuildTimestampsEnabled,
 		AuthConfig:             authConfig,
 	}, nil
 }

internal/config/xcelerate/config_test.go

@@ -68,6 +68,7 @@ func TestConfig_Save(t *testing.T) {
 			OriginalXcodebuildPath: "/usr/bin/xcodebuild",
 			BuildCacheEnabled:      true,
 			DebugLogging:           true,
+			XcodebuildTimestamps:   true,
 		}
 		err := config.Save(mockLogger, mockOsProxy, mockEncoderFactory)
 
@@ -205,8 +206,9 @@ func TestConfig_NewConfig(t *testing.T) {
 		}
 
 		actual, err := xcelerate.NewConfig(context.Background(), mockLogger, xcelerate.Params{
-			BuildCacheEnabled: true,
-			DebugLogging:      true,
+			BuildCacheEnabled:           true,
+			DebugLogging:                true,
+			XcodebuildTimestampsEnabled: true,
 		}, envs, osProxyMock, func(_ context.Context, command string, args ...string) utils.Command {
 			assert.Equal(t, "which", command)
 			require.Len(t, args, 1)
@@ -225,6 +227,7 @@ func TestConfig_NewConfig(t *testing.T) {
 			BuildCacheEndpoint:     "grpcs://bitrise-accelerate.services.bitrise.io",
 			BuildCacheEnabled:      true,
 			DebugLogging:           true,
+			XcodebuildTimestamps:   true,
 			AuthConfig: common.CacheAuthConfig{
 				AuthToken:   "auth-token",
 				WorkspaceID: "workspace-id",
@@ -257,9 +260,10 @@ func TestConfig_NewConfig(t *testing.T) {
 		}
 
 		actual, err := xcelerate.NewConfig(context.Background(), mockLogger, xcelerate.Params{
-			BuildCacheEnabled: true,
-			DebugLogging:      true,
-			Silent:            true,
+			BuildCacheEnabled:           true,
+			DebugLogging:                true,
+			Silent:                      true,
+			XcodebuildTimestampsEnabled: true,
 		}, envs, osProxyMock, func(_ context.Context, command string, args ...string) utils.Command {
 			return cmdMock
 		})
@@ -274,6 +278,7 @@ func TestConfig_NewConfig(t *testing.T) {
 			BuildCacheEndpoint:     "grpcs://bitrise-accelerate.services.bitrise.io",
 			BuildCacheEnabled:      true,
 			DebugLogging:           false,
+			XcodebuildTimestamps:   false,
 			Silent:                 true,
 			AuthConfig: common.CacheAuthConfig{
 				AuthToken:   "auth-token",

internal/xcelerate/xcodeargs/runner.go

@@ -1,14 +1,17 @@
 package xcodeargs
 
 import (
+	"bufio"
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"os"
 	"os/exec"
 	"os/signal"
 	"regexp"
 	"strings"
+	"sync"
 	"syscall"
 	"time"
 
@@ -58,14 +61,15 @@ func (runner *DefaultRunner) Run(ctx context.Context, args []string) RunStats {
 	runner.logger.TInfof("Running xcodebuild command: %s", strings.Join(append([]string{xcodePath}, args...), " "))
 
 	innerCmd := exec.CommandContext(ctx, xcodePath, args...)
-	innerCmd.Stdout = os.Stdout
-	innerCmd.Stderr = os.Stderr
 	innerCmd.Stdin = os.Stdin
+	var wg sync.WaitGroup
+	runner.setupOutputPipes(ctx, innerCmd, &wg)
 
 	interruptCtx, cancel := context.WithCancel(ctx)
 	runner.handleInterrupt(interruptCtx, innerCmd)
 
 	err := innerCmd.Run()
+	wg.Wait()
 
 	cancel()
 	duration := time.Since(runStats.StartTime)
@@ -88,6 +92,31 @@ func (runner *DefaultRunner) Run(ctx context.Context, args []string) RunStats {
 	return runStats
 }
 
+func (runner *DefaultRunner) setupOutputPipes(ctx context.Context, cmd *exec.Cmd, wg *sync.WaitGroup) {
+	stdOutReader, err := cmd.StdoutPipe()
+	if err != nil {
+		runner.logger.Errorf("Failed to get stdout pipe: %v", err)
+		cmd.Stdout = os.Stdout
+	} else {
+		wg.Add(1)
+		go func() {
+			runner.streamOutput(ctx, stdOutReader, os.Stdout)
+			wg.Done()
+		}()
+	}
+	stdErrReader, err := cmd.StderrPipe()
+	if err != nil {
+		runner.logger.Errorf("Failed to get stderr pipe: %v", err)
+		cmd.Stderr = os.Stderr
+	} else {
+		wg.Add(1)
+		go func() {
+			runner.streamOutput(ctx, stdErrReader, os.Stderr)
+			wg.Done()
+		}()
+	}
+}
+
 func (runner *DefaultRunner) handleInterrupt(ctx context.Context, cmd *exec.Cmd) {
 	sig := make(chan os.Signal, 1)
 	signal.Notify(sig, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
@@ -157,3 +186,31 @@ func (runner *DefaultRunner) determineXcodeVersionAndBuildNumber(ctx context.Con
 
 	return nil
 }
+
+func (runner *DefaultRunner) streamOutput(ctx context.Context, reader io.ReadCloser, writer io.Writer) {
+	scanner := bufio.NewScanner(reader)
+	const maxTokenSize = 10 * 1024 * 1024
+	buf := make([]byte, 0, 64*1024)
+	scanner.Buffer(buf, maxTokenSize)
+	for scanner.Scan() {
+		select {
+		case <-ctx.Done():
+			return
+		default:
+		}
+
+		line := scanner.Text()
+
+		if runner.config.XcodebuildTimestamps && !runner.config.Silent {
+			timestamp := time.Now().Format("15:04:05")
+			line = fmt.Sprintf("[%s] %s", timestamp, line)
+		}
+
+		//nolint: errcheck
+		fmt.Fprintf(writer, "%s\n", line)
+	}
+
+	if err := scanner.Err(); err != nil {
+		runner.logger.Errorf("Failed to scan stdout: %v", err)
+	}
+}