[STEP-2079] Add xcbeautify log formatter (#373)

- Added xcbeautify log formatter option.
- Fixed findIDEDistrubutionLogsPath lookup, broken due to different quoting in latest Xcodes.
- Removed extraneous %!(EXTRA ) from plsit content printing.
- Some logging improvements.
- Removed errorFormatter and xcodebuild errorfinder in the step as package version is available.

Author: lpusok

README.md

@@ -128,7 +128,7 @@ Build a development IPA with custom xcconfig file path:
 | `xcconfig_content` | Build settings to override the project's build settings, using xcodebuild's `-xcconfig` option.  You can't define `-xcconfig` option in `Additional options for the xcodebuild command` if this input is set.  If empty, no setting is changed. When set it can be either: 1.  Existing `.xcconfig` file path.      Example:      `./ios-sample/ios-sample/Configurations/Dev.xcconfig`  2.  The contents of a newly created temporary `.xcconfig` file. (This is the default.)      Build settings must be separated by newline character (`\n`).      Example:     ```     COMPILER_INDEX_STORE_ENABLE = NO     ONLY_ACTIVE_ARCH[config=Debug][sdk=*][arch=*] = YES     ``` |  | `COMPILER_INDEX_STORE_ENABLE = NO` |
 | `perform_clean_action` | If this input is set, `clean` xcodebuild action will be performed besides the `archive` action. | required | `no` |
 | `xcodebuild_options` | Additional options to be added to the executed xcodebuild command.  Prefer using `Build settings (xcconfig)` input for specifying `-xcconfig` option. You can't use both.  `-destination` is set automatically, unless specified explicitely. |  |  |
-| `log_formatter` | Defines how `xcodebuild` command's log is formatted.  Available options:  - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty. - `xcodebuild`: Only the last 20 lines of raw xcodebuild output will be visible in the build log.  The raw xcodebuild log will be exported in both cases. | required | `xcpretty` |
+| `log_formatter` | Defines how `xcodebuild` command's log is formatted.  Available options: - `xcbeautify`: The xcodebuild command's output will be beautified by xcbeautify. - `xcodebuild`: Only the last 20 lines of raw xcodebuild output will be visible in the build log. - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty.  The raw xcodebuild log will be exported in both cases. | required | `xcpretty` |
 | `automatic_code_signing` | This input determines which Bitrise Apple service connection should be used for automatic code signing.  Available values: - `off`: Do not do any auto code signing. - `api-key`: [Bitrise Apple Service connection with API Key](https://devcenter.bitrise.io/getting-started/connecting-to-services/setting-up-connection-to-an-apple-service-with-api-key/). - `apple-id`: [Bitrise Apple Service connection with Apple ID](https://devcenter.bitrise.io/getting-started/connecting-to-services/connecting-to-an-apple-service-with-apple-id/). | required | `off` |
 | `register_test_devices` | If this input is set, the Step will register the known test devices on Bitrise from team members with the Apple Developer Portal.  Note that setting this to yes may cause devices to be registered against your limited quantity of test devices in the Apple Developer Portal, which can only be removed once annually during your renewal window. | required | `no` |
 | `test_device_list_path` | If this input is set, the Step will register the listed devices from this file with the Apple Developer Portal.  The format of the file is a comma separated list of the identifiers. For example: `00000000–0000000000000001,00000000–0000000000000002,00000000–0000000000000003`  And in the above example the registered devices appear with the name of `Device 1`, `Device 2` and `Device 3` in the Apple Developer Portal.  Note that setting this will have a higher priority than the Bitrise provided devices list. |  |  |

e2e/bitrise.yml

@@ -308,7 +308,7 @@ workflows:
     - CODE_SIGNING_METHOD: api-key
     - MIN_DAYS_PROFILE_VALID: 0
     - IPA_EXPORT_METHOD: app-store
-    - LOG_FORMATTER: xcpretty
+    - LOG_FORMATTER: xcbeautify
     after_run:
     - _run
     - _check_outputs
@@ -335,7 +335,7 @@ workflows:
     - TEAM_ID: 72SA8V3WYL
     - MIN_DAYS_PROFILE_VALID: 0
     - IPA_EXPORT_METHOD: app-store
-    - LOG_FORMATTER: xcpretty
+    - LOG_FORMATTER: xcbeautify
     after_run:
     - _run
     - _check_outputs

formatted_error_test.go

@@ -8,7 +8,7 @@ require (
 	github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.23
 	github.com/bitrise-io/go-utils v1.0.12
 	github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.23
-	github.com/bitrise-io/go-xcode v1.1.2
+	github.com/bitrise-io/go-xcode v1.2.0
 	github.com/bitrise-io/go-xcode/v2 v2.0.0-alpha.54
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
 	github.com/stretchr/testify v1.10.0

go.mod

@@ -11,8 +11,8 @@ github.com/bitrise-io/go-utils v1.0.12 h1:iJV1ZpyvSA0NCte/N6x+aIQ9TrNr5sIBlcJBf0
 github.com/bitrise-io/go-utils v1.0.12/go.mod h1:ZY1DI+fEpZuFpO9szgDeICM4QbqoWVt0RSY3tRI1heY=
 github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.23 h1:Dfh4nyZPuEtilBisidejqxBrkx9cWvbOUrpq8VEION0=
 github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.23/go.mod h1:3XUplo0dOWc3DqT2XA2SeHToDSg7+j1y1HTHibT2H68=
-github.com/bitrise-io/go-xcode v1.1.2 h1:7tit56lNPPzH714pBt083z/iZh7P44vgVsNrEdvkYG4=
-github.com/bitrise-io/go-xcode v1.1.2/go.mod h1:9OwsvrhZ4A2JxHVoEY7CPcABAKA+OE7FQqFfBfvbFuY=
+github.com/bitrise-io/go-xcode v1.2.0 h1:rbyeM7y1CcGD+udmODEPcVN6ek4HjuP9DQ/FHNY3JPE=
+github.com/bitrise-io/go-xcode v1.2.0/go.mod h1:9OwsvrhZ4A2JxHVoEY7CPcABAKA+OE7FQqFfBfvbFuY=
 github.com/bitrise-io/go-xcode/v2 v2.0.0-alpha.54 h1:xTIh8AbSVWfSpkhyHj0uOO0I9BPjz5yJcIIPVy3TbGg=
 github.com/bitrise-io/go-xcode/v2 v2.0.0-alpha.54/go.mod h1:T4rhWQljdgH5As4Dq/RQWuazdScY0YB7uZAMuBUnxeY=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=

go.sum

@@ -1,16 +1,18 @@
 package main
 
 import (
-	"errors"
 	"fmt"
 	"os"
 
+	"github.com/bitrise-io/go-steputils/v2/ruby"
 	"github.com/bitrise-io/go-steputils/v2/stepconf"
 	"github.com/bitrise-io/go-utils/v2/command"
 	"github.com/bitrise-io/go-utils/v2/env"
+	"github.com/bitrise-io/go-utils/v2/errorutil"
 	"github.com/bitrise-io/go-utils/v2/fileutil"
 	"github.com/bitrise-io/go-utils/v2/log"
 	"github.com/bitrise-io/go-utils/v2/pathutil"
+	"github.com/bitrise-io/go-xcode/v2/xcodecommand"
 	"github.com/bitrise-steplib/steps-xcode-archive/step"
 )
 
@@ -20,66 +22,84 @@ func main() {
 
 func run() int {
 	logger := log.NewLogger()
-	archiver := createXcodebuildArchiver(logger)
-
-	config, err := archiver.ProcessInputs()
+	configParser := createConfigParser(logger)
+	config, err := configParser.ProcessInputs()
 	if err != nil {
-		logger.Errorf(formattedError(fmt.Errorf("Failed to process Step inputs: %w", err)))
+		logger.Errorf("%s", errorutil.FormattedError(fmt.Errorf("Failed to process Step inputs: %w", err)))
 		return 1
 	}
 
-	dependenciesOpts := step.EnsureDependenciesOpts{
-		XCPretty: config.LogFormatter == "xcpretty",
-	}
-	if err := archiver.EnsureDependencies(dependenciesOpts); err != nil {
-		var xcprettyInstallErr step.XCPrettyInstallError
-		if errors.As(err, &xcprettyInstallErr) {
-			logger.Warnf("Installing xcpretty failed: %s", err)
-			logger.Warnf("Switching to xcodebuild for log formatter")
-			config.LogFormatter = "xcodebuild"
-		} else {
-			logger.Errorf(formattedError(fmt.Errorf("Failed to install Step dependencies: %w", err)))
-			return 1
-		}
+	archiver, err := createXcodebuildArchiver(logger, config.LogFormatter)
+	if err != nil {
+		logger.Errorf("%s", errorutil.FormattedError(fmt.Errorf("Failed to process Step inputs: %w", err)))
+		return 1
 	}
 
+	archiver.EnsureDependencies()
+
 	exitCode := 0
 	runOpts := createRunOptions(config)
 	result, err := archiver.Run(runOpts)
 	if err != nil {
-		logger.Errorf(formattedError(fmt.Errorf("Failed to execute Step main logic: %w", err)))
+		logger.Errorf("%s", errorutil.FormattedError(fmt.Errorf("Failed to execute Step main logic: %w", err)))
 		exitCode = 1
 		// don't return as step outputs needs to be exported even in case of failure (for example the xcodebuild logs)
 	}
 
 	exportOpts := createExportOptions(config, result)
 	if err := archiver.ExportOutput(exportOpts); err != nil {
-		logger.Errorf(formattedError(fmt.Errorf("Failed to export Step outputs: %w", err)))
+		logger.Errorf("%s", errorutil.FormattedError(fmt.Errorf("Failed to export Step outputs: %w", err)))
 		return 1
 	}
 
 	return exitCode
 }
 
-func createXcodebuildArchiver(logger log.Logger) step.XcodebuildArchiver {
-	xcodeVersionProvider := step.NewXcodebuildXcodeVersionProvider()
+func createConfigParser(logger log.Logger) step.XcodebuildArchiveConfigParser {
 	envRepository := env.NewRepository()
 	inputParser := stepconf.NewInputParser(envRepository)
+	xcodeVersionProvider := step.NewXcodebuildXcodeVersionProvider()
+	fileManager := fileutil.NewFileManager()
+	cmdFactory := command.NewFactory(envRepository)
+
+	return step.NewXcodeArchiveConfigParser(inputParser, xcodeVersionProvider, fileManager, cmdFactory, logger)
+}
+
+func createXcodebuildArchiver(logger log.Logger, logFormatter string) (step.XcodebuildArchiver, error) {
+	envRepository := env.NewRepository()
 	pathProvider := pathutil.NewPathProvider()
 	pathChecker := pathutil.NewPathChecker()
 	pathModifier := pathutil.NewPathModifier()
 	fileManager := fileutil.NewFileManager()
 	cmdFactory := command.NewFactory(envRepository)
 
-	return step.NewXcodebuildArchiver(xcodeVersionProvider, inputParser, pathProvider, pathChecker, pathModifier, fileManager, logger, cmdFactory)
+	xcodeCommandRunner := xcodecommand.Runner(nil)
+	switch logFormatter {
+	case step.XcodebuildTool:
+		xcodeCommandRunner = xcodecommand.NewRawCommandRunner(logger, cmdFactory)
+	case step.XcbeautifyTool:
+		xcodeCommandRunner = xcodecommand.NewXcbeautifyRunner(logger, cmdFactory)
+	case step.XcprettyTool:
+		commandLocator := env.NewCommandLocator()
+		rubyComamndFactory, err := ruby.NewCommandFactory(cmdFactory, commandLocator)
+		if err != nil {
+			return step.XcodebuildArchiver{}, fmt.Errorf("failed to install xcpretty: %s", err)
+		}
+		rubyEnv := ruby.NewEnvironment(rubyComamndFactory, commandLocator, logger)
+
+		xcodeCommandRunner = xcodecommand.NewXcprettyCommandRunner(logger, cmdFactory, pathChecker, fileManager, rubyComamndFactory, rubyEnv)
+	default:
+		panic(fmt.Sprintf("Unknown log formatter: %s", logFormatter))
+	}
+
+	return step.NewXcodebuildArchiver(xcodeCommandRunner, logFormatter, pathProvider, pathChecker, pathModifier, fileManager, cmdFactory, logger), nil
 }
 
 func createRunOptions(config step.Config) step.RunOpts {
 	return step.RunOpts{
 		ProjectPath:       config.ProjectPath,
 		Scheme:            config.Scheme,
 		Configuration:     config.Configuration,
-		LogFormatter:      config.LogFormatter,
 		XcodeMajorVersion: config.XcodeMajorVersion,
 		ArtifactName:      config.ArtifactName,
 

main.go

@@ -175,14 +175,15 @@ inputs:
       Defines how `xcodebuild` command's log is formatted.
 
       Available options:
-
-      - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty.
+      - `xcbeautify`: The xcodebuild command's output will be beautified by xcbeautify.
       - `xcodebuild`: Only the last 20 lines of raw xcodebuild output will be visible in the build log.
+      - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty.
 
       The raw xcodebuild log will be exported in both cases.
     value_options:
-    - xcpretty
+    - xcbeautify
     - xcodebuild
+    - xcpretty
     is_required: true
 
 # Automatic code signing

step.yml

@@ -1,56 +1,33 @@
 package step
 
 import (
-	"bytes"
 	"fmt"
 	"os"
 	"strings"
-	"time"
 
-	"github.com/bitrise-io/go-utils/progress"
 	"github.com/bitrise-io/go-utils/v2/log"
+	"github.com/bitrise-io/go-xcode/v2/xcodecommand"
 	"github.com/bitrise-io/go-xcode/xcodebuild"
 	cache "github.com/bitrise-io/go-xcode/xcodecache"
-	"github.com/bitrise-io/go-xcode/xcpretty"
 )
 
-func runArchiveCommandWithRetry(archiveCmd *xcodebuild.CommandBuilder, useXcpretty bool, swiftPackagesPath string, logger log.Logger) (string, error) {
-	output, err := runArchiveCommand(archiveCmd, useXcpretty, logger)
+func runArchiveCommandWithRetry(xcodeCommandRunner xcodecommand.Runner, logFormatter string, archiveCmd *xcodebuild.CommandBuilder, swiftPackagesPath string, logger log.Logger) (string, error) {
+	output, err := runArchiveCommand(xcodeCommandRunner, logFormatter, archiveCmd, logger)
 	if err != nil && swiftPackagesPath != "" && strings.Contains(output, cache.SwiftPackagesStateInvalid) {
 		logger.Warnf("Archive failed, swift packages cache is in an invalid state, error: %s", err)
 		if err := os.RemoveAll(swiftPackagesPath); err != nil {
 			return output, fmt.Errorf("failed to remove invalid Swift package caches, error: %s", err)
 		}
-		return runArchiveCommand(archiveCmd, useXcpretty, logger)
+		return runArchiveCommand(xcodeCommandRunner, logFormatter, archiveCmd, logger)
 	}
 	return output, err
 }
 
-func runArchiveCommand(archiveCmd *xcodebuild.CommandBuilder, useXcpretty bool, logger log.Logger) (string, error) {
-	if useXcpretty {
-		xcprettyCmd := xcpretty.New(archiveCmd)
-
-		logger.TDonef("$ %s", xcprettyCmd.PrintableCmd())
-		logger.Println()
-
-		out, err := xcprettyCmd.Run()
-		return out, wrapXcodebuildCommandError(xcprettyCmd, out, err)
+func runArchiveCommand(xcodeCommandRunner xcodecommand.Runner, logFormatter string, archiveCmd *xcodebuild.CommandBuilder, logger log.Logger) (string, error) {
+	output, err := xcodeCommandRunner.Run("", archiveCmd.CommandArgs(), []string{})
+	if logFormatter == XcodebuildTool || err != nil {
+		printLastLinesOfXcodebuildLog(logger, string(output.RawOut), err == nil)
 	}
 
-	// Using xcodebuild
-	logger.TDonef("$ %s", archiveCmd.PrintableCmd())
-	logger.Println()
-
-	var output bytes.Buffer
-	archiveRootCmd := archiveCmd.Command()
-	archiveRootCmd.SetStdout(&output)
-	archiveRootCmd.SetStderr(&output)
-
-	var err error
-	progress.SimpleProgress(".", time.Minute, func() {
-		err = archiveRootCmd.Run()
-	})
-	out := output.String()
-
-	return output.String(), wrapXcodebuildCommandError(archiveCmd, out, err)
+	return string(output.RawOut), err
 }