Apply standard format, add dummy server

pkg/command/default.go

@@ -0,0 +1,15 @@
+package command
+
+import (
+	"github.com/spf13/viper"
+)
+
+// init defined the default options for viper.
+func init() {
+	viper.SetDefault("debug.addr", "0.0.0.0:8190")
+	viper.SetDefault("debug.token", "")
+	viper.SetDefault("debug.pprof", false)
+
+	viper.SetDefault("http.addr", "0.0.0.0:8180")
+	viper.SetDefault("http.root", "/")
+}

pkg/command/defaults.go

@@ -1,10 +0,0 @@
-package command
-
-import (
-	"github.com/spf13/viper"
-)
-
-func init() {
-	viper.SetDefault("server.addr", "0.0.0.0:8180")
-	viper.SetDefault("metrics.addr", "0.0.0.0:8190")
-}

pkg/command/health.go

@@ -1,6 +1,10 @@
 package command
 
 import (
+	"fmt"
+	"net/http"
+	"os"
+
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -13,15 +17,38 @@ func Health() *cobra.Command {
 		Short: "Check health status",
 		Long:  "",
 		Run: func(cmd *cobra.Command, args []string) {
-			log.Info().
-				Str("addr", viper.GetString("metrics.addr")).
-				Msg("Executed health command")
+			resp, err := http.Get(
+				fmt.Sprintf(
+					"http://%s/healthz",
+					viper.GetString("debug.addr"),
+				),
+			)
+
+			if err != nil {
+				log.Error().
+					Err(err).
+					Msg("Failed to request health check")
+
+				os.Exit(1)
+			}
+
+			defer resp.Body.Close()
+
+			if resp.StatusCode != 200 {
+				log.Error().
+					Int("code", resp.StatusCode).
+					Msg("Health seems to be in bad state")
+
+				os.Exit(1)
+			}
+
+			os.Exit(0)
 		},
 	}
 
-	cmd.Flags().String("metrics-addr", "", "Address to metrics endpoint")
-	viper.BindPFlag("metrics.addr", cmd.Flags().Lookup("metrics-addr"))
-	viper.BindEnv("metrics.addr", "WEBDAV_METRICS_ADDR")
+	cmd.Flags().String("debug-addr", "", "Address to debug endpoint")
+	viper.BindPFlag("debug.addr", cmd.Flags().Lookup("debug-addr"))
+	viper.BindEnv("debug.addr", "WEBDAV_DEBUG_ADDR")
 
 	return cmd
 }

pkg/command/root.go

@@ -45,6 +45,7 @@ func Root() *cobra.Command {
 	return cmd
 }
 
+// setupLogger prepares the logger.
 func setupLogger() {
 	switch strings.ToLower(viper.GetString("log.level")) {
 	case "panic":
@@ -73,6 +74,7 @@ func setupLogger() {
 	}
 }
 
+// setupConfig prepares the config.
 func setupConfig() {
 	viper.SetConfigName("webdav")
 

pkg/command/server.go

@@ -1,6 +1,17 @@
 package command
 
 import (
+	"context"
+	"net"
+	"net/http"
+	"os"
+	"os/signal"
+	"strings"
+	"time"
+
+	"github.com/oklog/run"
+	"github.com/owncloud/ocis-webdav/pkg/router/debug"
+	"github.com/owncloud/ocis-webdav/pkg/router/server"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -12,16 +23,215 @@ func Server() *cobra.Command {
 		Use:   "server",
 		Short: "Start integrated server",
 		Long:  "",
-		Run: func(cmd *cobra.Command, args []string) {
-			log.Info().
-				Str("addr", viper.GetString("server.addr")).
-				Msg("Executed server command")
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var gr run.Group
+
+			{
+				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,
+				}
+
+				gr.Add(func() error {
+					log.Info().
+						Str("addr", viper.GetString("debug.addr")).
+						Msg("Starting debug 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")
+				})
+			}
+
+			{
+				server := &http.Server{
+					Addr: viper.GetString("http.addr"),
+					Handler: server.Router(
+						server.WithRoot(viper.GetString("http.root")),
+					),
+					ReadTimeout:  5 * time.Second,
+					WriteTimeout: 10 * time.Second,
+				}
+
+				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)
+					defer cancel()
+
+					if err := server.Shutdown(ctx); err != nil {
+						log.Error().
+							Err(err).
+							Msg("Failed to shutdown http server gracefully")
+
+						return
+					}
+
+					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")
+				})
+			}
+
+			{
+				stop := make(chan os.Signal, 1)
+
+				gr.Add(func() error {
+					signal.Notify(stop, os.Interrupt)
+
+					<-stop
+
+					return nil
+				}, func(err error) {
+					close(stop)
+				})
+			}
+
+			return gr.Run()
 		},
 	}
 
-	cmd.Flags().String("server-addr", "", "Address to bind the server")
-	viper.BindPFlag("server.addr", cmd.Flags().Lookup("server-addr"))
-	viper.BindEnv("server.addr", "WEBDAV_SERVER_ADDR")
+	cmd.Flags().String("debug-addr", "", "Address to bind debug server")
+	viper.BindPFlag("debug.addr", cmd.Flags().Lookup("debug-addr"))
+	viper.BindEnv("debug.addr", "WEBDAV_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", "WEBDAV_DEBUG_TOKEN")
+
+	cmd.Flags().Bool("debug-pprof", false, "Enable pprof debugging")
+	viper.BindPFlag("debug.pprof", cmd.Flags().Lookup("debug-pprof"))
+	viper.BindEnv("debug.pprof", "WEBDAV_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", "WEBDAV_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", "WEBDAV_HTTP_ROOT")
 
 	return cmd
 }

pkg/handler/metrics/metrics.go

@@ -0,0 +1,58 @@
+package metrics
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"github.com/rs/zerolog/log"
+)
+
+var (
+	// ErrInvalidToken is returned when the request token is invalid.
+	ErrInvalidToken = `Invalid or missing token`
+)
+
+// metrics gets initialized by New and provides the handler.
+type metrics struct {
+	token string
+}
+
+// ServeHTTP just implements the http.Handler interface.
+func (m metrics) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if m.token == "" {
+		promhttp.Handler().ServeHTTP(w, r)
+		return
+	}
+
+	header := r.Header.Get("Authorization")
+
+	if header == "" {
+		log.Debug().
+			Msg("Missing auth header")
+
+		http.Error(w, ErrInvalidToken, http.StatusUnauthorized)
+		return
+	}
+
+	if header != fmt.Sprintf("Bearer %s", m.token) {
+		log.Debug().
+			Msg("Invalid token provided")
+
+		http.Error(w, ErrInvalidToken, http.StatusUnauthorized)
+		return
+	}
+
+	promhttp.Handler().ServeHTTP(w, r)
+}
+
+// Handler returns the handler for metrics endpoint.
+func Handler(opts ...Option) http.Handler {
+	m := new(metrics)
+
+	for _, opt := range opts {
+		opt(m)
+	}
+
+	return m
+}

pkg/handler/metrics/option.go

@@ -0,0 +1,11 @@
+package metrics
+
+// Option configures an assets option.
+type Option func(*metrics)
+
+// WithToken returns an option to set a token.
+func WithToken(val string) Option {
+	return func(m *metrics) {
+		m.token = val
+	}
+}

pkg/middleware/header/header.go

@@ -0,0 +1,60 @@
+package header
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/owncloud/ocis-webdav/pkg/version"
+)
+
+// Cache writes required cache headers to all requests.
+func Cache(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Cache-Control", "no-cache, no-store, max-age=0, must-revalidate, value")
+		w.Header().Set("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
+		w.Header().Set("Last-Modified", time.Now().UTC().Format(http.TimeFormat))
+
+		next.ServeHTTP(w, r)
+	})
+}
+
+// Options writes required option headers to all requests.
+func Options(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != "OPTIONS" {
+			next.ServeHTTP(w, r)
+		} else {
+			w.Header().Set("Access-Control-Allow-Origin", "*")
+			w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, PATCH, DELETE, OPTIONS")
+			w.Header().Set("Access-Control-Allow-Headers", "authorization, origin, content-type, accept")
+			w.Header().Set("Allow", "HEAD, GET, POST, PUT, PATCH, DELETE, OPTIONS")
+
+			w.WriteHeader(http.StatusOK)
+		}
+	})
+}
+
+// Secure writes required access headers to all requests.
+func Secure(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Access-Control-Allow-Origin", "*")
+		w.Header().Set("X-Frame-Options", "DENY")
+		w.Header().Set("X-Content-Type-Options", "nosniff")
+		w.Header().Set("X-XSS-Protection", "1; mode=block")
+
+		if r.TLS != nil {
+			w.Header().Set("Strict-Transport-Security", "max-age=31536000")
+		}
+
+		next.ServeHTTP(w, r)
+	})
+}
+
+// Version writes the current version to the headers.
+func Version(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("X-WEBDAV-VERSION", version.String)
+
+		next.ServeHTTP(w, r)
+	})
+}

pkg/router/debug/debug.go

@@ -0,0 +1,74 @@
+package debug
+
+import (
+	"io"
+	"net/http"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/chi/middleware"
+	"github.com/owncloud/ocis-webdav/pkg/handler/metrics"
+	"github.com/owncloud/ocis-webdav/pkg/middleware/header"
+	"github.com/rs/zerolog/hlog"
+	"github.com/rs/zerolog/log"
+)
+
+// debug gets initialized by Router and configures the router.
+type debug struct {
+	token string
+	pprof bool
+}
+
+// Router initializes a router for the debug server.
+func Router(opts ...Option) *chi.Mux {
+	d := new(debug)
+
+	for _, opt := range opts {
+		opt(d)
+	}
+
+	mux := chi.NewRouter()
+
+	mux.Use(hlog.NewHandler(log.Logger))
+	mux.Use(hlog.RemoteAddrHandler("ip"))
+	mux.Use(hlog.URLHandler("path"))
+	mux.Use(hlog.MethodHandler("method"))
+	mux.Use(hlog.RequestIDHandler("request_id", "Request-Id"))
+
+	mux.Use(middleware.RealIP)
+	mux.Use(header.Version)
+	mux.Use(header.Cache)
+	mux.Use(header.Secure)
+	mux.Use(header.Options)
+
+	mux.Route("/", func(root chi.Router) {
+		if d.pprof {
+			root.Mount(
+				"/debug",
+				middleware.Profiler(),
+			)
+		}
+
+		root.Mount(
+			"/metrics",
+			metrics.Handler(
+				metrics.WithToken(d.token),
+			),
+		)
+
+		root.Get("/healthz", func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "text/plain")
+			w.WriteHeader(http.StatusOK)
+
+			io.WriteString(w, http.StatusText(http.StatusOK))
+		})
+
+		root.Get("/readyz", func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "text/plain")
+			w.WriteHeader(http.StatusOK)
+
+			io.WriteString(w, http.StatusText(http.StatusOK))
+		})
+	})
+
+	return mux
+}

pkg/router/debug/option.go

@@ -0,0 +1,18 @@
+package debug
+
+// Option configures an assets option.
+type Option func(*debug)
+
+// WithToken returns an option to set a token.
+func WithToken(val string) Option {
+	return func(d *debug) {
+		d.token = val
+	}
+}
+
+// WithPprof returns an option to enable pprof.
+func WithPprof(val bool) Option {
+	return func(d *debug) {
+		d.pprof = val
+	}
+}

pkg/router/server/option.go

@@ -0,0 +1,11 @@
+package server
+
+// Option configures an assets option.
+type Option func(*server)
+
+// WithRoot returns an option to set root.
+func WithRoot(val string) Option {
+	return func(s *server) {
+		s.root = val
+	}
+}

pkg/router/server/server.go

@@ -0,0 +1,61 @@
+package server
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/go-chi/chi"
+	"github.com/go-chi/chi/middleware"
+	"github.com/owncloud/ocis-webdav/pkg/middleware/header"
+	"github.com/rs/zerolog/hlog"
+	"github.com/rs/zerolog/log"
+)
+
+// server gets initialized by Router and configures the router.
+type server struct {
+	root string
+}
+
+// Router initializes a router for the http server.
+func Router(opts ...Option) *chi.Mux {
+	s := new(server)
+
+	for _, opt := range opts {
+		opt(s)
+	}
+
+	mux := chi.NewRouter()
+
+	mux.Use(hlog.NewHandler(log.Logger))
+	mux.Use(hlog.RemoteAddrHandler("ip"))
+	mux.Use(hlog.URLHandler("path"))
+	mux.Use(hlog.MethodHandler("method"))
+	mux.Use(hlog.RequestIDHandler("request_id", "Request-Id"))
+
+	mux.Use(hlog.AccessHandler(func(r *http.Request, status, size int, duration time.Duration) {
+		hlog.FromRequest(r).Debug().
+			Str("method", r.Method).
+			Str("url", r.URL.String()).
+			Int("status", status).
+			Int("size", size).
+			Dur("duration", duration).
+			Msg("")
+	}))
+
+	mux.Use(middleware.RealIP)
+	mux.Use(header.Version)
+	mux.Use(header.Cache)
+	mux.Use(header.Secure)
+	mux.Use(header.Options)
+
+	mux.Route(s.root, func(root chi.Router) {
+		root.Get("/", func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "text/plain")
+			w.WriteHeader(http.StatusNotFound)
+
+			http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
+		})
+	})
+
+	return mux
+}