Restructure project similar to hello and graph

pkg/command/default.go

@@ -1,18 +0,0 @@
-package command
-
-import (
-	"github.com/spf13/viper"
-)
-
-// init defined the default options for viper.
-func init() {
-	viper.SetDefault("debug.addr", "0.0.0.0:8090")
-	viper.SetDefault("debug.token", "")
-	viper.SetDefault("debug.pprof", false)
-
-	viper.SetDefault("http.addr", "0.0.0.0:8080")
-	viper.SetDefault("http.root", "/")
-
-	viper.SetDefault("asset.path", "")
-	viper.SetDefault("config.file", "")
-}

pkg/command/health.go

@@ -3,52 +3,47 @@ package command
 import (
 	"fmt"
 	"net/http"
-	"os"
 
-	"github.com/rs/zerolog/log"
-	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
+	"github.com/micro/cli"
+	"github.com/owncloud/ocis-phoenix/pkg/config"
+	"github.com/owncloud/ocis-phoenix/pkg/flagset"
 )
 
 // Health is the entrypoint for the health command.
-func Health() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "health",
-		Short: "Check health status",
-		Long:  "",
-		Run: func(cmd *cobra.Command, args []string) {
+func Health(cfg *config.Config) cli.Command {
+	return cli.Command{
+		Name:  "health",
+		Usage: "Check health status",
+		Flags: flagset.HealthWithConfig(cfg),
+		Action: func(c *cli.Context) error {
+			logger := NewLogger(cfg)
+
 			resp, err := http.Get(
 				fmt.Sprintf(
 					"http://%s/healthz",
-					viper.GetString("debug.addr"),
+					cfg.Debug.Addr,
 				),
 			)
 
 			if err != nil {
-				log.Error().
+				logger.Fatal().
 					Err(err).
 					Msg("Failed to request health check")
-
-				os.Exit(1)
 			}
 
 			defer resp.Body.Close()
 
 			if resp.StatusCode != 200 {
-				log.Error().
+				logger.Fatal().
 					Int("code", resp.StatusCode).
 					Msg("Health seems to be in bad state")
-
-				os.Exit(1)
 			}
 
-			os.Exit(0)
+			logger.Debug().
+				Int("code", resp.StatusCode).
+				Msg("Health got a good state")
+
+			return nil
 		},
 	}
-
-	cmd.Flags().String("debug-addr", "", "Address to debug endpoint")
-	viper.BindPFlag("debug.addr", cmd.Flags().Lookup("debug-addr"))
-	viper.BindEnv("debug.addr", "PHOENIX_DEBUG_ADDR")
-
-	return cmd
 }

pkg/command/health_test.go

@@ -1,9 +0,0 @@
-package command
-
-import (
-	"testing"
-)
-
-func TestHealth(t *testing.T) {
-	t.Skip()
-}

pkg/command/root.go

@@ -4,101 +4,100 @@ import (
 	"os"
 	"strings"
 
+	"github.com/micro/cli"
+	"github.com/owncloud/ocis-phoenix/pkg/config"
+	"github.com/owncloud/ocis-phoenix/pkg/flagset"
 	"github.com/owncloud/ocis-phoenix/pkg/version"
-	"github.com/rs/zerolog"
-	"github.com/rs/zerolog/log"
-	"github.com/spf13/cobra"
+	"github.com/owncloud/ocis-pkg/log"
 	"github.com/spf13/viper"
 )
 
-// Root is the entry point for the ocis-phoenix command.
-func Root() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:     "ocis-phoenix",
-		Short:   "Reva service for phoenix",
-		Long:    ``,
-		Version: version.String,
-		PersistentPreRun: func(cmd *cobra.Command, args []string) {
-			setupLogger()
-			setupConfig()
+// Execute is the entry point for the ocis-phoenix command.
+func Execute() error {
+	cfg := config.New()
+
+	app := &cli.App{
+		Name:     "ocis-phoenix",
+		Version:  version.String,
+		Usage:    "Serve Phoenix for oCIS",
+		Compiled: version.Compiled(),
+
+		Authors: []cli.Author{
+			{
+				Name:  "ownCloud GmbH",
+				Email: "support@owncloud.com",
+			},
+		},
+
+		Flags: flagset.RootWithConfig(cfg),
+
+		Before: func(c *cli.Context) error {
+			logger := NewLogger(cfg)
+
+			viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
+			viper.SetEnvPrefix("PHOENIX")
+			viper.AutomaticEnv()
+
+			if c.IsSet("config-file") {
+				viper.SetConfigFile(c.String("config-file"))
+			} else {
+				viper.SetConfigName("phoenix")
+
+				viper.AddConfigPath("/etc/ocis")
+				viper.AddConfigPath("$HOME/.ocis")
+				viper.AddConfigPath("./config")
+			}
+
+			if err := viper.ReadInConfig(); err != nil {
+				switch err.(type) {
+				case viper.ConfigFileNotFoundError:
+					logger.Info().
+						Msg("Continue without config")
+				case viper.UnsupportedConfigError:
+					logger.Fatal().
+						Err(err).
+						Msg("Unsupported config type")
+				default:
+					logger.Fatal().
+						Err(err).
+						Msg("Failed to read config")
+				}
+			}
+
+			if err := viper.Unmarshal(&cfg); err != nil {
+				logger.Fatal().
+					Err(err).
+					Msg("Failed to parse config")
+			}
+
+			return nil
+		},
+
+		Commands: []cli.Command{
+			Server(cfg),
+			Health(cfg),
 		},
 	}
 
-	cmd.PersistentFlags().String("log-level", "", "Set logging level")
-	viper.BindPFlag("log.level", cmd.PersistentFlags().Lookup("log-level"))
-	viper.SetDefault("log.level", "info")
-	viper.BindEnv("log.level", "PHOENIX_LOG_LEVEL")
-
-	cmd.PersistentFlags().Bool("log-pretty", false, "Enable pretty logging")
-	viper.BindPFlag("log.pretty", cmd.PersistentFlags().Lookup("log-pretty"))
-	viper.SetDefault("log.pretty", true)
-	viper.BindEnv("log.pretty", "PHOENIX_LOG_PRETTY")
-
-	cmd.PersistentFlags().Bool("log-color", false, "Enable colored logging")
-	viper.BindPFlag("log.color", cmd.PersistentFlags().Lookup("log-color"))
-	viper.SetDefault("log.color", true)
-	viper.BindEnv("log.color", "PHOENIX_LOG_COLOR")
-
-	cmd.AddCommand(Server())
-	cmd.AddCommand(Health())
-
-	return cmd
-}
-
-// setupLogger prepares the logger.
-func setupLogger() {
-	switch strings.ToLower(viper.GetString("log.level")) {
-	case "panic":
-		zerolog.SetGlobalLevel(zerolog.PanicLevel)
-	case "fatal":
-		zerolog.SetGlobalLevel(zerolog.FatalLevel)
-	case "error":
-		zerolog.SetGlobalLevel(zerolog.ErrorLevel)
-	case "warn":
-		zerolog.SetGlobalLevel(zerolog.WarnLevel)
-	case "info":
-		zerolog.SetGlobalLevel(zerolog.InfoLevel)
-	case "debug":
-		zerolog.SetGlobalLevel(zerolog.DebugLevel)
-	default:
-		zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	cli.HelpFlag = &cli.BoolFlag{
+		Name:  "help,h",
+		Usage: "Show the help",
 	}
 
-	if viper.GetBool("log.pretty") {
-		log.Logger = log.Output(
-			zerolog.ConsoleWriter{
-				Out:     os.Stderr,
-				NoColor: !viper.GetBool("log.color"),
-			},
-		)
+	cli.VersionFlag = &cli.BoolFlag{
+		Name:  "version,v",
+		Usage: "Print the version",
 	}
+
+	return app.Run(os.Args)
 }
 
-// setupConfig prepares the config.
-func setupConfig() {
-	viper.SetConfigName("phoenix")
-
-	viper.AddConfigPath("/etc/ocis")
-	viper.AddConfigPath("$HOME/.ocis")
-	viper.AddConfigPath("./config")
-
-	if err := viper.ReadInConfig(); err != nil {
-		switch err.(type) {
-		case viper.ConfigFileNotFoundError:
-			log.Debug().
-				Msg("Initializing without config file")
-		case viper.UnsupportedConfigError:
-			log.Fatal().
-				Msg("Unsupported config type")
-		default:
-			if e := log.Debug(); e.Enabled() {
-				log.Fatal().
-					Err(err).
-					Msg("Failed to read config")
-			} else {
-				log.Fatal().
-					Msg("Failed to read config")
-			}
-		}
-	}
+// NewLogger initializes a service-specific logger instance.
+func NewLogger(cfg *config.Config) log.Logger {
+	return log.NewLogger(
+		log.Name("phoenix"),
+		log.Level(cfg.Log.Level),
+		log.Pretty(cfg.Log.Pretty),
+		log.Color(cfg.Log.Color),
+	)
 }

pkg/command/root_test.go

@@ -1,9 +0,0 @@
-package command
-
-import (
-	"testing"
-)
-
-func TestRoot(t *testing.T) {
-	t.Skip()
-}

pkg/command/server.go

@@ -2,198 +2,189 @@ package command
 
 import (
 	"context"
-	"net"
-	"net/http"
 	"os"
 	"os/signal"
-	"strings"
 	"time"
 
+	"contrib.go.opencensus.io/exporter/jaeger"
+	"contrib.go.opencensus.io/exporter/ocagent"
+	"contrib.go.opencensus.io/exporter/zipkin"
+	"github.com/micro/cli"
 	"github.com/oklog/run"
-	"github.com/owncloud/ocis-phoenix/pkg/router/debug"
-	"github.com/owncloud/ocis-phoenix/pkg/router/server"
-	"github.com/rs/zerolog/log"
-	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
+	openzipkin "github.com/openzipkin/zipkin-go"
+	zipkinhttp "github.com/openzipkin/zipkin-go/reporter/http"
+	"github.com/owncloud/ocis-phoenix/pkg/config"
+	"github.com/owncloud/ocis-phoenix/pkg/flagset"
+	"github.com/owncloud/ocis-phoenix/pkg/metrics"
+	"github.com/owncloud/ocis-phoenix/pkg/server/debug"
+	"github.com/owncloud/ocis-phoenix/pkg/server/http"
+	"go.opencensus.io/stats/view"
+	"go.opencensus.io/trace"
 )
 
 // Server is the entrypoint for the server command.
-func Server() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "server",
-		Short: "Start integrated server",
-		Long:  "",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			var gr run.Group
+func Server(cfg *config.Config) cli.Command {
+	return cli.Command{
+		Name:  "server",
+		Usage: "Start integrated server",
+		Flags: flagset.ServerWithConfig(cfg),
+		Action: func(c *cli.Context) error {
+			logger := NewLogger(cfg)
+
+			if cfg.Tracing.Enabled {
+				switch t := cfg.Tracing.Type; t {
+				case "agent":
+					exporter, err := ocagent.NewExporter(
+						ocagent.WithReconnectionPeriod(5*time.Second),
+						ocagent.WithAddress(cfg.Tracing.Endpoint),
+						ocagent.WithServiceName(cfg.Tracing.Service),
+					)
+
+					if err != nil {
+						logger.Error().
+							Err(err).
+							Str("endpoint", cfg.Tracing.Endpoint).
+							Str("collector", cfg.Tracing.Collector).
+							Msg("Failed to create agent tracing")
+
+						return err
+					}
+
+					trace.RegisterExporter(exporter)
+					view.RegisterExporter(exporter)
+
+				case "jaeger":
+					exporter, err := jaeger.NewExporter(
+						jaeger.Options{
+							AgentEndpoint:     cfg.Tracing.Endpoint,
+							CollectorEndpoint: cfg.Tracing.Collector,
+							ServiceName:       cfg.Tracing.Service,
+						},
+					)
+
+					if err != nil {
+						logger.Error().
+							Err(err).
+							Str("endpoint", cfg.Tracing.Endpoint).
+							Str("collector", cfg.Tracing.Collector).
+							Msg("Failed to create jaeger tracing")
+
+						return err
+					}
+
+					trace.RegisterExporter(exporter)
+
+				case "zipkin":
+					endpoint, err := openzipkin.NewEndpoint(
+						cfg.Tracing.Service,
+						cfg.Tracing.Endpoint,
+					)
+
+					if err != nil {
+						logger.Error().
+							Err(err).
+							Str("endpoint", cfg.Tracing.Endpoint).
+							Str("collector", cfg.Tracing.Collector).
+							Msg("Failed to create zipkin tracing")
+
+						return err
+					}
+
+					exporter := zipkin.NewExporter(
+						zipkinhttp.NewReporter(
+							cfg.Tracing.Collector,
+						),
+						endpoint,
+					)
+
+					trace.RegisterExporter(exporter)
+
+				default:
+					logger.Warn().
+						Str("type", t).
+						Msg("Unknown tracing backend")
+				}
+
+				trace.ApplyConfig(
+					trace.Config{
+						DefaultSampler: trace.AlwaysSample(),
+					},
+				)
+			} else {
+				logger.Debug().
+					Msg("Tracing is not enabled")
+			}
+
+			var (
+				gr          = run.Group{}
+				ctx, cancel = context.WithCancel(context.Background())
+				metrics     = metrics.New()
+			)
+
+			defer cancel()
 
 			{
-				server := &http.Server{
-					Addr: viper.GetString("debug.addr"),
-					Handler: debug.Router(
-						debug.WithToken(viper.GetString("debug.token")),
-						debug.WithPprof(viper.GetBool("debug.pprof")),
-					),
-					ReadTimeout:  5 * time.Second,
-					WriteTimeout: 10 * time.Second,
+				server, err := http.Server(
+					http.Logger(logger),
+					http.Context(ctx),
+					http.Config(cfg),
+					http.Metrics(metrics),
+				)
+
+				if err != nil {
+					logger.Info().
+						Err(err).
+						Str("transport", "http").
+						Msg("Failed to initialize server")
+
+					return err
 				}
 
 				gr.Add(func() error {
-					log.Info().
-						Str("addr", viper.GetString("debug.addr")).
-						Msg("Starting debug server")
+					return server.Run()
+				}, func(_ error) {
+					logger.Info().
+						Str("transport", "http").
+						Msg("Shutting down server")
 
-					if strings.HasPrefix(viper.GetString("debug.addr"), "unix://") {
-						socket := strings.TrimPrefix(viper.GetString("debug.addr"), "unix://")
-
-						if err := os.Remove(socket); err != nil && !os.IsNotExist(err) {
-							log.Error().
-								Err(err).
-								Str("socket", socket).
-								Msg("Failed to remove existing debug socket")
-
-							return err
-						}
-
-						listener, err := net.ListenUnix(
-							"unix",
-							&net.UnixAddr{
-								Name: socket,
-								Net:  "unix",
-							},
-						)
-
-						if err != nil {
-							log.Error().
-								Err(err).
-								Msg("Failed to initialize debug unix socket")
-
-							return err
-						}
-
-						if err = os.Chmod(socket, os.FileMode(0666)); err != nil {
-							log.Error().
-								Err(err).
-								Msg("Failed to change debug socket permissions")
-
-							return err
-						}
-
-						return server.Serve(listener)
-					}
-
-					return server.ListenAndServe()
-				}, func(reason error) {
-					ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
-					defer cancel()
-
-					if err := server.Shutdown(ctx); err != nil {
-						log.Error().
-							Err(err).
-							Msg("Failed to shutdown debug server gracefully")
-
-						return
-					}
-
-					if strings.HasPrefix(viper.GetString("debug.addr"), "unix://") {
-						socket := strings.TrimPrefix(viper.GetString("debug.addr"), "unix://")
-
-						if err := os.Remove(socket); err != nil && !os.IsNotExist(err) {
-							log.Error().
-								Err(err).
-								Str("socket", socket).
-								Msg("Failed to remove debug server socket")
-						}
-					}
-
-					log.Info().
-						Err(reason).
-						Msg("Shutdown debug server gracefully")
+					cancel()
 				})
 			}
 
 			{
-				server := &http.Server{
-					Addr: viper.GetString("http.addr"),
-					Handler: server.Router(
-						server.WithRoot(viper.GetString("http.root")),
-						server.WithPath(viper.GetString("asset.path")),
-						server.WithConfig(viper.GetString("config.file")),
-					),
-					ReadTimeout:  5 * time.Second,
-					WriteTimeout: 10 * time.Second,
+				server, err := debug.Server(
+					debug.Logger(logger),
+					debug.Context(ctx),
+					debug.Config(cfg),
+				)
+
+				if err != nil {
+					logger.Info().
+						Err(err).
+						Str("transport", "debug").
+						Msg("Failed to initialize server")
+
+					return err
 				}
 
 				gr.Add(func() error {
-					log.Info().
-						Str("addr", viper.GetString("http.addr")).
-						Msg("Starting http server")
-
-					if strings.HasPrefix(viper.GetString("http.addr"), "unix://") {
-						socket := strings.TrimPrefix(viper.GetString("http.addr"), "unix://")
-
-						if err := os.Remove(socket); err != nil && !os.IsNotExist(err) {
-							log.Error().
-								Err(err).
-								Str("socket", socket).
-								Msg("Failed to remove existing http socket")
-
-							return err
-						}
-
-						listener, err := net.ListenUnix(
-							"unix",
-							&net.UnixAddr{
-								Name: socket,
-								Net:  "unix",
-							},
-						)
-
-						if err != nil {
-							log.Error().
-								Err(err).
-								Msg("Failed to initialize http unix socket")
-
-							return err
-						}
-
-						if err = os.Chmod(socket, os.FileMode(0666)); err != nil {
-							log.Error().
-								Err(err).
-								Msg("Failed to change http socket permissions")
-
-							return err
-						}
-
-						return server.Serve(listener)
-					}
-
 					return server.ListenAndServe()
-				}, func(reason error) {
-					ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+				}, func(_ error) {
+					ctx, timeout := context.WithTimeout(ctx, 5*time.Second)
+
+					defer timeout()
 					defer cancel()
 
 					if err := server.Shutdown(ctx); err != nil {
-						log.Error().
+						logger.Info().
 							Err(err).
-							Msg("Failed to shutdown http server gracefully")
-
-						return
+							Str("transport", "debug").
+							Msg("Failed to shutdown server")
+					} else {
+						logger.Info().
+							Str("transport", "debug").
+							Msg("Shutting down server")
 					}
-
-					if strings.HasPrefix(viper.GetString("http.addr"), "unix://") {
-						socket := strings.TrimPrefix(viper.GetString("http.addr"), "unix://")
-
-						if err := os.Remove(socket); err != nil && !os.IsNotExist(err) {
-							log.Error().
-								Err(err).
-								Str("socket", socket).
-								Msg("Failed to remove http server socket")
-						}
-					}
-
-					log.Info().
-						Err(reason).
-						Msg("Shutdown http server gracefully")
 				})
 			}
 
@@ -208,40 +199,11 @@ func Server() *cobra.Command {
 					return nil
 				}, func(err error) {
 					close(stop)
+					cancel()
 				})
 			}
 
 			return gr.Run()
 		},
 	}
-
-	cmd.Flags().String("debug-addr", "", "Address to bind debug server")
-	viper.BindPFlag("debug.addr", cmd.Flags().Lookup("debug-addr"))
-	viper.BindEnv("debug.addr", "PHOENIX_DEBUG_ADDR")
-
-	cmd.Flags().String("debug-token", "", "Token to grant metrics access")
-	viper.BindPFlag("debug.token", cmd.Flags().Lookup("debug-token"))
-	viper.BindEnv("debug.token", "PHOENIX_DEBUG_TOKEN")
-
-	cmd.Flags().Bool("debug-pprof", false, "Enable pprof debugging")
-	viper.BindPFlag("debug.pprof", cmd.Flags().Lookup("debug-pprof"))
-	viper.BindEnv("debug.pprof", "PHOENIX_DEBUG_PPROF")
-
-	cmd.Flags().String("http-addr", "", "Address to bind http server")
-	viper.BindPFlag("http.addr", cmd.Flags().Lookup("http-addr"))
-	viper.BindEnv("http.addr", "PHOENIX_HTTP_ADDR")
-
-	cmd.Flags().String("http-root", "", "Root path for http endpoint")
-	viper.BindPFlag("http.root", cmd.Flags().Lookup("http-root"))
-	viper.BindEnv("http.root", "PHOENIX_HTTP_ROOT")
-
-	cmd.Flags().String("asset-path", "", "Path to custom assets")
-	viper.BindPFlag("asset.path", cmd.Flags().Lookup("asset-path"))
-	viper.BindEnv("asset.path", "PHOENIX_ASSET_PATH")
-
-	cmd.Flags().String("config-file", "", "Path to phoenix config")
-	viper.BindPFlag("config.file", cmd.Flags().Lookup("config-file"))
-	viper.BindEnv("config.file", "PHOENIX_CONFIG_FILE")
-
-	return cmd
 }

pkg/command/server_test.go

@@ -1,9 +0,0 @@
-package command
-
-import (
-	"testing"
-)
-
-func TestServer(t *testing.T) {
-	t.Skip()
-}