Merge pull request #168 from go-flutter-desktop/improved-packaging-tools-instructions

jld3103 · web-flow · commit fb103e46e863 · 2020-10-29T18:16:26.000+01:00
Improve missing packaging tools instructions
diff --git a/Dockerfile b/Dockerfile
@@ -101,6 +101,9 @@ RUN sed -i "s/#XferCommand/XferCommand/g" /etc/pacman.conf
 # This makes makepkg believe we are not root. Bypassing the root check is ok, because we are in a container
 ENV EUID=1
 
+# Create symlink for darwin-dmg
+RUN ln -s $(which genisoimage) /usr/bin/mkisofs
+
 COPY --from=flutterbuilder /opt/flutter /opt/flutter
 RUN ln -sf /opt/flutter/bin/flutter /usr/bin/flutter
 
diff --git a/cmd/build.go b/cmd/build.go
@@ -245,9 +245,9 @@ func subcommandBuild(targetOS string, packagingTask packaging.Task, vmArguments
 			buildGoBinary(targetOS, vmArguments)
 		}
 		if packagingTask != packaging.NoopTask {
-			log.Infof("Packaging app for %s-%s", targetOS, packagingTask.Name())
+			log.Infof("Packaging app for %s", packagingTask.Name())
 			packagingTask.Pack(buildVersionNumber, buildOrRunMode)
-			log.Infof("Successfully packaged app for %s-%s", targetOS, packagingTask.Name())
+			log.Infof("Successfully packaged app for %s", packagingTask.Name())
 		}
 	}
 }
diff --git a/cmd/docker.go b/cmd/docker.go
@@ -92,7 +92,7 @@ func dockerHoverBuild(targetOS string, packagingTask packaging.Task, buildFlags
 	dockerArgs = append(dockerArgs, dockerImage)
 	targetOSAndPackaging := targetOS
 	if packName := packagingTask.Name(); packName != "" {
-		targetOSAndPackaging += "-" + packName
+		targetOSAndPackaging = packName
 	}
 	hoverCommand := []string{"hover-safe.sh", "build", targetOSAndPackaging}
 	hoverCommand = append(hoverCommand, buildFlags...)
diff --git a/cmd/doctor.go b/cmd/doctor.go
@@ -13,6 +13,7 @@ import (
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v2"
 
+	"github.com/go-flutter-desktop/hover/cmd/packaging"
 	"github.com/go-flutter-desktop/hover/internal/build"
 	"github.com/go-flutter-desktop/hover/internal/config"
 	"github.com/go-flutter-desktop/hover/internal/log"
@@ -38,6 +39,24 @@ var doctorCmd = &cobra.Command{
 		hoverVersion := version.HoverVersion()
 		log.Infof("Hover version %s running on %s", hoverVersion, runtime.GOOS)
 
+		log.Infof("Sharing packaging tools")
+		for _, task := range []packaging.Task{
+			packaging.DarwinBundleTask,
+			packaging.DarwinDmgTask,
+			packaging.DarwinPkgTask,
+			packaging.LinuxAppImageTask,
+			packaging.LinuxDebTask,
+			packaging.LinuxPkgTask,
+			packaging.LinuxRpmTask,
+			packaging.LinuxSnapTask,
+			packaging.WindowsMsiTask,
+		} {
+			if task.IsSupported() {
+				log.Infof("%s is supported", task.Name())
+			}
+		}
+		log.Printf("")
+
 		log.Infof("Sharing flutter version")
 		cmdFlutterVersion := exec.Command(build.FlutterBin(), "--version")
 		cmdFlutterVersion.Stderr = os.Stderr
diff --git a/cmd/packaging/darwin-bundle.go b/cmd/packaging/darwin-bundle.go
@@ -48,7 +48,7 @@ var DarwinBundleTask = &packagingTask{
 
 		return outputFileName, nil
 	},
-	requiredTools: map[string][]string{
+	requiredTools: map[string]map[string]string{
 		"linux":   {},
 		"darwin":  {},
 		"windows": {},
diff --git a/cmd/packaging/darwin-dmg.go b/cmd/packaging/darwin-dmg.go
@@ -31,25 +31,31 @@ var DarwinDmgTask = &packagingTask{
 			return "", err
 		}
 
-		var cmdGenisoimage *exec.Cmd
+		var cmdCreateBundle *exec.Cmd
 		switch os := runtime.GOOS; os {
 		case "darwin":
-			cmdGenisoimage = exec.Command("hdiutil", "create", "-volname", packageName, "-srcfolder", "dmgdir", "-ov", "-format", "UDBZ", outputFileName)
+			cmdCreateBundle = exec.Command("hdiutil", "create", "-volname", packageName, "-srcfolder", "dmgdir", "-ov", "-format", "UDBZ", outputFileName)
 		case "linux":
-			cmdGenisoimage = exec.Command("genisoimage", "-V", packageName, "-D", "-R", "-apple", "-no-pad", "-o", outputFileName, "dmgdir")
+			cmdCreateBundle = exec.Command("mkisofs", "-V", packageName, "-D", "-R", "-apple", "-no-pad", "-o", outputFileName, "dmgdir")
 		}
-		cmdGenisoimage.Dir = tmpPath
-		cmdGenisoimage.Stdout = os.Stdout
-		cmdGenisoimage.Stderr = os.Stderr
-		err = cmdGenisoimage.Run()
+		cmdCreateBundle.Dir = tmpPath
+		cmdCreateBundle.Stdout = os.Stdout
+		cmdCreateBundle.Stderr = os.Stderr
+		err = cmdCreateBundle.Run()
 		if err != nil {
 			return "", err
 		}
 		return outputFileName, nil
 	},
 	skipAssertInitialized: true,
-	requiredTools: map[string][]string{
-		"linux":  {"ln", "genisoimage"},
-		"darwin": {"ln", "hdiutil"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"ln":      "Install ln from your package manager",
+			"mkisofs": "Install mkisofs from your package manager. Some distros ship genisoimage which is a fork of mkisofs. Create a symlink for it like this: ln -s $(which genisoimage) /usr/bin/mkisofs",
+		},
+		"darwin": {
+			"ln":      "Install ln from your package manager",
+			"hdiutil": "Install hdiutil from your package manager",
+		},
 	},
 }
diff --git a/cmd/packaging/darwin-pkg.go b/cmd/packaging/darwin-pkg.go
@@ -115,8 +115,20 @@ var DarwinPkgTask = &packagingTask{
 		}
 		return outputFileName, nil
 	},
-	requiredTools: map[string][]string{
-		"linux":  {"find", "cpio", "gzip", "mkbom", "xar"},
-		"darwin": {"find", "cpio", "gzip", "mkbom", "xar"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"find":  "Install find from your package manager",
+			"cpio":  "Install cpio from your package manager",
+			"gzip":  "Install gzip from your package manager",
+			"mkbom": "Install bomutils from your package manager or from https://github.com/hogliux/bomutils",
+			"xar":   "Install xar from your package manager or from https://github.com/mackyle/xar",
+		},
+		"darwin": {
+			"find":  "Install find from your package manager",
+			"cpio":  "Install cpio from your package manager",
+			"gzip":  "Install gzip from your package manager",
+			"mkbom": "Install bomutils from your package manager or from https://github.com/hogliux/bomutils",
+			"xar":   "Install xar from your package manager or from https://github.com/mackyle/xar",
+		},
 	},
 }
diff --git a/cmd/packaging/linux-appimage.go b/cmd/packaging/linux-appimage.go
@@ -61,7 +61,9 @@ var LinuxAppImageTask = &packagingTask{
 		}
 		return fmt.Sprintf("%s-%s-x86_64.AppImage", strings.ReplaceAll(applicationName, " ", "_"), version), nil
 	},
-	requiredTools: map[string][]string{
-		"linux": {"appimagetool"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"appimagetool": "Install appimagetool from your package manager or from https://github.com/AppImage/AppImageKit#appimagetool-usage",
+		},
 	},
 }
diff --git a/cmd/packaging/linux-deb.go b/cmd/packaging/linux-deb.go
@@ -33,7 +33,9 @@ var LinuxDebTask = &packagingTask{
 		}
 		return outputFileName, nil
 	},
-	requiredTools: map[string][]string{
-		"linux": {"dpkg-deb"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"makepkg": "You need to be on Debian, Ubuntu or another distro that uses apt/dpkg as package manager to use this. Installing dpkg on other distros is hard and dangerous.",
+		},
 	},
 }
diff --git a/cmd/packaging/linux-pkg.go b/cmd/packaging/linux-pkg.go
@@ -34,7 +34,9 @@ var LinuxPkgTask = &packagingTask{
 		}
 		return fmt.Sprintf("%s-%s-%s-x86_64%s", packageName, version, release, extension), nil
 	},
-	requiredTools: map[string][]string{
-		"linux": {"makepkg"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"makepkg": "You need to be on Arch Linux or another distro that uses pacman as package manager to use this. Installing makepkg on other distros is hard and dangerous.",
+		},
 	},
 }
diff --git a/cmd/packaging/linux-rpm.go b/cmd/packaging/linux-rpm.go
@@ -32,7 +32,9 @@ var LinuxRpmTask = &packagingTask{
 		}
 		return fmt.Sprintf("RPMS/x86_64/%s-%s-%s.x86_64.rpm", packageName, version, release), nil
 	},
-	requiredTools: map[string][]string{
-		"linux": {"rpmbuild"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"rpmbuild": "You need to be on Red Hat Linux or another distro that uses rpm as package manager to use this. Installing rpmbuild on other distros is hard and dangerous.",
+		},
 	},
 }
diff --git a/cmd/packaging/linux-snap.go b/cmd/packaging/linux-snap.go
@@ -27,7 +27,9 @@ var LinuxSnapTask = &packagingTask{
 		}
 		return fmt.Sprintf("%s_%s_amd64.snap", packageName, version), nil
 	},
-	requiredTools: map[string][]string{
-		"linux": {"snapcraft"},
+	requiredTools: map[string]map[string]string{
+		"linux": {
+			"snapcraft": "Install snapd from your package manager or from https://snapcraft.io/docs/installing-snapd",
+		},
 	},
 }
diff --git a/cmd/packaging/noop.go b/cmd/packaging/noop.go
@@ -11,4 +11,5 @@ func (_ *noopTask) Init()                   {}
 func (_ *noopTask) IsInitialized() bool     { return true }
 func (_ *noopTask) AssertInitialized()      {}
 func (_ *noopTask) Pack(string, build.Mode) {}
+func (_ *noopTask) IsSupported() bool       { return true }
 func (_ *noopTask) AssertSupported()        {}
diff --git a/cmd/packaging/packaging.go b/cmd/packaging/packaging.go
@@ -66,34 +66,49 @@ type packagingTask struct {
 	flutterBuildOutputDirectory    string                                                                                               // Path to copy the build output of the app to. Operates in the temporary directory
 	packagingFunction              func(tmpPath, applicationName, packageName, executableName, version, release string) (string, error) // Function that actually packages the app. Needs to check for OS specific tools etc. . Returns the path of the packaged file
 	skipAssertInitialized          bool                                                                                                 // Set to true when a task doesn't need to be initialized.
-	requiredTools                  map[string][]string                                                                                  // Map of list of tools required to package per OS
+	requiredTools                  map[string]map[string]string                                                                         // Map of list of tools required to package per OS
 }
 
 func (t *packagingTask) AssertSupported() {
+	if !t.IsSupported() {
+		os.Exit(1)
+	}
+}
+
+func (t *packagingTask) IsSupported() bool {
 	for task := range t.dependsOn {
-		task.AssertSupported()
+		if !task.IsSupported() {
+			return false
+		}
 	}
 	if _, osIsSupported := t.requiredTools[runtime.GOOS]; !osIsSupported {
 		log.Errorf("Packaging %s is not supported on %s", t.packagingFormatName, runtime.GOOS)
 		log.Errorf("To still package %s on %s you need to run hover with the `--docker` flag.", t.packagingFormatName, runtime.GOOS)
-		os.Exit(1)
+		return false
 	}
 	var unavailableTools []string
-	for _, tool := range t.requiredTools[runtime.GOOS] {
+	for tool := range t.requiredTools[runtime.GOOS] {
 		_, err := exec.LookPath(tool)
 		if err != nil {
 			unavailableTools = append(unavailableTools, tool)
 		}
 	}
 	if len(unavailableTools) > 0 {
 		log.Errorf("To package %s these tools are required: %s", t.packagingFormatName, strings.Join(unavailableTools, ","))
-		log.Errorf("To still package %s without the required tools installed you need to run hover with the `--docker` flag.", t.packagingFormatName)
-		os.Exit(1)
+		for _, tool := range unavailableTools {
+			text := t.requiredTools[runtime.GOOS][tool]
+			if len(text) > 0 {
+				log.Infof(text)
+			}
+		}
+		log.Infof("To still package %s without the required tools installed you need to run hover with the `--docker` flag.", t.packagingFormatName)
+		return false
 	}
+	return true
 }
 
 func (t *packagingTask) Name() string {
-	return strings.SplitN(t.packagingFormatName, "-", 2)[1]
+	return t.packagingFormatName
 }
 
 func (t *packagingTask) Init() {
diff --git a/cmd/packaging/task.go b/cmd/packaging/task.go
@@ -10,5 +10,6 @@ type Task interface {
 	IsInitialized() bool
 	AssertInitialized()
 	Pack(buildVersion string, mode build.Mode)
+	IsSupported() bool
 	AssertSupported()
 }
diff --git a/cmd/packaging/windows-msi.go b/cmd/packaging/windows-msi.go
@@ -93,9 +93,13 @@ var WindowsMsiTask = &packagingTask{
 		}
 		return outputFileName, nil
 	},
-	requiredTools: map[string][]string{
-		"windows": {"candle", "light"},
-		"linux":   {"wixl"},
+	requiredTools: map[string]map[string]string{
+		"windows": {
+			"candle": "Install the WiX Toolset from https://wixtoolset.org/releases/", // Only for one tool, because displaying the message twice makes no sense
+		},
+		"linux": {
+			"wixl": "Install msitools from your package manager or from https://wiki.gnome.org/msitools/",
+		},
 	},
 	generateInitFiles: func(packageName, path string) {
 		b := make([]byte, 16)

Original file line number	Diff line number	Diff line change
`@@ -245,9 +245,9 @@ func subcommandBuild(targetOS string, packagingTask packaging.Task, vmArguments`
`245`	`245`	`buildGoBinary(targetOS, vmArguments)`
`246`	`246`	`}`
`247`	`247`	`if packagingTask != packaging.NoopTask {`
`248`		`- log.Infof("Packaging app for %s-%s", targetOS, packagingTask.Name())`
	`248`	`+ log.Infof("Packaging app for %s", packagingTask.Name())`
`249`	`249`	`packagingTask.Pack(buildVersionNumber, buildOrRunMode)`
`250`		`- log.Infof("Successfully packaged app for %s-%s", targetOS, packagingTask.Name())`
	`250`	`+ log.Infof("Successfully packaged app for %s", packagingTask.Name())`
`251`	`251`	`}`
`252`	`252`	`}`
`253`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func dockerHoverBuild(targetOS string, packagingTask packaging.Task, buildFlags`
`92`	`92`	`dockerArgs = append(dockerArgs, dockerImage)`
`93`	`93`	`targetOSAndPackaging := targetOS`
`94`	`94`	`if packName := packagingTask.Name(); packName != "" {`
`95`		`- targetOSAndPackaging += "-" + packName`
	`95`	`+ targetOSAndPackaging = packName`
`96`	`96`	`}`
`97`	`97`	`hoverCommand := []string{"hover-safe.sh", "build", targetOSAndPackaging}`
`98`	`98`	`hoverCommand = append(hoverCommand, buildFlags...)`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,9 @@ var LinuxAppImageTask = &packagingTask{`
`61`	`61`	`}`
`62`	`62`	`return fmt.Sprintf("%s-%s-x86_64.AppImage", strings.ReplaceAll(applicationName, " ", "_"), version), nil`
`63`	`63`	`},`
`64`		`- requiredTools: map[string][]string{`
`65`		`- "linux": {"appimagetool"},`
	`64`	`+ requiredTools: map[string]map[string]string{`
	`65`	`+ "linux": {`
	`66`	`+ "appimagetool": "Install appimagetool from your package manager or from https://github.com/AppImage/AppImageKit#appimagetool-usage",`
	`67`	`+ },`
`66`	`68`	`},`
`67`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ var LinuxDebTask = &packagingTask{`
`33`	`33`	`}`
`34`	`34`	`return outputFileName, nil`
`35`	`35`	`},`
`36`		`- requiredTools: map[string][]string{`
`37`		`- "linux": {"dpkg-deb"},`
	`36`	`+ requiredTools: map[string]map[string]string{`
	`37`	`+ "linux": {`
	`38`	`+ "makepkg": "You need to be on Debian, Ubuntu or another distro that uses apt/dpkg as package manager to use this. Installing dpkg on other distros is hard and dangerous.",`
	`39`	`+ },`
`38`	`40`	`},`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,9 @@ var LinuxPkgTask = &packagingTask{`
`34`	`34`	`}`
`35`	`35`	`return fmt.Sprintf("%s-%s-%s-x86_64%s", packageName, version, release, extension), nil`
`36`	`36`	`},`
`37`		`- requiredTools: map[string][]string{`
`38`		`- "linux": {"makepkg"},`
	`37`	`+ requiredTools: map[string]map[string]string{`
	`38`	`+ "linux": {`
	`39`	`+ "makepkg": "You need to be on Arch Linux or another distro that uses pacman as package manager to use this. Installing makepkg on other distros is hard and dangerous.",`
	`40`	`+ },`
`39`	`41`	`},`
`40`	`42`	`}`