move main.go logic out of commands (#38555)

* move main.go logic out of commands

pkg/cmd/grafana-cli/commands/cli.go

@@ -0,0 +1,102 @@
+package commands
+
+import (
+	"fmt"
+	"os"
+	"runtime"
+
+	"github.com/fatih/color"
+	"github.com/grafana/grafana/pkg/cmd/grafana-cli/logger"
+	"github.com/grafana/grafana/pkg/cmd/grafana-cli/services"
+	"github.com/grafana/grafana/pkg/cmd/grafana-cli/utils"
+	"github.com/urfave/cli/v2"
+)
+
+// RunCLI is the entrypoint for the grafana-cli command. It returns the exit code for the grafana-cli program.
+func RunCLI(version string) int {
+	setupLogging()
+
+	app := &cli.App{
+		Name: "Grafana CLI",
+		Authors: []*cli.Author{
+			{
+				Name:  "Grafana Project",
+				Email: "hello@grafana.com",
+			},
+		},
+		Version: version,
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:    "pluginsDir",
+				Usage:   "Path to the Grafana plugin directory",
+				Value:   utils.GetGrafanaPluginDir(runtime.GOOS),
+				EnvVars: []string{"GF_PLUGIN_DIR"},
+			},
+			&cli.StringFlag{
+				Name:    "repo",
+				Usage:   "URL to the plugin repository",
+				Value:   "https://grafana.com/api/plugins",
+				EnvVars: []string{"GF_PLUGIN_REPO"},
+			},
+			&cli.StringFlag{
+				Name:    "pluginUrl",
+				Usage:   "Full url to the plugin zip file instead of downloading the plugin from grafana.com/api",
+				Value:   "",
+				EnvVars: []string{"GF_PLUGIN_URL"},
+			},
+			&cli.BoolFlag{
+				Name:  "insecure",
+				Usage: "Skip TLS verification (insecure)",
+			},
+			&cli.BoolFlag{
+				Name:  "debug, d",
+				Usage: "Enable debug logging",
+			},
+			&cli.StringFlag{
+				Name:  "configOverrides",
+				Usage: "Configuration options to override defaults as a string. e.g. cfg:default.paths.log=/dev/null",
+			},
+			&cli.StringFlag{
+				Name:  "homepath",
+				Usage: "Path to Grafana install/home path, defaults to working directory",
+			},
+			&cli.StringFlag{
+				Name:  "config",
+				Usage: "Path to config file",
+			},
+		},
+		Commands:        Commands,
+		CommandNotFound: cmdNotFound,
+	}
+
+	app.Before = func(c *cli.Context) error {
+		services.Init(version, c.Bool("insecure"), c.Bool("debug"))
+		return nil
+	}
+
+	if err := app.Run(os.Args); err != nil {
+		logger.Errorf("%s: %s %s\n", color.RedString("Error"), color.RedString("✗"), err)
+		return 1
+	}
+
+	return 0
+}
+
+func setupLogging() {
+	for _, f := range os.Args {
+		if f == "-d" || f == "--debug" || f == "-debug" {
+			logger.SetDebug(true)
+		}
+	}
+}
+
+func cmdNotFound(c *cli.Context, command string) {
+	fmt.Printf(
+		"%s: '%s' is not a %s command. See '%s --help'.\n",
+		c.App.Name,
+		command,
+		c.App.Name,
+		os.Args[0],
+	)
+	os.Exit(1)
+}

pkg/cmd/grafana-cli/main.go

@@ -1,102 +1,14 @@
 package main
 
 import (
-	"fmt"
 	"os"
-	"runtime"
 
-	"github.com/fatih/color"
 	"github.com/grafana/grafana/pkg/cmd/grafana-cli/commands"
-	"github.com/grafana/grafana/pkg/cmd/grafana-cli/logger"
-	"github.com/grafana/grafana/pkg/cmd/grafana-cli/services"
-	"github.com/grafana/grafana/pkg/cmd/grafana-cli/utils"
-	"github.com/urfave/cli/v2"
 )
 
+// Version is overridden by build flags
 var version = "main"
 
 func main() {
-	setupLogging()
+	os.Exit(commands.RunCLI(version))
-
-	app := &cli.App{
-		Name: "Grafana CLI",
-		Authors: []*cli.Author{
-			{
-				Name:  "Grafana Project",
-				Email: "hello@grafana.com",
-			},
-		},
-		Version: version,
-		Flags: []cli.Flag{
-			&cli.StringFlag{
-				Name:    "pluginsDir",
-				Usage:   "Path to the Grafana plugin directory",
-				Value:   utils.GetGrafanaPluginDir(runtime.GOOS),
-				EnvVars: []string{"GF_PLUGIN_DIR"},
-			},
-			&cli.StringFlag{
-				Name:    "repo",
-				Usage:   "URL to the plugin repository",
-				Value:   "https://grafana.com/api/plugins",
-				EnvVars: []string{"GF_PLUGIN_REPO"},
-			},
-			&cli.StringFlag{
-				Name:    "pluginUrl",
-				Usage:   "Full url to the plugin zip file instead of downloading the plugin from grafana.com/api",
-				Value:   "",
-				EnvVars: []string{"GF_PLUGIN_URL"},
-			},
-			&cli.BoolFlag{
-				Name:  "insecure",
-				Usage: "Skip TLS verification (insecure)",
-			},
-			&cli.BoolFlag{
-				Name:  "debug, d",
-				Usage: "Enable debug logging",
-			},
-			&cli.StringFlag{
-				Name:  "configOverrides",
-				Usage: "Configuration options to override defaults as a string. e.g. cfg:default.paths.log=/dev/null",
-			},
-			&cli.StringFlag{
-				Name:  "homepath",
-				Usage: "Path to Grafana install/home path, defaults to working directory",
-			},
-			&cli.StringFlag{
-				Name:  "config",
-				Usage: "Path to config file",
-			},
-		},
-		Commands:        commands.Commands,
-		CommandNotFound: cmdNotFound,
-	}
-
-	app.Before = func(c *cli.Context) error {
-		services.Init(version, c.Bool("insecure"), c.Bool("debug"))
-		return nil
-	}
-
-	if err := app.Run(os.Args); err != nil {
-		logger.Errorf("%s: %s %s\n", color.RedString("Error"), color.RedString("✗"), err)
-		os.Exit(1)
-	}
-}
-
-func setupLogging() {
-	for _, f := range os.Args {
-		if f == "-d" || f == "--debug" || f == "-debug" {
-			logger.SetDebug(true)
-		}
-	}
-}
-
-func cmdNotFound(c *cli.Context, command string) {
-	fmt.Printf(
-		"%s: '%s' is not a %s command. See '%s --help'.\n",
-		c.App.Name,
-		command,
-		c.App.Name,
-		os.Args[0],
-	)
-	os.Exit(1)
 }

pkg/cmd/grafana-server/commands/cli.go

@@ -0,0 +1,211 @@
+package commands
+
+import (
+	"context"
+	"errors"
+	"flag"
+	"fmt"
+	"net/http"
+	_ "net/http/pprof"
+	"os"
+	"os/signal"
+	"runtime"
+	"runtime/debug"
+	"runtime/trace"
+	"strconv"
+	"syscall"
+	"time"
+
+	"github.com/grafana/grafana/pkg/api"
+	"github.com/grafana/grafana/pkg/extensions"
+	"github.com/grafana/grafana/pkg/infra/log"
+	"github.com/grafana/grafana/pkg/infra/metrics"
+	"github.com/grafana/grafana/pkg/server"
+	_ "github.com/grafana/grafana/pkg/services/alerting/conditions"
+	_ "github.com/grafana/grafana/pkg/services/alerting/notifiers"
+	"github.com/grafana/grafana/pkg/setting"
+)
+
+type ServerOptions struct {
+	Version     string
+	Commit      string
+	BuildBranch string
+	BuildStamp  string
+}
+
+type exitWithCode struct {
+	reason string
+	code   int
+}
+
+func (e exitWithCode) Error() string {
+	return e.reason
+}
+
+func RunServer(opt ServerOptions) int {
+	var (
+		configFile = flag.String("config", "", "path to config file")
+		homePath   = flag.String("homepath", "", "path to grafana install/home path, defaults to working directory")
+		pidFile    = flag.String("pidfile", "", "path to pid file")
+		packaging  = flag.String("packaging", "unknown", "describes the way Grafana was installed")
+
+		v           = flag.Bool("v", false, "prints current version and exits")
+		vv          = flag.Bool("vv", false, "prints current version, all dependencies and exits")
+		profile     = flag.Bool("profile", false, "Turn on pprof profiling")
+		profileAddr = flag.String("profile-addr", "localhost", "Define custom address for profiling")
+		profilePort = flag.Uint64("profile-port", 6060, "Define custom port for profiling")
+		tracing     = flag.Bool("tracing", false, "Turn on tracing")
+		tracingFile = flag.String("tracing-file", "trace.out", "Define tracing output file")
+	)
+
+	flag.Parse()
+
+	if *v || *vv {
+		fmt.Printf("Version %s (commit: %s, branch: %s)\n", opt.Version, opt.Commit, opt.BuildBranch)
+		if *vv {
+			fmt.Println("Dependencies:")
+			if info, ok := debug.ReadBuildInfo(); ok {
+				for _, dep := range info.Deps {
+					fmt.Println(dep.Path, dep.Version)
+				}
+			}
+		}
+		return 0
+	}
+
+	profileDiagnostics := newProfilingDiagnostics(*profile, *profileAddr, *profilePort)
+	if err := profileDiagnostics.overrideWithEnv(); err != nil {
+		fmt.Fprintln(os.Stderr, err.Error())
+		return 1
+	}
+
+	traceDiagnostics := newTracingDiagnostics(*tracing, *tracingFile)
+	if err := traceDiagnostics.overrideWithEnv(); err != nil {
+		fmt.Fprintln(os.Stderr, err.Error())
+		return 1
+	}
+
+	if profileDiagnostics.enabled {
+		fmt.Println("diagnostics: pprof profiling enabled", "addr", profileDiagnostics.addr, "port", profileDiagnostics.port)
+		runtime.SetBlockProfileRate(1)
+		go func() {
+			err := http.ListenAndServe(fmt.Sprintf("%s:%d", profileDiagnostics.addr, profileDiagnostics.port), nil)
+			if err != nil {
+				panic(err)
+			}
+		}()
+	}
+
+	if err := executeServer(*configFile, *homePath, *pidFile, *packaging, traceDiagnostics, opt); err != nil {
+		code := 1
+		var ewc exitWithCode
+		if errors.As(err, &ewc) {
+			code = ewc.code
+		}
+		if code != 0 {
+			fmt.Fprintf(os.Stderr, "%s\n", err.Error())
+		}
+
+		return code
+	}
+
+	return 0
+}
+
+func executeServer(configFile, homePath, pidFile, packaging string, traceDiagnostics *tracingDiagnostics, opt ServerOptions) error {
+	defer func() {
+		if err := log.Close(); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to close log: %s\n", err)
+		}
+	}()
+
+	if traceDiagnostics.enabled {
+		fmt.Println("diagnostics: tracing enabled", "file", traceDiagnostics.file)
+		f, err := os.Create(traceDiagnostics.file)
+		if err != nil {
+			panic(err)
+		}
+		defer func() {
+			if err := f.Close(); err != nil {
+				log.Error("Failed to write trace diagnostics", "path", traceDiagnostics.file, "err", err)
+			}
+		}()
+
+		if err := trace.Start(f); err != nil {
+			panic(err)
+		}
+		defer trace.Stop()
+	}
+
+	buildstampInt64, err := strconv.ParseInt(opt.BuildStamp, 10, 64)
+	if err != nil || buildstampInt64 == 0 {
+		buildstampInt64 = time.Now().Unix()
+	}
+
+	setting.BuildVersion = opt.Version
+	setting.BuildCommit = opt.Commit
+	setting.BuildStamp = buildstampInt64
+	setting.BuildBranch = opt.BuildBranch
+	setting.IsEnterprise = extensions.IsEnterprise
+	setting.Packaging = validPackaging(packaging)
+
+	metrics.SetBuildInformation(opt.Version, opt.Commit, opt.BuildBranch)
+
+	s, err := server.Initialize(setting.CommandLineArgs{
+		Config: configFile, HomePath: homePath, Args: flag.Args(),
+	}, server.Options{
+		PidFile: pidFile, Version: opt.Version, Commit: opt.Commit, BuildBranch: opt.BuildBranch,
+	}, api.ServerOptions{})
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Failed to start grafana. error: %s\n", err.Error())
+		return err
+	}
+
+	ctx := context.Background()
+
+	go listenToSystemSignals(ctx, s)
+
+	if err := s.Run(); err != nil {
+		code := s.ExitCode(err)
+		return exitWithCode{
+			reason: err.Error(),
+			code:   code,
+		}
+	}
+
+	return nil
+}
+
+func validPackaging(packaging string) string {
+	validTypes := []string{"dev", "deb", "rpm", "docker", "brew", "hosted", "unknown"}
+	for _, vt := range validTypes {
+		if packaging == vt {
+			return packaging
+		}
+	}
+	return "unknown"
+}
+
+func listenToSystemSignals(ctx context.Context, s *server.Server) {
+	signalChan := make(chan os.Signal, 1)
+	sighupChan := make(chan os.Signal, 1)
+
+	signal.Notify(sighupChan, syscall.SIGHUP)
+	signal.Notify(signalChan, os.Interrupt, syscall.SIGTERM)
+
+	for {
+		select {
+		case <-sighupChan:
+			if err := log.Reload(); err != nil {
+				fmt.Fprintf(os.Stderr, "Failed to reload loggers: %s\n", err)
+			}
+		case sig := <-signalChan:
+			ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
+			defer cancel()
+			if err := s.Shutdown(ctx, fmt.Sprintf("System signal: %s", sig)); err != nil {
+				fmt.Fprintf(os.Stderr, "Timed out waiting for server to shut down\n")
+			}
+			return
+		}
+	}
+}

pkg/cmd/grafana-server/commands/diagnostics.go

@@ -1,4 +1,4 @@
-package main
+package commands
 
 import (
 	"fmt"

pkg/cmd/grafana-server/commands/diagnostics_test.go

@@ -1,4 +1,4 @@
-package main
+package commands
 
 import (
 	"fmt"

pkg/cmd/grafana-server/main.go

@@ -1,29 +1,9 @@
 package main
 
 import (
-	"context"
-	"errors"
-	"flag"
-	"fmt"
-	"net/http"
-	_ "net/http/pprof"
 	"os"
-	"os/signal"
-	"runtime"
-	"runtime/debug"
-	"runtime/trace"
-	"strconv"
-	"syscall"
-	"time"
 
-	"github.com/grafana/grafana/pkg/api"
+	"github.com/grafana/grafana/pkg/cmd/grafana-server/commands"
-	"github.com/grafana/grafana/pkg/extensions"
-	"github.com/grafana/grafana/pkg/infra/log"
-	"github.com/grafana/grafana/pkg/infra/metrics"
-	"github.com/grafana/grafana/pkg/server"
-	_ "github.com/grafana/grafana/pkg/services/alerting/conditions"
-	_ "github.com/grafana/grafana/pkg/services/alerting/notifiers"
-	"github.com/grafana/grafana/pkg/setting"
 )
 
 // The following variables cannot be constants, since they can be overridden through the -X link flag
@@ -32,177 +12,11 @@ var commit = "NA"
 var buildBranch = "main"
 var buildstamp string
 
-type exitWithCode struct {
-	reason string
-	code   int
-}
-
-func (e exitWithCode) Error() string {
-	return e.reason
-}
-
 func main() {
-	var (
+	os.Exit(commands.RunServer(commands.ServerOptions{
-		configFile = flag.String("config", "", "path to config file")
+		Version:     version,
-		homePath   = flag.String("homepath", "", "path to grafana install/home path, defaults to working directory")
+		Commit:      commit,
-		pidFile    = flag.String("pidfile", "", "path to pid file")
+		BuildBranch: buildBranch,
-		packaging  = flag.String("packaging", "unknown", "describes the way Grafana was installed")
+		BuildStamp:  buildstamp,
-
+	}))
-		v           = flag.Bool("v", false, "prints current version and exits")
-		vv          = flag.Bool("vv", false, "prints current version, all dependencies and exits")
-		profile     = flag.Bool("profile", false, "Turn on pprof profiling")
-		profileAddr = flag.String("profile-addr", "localhost", "Define custom address for profiling")
-		profilePort = flag.Uint64("profile-port", 6060, "Define custom port for profiling")
-		tracing     = flag.Bool("tracing", false, "Turn on tracing")
-		tracingFile = flag.String("tracing-file", "trace.out", "Define tracing output file")
-	)
-
-	flag.Parse()
-
-	if *v || *vv {
-		fmt.Printf("Version %s (commit: %s, branch: %s)\n", version, commit, buildBranch)
-		if *vv {
-			fmt.Println("Dependencies:")
-			if info, ok := debug.ReadBuildInfo(); ok {
-				for _, dep := range info.Deps {
-					fmt.Println(dep.Path, dep.Version)
-				}
-			}
-		}
-		os.Exit(0)
-	}
-
-	profileDiagnostics := newProfilingDiagnostics(*profile, *profileAddr, *profilePort)
-	if err := profileDiagnostics.overrideWithEnv(); err != nil {
-		fmt.Fprintln(os.Stderr, err.Error())
-		os.Exit(1)
-	}
-
-	traceDiagnostics := newTracingDiagnostics(*tracing, *tracingFile)
-	if err := traceDiagnostics.overrideWithEnv(); err != nil {
-		fmt.Fprintln(os.Stderr, err.Error())
-		os.Exit(1)
-	}
-
-	if profileDiagnostics.enabled {
-		fmt.Println("diagnostics: pprof profiling enabled", "addr", profileDiagnostics.addr, "port", profileDiagnostics.port)
-		runtime.SetBlockProfileRate(1)
-		go func() {
-			err := http.ListenAndServe(fmt.Sprintf("%s:%d", profileDiagnostics.addr, profileDiagnostics.port), nil)
-			if err != nil {
-				panic(err)
-			}
-		}()
-	}
-
-	if err := executeServer(*configFile, *homePath, *pidFile, *packaging, traceDiagnostics); err != nil {
-		code := 1
-		var ewc exitWithCode
-		if errors.As(err, &ewc) {
-			code = ewc.code
-		}
-		if code != 0 {
-			fmt.Fprintf(os.Stderr, "%s\n", err.Error())
-		}
-
-		os.Exit(code)
-	}
-}
-
-func executeServer(configFile, homePath, pidFile, packaging string, traceDiagnostics *tracingDiagnostics) error {
-	defer func() {
-		if err := log.Close(); err != nil {
-			fmt.Fprintf(os.Stderr, "Failed to close log: %s\n", err)
-		}
-	}()
-
-	if traceDiagnostics.enabled {
-		fmt.Println("diagnostics: tracing enabled", "file", traceDiagnostics.file)
-		f, err := os.Create(traceDiagnostics.file)
-		if err != nil {
-			panic(err)
-		}
-		defer func() {
-			if err := f.Close(); err != nil {
-				log.Error("Failed to write trace diagnostics", "path", traceDiagnostics.file, "err", err)
-			}
-		}()
-
-		if err := trace.Start(f); err != nil {
-			panic(err)
-		}
-		defer trace.Stop()
-	}
-
-	buildstampInt64, err := strconv.ParseInt(buildstamp, 10, 64)
-	if err != nil || buildstampInt64 == 0 {
-		buildstampInt64 = time.Now().Unix()
-	}
-
-	setting.BuildVersion = version
-	setting.BuildCommit = commit
-	setting.BuildStamp = buildstampInt64
-	setting.BuildBranch = buildBranch
-	setting.IsEnterprise = extensions.IsEnterprise
-	setting.Packaging = validPackaging(packaging)
-
-	metrics.SetBuildInformation(version, commit, buildBranch)
-
-	s, err := server.Initialize(setting.CommandLineArgs{
-		Config: configFile, HomePath: homePath, Args: flag.Args(),
-	}, server.Options{
-		PidFile: pidFile, Version: version, Commit: commit, BuildBranch: buildBranch,
-	}, api.ServerOptions{})
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "Failed to start grafana. error: %s\n", err.Error())
-		return err
-	}
-
-	ctx := context.Background()
-
-	go listenToSystemSignals(ctx, s)
-
-	if err := s.Run(); err != nil {
-		code := s.ExitCode(err)
-		return exitWithCode{
-			reason: err.Error(),
-			code:   code,
-		}
-	}
-
-	return nil
-}
-
-func validPackaging(packaging string) string {
-	validTypes := []string{"dev", "deb", "rpm", "docker", "brew", "hosted", "unknown"}
-	for _, vt := range validTypes {
-		if packaging == vt {
-			return packaging
-		}
-	}
-	return "unknown"
-}
-
-func listenToSystemSignals(ctx context.Context, s *server.Server) {
-	signalChan := make(chan os.Signal, 1)
-	sighupChan := make(chan os.Signal, 1)
-
-	signal.Notify(sighupChan, syscall.SIGHUP)
-	signal.Notify(signalChan, os.Interrupt, syscall.SIGTERM)
-
-	for {
-		select {
-		case <-sighupChan:
-			if err := log.Reload(); err != nil {
-				fmt.Fprintf(os.Stderr, "Failed to reload loggers: %s\n", err)
-			}
-		case sig := <-signalChan:
-			ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
-			defer cancel()
-			if err := s.Shutdown(ctx, fmt.Sprintf("System signal: %s", sig)); err != nil {
-				fmt.Fprintf(os.Stderr, "Timed out waiting for server to shut down\n")
-			}
-			return
-		}
-	}
 }