More extended help

Author: ewoutp

help.go

@@ -30,7 +30,79 @@ import (
 	"github.com/fatih/color"
 )
 
-// --sync.server.keyfile
+// --docker.container missing
+func showDockerContainerNameMissingHelp() {
+	showFatalHelp(
+		"Cannot find docker container name.",
+		"",
+		"How to solve this:",
+		"1 - Add a commandline argument:",
+		"",
+		"    `arangodb ... --docker.container=<name of container you run starter in>`",
+		"",
+	)
+}
+
+// --cluster.agency-size invalid.
+func showClusterAgencySizeInvalidHelp() {
+	showFatalHelp(
+		"Cluster agency size is invalid cluster.agency-size needs to be a positive, odd number.",
+		"",
+		"How to solve this:",
+		"1 - Use a positive, odd number as agency size:",
+		"",
+		"    `arangodb ... --cluster.agency-size=<1, 3 or 5...>`",
+		"",
+	)
+}
+
+// --cluster.agency-size=1 without specifying --starter.address.
+func showClusterAgencySize1WithoutAddressHelp() {
+	showFatalHelp(
+		"With a cluster agency size of 1, a starter address is required.",
+		"",
+		"How to solve this:",
+		"1 - Add a commandline argument:",
+		"",
+		"    `arangodb ... --starter.address=<IP address of current machine>`",
+		"",
+	)
+}
+
+// setting both --docker.image and --server.rr is not possible.
+func showDockerImageWithRRIsNotAllowedHelp() {
+	showFatalHelp(
+		"Using RR is not possible with docker.",
+		"",
+		"How to solve this:",
+		"1 - Remove `--server.rr=...` commandline argument.",
+		"",
+	)
+}
+
+// setting both --docker.net-host and --docker.net-mode is not possible
+func showDockerNetHostAndNotModeNotBothAllowedHelp() {
+	showFatalHelp(
+		"It is not allowed to set `--docker.net-host` and `--docker.net-mode` at the same time.",
+		"",
+		"How to solve this:",
+		"1 - Remove  one of these two commandline arguments.",
+		"",
+	)
+}
+
+// Arangod is not found at given path.
+func showArangodExecutableNotFoundHelp(arangodPath string) {
+	showFatalHelp(
+		fmt.Sprintf("Cannot find `arangod` (expected at `%s`).", arangodPath),
+		"",
+		"How to solve this:",
+		"1 - Install ArangoDB locally or run the ArangoDB starter in docker. (see RADME for details).",
+		"",
+	)
+}
+
+// --sync.server.keyfile is missing
 func showSyncMasterServerKeyfileMissingHelp() {
 	showFatalHelp(
 		"A TLS certificate used for the HTTPS connection of the arangosync syncmaster is missing.",
@@ -78,14 +150,18 @@ func showSyncMasterClientCAFileMissingHelp() {
 // underneeth and the exit with code 1.
 // Backticks in the lines are colored yellow.
 func showFatalHelp(title string, lines ...string) {
-	log.Error(title)
+	log.Error(highlight(title))
 	content := strings.Join(lines, "\n")
+	fmt.Println(highlight(content))
+	os.Exit(1)
+}
+
+func highlight(content string) string {
 	parts := strings.Split(content, "`")
 	for i, p := range parts {
 		if i%2 == 1 {
 			parts[i] = color.YellowString(p)
 		}
 	}
-	fmt.Println(strings.Join(parts, ""))
-	os.Exit(1)
+	return strings.Join(parts, "")
 }

main.go

@@ -461,7 +461,7 @@ func mustPrepareService(generateAutoKeyFile bool) (*service.Service, service.Boo
 		info, err := findDockerContainerInfo(dockerEndpoint)
 		if err != nil {
 			if dockerContainerName == "" {
-				log.Fatalf("Cannot find docker container name. Please specify using --dockerContainer=...")
+				showDockerContainerNameMissingHelp()
 			}
 		} else {
 			if dockerContainerName == "" {
@@ -475,19 +475,19 @@ func mustPrepareService(generateAutoKeyFile bool) (*service.Service, service.Boo
 
 	// Some plausibility checks:
 	if agencySize%2 == 0 || agencySize <= 0 {
-		log.Fatal("Error: cluster.agency-size needs to be a positive, odd number.")
+		showClusterAgencySizeInvalidHelp()
 	}
 	if agencySize == 1 && ownAddress == "" {
-		log.Fatal("Error: if cluster.agency-size==1, starter.address must be given.")
+		showClusterAgencySize1WithoutAddressHelp()
 	}
 	if dockerArangodImage != "" && rrPath != "" {
-		log.Fatal("Error: using --docker.image and --server.rr is not possible.")
+		showDockerImageWithRRIsNotAllowedHelp()
 	}
 	if dockerNetHost {
 		if dockerNetworkMode == "" {
 			dockerNetworkMode = "host"
 		} else if dockerNetworkMode != "host" {
-			log.Fatal("Error: cannot set --docker.net-host and --docker.net-mode at the same time")
+			showDockerNetHostAndNotModeNotBothAllowedHelp()
 		}
 	}
 	imagePullPolicy, err := service.ParseImagePullPolicy(dockerImagePullPolicy, dockerArangodImage)
@@ -509,8 +509,7 @@ func mustPrepareService(generateAutoKeyFile bool) (*service.Service, service.Boo
 	// Check database executable
 	if !runningInDocker {
 		if _, err := os.Stat(arangodPath); os.IsNotExist(err) {
-			log.Errorf("Cannot find arangod (expected at %s).", arangodPath)
-			log.Fatal("Please install ArangoDB locally or run the ArangoDB starter in docker (see README for details).")
+			showArangodExecutableNotFoundHelp(arangodPath)
 		}
 		log.Debugf("Using %s as default arangod executable.", arangodPath)
 		log.Debugf("Using %s as default JS dir.", arangodJSPath)