Merge branch '38-linter-warnings' into 'master'

chore: check and fix suppressed linter warnings (#38)

Closes #38

See merge request postgres-ai/database-lab!381

Author: agneum

.golangci.yml

@@ -13,9 +13,20 @@ linters-settings:
   errcheck:
     check-type-assertions: false
     check-blank: false
-    exclude: ./errcheck_excludes.txt
+    exclude-functions:
+      - (*os.File).Close
+  errorlint:
+    errorf: true
+    asserts: true
+    comparison: true
   gofmt:
     simplify: true
+  gofumpt:
+    lang-version: "1.17"
+    extra-rules: false
+  gosimple:
+    go: "1.17"
+    checks: [ "all" ]
   goimports:
     local-prefixes: gitlab.com/postgres-ai/database-lab
   dupl:
@@ -29,7 +40,7 @@ linters-settings:
   gomnd:
     settings:
       mnd:
-        ignored-functions: strconv.Format*,os.*
+        ignored-functions: strconv.Format*,os.*,strconv.Parse*,strings.SplitN,bytes.SplitN
   revive:
     min-confidence: 0.8
   unused:
@@ -50,6 +61,8 @@ linters-settings:
       - hugeParam
     enabled-tags:
       - performance
+    disabled-tags:
+      - experimental
 
 linters:
   enable:
@@ -99,5 +112,3 @@ issues:
   exclude-use-default: false
   max-issues-per-linter: 0
   max-same-issues: 0
-
-  new-from-rev: 9e951ebe

cmd/database-lab/main.go

@@ -75,7 +75,8 @@ func main() {
 
 	pm := pool.NewPoolManager(&cfg.PoolManager, runner)
 	if err := pm.ReloadPools(); err != nil {
-		log.Fatal(err.Error())
+		log.Err(err.Error())
+		return
 	}
 
 	internalNetworkID, err := networks.Setup(ctx, dockerCLI, engProps.InstanceID, engProps.ContainerName)

errcheck_excludes.txt

@@ -293,6 +293,11 @@ func (p *Profiler) RenderStat() string {
 	return p.out.String()
 }
 
+const (
+	percentColumnSize = 6
+	timingColumnSize  = 12
+)
+
 // printHeader prints stats header.
 func (p *Profiler) printHeader() {
 	p.out.WriteString(fmt.Sprintf("%% time      seconds wait_event\n"))
@@ -320,14 +325,16 @@ func (p *Profiler) printStat() {
 
 	// Print stats and calculating totals.
 	for _, e := range eventsList {
-		p.out.WriteString(fmt.Sprintf("%-*.2f %*.6f %s\n", 6, p.waitEventPercents[e.waitEventName], 12, e.waitEventValue, e.waitEventName))
+		p.out.WriteString(fmt.Sprintf("%-*.2f %*.6f %s\n", percentColumnSize, p.waitEventPercents[e.waitEventName],
+			timingColumnSize, e.waitEventValue, e.waitEventName))
+
 		totalPct += p.waitEventPercents[e.waitEventName]
 		totalTime += e.waitEventValue
 	}
 
 	// Print totals.
 	p.out.WriteString("------ ------------ -----------------------------\n")
-	p.out.WriteString(fmt.Sprintf("%-*.2f %*.6f\n", 6, totalPct, 12, totalTime))
+	p.out.WriteString(fmt.Sprintf("%-*.2f %*.6f\n", percentColumnSize, totalPct, timingColumnSize, totalTime))
 }
 
 // EstimateTime estimates time.

internal/estimator/profile.go

@@ -131,7 +131,6 @@ func Stop(r runners.Runner, p *resources.Pool, name string) error {
 		}
 
 		log.Msg("docker container was not found, ignore", err)
-
 	}
 
 	if _, err := r.Run("rm -rf " + p.SocketCloneDir(name) + "/*"); err != nil {

internal/provision/databases/postgres/postgres.go

@@ -85,7 +85,7 @@ func NewManager(runner runners.Runner, config ManagerConfig) (FSManager, error)
 		}
 
 	default:
-		return nil, errors.New(fmt.Sprintf(`unsupported thin-clone manager specified: "%s"`, config.Pool.Mode))
+		return nil, fmt.Errorf(`unsupported thin-clone manager specified: "%s"`, config.Pool.Mode)
 	}
 
 	log.Dbg(fmt.Sprintf(`Using "%s" thin-clone manager.`, config.Pool.Mode))

internal/provision/pool/manager.go

@@ -30,10 +30,12 @@ const (
 	sudoParams = "--non-interactive"
 )
 
+// Runner runs commands.
 type Runner interface {
 	Run(string, ...bool) (string, error)
 }
 
+// RunnerError represents a runner error.
 type RunnerError struct {
 	Msg        string
 	ExitStatus int
@@ -51,12 +53,10 @@ func NewRunnerError(command string, stderr string, e error) error {
 	case (*exec.ExitError):
 		// SO: https://stackoverflow.com/questions/10385551/get-exit-code-go.
 		// The program has exited with an exit code != 0
-
 		// This works on both Unix and Windows. Although package
 		// syscall is generally platform dependent, WaitStatus is
 		// defined for both Unix and Windows and in both cases has
 		// an ExitStatus() method with the same signature.
-
 		if status, ok := err.Sys().(syscall.WaitStatus); ok {
 			exitStatus = status.ExitStatus()
 		}
@@ -72,11 +72,12 @@ func NewRunnerError(command string, stderr string, e error) error {
 	}
 }
 
+// Error returns runner error.
 func (e RunnerError) Error() string {
 	return e.Msg
 }
 
-// Local.
+// LocalRunner represents implementation of a local runner.
 type LocalRunner struct {
 	UseSudo bool
 }
@@ -90,6 +91,7 @@ func NewLocalRunner(useSudo bool) *LocalRunner {
 	return r
 }
 
+// Run executes command.
 func (r *LocalRunner) Run(command string, options ...bool) (string, error) {
 	command = strings.Trim(command, " \n")
 	if len(command) == 0 {
@@ -104,9 +106,6 @@ func (r *LocalRunner) Run(command string, options ...bool) (string, error) {
 		log.Dbg(fmt.Sprintf(`Run(Local): "%s"`, logCommand))
 	}
 
-	var out bytes.Buffer
-	var stderr bytes.Buffer
-
 	if runtime.GOOS == "windows" {
 		return "", errors.New("Windows is not supported")
 	}
@@ -117,6 +116,11 @@ func (r *LocalRunner) Run(command string, options ...bool) (string, error) {
 
 	cmd := exec.Command("/bin/bash", "-c", command)
 
+	var (
+		out    bytes.Buffer
+		stderr bytes.Buffer
+	)
+
 	cmd.Stdout = &out
 	cmd.Stderr = &stderr
 

internal/provision/runners/runners.go

@@ -125,7 +125,7 @@ func (m *LVManager) GetSessionState(_ string) (*resources.SessionState, error) {
 	return &resources.SessionState{}, nil
 }
 
-// GetDiskState is not implemented.
+// GetFilesystemState is not implemented.
 func (m *LVManager) GetFilesystemState() (models.FileSystem, error) {
 	// TODO(anatoly): Implement.
 	return models.FileSystem{Mode: PoolMode}, nil

internal/provision/thinclones/lvm/lvmanager.go

@@ -19,6 +19,7 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/models"
 )

pkg/client/dblabapi/client.go

@@ -17,6 +17,7 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+
 	"gitlab.com/postgres-ai/database-lab/v3/pkg/log"
 )
 

pkg/client/platform/client.go

@@ -2,29 +2,21 @@
 2019 © Postgres.ai
 */
 
+// Package log formats and prints log messages.
 package log
 
 import (
 	"encoding/json"
 	"fmt"
 	"log"
 	"os"
+	"strings"
 )
 
 var debugMode = true
 
 var std = log.New(os.Stderr, "", log.LstdFlags|log.Lshortfile)
 
-const (
-	WHITE  = "\x1b[1;37m"
-	RED    = "\x1b[1;31m"
-	GREEN  = "\x1b[1;32m"
-	YELLOW = "\x1b[1;33m"
-	END    = "\x1b[0m"
-	OK     = GREEN + "OK" + END
-	FAIL   = RED + "Fail" + END
-)
-
 const (
 	calldepth = 3
 )
@@ -33,47 +25,58 @@ func toString(i1 interface{}) string {
 	if i1 == nil {
 		return ""
 	}
+
 	switch i2 := i1.(type) {
-	default:
-		return fmt.Sprint(i2)
 	case bool:
 		if i2 {
 			return "true"
-		} else {
-			return "false"
 		}
+
+		return "false"
+
 	case string:
 		return i2
+
 	case *bool:
 		if i2 == nil {
 			return ""
 		}
+
 		if *i2 {
 			return "true"
-		} else {
-			return "false"
 		}
+
+		return "false"
+
 	case *string:
 		if i2 == nil {
 			return ""
 		}
+
 		return *i2
+
 	case *json.Number:
 		return i2.String()
+
 	case json.Number:
 		return i2.String()
+
+	default:
+		return fmt.Sprint(i2)
 	}
 }
 
 func prepareMessage(v ...interface{}) string {
-	message := ""
+	builder := strings.Builder{}
+
 	for _, value := range v {
-		message = message + " " + toString(value)
+		builder.WriteString(" " + toString(value))
 	}
-	return message
+
+	return builder.String()
 }
 
-func println(v ...interface{}) {
+func printLine(v ...interface{}) {
 	_ = std.Output(calldepth, fmt.Sprintln(v...))
 }
 
@@ -92,38 +95,39 @@ func SetDebug(enable bool) {
 	}
 }
 
-// Output message.
+// Msg outputs message.
 func Msg(v ...interface{}) {
-	println("[INFO]  " + prepareMessage(v...))
+	printLine("[INFO]  " + prepareMessage(v...))
 }
 
 // Warn outputs a warning message.
 func Warn(v ...interface{}) {
-	println("[WARNING]  " + prepareMessage(v...))
+	printLine("[WARNING]  " + prepareMessage(v...))
 }
 
-// Output debug message.
+// Dbg outputs debug message.
 func Dbg(v ...interface{}) {
 	if debugMode {
-		println("[DEBUG] " + prepareMessage(v...))
+		printLine("[DEBUG] " + prepareMessage(v...))
 	}
 }
 
-// Output error message.
+// Err outputs error message.
 func Err(v ...interface{}) {
-	println("[ERROR] " + prepareMessage(v...))
+	printLine("[ERROR] " + prepareMessage(v...))
 }
 
 // Errf outputs formatted log.
 func Errf(format string, v ...interface{}) {
 	printf("[ERROR] "+format, v...)
 }
 
-// Messages for security audit.
+// Audit outputs messages for security audit.
 func Audit(v ...interface{}) {
-	println("[AUDIT] " + prepareMessage(v...))
+	printLine("[AUDIT] " + prepareMessage(v...))
 }
 
+// Fatal prints fatal message and exits.
 func Fatal(v ...interface{}) {
 	log.Fatal("[FATAL] " + prepareMessage(v...))
 }