Add status reason messaging

bitrise/print.go

@@ -39,7 +39,7 @@ func trimTitle(title string, titleSuffix string, titleBoxWidth int) string {
 		return title
 	}
 
-	return fmt.Sprintf("%s %s", title, titleSuffix)
+	return strings.TrimSpace(fmt.Sprintf("%s %s", title, titleSuffix))
 }
 
 func getTrimmedStepName(stepRunResult models.StepRunResultsModel) string {
@@ -59,7 +59,7 @@ func getTrimmedStepName(stepRunResult models.StepRunResultsModel) string {
 	}
 
 	suffix := ""
-	reason := stepRunResult.Status.Reason(stepRunResult.ExitCode)
+	reason := stepRunResult.ShortReason()
 	if reason != "" {
 		suffix = fmt.Sprintf("(%s)", reason)
 	}

bitrise/print_test.go

@@ -35,7 +35,7 @@ func TestGetTrimmedStepName(t *testing.T) {
 		}
 
 		actual := getTrimmedStepName(result)
-		expected := "This is a very long string, this is a very long string, thi..."
+		expected := "This is a very long string, this is a very long s... (Success)"
 		require.Equal(t, expected, actual)
 	}
 
@@ -58,7 +58,7 @@ func TestGetTrimmedStepName(t *testing.T) {
 		}
 
 		actual := getTrimmedStepName(result)
-		expected := ""
+		expected := "(Success)"
 		require.Equal(t, expected, actual)
 	}
 }
@@ -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,15 +104,15 @@ 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",
 			result: models.StepRunResultsModel{
 				StepInfo: noTitleInfo,
 				Status:   models.StepRunStatusCodeSuccess,
 			},
-			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m\x1b[0m                                                              | 0.00 sec |",
+			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m(Success)\x1b[0m                                                     | 0.00 sec |",
 		},
 		{
 			name: "long runtime",
@@ -121,7 +121,7 @@ func Test_getRunningStepFooterMainSection(t *testing.T) {
 				Status:   models.StepRunStatusCodeSuccess,
 				RunTime:  100 * 1000 * 1e9, // 100 * 1000 * 10^9 nanosec = 100 000 sec
 			},
-			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m\x1b[0m                                                              | 28 hour  |",
+			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m(Success)\x1b[0m                                                     | 28 hour  |",
 		},
 		{
 			name: "very long runtime",
@@ -130,7 +130,7 @@ func Test_getRunningStepFooterMainSection(t *testing.T) {
 				Status:   models.StepRunStatusCodeSuccess,
 				RunTime:  time.Duration(1000) * time.Hour,
 			},
-			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m\x1b[0m                                                              | 999+ hour|",
+			expected: "| \x1b[32;1m✓\x1b[0m | \x1b[32;1m(Success)\x1b[0m                                                     | 999+ hour|",
 		},
 	}
 	for _, tt := range tests {

cli/build_run_result_collector.go

@@ -10,7 +10,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"
@@ -121,31 +120,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
 	}
 
@@ -204,7 +188,8 @@ func stepFinishedParamsFromResults(results models.StepRunResultsModel, stepExecu
 		ExecutionId:    stepExecutionId,
 		InternalStatus: int(results.Status),
 		Status:         results.Status.HumanReadableStatus(),
-		StatusReason:   results.Status.Reason(results.ExitCode),
+		StatusReason:   results.StatusReason(),
+		ShortReason:    results.ShortReason(),
 		Title:          title,
 		RunTime:        results.RunTime.Milliseconds(),
 		SupportURL:     supportURL,

cli/run_util.go

@@ -707,6 +707,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

log/event_print.go

@@ -91,9 +91,12 @@ func generateStepFinishedFooterLines(params StepFinishedParams) []string {
 	}
 
 	var lines []string
+	if params.StatusReason != "" {
+		lines = append(lines, params.StatusReason)
+	}
 	lines = append(lines, sectionSeparator)
 	lines = append(lines, mainSeparator)
-	lines = append(lines, getSummaryFooterRow(params.InternalStatus, params.Title, params.StatusReason, params.RunTime, deprecated))
+	lines = append(lines, getSummaryFooterRow(params.InternalStatus, params.Title, params.ShortReason, params.RunTime, deprecated))
 	lines = append(lines, mainSeparator)
 
 	hasPreviousSection := false

log/event_print_test.go

@@ -113,6 +113,8 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeSuccess,
 				Status:         "success",
+				StatusReason:   "",
+				ShortReason:    "",
 				Title:          "Normal step name",
 				RunTime:        1234567,
 				LastStep:       true,
@@ -130,14 +132,16 @@ func TestStepFooterPrinting(t *testing.T) {
 				InternalStatus: models.StepRunStatusCodeFailed,
 				Status:         "failed",
 				StatusReason:   "exit code: 1",
+				ShortReason:    "exit code: 1",
 				Title:          "Loooooooooooooooooooooooooooooooooong step name",
 				RunTime:        9999,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"exit code: 1",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1mx\u001B[0m | \u001B[31;1mLoooooooooooooooooooooooooooooooooong step ... (exit code: 1)\u001B[0m | 10.00 sec |",
+				"| \x1b[31;1mx\x1b[0m | \x1b[31;1mLoooooooooooooooooooooooooooooooooong step ... (exit code: 1)\x1b[0m | 10.00 sec |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -146,15 +150,17 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeFailedSkippable,
 				Status:         "failed_skippable",
-				StatusReason:   "exit code: 2",
+				StatusReason:   "This Step failed, but it was marked as “is_skippable”, so the build continued.",
+				ShortReason:    "exit code: 1",
 				Title:          "Simple Git",
 				RunTime:        3333,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"This Step failed, but it was marked as “is_skippable”, so the build continued.",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[33;1m!\u001B[0m | \u001B[33;1mSimple Git (exit code: 2)                                    \u001B[0m | 3.33 sec |",
+				"| \x1b[33;1m!\x1b[0m | \x1b[33;1mSimple Git (exit code: 1)                                    \x1b[0m | 3.33 sec |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -163,14 +169,17 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeSkipped,
 				Status:         "skipped",
+				StatusReason:   "This Step was skipped, because a previous Step failed, and this Step was not marked “is_always_run”.",
+				ShortReason:    "skipped",
 				Title:          "Step",
 				RunTime:        654321,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"This Step was skipped, because a previous Step failed, and this Step was not marked “is_always_run”.",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[34;1m-\u001B[0m | \u001B[34;1mStep                                                         \u001B[0m | 10.9 min |",
+				"| \x1b[34;1m-\x1b[0m | \x1b[34;1mStep (skipped)                                               \x1b[0m | 10.9 min |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -179,14 +188,21 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeSkippedWithRunIf,
 				Status:         "skipped_with_run_if",
-				Title:          "Step",
-				RunTime:        42424242,
-				LastStep:       true,
+				StatusReason: `
+This Step was skipped, because its “run_if” expression evaluated to false.
+
+The “run_if” expression was: false
+`,
+				ShortReason: "skipped due to run_if",
+				Title:       "Step",
+				RunTime:     42424242,
+				LastStep:    true,
 			},
 			expectedOutput: []string{
+				"\nThis Step was skipped, because its “run_if” expression evaluated to false.\n\nThe “run_if” expression was: false\n",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[34;1m-\u001B[0m | \u001B[34;1mStep                                                         \u001B[0m | 12 hour |",
+				"| \x1b[34;1m-\x1b[0m | \x1b[34;1mStep (skipped due to run_if)                                 \x1b[0m | 12 hour |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -196,14 +212,16 @@ func TestStepFooterPrinting(t *testing.T) {
 				InternalStatus: models.StepRunStatusCodePreparationFailed,
 				Status:         "preparation_failed",
 				StatusReason:   "exit code: 3",
+				ShortReason:    "exit code: 3",
 				Title:          "Step",
 				RunTime:        11111,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"exit code: 3",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1mx\u001B[0m | \u001B[31;1mStep (exit code: 3)                                          \u001B[0m | 11.11 sec |",
+				"| \x1b[31;1mx\x1b[0m | \x1b[31;1mStep (exit code: 3)                                          \x1b[0m | 11.11 sec |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -212,15 +230,17 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusAbortedWithCustomTimeout,
 				Status:         "aborted_with_custom_timeout",
-				StatusReason:   "timed out",
+				StatusReason:   "This Step timed out after 5m.",
+				ShortReason:    "timed out",
 				Title:          "Step",
 				RunTime:        99099,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"This Step timed out after 5m.",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1m/\u001B[0m | \u001B[31;1mStep (timed out)                                             \u001B[0m | 1.7 min |",
+				"| \x1b[31;1m/\x1b[0m | \x1b[31;1mStep (timed out)                                             \x1b[0m | 1.7 min |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -229,15 +249,17 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusAbortedWithNoOutputTimeout,
 				Status:         "aborted_with_no_output",
-				StatusReason:   "timed out due to no output",
+				StatusReason:   "This Step failed, because it has not sent any output for 4m.",
+				ShortReason:    "timed out due to no output",
 				Title:          "Step",
 				RunTime:        101,
 				LastStep:       true,
 			},
 			expectedOutput: []string{
+				"This Step failed, because it has not sent any output for 4m.",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1m/\u001B[0m | \u001B[31;1mStep (timed out due to no output)                            \u001B[0m | 0.10 sec |",
+				"| \x1b[31;1m/\x1b[0m | \x1b[31;1mStep (timed out due to no output)                            \x1b[0m | 0.10 sec |",
 				"+---+---------------------------------------------------------------+----------+",
 			},
 		},
@@ -247,6 +269,7 @@ func TestStepFooterPrinting(t *testing.T) {
 				InternalStatus: models.StepRunStatusCodeFailed,
 				Status:         "failed",
 				StatusReason:   "exit code: 11",
+				ShortReason:    "exit code: 11",
 				Title:          "Failed step",
 				RunTime:        88888,
 				SupportURL:     "https://issue-url-issue-url-issue-url-issue-url-issue-url-issue-url-issue-url-issue-url",
@@ -257,9 +280,10 @@ func TestStepFooterPrinting(t *testing.T) {
 				LastStep: true,
 			},
 			expectedOutput: []string{
+				"exit code: 11",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1mx\u001B[0m | \u001B[31;1mFailed step (exit code: 11)                                  \u001B[0m | 1.5 min |",
+				"| \x1b[31;1mx\x1b[0m | \x1b[31;1mFailed step (exit code: 11)                                  \x1b[0m | 1.5 min |",
 				"+---+---------------------------------------------------------------+----------+",
 				"| Issue tracker: https://issue-url-issue-url-issue-url-issue-url-issue-url-... |",
 				"| Source: https://source-code-url                                              |",
@@ -271,6 +295,8 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeSuccess,
 				Status:         "success",
+				StatusReason:   "",
+				ShortReason:    "",
 				Title:          "Step",
 				RunTime:        65748,
 				Update: &StepUpdate{
@@ -298,6 +324,7 @@ func TestStepFooterPrinting(t *testing.T) {
 				InternalStatus: models.StepRunStatusCodeFailed,
 				Status:         "failed",
 				StatusReason:   "exit code: 42",
+				ShortReason:    "exit code: 42",
 				Title:          "Loooooooooong step naaaaaaaaaaaaaaaaaaaaaaaaaaaaaaame",
 				RunTime:        223,
 				Deprecation: &StepDeprecation{
@@ -307,12 +334,13 @@ func TestStepFooterPrinting(t *testing.T) {
 				LastStep: true,
 			},
 			expectedOutput: []string{
+				"exit code: 42",
 				"|                                                                              |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1mx\u001B[0m | \u001B[31;1m[Deprecated]\u001B[0m \u001B[31;1mLoooooooooong step naaaaaaaaa... (exit code: 42)\u001B[0m | 0.22 sec |",
+				"| \x1b[31;1mx\x1b[0m | \x1b[31;1m[Deprecated]\x1b[0m \x1b[31;1mLoooooooooong step naaaaaaaaa... (exit code: 42)\x1b[0m | 0.22 sec |",
 				"+---+---------------------------------------------------------------+----------+",
-				"| \u001B[31;1mRemoval date:\u001B[0m 2022-10-26                                                     |",
-				"| \u001B[31;1mRemoval notes:\u001B[0m Lorem ipsum dolor sit amet, consectetur adipiscing elit. In   |",
+				"| \x1b[31;1mRemoval date:\x1b[0m 2022-10-26                                                     |",
+				"| \x1b[31;1mRemoval notes:\x1b[0m Lorem ipsum dolor sit amet, consectetur adipiscing elit. In   |",
 				"| at ipsum nec orci convallis efficitur. Nulla ultrices eros non nisi tempus   |",
 				"| feugiat. Donec ac sapien in odio ultrices ullamcorper vel id erat. Interdum  |",
 				"| et malesuada fames ac ante ipsum primis in faucibus. Sed sed placerat        |",
@@ -325,6 +353,8 @@ func TestStepFooterPrinting(t *testing.T) {
 			params: StepFinishedParams{
 				InternalStatus: models.StepRunStatusCodeSuccess,
 				Status:         "success",
+				StatusReason:   "",
+				ShortReason:    "",
 				Title:          "Regular step",
 				RunTime:        111111111111,
 				Errors: []StepError{

log/models.go

@@ -39,6 +39,7 @@ type StepFinishedParams struct {
 	InternalStatus int         `json:"-"`
 	Status         string      `json:"status"`
 	StatusReason   string      `json:"status_reason,omitempty"`
+	ShortReason    string      `json:"status_reason_short,omitempty"`
 	Title          string      `json:"title"`
 	RunTime        int64       `json:"run_time_in_ms"`
 	SupportURL     string      `json:"support_url"`