Skip to content

Commit

Permalink
fix: siplify skip_output and output logic
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrexox
mrexox committed Mar 13, 2024
1 parent 7245a72 commit 30e13e7
Show file tree
Hide file tree
Showing 5 changed files with 234 additions and 349 deletions.
21 changes: 8 additions & 13 deletions internal/lefthook/run.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,16 @@ func (l *Lefthook) Run(hookName string, args RunArgs, gitArgs []string) error {
log.SetLevel(log.WarnLevel)
}

outputLogTags := os.Getenv(envOutput)
outputSkipTags := os.Getenv(envSkipOutput)
enableLogTags := os.Getenv(envOutput)
disableLogTags := os.Getenv(envSkipOutput)

var logSettings log.Settings
logSettings := log.NewSettings()
logSettings.Apply(enableLogTags, disableLogTags, cfg.Output, cfg.SkipOutput)

if outputSkipTags == "" && cfg.SkipOutput == nil {
logSettings = log.NewSettings()
logSettings.ApplySettings(outputLogTags, cfg.Output)
} else {
// Deprecate skip_output in the future. Leaving as is to reduce noise in output.
// log.Warn("skip_output is deprecated, please use output option")

logSettings = log.NewSkipSettings() //nolint:staticcheck //SA1019: for temporary backward compatibility
logSettings.ApplySettings(outputSkipTags, cfg.SkipOutput)
}
// Deprecate skip_output in the future. Leaving as is to reduce noise in output.
// if outputSkipTags != "" || cfg.SkipOutput != nil {
// log.Warn("skip_output is deprecated, please use output option")
// }

if logSettings.LogMeta() {
log.Box(
Expand Down
162 changes: 113 additions & 49 deletions internal/log/settings.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,23 @@ const (
executionOutput
executionInfo
emptySummary
enableAll = ^0 // Set all bits as 1
)

const (
disableAll = 0
skipMeta = (1 << iota)
skipSuccess
skipFailure
skipSummary
skipSkips
skipExecution
skipExecutionOutput
skipExecutionInfo
skipEmptySummary
)

type Settings interface {
ApplySettings(tags string, skipOutput interface{})
Apply(enableTags, disableTags string, enable, disable interface{})
LogSuccess() bool
LogFailure() bool
LogSummary() bool
Expand All @@ -30,111 +42,163 @@ type Settings interface {
LogEmptySummary() bool
}

type OutputSettings int16
type LogSettings struct {
bitmap int16
}

func NewSettings() Settings {
var s OutputSettings
s := LogSettings{^disableAll}
return &s
}

func (s *OutputSettings) ApplySettings(tags string, output interface{}) {
if tags == "" && (output == nil || output == "") {
s.enableAll(true)
func (s *LogSettings) Apply(enableTags, disableTags string, enable, disable interface{}) {
if enableTags == "" && disableTags == "" && (enable == nil || enable == "") && (disable == nil || disable == "") {
s.enableAll()
return
}

if val, ok := output.(bool); ok {
s.enableAll(val)
if enableOutput, ok := enable.(bool); ok && enableTags == "" && disableTags == "" {
if enableOutput {
s.enableAll()
} else {
s.disableAll()
}
return
}

if options, ok := output.([]interface{}); ok {
if len(options) == 0 {
s.enableAll(true)
if disableOutput, ok := disable.(bool); ok && enableTags == "" && disableTags == "" {
if disableOutput {
s.disableAll()
return
}
for _, option := range options {
if optStr, ok := option.(string); ok {
s.applySetting(optStr)
}

if enableOptions, ok := enable.([]interface{}); ok {
if len(enableOptions) != 0 {
s.bitmap = disableAll
}

for _, option := range enableOptions {
if value, ok := option.(string); ok {
s.enable(value)
}
}
}

if disableOptions, ok := disable.([]interface{}); ok {
for _, option := range disableOptions {
if value, ok := option.(string); ok {
s.disable(value)
}
}
}

if tags != "" {
for _, tag := range strings.Split(tags, ",") {
s.applySetting(tag)
if enableTags != "" {
s.bitmap = disableAll

for _, tag := range strings.Split(enableTags, ",") {
s.enable(tag)
}
}

if disableTags != "" {
for _, tag := range strings.Split(disableTags, ",") {
s.disable(tag)
}
}
}

func (s *OutputSettings) applySetting(setting string) {
func (s *LogSettings) enable(setting string) {
switch setting {
case "meta":
*s |= meta
s.bitmap |= meta
case "success":
*s |= success
s.bitmap |= success
case "failure":
*s |= failure
s.bitmap |= failure
case "summary":
*s |= summary
s.bitmap |= summary | success | failure
case "skips":
*s |= skips
s.bitmap |= skips
case "execution":
*s |= execution
s.bitmap |= execution | executionOutput | executionInfo
case "execution_out":
*s |= executionOutput
s.bitmap |= executionOutput | execution
case "execution_info":
*s |= executionInfo
s.bitmap |= executionInfo | execution
case "empty_summary":
*s |= emptySummary
s.bitmap |= emptySummary
}
}

func (s *OutputSettings) enableAll(val bool) {
if val {
*s = enableAll // Enable all params
} else {
*s |= failure // Disable all params
func (s *LogSettings) disable(setting string) {
switch setting {
case "meta":
s.bitmap &= ^meta
case "success":
s.bitmap &= ^success
case "failure":
s.bitmap &= ^failure
case "summary":
s.bitmap &= ^summary & ^success & ^failure
case "skips":
s.bitmap &= ^skips
case "execution":
s.bitmap &= ^execution & ^executionOutput & ^executionInfo
case "execution_out":
s.bitmap &= ^executionOutput
case "execution_info":
s.bitmap &= ^executionInfo
case "empty_summary":
s.bitmap &= ^emptySummary
}
}

func (s *LogSettings) enableAll() {
s.bitmap = ^disableAll
}

func (s *LogSettings) disableAll() {
s.bitmap = failure
}

// Checks the state of params.
func (s OutputSettings) isEnable(option int16) bool {
return int16(s)&option != 0
func (s LogSettings) isEnable(option int16) bool {
return s.bitmap&option != 0
}

func (s OutputSettings) LogSuccess() bool {
return s.isEnable(success) || s.isEnable(summary)
func (s LogSettings) LogSuccess() bool {
return s.isEnable(success)
}

func (s OutputSettings) LogFailure() bool {
return s.isEnable(failure) || s.isEnable(summary)
func (s LogSettings) LogFailure() bool {
return s.isEnable(failure)
}

func (s OutputSettings) LogSummary() bool {
func (s LogSettings) LogSummary() bool {
return s.isEnable(summary)
}

func (s OutputSettings) LogMeta() bool {
func (s LogSettings) LogMeta() bool {
return s.isEnable(meta)
}

func (s OutputSettings) LogExecution() bool {
return s.isEnable(execution) || s.isEnable(executionOutput) || s.isEnable(executionInfo)
func (s LogSettings) LogExecution() bool {
return s.isEnable(execution)
}

func (s OutputSettings) LogExecutionOutput() bool {
return s.isEnable(execution) || s.isEnable(executionOutput)
func (s LogSettings) LogExecutionOutput() bool {
return s.isEnable(executionOutput)
}

func (s OutputSettings) LogExecutionInfo() bool {
return s.isEnable(execution) || s.isEnable(executionInfo)
func (s LogSettings) LogExecutionInfo() bool {
return s.isEnable(executionInfo)
}

func (s OutputSettings) LogSkips() bool {
func (s LogSettings) LogSkips() bool {
return s.isEnable(skips)
}

func (s OutputSettings) LogEmptySummary() bool {
func (s LogSettings) LogEmptySummary() bool {
return s.isEnable(emptySummary)
}
Loading

0 comments on commit 30e13e7

Please sign in to comment.