Add status reason messaging

_tests/integration/log_format_test.go

@@ -150,9 +150,7 @@ func convertStepFinishedEventLog(line []byte) (string, error) {
 	if err != nil {
 		return "", err
 	}
-
-	eventLog.Content.InternalStatus = models.InternalStatus(eventLog.Content.Status)
-
+
 	var buf bytes.Buffer
 	logger := log.NewLogger(log.LoggerOpts{LoggerType: log.ConsoleLogger, Writer: &buf})
 	logger.PrintStepFinishedEvent(eventLog.Content)

bitrise/print.go

@@ -25,21 +25,25 @@ const (
 //------------------------------
 
 func trimTitle(title string, titleSuffix string, titleBoxWidth int) string {
-	length := len(title)
-	if titleSuffix != "" {
-		length += 1 + len(titleSuffix)
-	}
+	titleWithSuffix := combineTitleAndSuffix(title, titleSuffix)
+	return log.WidthConstrainedString(titleWithSuffix, titleBoxWidth)
+}
 
-	if length > titleBoxWidth {
-		diff := length - titleBoxWidth
-		title = stringutil.MaxFirstCharsWithDots(title, len(title)-diff)
+func combineTitleAndSuffix(title, suffix string) string {
+	var titleWithSuffix string
+
+	if len(title) > 0 {
+		titleWithSuffix = title
 	}
 
-	if titleSuffix == "" {
-		return title
+	if len(suffix) > 0 {
+		if len(titleWithSuffix) > 0 {
+			titleWithSuffix += " "
+		}
+		titleWithSuffix += suffix
 	}
 
-	return fmt.Sprintf("%s %s", title, titleSuffix)
+	return titleWithSuffix
 }
 
 func getTrimmedStepName(stepRunResult models.StepRunResultsModel) string {
@@ -59,7 +63,7 @@ func getTrimmedStepName(stepRunResult models.StepRunResultsModel) string {
 	}
 
 	suffix := ""
-	reason := stepRunResult.Status.Reason(stepRunResult.ExitCode)
+	reason := stepRunResult.Status.Name()
 	if reason != "" {
 		suffix = fmt.Sprintf("(%s)", reason)
 	}

bitrise/print_test.go

@@ -39,7 +39,7 @@ func TestGetTrimmedStepName(t *testing.T) {
 		require.Equal(t, expected, actual)
 	}
 
-	t.Log("failed step")
+	t.Log("successful step - empty title")
 	{
 		stepInfo := stepmanModels.StepInfoModel{
 			Step: stepmanModels.StepModel{
@@ -92,7 +92,7 @@ func Test_getRunningStepFooterMainSection(t *testing.T) {
 				ErrorStr: longStr,
 				ExitCode: 1,
 			},
-			expected: "| \x1b[31;1mx\x1b[0m | \x1b[31;1mThis is a very long string, this is a very l... (exit code: 1)\x1b[0m| 0.01 sec |",
+			expected: "| \x1b[31;1mx\x1b[0m | \x1b[31;1mThis is a very long string, this is a very long st... (Failed)\x1b[0m| 0.01 sec |",
 		},
 		{
 			name: "aborted step due to no output",
@@ -104,7 +104,7 @@ func Test_getRunningStepFooterMainSection(t *testing.T) {
 				ErrorStr: longStr,
 				ExitCode: 1,
 			},
-			expected: "| \x1b[31;1m/\x1b[0m | \x1b[31;1mThis is a very long string, th... (timed out due to no output)\x1b[0m| 0.01 sec |",
+			expected: "| \x1b[31;1m/\x1b[0m | \x1b[31;1mThis is a very long string, this is a very long st... (Failed)\x1b[0m| 0.01 sec |",
 		},
 		{
 			name: "successful step",

cli/build_run_result_collector.go

@@ -2,6 +2,7 @@ package cli
 
 import (
 	"errors"
+	"fmt"
 	"time"
 
 	"github.com/bitrise-io/bitrise/analytics"
@@ -10,8 +11,6 @@ import (
 	"github.com/bitrise-io/bitrise/models"
 	"github.com/bitrise-io/bitrise/tools/timeoutcmd"
 	"github.com/bitrise-io/bitrise/utils"
-	"github.com/bitrise-io/go-utils/colorstring"
-	"github.com/bitrise-io/go-utils/errorutil"
 	"github.com/bitrise-io/go-utils/pointers"
 	coreanalytics "github.com/bitrise-io/go-utils/v2/analytics"
 	stepmanModels "github.com/bitrise-io/stepman/models"
@@ -75,25 +74,18 @@ func (r buildRunResultCollector) registerStepRunResults(
 		DefinitionPth:   stepInfoPtr.DefinitionPth,
 	}
 
-	isExitStatusError := true
-	if err != nil {
-		isExitStatusError = errorutil.IsExitStatusError(err)
-	}
-
-	// Print step preparation errors before the step header box,
-	// other errors are printed within the step box.
-	if status == models.StepRunStatusCodePreparationFailed && err != nil {
-		if !isExitStatusError {
-			log.Errorf("Preparing Step (%s) failed: %s", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"), err)
-		}
-	}
 	if printStepHeader {
 		logStepStarted(stepInfoPtr, step, stepIdxPtr, stepExecutionId, stepStartTime)
 	}
 
 	errStr := ""
 	if err != nil {
-		errStr = err.Error()
+		if status == models.StepRunStatusCodePreparationFailed {
+			stepTitle := pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title")
+			errStr = fmt.Sprintf("Preparing Step (%s) failed: %s", stepTitle, err.Error())
+		} else {
+			errStr = err.Error()
+		}
 	}
 
 	stepResults := models.StepRunResultsModel{
@@ -121,31 +113,16 @@ func (r buildRunResultCollector) registerStepRunResults(
 	case models.StepRunStatusCodePreparationFailed:
 		buildRunResults.FailedSteps = append(buildRunResults.FailedSteps, stepResults)
 	case models.StepRunStatusCodeFailed:
-		if !isExitStatusError {
-			log.Errorf("Step (%s) failed: %s", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"), err)
-		}
 		buildRunResults.FailedSteps = append(buildRunResults.FailedSteps, stepResults)
 	case models.StepRunStatusCodeFailedSkippable:
-		if !isExitStatusError {
-			log.Warnf("Step (%s) failed, but was marked as skippable: %s", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"), err)
-		} else {
-			log.Warnf("Step (%s) failed, but was marked as skippable", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"))
-		}
 		buildRunResults.FailedSkippableSteps = append(buildRunResults.FailedSkippableSteps, stepResults)
 	case models.StepRunStatusAbortedWithCustomTimeout, models.StepRunStatusAbortedWithNoOutputTimeout:
-		log.Errorf("Step (%s) aborted: %s", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"), err)
 		buildRunResults.FailedSteps = append(buildRunResults.FailedSteps, stepResults)
 	case models.StepRunStatusCodeSkipped:
-		log.Warnf("A previous step failed, and this step (%s) was not marked as IsAlwaysRun, skipped", pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title"))
 		buildRunResults.SkippedSteps = append(buildRunResults.SkippedSteps, stepResults)
 	case models.StepRunStatusCodeSkippedWithRunIf:
-		log.Warn("The step's (" + pointers.StringWithDefault(stepInfoCopy.Step.Title, "missing title") + ") Run-If expression evaluated to false - skipping")
-		if runIf != "" {
-			log.Info("The Run-If expression was: ", colorstring.Blue(runIf))
-		}
 		buildRunResults.SkippedSteps = append(buildRunResults.SkippedSteps, stepResults)
 	default:
-		log.Error("Unknown result code")
 		return
 	}
 
@@ -173,14 +150,6 @@ func stepFinishedParamsFromResults(results models.StepRunResultsModel, stepExecu
 		sourceURL = *results.StepInfo.Step.SourceCodeURL
 	}
 
-	var errors []log.StepError
-	if results.ErrorStr != "" && results.Status.IsFailure() {
-		errors = append(errors, log.StepError{
-			Code:    results.ExitCode,
-			Message: results.ErrorStr,
-		})
-	}
-
 	var stepUpdate *log.StepUpdate
 	updateAvailable, _ := utils.IsUpdateAvailable(results.StepInfo.Version, results.StepInfo.LatestVersion)
 	if updateAvailable {
@@ -200,18 +169,21 @@ func stepFinishedParamsFromResults(results models.StepRunResultsModel, stepExecu
 		}
 	}
 
-	return log.StepFinishedParams{
-		ExecutionId:    stepExecutionId,
-		InternalStatus: int(results.Status),
-		Status:         results.Status.HumanReadableStatus(),
-		StatusReason:   results.Status.Reason(results.ExitCode),
-		Title:          title,
-		RunTime:        results.RunTime.Milliseconds(),
-		SupportURL:     supportURL,
-		SourceCodeURL:  sourceURL,
-		Errors:         errors,
-		Update:         stepUpdate,
-		Deprecation:    stepDeprecation,
-		LastStep:       isLastStep,
+	params := log.StepFinishedParams{
+		ExecutionId:   stepExecutionId,
+		Status:        results.Status.String(),
+		Title:         title,
+		RunTime:       results.RunTime.Milliseconds(),
+		SupportURL:    supportURL,
+		SourceCodeURL: sourceURL,
+		Update:        stepUpdate,
+		Deprecation:   stepDeprecation,
+		LastStep:      isLastStep,
 	}
+
+	statusReason, stepErrors := results.StatusReasonAndErrors()
+	params.StatusReason = statusReason
+	params.Errors = stepErrors
+
+	return params
 }

cli/run_test.go

@@ -1630,8 +1630,11 @@ route_map:
 			// Then
 			require.NoError(t, err)
 			for _, expectedEvent := range test.expectedTriggeredEvents {
-				output := buf.String()
-				assert.True(t, strings.Contains(output, expectedEvent), output)
+				condition := func() bool {
+					output := buf.String()
+					return strings.Contains(output, expectedEvent)
+				}
+				assert.Eventuallyf(t, condition, 5*time.Second, 150*time.Millisecond, "", "")
 			}
 		}
 	}

cli/run_util.go

@@ -218,14 +218,14 @@ func CreateBitriseConfigFromCLIParams(bitriseConfigBase64Data, bitriseConfigPath
 		bitriseConfig = config
 	}
 
-	isConfigVersionOK, err := versions.IsVersionGreaterOrEqual(models.Version, bitriseConfig.FormatVersion)
+	isConfigVersionOK, err := versions.IsVersionGreaterOrEqual(models.FormatVersion, bitriseConfig.FormatVersion)
 	if err != nil {
-		log.Warn("bitrise CLI model version: ", models.Version)
+		log.Warn("bitrise CLI model version: ", models.FormatVersion)
 		log.Warn("bitrise.yml Format Version: ", bitriseConfig.FormatVersion)
 		return models.BitriseDataModel{}, warnings, fmt.Errorf("Failed to compare bitrise CLI models's version with the bitrise.yml FormatVersion: %s", err)
 	}
 	if !isConfigVersionOK {
-		log.Warnf("The bitrise.yml has a higher Format Version (%s) than the bitrise CLI model's version (%s).", bitriseConfig.FormatVersion, models.Version)
+		log.Warnf("The bitrise.yml has a higher Format Version (%s) than the bitrise CLI model's version (%s).", bitriseConfig.FormatVersion, models.FormatVersion)
 		return models.BitriseDataModel{}, warnings, errors.New("This bitrise.yml was created with and for a newer version of bitrise CLI, please upgrade your bitrise CLI to use this bitrise.yml")
 	}
 
@@ -607,6 +607,7 @@ func activateAndRunSteps(
 		// Per step variables
 		stepStartTime = time.Now()
 		isLastStep := isLastWorkflow && (idx == len(workflow.Steps)-1)
+		// TODO: stepInfoPtr.Step is not a real step, only stores presentation properties (printed in the step boxes)
 		stepInfoPtr := stepmanModels.StepInfoModel{}
 		stepIdxPtr := idx
 
@@ -707,6 +708,18 @@ func activateAndRunSteps(
 			stepInfoPtr.Step.SourceCodeURL = pointers.NewStringPtr(*mergedStep.SourceCodeURL)
 		}
 
+		if mergedStep.RunIf != nil {
+			stepInfoPtr.Step.RunIf = pointers.NewStringPtr(*mergedStep.RunIf)
+		}
+
+		if mergedStep.Timeout != nil {
+			stepInfoPtr.Step.Timeout = pointers.NewIntPtr(*mergedStep.Timeout)
+		}
+
+		if mergedStep.NoOutputTimeout != nil {
+			stepInfoPtr.Step.NoOutputTimeout = pointers.NewIntPtr(*mergedStep.NoOutputTimeout)
+		}
+
 		// At this point we have a filled up step info model and also have a step model which is contains the merged step
 		// data from the bitrise.yml and the steps step.yml.
 		// If the step title contains the step id or the step library as a prefix then we will take the original steps

cli/version.go

@@ -33,7 +33,7 @@ func printVersionCmd(c *cli.Context) error {
 	}
 
 	if fullVersion {
-		versionOutput.FormatVersion = models.Version
+		versionOutput.FormatVersion = models.FormatVersion
 		versionOutput.BuildNumber = version.BuildNumber
 		versionOutput.Commit = version.Commit
 		versionOutput.OS = fmt.Sprintf("%s (%s)", runtime.GOOS, runtime.GOARCH)

log/event_print.go

@@ -8,6 +8,7 @@ import (
 	"github.com/bitrise-io/bitrise/log/corelog"
 	"github.com/bitrise-io/bitrise/models"
 	"github.com/bitrise-io/bitrise/utils"
+	"github.com/bitrise-io/go-utils/colorstring"
 	"github.com/bitrise-io/go-utils/stringutil"
 )
 
@@ -63,10 +64,10 @@ func getHeaderLine(content string) string {
 }
 
 func widthConstrainedStringWithBorder(content string, width int) string {
-	return fmt.Sprintf("| %s |", widthConstrainedString(content, width))
+	return fmt.Sprintf("| %s |", WidthConstrainedString(content, width))
 }
 
-func widthConstrainedString(content string, width int) string {
+func WidthConstrainedString(content string, width int) string {
 	widthDiff := len(content) - width
 
 	if widthDiff < 0 {
@@ -91,9 +92,17 @@ func generateStepFinishedFooterLines(params StepFinishedParams) []string {
 	}
 
 	var lines []string
+
+	for _, stepError := range params.Errors {
+		lines = append(lines, colorstring.Red(stepError.Message))
+	}
+	if params.StatusReason != "" {
+		lines = append(lines, colorstring.Blue(params.StatusReason))
+	}
 	lines = append(lines, sectionSeparator)
 	lines = append(lines, mainSeparator)
-	lines = append(lines, getSummaryFooterRow(params.InternalStatus, params.Title, params.StatusReason, params.RunTime, deprecated))
+	status := models.NewStepRunStatus(params.Status)
+	lines = append(lines, getSummaryFooterRow(status, params.Title, status.Name(), params.RunTime, deprecated))
 	lines = append(lines, mainSeparator)
 
 	hasPreviousSection := false
@@ -132,15 +141,15 @@ func generateStepFinishedFooterLines(params StepFinishedParams) []string {
 	return lines
 }
 
-func getSummaryFooterRow(status int, title, reason string, duration int64, deprecated bool) string {
+func getSummaryFooterRow(status models.StepRunStatus, title, reason string, duration int64, deprecated bool) string {
 	icon, level := transformStatusToIconAndLevel(status)
 	footerTitle := getFooterTitle(level, title, reason, deprecated, footerTitleBoxWidth)
 	executionTime := getFooterExecutionTime(duration)
 
 	return fmt.Sprintf("|%s|%s|%s|", icon, footerTitle, executionTime)
 }
 
-func transformStatusToIconAndLevel(status int) (string, corelog.Level) {
+func transformStatusToIconAndLevel(status models.StepRunStatus) (string, corelog.Level) {
 	var icon string
 	var level corelog.Level
 
@@ -202,10 +211,10 @@ func getFooterTitle(level corelog.Level, title, reason string, deprecated bool,
 
 		// Deduct the deprecated prefix length and the space between them to only shorten the title
 		actualWidth = actualWidth - len(deprecatedPrefix) - 1
-		widthConstrainedTitle := widthConstrainedString(title, actualWidth)
+		widthConstrainedTitle := WidthConstrainedString(title, actualWidth)
 		title = fmt.Sprintf("%s %s", corelog.AddColor(corelog.ErrorLevel, deprecatedPrefix), corelog.AddColor(level, widthConstrainedTitle))
 	} else {
-		title = widthConstrainedString(title, actualWidth)
+		title = WidthConstrainedString(title, actualWidth)
 		title = corelog.AddColor(level, title)
 	}