Introduce FinishWithType() method for Logger (#17)

* Introduce FinishWithType() method for Logger

* .golangci.yml: copy Cirrus CLI's config

* .golangci.yml: disable ifshort linter

* Use fast-forward emoji for skipped status

Author: edigaryev

.golangci.yml

@@ -9,17 +9,58 @@ linters-settings:
     default-signifies-exhaustive: true
 
 linters:
-  # Selecting all available presets effectively enables all linters.
-  presets:
-    - bugs
-    - complexity
-    - format
-    - performance
-    - style
-    - unused
+  enable:
+  - asciicheck
+  - bodyclose
+  - deadcode
+  - depguard
+  - dogsled
+  - dupl
+  - errcheck
+  - exhaustive
+  - exportloopref
+  - gochecknoinits
+  - gocognit
+  - goconst
+  - gocritic
+  - gocyclo
+  - godot
+  - godox
+  - goerr113
+  - gofmt
+  - goheader
+  - golint
+  - gomodguard
+  - goprintffuncname
+  - gosec
+  - gosimple
+  - govet
+  - ineffassign
+  - interfacer
+  - lll
+  - makezero
+  - misspell
+  - nakedret
+  - nestif
+  - noctx
+  - nolintlint
+  - predeclared
+  - rowserrcheck
+  - scopelint
+  - sqlclosecheck
+  - staticcheck
+  - structcheck
+  - stylecheck
+  - testpackage
+  - tparallel
+  - typecheck
+  - unconvert
+  - unparam
+  - unused
+  - varcheck
+  - whitespace
 
   disable:
-    - exhaustivestruct
     # Messages like "struct of size 104 bytes could be of size 96 bytes" from a package
     # that was last updated 2 years ago[1] are barely helpful.
     #
@@ -35,15 +76,54 @@ linters:
 
     # New linters that require a lot of codebase churn and noise, but perhaps we can enable them in the future.
     - nlreturn
+    - wrapcheck
+    - errorlint
+
+    # Unfortunately, we use globals due to how spf13/cobra works.
+    - gochecknoglobals
+
+    # That's fine that some Proto objects don't have all fields initialized
+    - exhaustivestruct
 
     # Style linters that are total nuts.
     - wsl
     - gofumpt
     - goimports
     - funlen
 
-    # That's fine that some Proto objects don't have all fields initialized
+    # This conflicts with the Protocol Buffers Version 3 design,
+    # which is largely based on default values for struct fields.
     - exhaustivestruct
+
+    # Enough parallelism for now.
+    - paralleltest
+
+    # Ill-based assumptions about identifiers like fmt.Println without taking context into account.
+    - forbidigo
+
+    # Advantages of using t.Helper() are too small to waste developer's cognitive stamina on it.
+    - thelper
+
+    # Too restrictive defaults, plus there's already a gocyclo linter in place.
+    - cyclop
+
+    # Gives false positives for textbook examples[1][2]
+    # [1]: https://github.com/charithe/durationcheck/issues/7
+    # [2]: https://golang.org/pkg/time/ (see "To convert an integer number of units to a Duration, multiply:")
+    - durationcheck
+
+    # No way to disable the "exported" check for the whole project[1]
+    # [1]: https://github.com/mgechev/revive/issues/244#issuecomment-560512162
+    - revive
+
+    # Unfortunately too much false-positives, e.g. for a 0700 umask or number 10 when using strconv.FormatInt()
+    - gomnd
+
+    # Pretty useless linter: there are clearly cases where declaring a variable makes the code more readable,
+    # yet the only way to weed these cases out is to decrease the "max-decl-chars" option from 30 to some other
+    # arbitrary value, which makes little sense.
+    - ifshort
+
 issues:
   # Don't hide multiple issues that belong to one class since GitHub annotations can handle them all nicely.
   max-issues-per-linter: 0

log_entry.go

@@ -32,19 +32,19 @@ func (entry *LogScopeStarted) GetScopes() []string {
 }
 
 type LogScopeFinished struct {
-	scopes  []string
-	success bool
+	scopes     []string
+	finishType FinishType
 }
 
-func NewLogScopeFinished(success bool, scopes ...string) *LogScopeFinished {
+func NewLogScopeFinished(finishType FinishType, scopes ...string) *LogScopeFinished {
 	return &LogScopeFinished{
-		scopes:  scopes,
-		success: success,
+		scopes:     scopes,
+		finishType: finishType,
 	}
 }
 
-func (entry *LogScopeFinished) Success() bool {
-	return entry.success
+func (entry *LogScopeFinished) FinishType() FinishType {
+	return entry.finishType
 }
 
 func (entry *LogScopeFinished) GetScopes() []string {

logger.go

@@ -18,6 +18,14 @@ type Logger struct {
 	entriesChannel chan *genericLogEntry
 }
 
+type FinishType int
+
+const (
+	FinishTypeSucceeded FinishType = iota
+	FinishTypeFailed
+	FinishTypeSkipped
+)
+
 func NewLogger(level LogLevel, renderer LogRendered) *Logger {
 	logger := &Logger{
 		level:          level,
@@ -83,8 +91,20 @@ func (logger *Logger) Logf(level LogLevel, format string, args ...interface{}) {
 }
 
 func (logger *Logger) Finish(success bool) {
+	var finishType FinishType
+
+	if success {
+		finishType = FinishTypeSucceeded
+	} else {
+		finishType = FinishTypeFailed
+	}
+
+	logger.FinishWithType(finishType)
+}
+
+func (logger *Logger) FinishWithType(finishType FinishType) {
 	logger.entriesChannel <- &genericLogEntry{
-		LogFinished: NewLogScopeFinished(success, logger.scopes...),
+		LogFinished: NewLogScopeFinished(finishType, logger.scopes...),
 	}
 }
 

renderers/config/interactive_config.go

@@ -13,6 +13,7 @@ type InteractiveRendererConfig struct {
 	ProgressIndicatorCycleDuration time.Duration
 	SuccessStatus                  string
 	FailureStatus                  string
+	SkippedStatus                  string
 	DescriptionLinesWhenFailed     int
 }
 
@@ -34,6 +35,7 @@ func NewDefaultEmojiRenderingConfig() *InteractiveRendererConfig {
 		ProgressIndicatorCycleDuration: time.Second,
 		SuccessStatus:                  "✅",
 		FailureStatus:                  "❌",
+		SkippedStatus:                  "⏩",
 		DescriptionLinesWhenFailed:     100,
 	}
 }
@@ -49,6 +51,7 @@ func NewDefaultSymbolsOnlyRenderingConfig() *InteractiveRendererConfig {
 		ProgressIndicatorCycleDuration: time.Second,
 		SuccessStatus:                  "+",
 		FailureStatus:                  "-",
+		SkippedStatus:                  "!",
 		DescriptionLinesWhenFailed:     100,
 	}
 }

renderers/interactive.go

@@ -51,15 +51,23 @@ func (r *InteractiveRenderer) RenderScopeStarted(entry *echelon.LogScopeStarted)
 
 func (r *InteractiveRenderer) RenderScopeFinished(entry *echelon.LogScopeFinished) {
 	n := findScopedNode(entry.GetScopes(), r)
-	if entry.Success() {
+
+	switch entry.FinishType() {
+	case echelon.FinishTypeSucceeded:
 		if n != r.rootNode {
 			n.ClearAllChildren()
 			n.ClearDescription()
 		}
 		n.CompleteWithColor(r.config.SuccessStatus, r.config.Colors.SuccessColor)
-	} else {
+	case echelon.FinishTypeFailed:
 		n.SetVisibleDescriptionLines(r.config.DescriptionLinesWhenFailed)
 		n.CompleteWithColor(r.config.FailureStatus, r.config.Colors.FailureColor)
+	case echelon.FinishTypeSkipped:
+		if n != r.rootNode {
+			n.ClearAllChildren()
+			n.ClearDescription()
+		}
+		n.CompleteWithColor(r.config.SkippedStatus, r.config.Colors.NeutralColor)
 	}
 }
 

renderers/simple.go

@@ -60,14 +60,20 @@ func (r SimpleRenderer) RenderScopeFinished(entry *echelon.LogScopeFinished) {
 	duration := now.Sub(startTime)
 	formatedDuration := utils.FormatDuration(duration, true)
 	lastScope := scopes[level-1]
-	if entry.Success() {
+
+	switch entry.FinishType() {
+	case echelon.FinishTypeSucceeded:
 		message := fmt.Sprintf("%s succeeded in %s!", quotedIfNeeded(lastScope), formatedDuration)
 		coloredMessage := terminal.GetColoredText(r.colors.SuccessColor, message)
 		r.renderEntry(coloredMessage)
-	} else {
+	case echelon.FinishTypeFailed:
 		message := fmt.Sprintf("%s failed in %s!", quotedIfNeeded(lastScope), formatedDuration)
 		coloredMessage := terminal.GetColoredText(r.colors.NeutralColor, message)
 		r.renderEntry(coloredMessage)
+	case echelon.FinishTypeSkipped:
+		message := fmt.Sprintf("%s skipped in %s!", quotedIfNeeded(lastScope), formatedDuration)
+		coloredMessage := terminal.GetColoredText(r.colors.NeutralColor, message)
+		r.renderEntry(coloredMessage)
 	}
 }