Move all code from cmd/maddy into root package

Build info helpers can be reused by maddyctl.
Same goes for directory configuration.

build_info.go

@@ -1,18 +1,17 @@
-package main
+package maddy
 
 import (
-	"fmt"
 	"runtime/debug"
 )
 
 var Version = "unknown (built from source tree)"
 
-func buildInfo() string {
+func BuildInfo() string {
 	if info, ok := debug.ReadBuildInfo(); ok {
 		if info.Main.Version == "(devel)" {
 			return Version
 		}
-		return fmt.Sprintf("%s %s", info.Main.Version, info.Main.Sum)
+		return info.Main.Version + " " + info.Main.Sum
 	}
-	return Version
+	return Version + " (GOPATH build)"
 }

cmd/maddy/main.go

@@ -1,127 +1,11 @@
 package main
 
 import (
-	"flag"
-	"net/http"
-	_ "net/http/pprof"
 	"os"
-	"path/filepath"
-	"runtime"
-	"strings"
 
 	"github.com/foxcpp/maddy"
-	"github.com/foxcpp/maddy/config"
-	"github.com/foxcpp/maddy/config/parser"
-	"github.com/foxcpp/maddy/log"
 )
 
 func main() {
-	configPath := flag.String("config", filepath.Join(ConfigDirectory, "maddy.conf"), "path to configuration file")
-
-	logTargets := flag.String("log", "stderr", "default logging target(s)")
-
-	flag.StringVar(&config.StateDirectory, "state", DefaultStateDirectory, "path to the state directory")
-	flag.StringVar(&config.LibexecDirectory, "libexec", DefaultLibexecDirectory, "path to the libexec directory")
-	flag.StringVar(&config.RuntimeDirectory, "runtime", DefaultRuntimeDirectory, "path to the runtime directory")
-
-	flag.BoolVar(&log.DefaultLogger.Debug, "debug", false, "enable debug logging")
-	profileEndpoint := flag.String("debug.pprof", "", "enable live profiler HTTP endpoint and listen on the specified endpoint")
-	blockProfileRate := flag.Int("debug.blockprofrate", 0, "set blocking profile rate")
-	mutexProfileFract := flag.Int("debug.mutexproffract", 0, "set mutex profile fraction)")
-
-	printVersion := flag.Bool("v", false, "print version and exit")
-
-	flag.Parse()
-
-	if *printVersion {
-		printBuildInfo()
-		return
-	}
-
-	var err error
-	log.DefaultLogger.Out, err = maddy.LogOutputOption(strings.Split(*logTargets, " "))
-	if err != nil {
-		log.Println(err)
-		os.Exit(2)
-	}
-
-	if err := ensureDirectoryWritable(config.StateDirectory); err != nil {
-		log.Println(err)
-		os.Exit(2)
-	}
-	if err := ensureDirectoryWritable(config.RuntimeDirectory); err != nil {
-		log.Println(err)
-		os.Exit(2)
-	}
-
-	if *profileEndpoint != "" {
-		go func() {
-			log.Println("listening on", "http://"+*profileEndpoint, "for profiler requests")
-			log.Println("failed to listen on profiler endpoint:", http.ListenAndServe(*profileEndpoint, nil))
-		}()
-	}
-
-	// These values can also be affected by environment so set them
-	// only if argument is specified.
-	if *mutexProfileFract != 0 {
-		runtime.SetMutexProfileFraction(*mutexProfileFract)
-	}
-	if *blockProfileRate != 0 {
-		runtime.SetBlockProfileRate(*blockProfileRate)
-	}
-
-	f, err := os.Open(*configPath)
-	if err != nil {
-		log.Printf("cannot open %q: %v\n", *configPath, err)
-		os.Exit(1)
-	}
-	defer f.Close()
-
-	// Make sure all paths we are going to use are absolute
-	// before we change the working directory.
-	config.StateDirectory, err = filepath.Abs(config.StateDirectory)
-	if err != nil {
-		log.Println(err)
-		os.Exit(1)
-	}
-	config.LibexecDirectory, err = filepath.Abs(config.LibexecDirectory)
-	if err != nil {
-		log.Println(err)
-		os.Exit(1)
-	}
-	config.RuntimeDirectory, err = filepath.Abs(config.RuntimeDirectory)
-	if err != nil {
-		log.Println(err)
-		os.Exit(1)
-	}
-
-	// Make directory constants accessible in configuration by using
-	// environment variables expansion.
-	if err := os.Setenv("MADDYSTATE", config.StateDirectory); err != nil {
-		log.Println(err)
-	}
-	if err := os.Setenv("MADDYLIBEXEC", config.LibexecDirectory); err != nil {
-		log.Println(err)
-	}
-	if err := os.Setenv("MADDYRUNTIME", config.RuntimeDirectory); err != nil {
-		log.Println(err)
-	}
-
-	cfg, err := parser.Read(f, *configPath)
-	if err != nil {
-		log.Printf("cannot parse %q: %v\n", *configPath, err)
-		os.Exit(1)
-	}
-
-	// Change the working directory to make all relative paths
-	// in configuration relative to state directory.
-	if err := os.Chdir(config.StateDirectory); err != nil {
-		log.Println(err)
-		os.Exit(1)
-	}
-
-	if err := maddy.Start(cfg); err != nil {
-		log.Println(err)
-		os.Exit(1)
-	}
+	os.Exit(maddy.Run())
 }

cmd/maddy/version.go

@@ -1,25 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"runtime/debug"
-)
-
-var Version = "unknown (built from source tree)"
-
-func printBuildInfo() {
-	if info, ok := debug.ReadBuildInfo(); ok {
-		if info.Main.Version == "(devel)" {
-			fmt.Println("maddy", Version)
-		} else {
-			fmt.Println("maddy", info.Main.Version, info.Main.Sum)
-		}
-	} else {
-		fmt.Println("maddy", Version)
-		fmt.Println()
-		fmt.Println("Building maddy in GOPATH mode can lead to wrong dependency")
-		fmt.Println("versions being used. Problems created by this will not be")
-		fmt.Println("addressed. Make sure you are building in Module Mode")
-		fmt.Println("(see README for details)")
-	}
-}

cmd/maddyctl/main.go

@@ -4,8 +4,10 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 
 	"github.com/emersion/go-imap/backend"
+	"github.com/foxcpp/maddy"
 	"github.com/urfave/cli"
 	"golang.org/x/crypto/bcrypt"
 )
@@ -28,20 +30,20 @@ func main() {
 	app := cli.NewApp()
 	app.Name = "maddyctl"
 	app.Usage = "maddy mail server administration utility"
-	app.Version = buildInfo()
+	app.Version = maddy.BuildInfo()
 
 	app.Flags = []cli.Flag{
 		cli.StringFlag{
 			Name:   "config",
 			Usage:  "Configuration file to use",
 			EnvVar: "MADDY_CONFIG",
-			Value:  "/etc/maddy/maddy.conf",
+			Value:  filepath.Join(maddy.ConfigDirectory, "maddy.conf"),
 		},
 		cli.StringFlag{
 			Name:   "state",
 			Usage:  "State directory to use",
 			EnvVar: "MADDY_STATE",
-			Value:  "/var/lib/maddy",
+			Value:  maddy.DefaultStateDirectory,
 		},
 	}
 

directories.go

@@ -1,9 +1,4 @@
-package main
-
-import (
-	"os"
-	"path/filepath"
-)
+package maddy
 
 var (
 	// ConfigDirectory specifies platform-specific value
@@ -46,19 +41,3 @@ var (
 	// only for purposes of modification using -X linker flag.
 	DefaultLibexecDirectory = "/usr/lib/maddy"
 )
-
-func ensureDirectoryWritable(path string) error {
-	if err := os.MkdirAll(path, 0700); err != nil {
-		return err
-	}
-
-	testFile, err := os.Create(filepath.Join(path, "writeable-test"))
-	if err != nil {
-		return err
-	}
-	testFile.Close()
-	if err := os.Remove(testFile.Name()); err != nil {
-		return err
-	}
-	return nil
-}

go.sum

@@ -153,6 +153,7 @@ golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
+golang.org/x/tools v0.0.0-20190907020128-2ca718005c18 h1:xFbv3LvlvQAmbNJFCBKRv1Ccvnh9FVsW0FX2kTWWowE=
 golang.org/x/tools v0.0.0-20190907020128-2ca718005c18/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/appengine v1.6.1 h1:QzqyMA1tlu6CgqCDUtU9V+ZKhLFT2dkJuANu5QaxI3I=

maddy.go

@@ -1,61 +0,0 @@
-package maddy
-
-import (
-	"io"
-
-	"github.com/foxcpp/maddy/config"
-	"github.com/foxcpp/maddy/log"
-
-	// Import packages for side-effect of module registration.
-	_ "github.com/foxcpp/maddy/auth/external"
-	_ "github.com/foxcpp/maddy/auth/pam"
-	_ "github.com/foxcpp/maddy/auth/shadow"
-	_ "github.com/foxcpp/maddy/check/dkim"
-	_ "github.com/foxcpp/maddy/check/dns"
-	_ "github.com/foxcpp/maddy/check/dnsbl"
-	_ "github.com/foxcpp/maddy/check/spf"
-	_ "github.com/foxcpp/maddy/endpoint/imap"
-	_ "github.com/foxcpp/maddy/endpoint/smtp"
-	_ "github.com/foxcpp/maddy/modify"
-	_ "github.com/foxcpp/maddy/modify/dkim"
-	_ "github.com/foxcpp/maddy/storage/sql"
-	_ "github.com/foxcpp/maddy/target/queue"
-	_ "github.com/foxcpp/maddy/target/remote"
-	_ "github.com/foxcpp/maddy/target/smtp_downstream"
-)
-
-func Start(cfg []config.Node) error {
-	globals := config.NewMap(nil, &config.Node{Children: cfg})
-	globals.String("hostname", false, false, "", nil)
-	globals.String("autogenerated_msg_domain", false, false, "", nil)
-	globals.Custom("tls", false, false, nil, config.TLSDirective, nil)
-	globals.Bool("storage_perdomain", false, false, nil)
-	globals.Bool("auth_perdomain", false, false, nil)
-	globals.StringList("auth_domains", false, false, nil, nil)
-	globals.Custom("log", false, false, defaultLogOutput, logOutput, &log.DefaultLogger.Out)
-	globals.Bool("debug", false, log.DefaultLogger.Debug, &log.DefaultLogger.Debug)
-	globals.AllowUnknown()
-	unknown, err := globals.Process()
-	if err != nil {
-		return err
-	}
-
-	defer log.DefaultLogger.Out.Close()
-
-	insts, err := instancesFromConfig(globals.Values, unknown)
-	if err != nil {
-		return err
-	}
-
-	handleSignals()
-
-	for _, inst := range insts {
-		if closer, ok := inst.(io.Closer); ok {
-			if err := closer.Close(); err != nil {
-				log.Printf("module %s (%s) close failed: %v", inst.Name(), inst.InstanceName(), err)
-			}
-		}
-	}
-
-	return nil
-}

module_main.go

@@ -1,11 +1,66 @@
 package maddy
 
 import (
+	"io"
+
 	"github.com/foxcpp/maddy/config"
 	"github.com/foxcpp/maddy/log"
 	"github.com/foxcpp/maddy/module"
+
+	// Import packages for side-effect of module registration.
+	_ "github.com/foxcpp/maddy/auth/external"
+	_ "github.com/foxcpp/maddy/auth/pam"
+	_ "github.com/foxcpp/maddy/auth/shadow"
+	_ "github.com/foxcpp/maddy/check/dkim"
+	_ "github.com/foxcpp/maddy/check/dns"
+	_ "github.com/foxcpp/maddy/check/dnsbl"
+	_ "github.com/foxcpp/maddy/check/spf"
+	_ "github.com/foxcpp/maddy/endpoint/imap"
+	_ "github.com/foxcpp/maddy/endpoint/smtp"
+	_ "github.com/foxcpp/maddy/modify"
+	_ "github.com/foxcpp/maddy/modify/dkim"
+	_ "github.com/foxcpp/maddy/storage/sql"
+	_ "github.com/foxcpp/maddy/target/queue"
+	_ "github.com/foxcpp/maddy/target/remote"
+	_ "github.com/foxcpp/maddy/target/smtp_downstream"
 )
 
+func moduleMain(cfg []config.Node) error {
+	globals := config.NewMap(nil, &config.Node{Children: cfg})
+	globals.String("hostname", false, false, "", nil)
+	globals.String("autogenerated_msg_domain", false, false, "", nil)
+	globals.Custom("tls", false, false, nil, config.TLSDirective, nil)
+	globals.Bool("storage_perdomain", false, false, nil)
+	globals.Bool("auth_perdomain", false, false, nil)
+	globals.StringList("auth_domains", false, false, nil, nil)
+	globals.Custom("log", false, false, defaultLogOutput, logOutput, &log.DefaultLogger.Out)
+	globals.Bool("debug", false, log.DefaultLogger.Debug, &log.DefaultLogger.Debug)
+	globals.AllowUnknown()
+	unknown, err := globals.Process()
+	if err != nil {
+		return err
+	}
+
+	defer log.DefaultLogger.Out.Close()
+
+	insts, err := instancesFromConfig(globals.Values, unknown)
+	if err != nil {
+		return err
+	}
+
+	handleSignals()
+
+	for _, inst := range insts {
+		if closer, ok := inst.(io.Closer); ok {
+			if err := closer.Close(); err != nil {
+				log.Printf("module %s (%s) close failed: %v", inst.Name(), inst.InstanceName(), err)
+			}
+		}
+	}
+
+	return nil
+}
+
 type modInfo struct {
 	instance module.Module
 	cfg      config.Node

run.go

@@ -0,0 +1,165 @@
+package maddy
+
+import (
+	"flag"
+	"fmt"
+	"net/http"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"github.com/foxcpp/maddy/config"
+	"github.com/foxcpp/maddy/config/parser"
+	"github.com/foxcpp/maddy/log"
+)
+
+var (
+	profileEndpoint   = flag.String("debug.pprof", "", "enable live profiler HTTP endpoint and listen on the specified endpoint")
+	blockProfileRate  = flag.Int("debug.blockprofrate", 0, "set blocking profile rate")
+	mutexProfileFract = flag.Int("debug.mutexproffract", 0, "set mutex profile fraction)")
+)
+
+// Run is the entry point for all maddy code. It takes care of command line arguments parsing,
+// logging initialization, directives setup, configuration reading. After all that, it
+// calls moduleMain to initialize and run modules.
+func Run() int {
+	flag.StringVar(&config.StateDirectory, "state", DefaultStateDirectory, "path to the state directory")
+	flag.StringVar(&config.LibexecDirectory, "libexec", DefaultLibexecDirectory, "path to the libexec directory")
+	flag.StringVar(&config.RuntimeDirectory, "runtime", DefaultRuntimeDirectory, "path to the runtime directory")
+	flag.BoolVar(&log.DefaultLogger.Debug, "debug", false, "enable debug logging")
+
+	var (
+		configPath   = flag.String("config", filepath.Join(ConfigDirectory, "maddy.conf"), "path to configuration file")
+		logTargets   = flag.String("log", "stderr", "default logging target(s)")
+		printVersion = flag.Bool("v", false, "print version and exit")
+	)
+	flag.Parse()
+
+	if *printVersion {
+		fmt.Println("maddy", BuildInfo())
+		return 0
+	}
+
+	flag.Parse()
+
+	var err error
+	log.DefaultLogger.Out, err = LogOutputOption(strings.Split(*logTargets, " "))
+	if err != nil {
+		log.Println(err)
+		return 2
+	}
+
+	initDebug()
+
+	// Lost the configuration before initDirs to make sure we will
+	// interpret the relative path correctly (initDirs changes the working
+	// directory).
+	f, err := os.Open(*configPath)
+	if err != nil {
+		log.Printf("cannot open %q: %v\n", configPath, err)
+		return 2
+	}
+	defer f.Close()
+
+	if err := initDirs(); err != nil {
+		log.Println(err)
+		return 2
+	}
+
+	// But but actually parse it after initDirs since it also sets a couple of
+	// environment variables that may be used in the configuration.
+	cfg, err := parser.Read(f, *configPath)
+	if err != nil {
+		log.Printf("cannot parse %q: %v\n", configPath, err)
+		return 2
+	}
+
+	if err := moduleMain(cfg); err != nil {
+		log.Println(err)
+		return 2
+	}
+
+	return 0
+}
+
+var ()
+
+func initDebug() {
+	if *profileEndpoint != "" {
+		go func() {
+			log.Println("listening on", "http://"+*profileEndpoint, "for profiler requests")
+			log.Println("failed to listen on profiler endpoint:", http.ListenAndServe(*profileEndpoint, nil))
+		}()
+	}
+
+	// These values can also be affected by environment so set them
+	// only if argument is specified.
+	if *mutexProfileFract != 0 {
+		runtime.SetMutexProfileFraction(*mutexProfileFract)
+	}
+	if *blockProfileRate != 0 {
+		runtime.SetBlockProfileRate(*blockProfileRate)
+	}
+}
+
+func initDirs() error {
+	if err := ensureDirectoryWritable(config.StateDirectory); err != nil {
+		return err
+	}
+	if err := ensureDirectoryWritable(config.RuntimeDirectory); err != nil {
+		return err
+	}
+
+	// Make sure all paths we are going to use are absolute
+	// before we change the working directory.
+	var err error
+	config.StateDirectory, err = filepath.Abs(config.StateDirectory)
+	if err != nil {
+		return err
+	}
+	config.LibexecDirectory, err = filepath.Abs(config.LibexecDirectory)
+	if err != nil {
+		return err
+	}
+	config.RuntimeDirectory, err = filepath.Abs(config.RuntimeDirectory)
+	if err != nil {
+		return err
+	}
+
+	// Make directory constants accessible in configuration by using
+	// environment variables expansion.
+	if err := os.Setenv("MADDYSTATE", config.StateDirectory); err != nil {
+		log.Println(err)
+	}
+	if err := os.Setenv("MADDYLIBEXEC", config.LibexecDirectory); err != nil {
+		log.Println(err)
+	}
+	if err := os.Setenv("MADDYRUNTIME", config.RuntimeDirectory); err != nil {
+		log.Println(err)
+	}
+
+	// Change the working directory to make all relative paths
+	// in configuration relative to state directory.
+	if err := os.Chdir(config.StateDirectory); err != nil {
+		log.Println(err)
+	}
+
+	return nil
+}
+
+func ensureDirectoryWritable(path string) error {
+	if err := os.MkdirAll(path, 0700); err != nil {
+		return err
+	}
+
+	testFile, err := os.Create(filepath.Join(path, "writeable-test"))
+	if err != nil {
+		return err
+	}
+	testFile.Close()
+	if err := os.Remove(testFile.Name()); err != nil {
+		return err
+	}
+	return nil
+}