feat: implement builder plugin

This plugin will allow users to override the builder used for their application, enabling users to use custom builders if desired.

plugins/builder/.gitignore

@@ -0,0 +1,9 @@
+/commands
+/core-post-deploy
+/subcommands/*
+/triggers/*
+/triggers
+/network-*
+/install
+/post-*
+/report

plugins/builder/Makefile

@@ -0,0 +1,6 @@
+SUBCOMMANDS = subcommands/report subcommands/set
+TRIGGERS = triggers/builder-detect triggers/install triggers/post-delete triggers/report
+BUILD = commands subcommands triggers
+PLUGIN_NAME = builder
+
+include ../../common.mk

plugins/builder/builder-detect

@@ -0,0 +1 @@
+triggers

plugins/builder/builder.go

@@ -0,0 +1,13 @@
+package builder
+
+var (
+	// DefaultProperties is a map of all valid network properties with corresponding default property values
+	DefaultProperties = map[string]string{
+		"selected": "",
+	}
+
+	// GlobalProperties is a map of all valid global network properties
+	GlobalProperties = map[string]bool{
+		"selected": true,
+	}
+)

plugins/builder/go.mod

@@ -0,0 +1,12 @@
+module github.com/dokku/dokku/plugins/builder
+
+go 1.15
+
+require (
+  github.com/codegangsta/inject v0.0.0-20150114235600-33e0aa1cb7c0
+  github.com/codeskyblue/go-sh v0.0.0-20190412065543-76bd3d59ff27
+  github.com/dokku/dokku/plugins/common v0.0.0-00010101000000-000000000000
+  github.com/spf13/pflag v1.0.5 // indirect
+)
+
+replace github.com/dokku/dokku/plugins/common => ../common

plugins/builder/go.sum

@@ -0,0 +1,10 @@
+github.com/codegangsta/inject v0.0.0-20150114235600-33e0aa1cb7c0 h1:sDMmm+q/3+BukdIpxwO365v/Rbspp2Nt5XntgQRXq8Q=
+github.com/codegangsta/inject v0.0.0-20150114235600-33e0aa1cb7c0/go.mod h1:4Zcjuz89kmFXt9morQgcfYZAYZ5n8WHjt81YYWIwtTM=
+github.com/codeskyblue/go-sh v0.0.0-20190412065543-76bd3d59ff27 h1:HHUr4P/aKh4quafGxDT9LDasjGdlGkzLbfmmrlng3kA=
+github.com/codeskyblue/go-sh v0.0.0-20190412065543-76bd3d59ff27/go.mod h1:VQx0hjo2oUeQkQUET7wRwradO6f+fN5jzXgB/zROxxE=
+github.com/ryanuber/columnize v1.1.2-0.20190319233515-9e6335e58db3 h1:utdYOikI1XjNtTFGCwSM6OmFJblU4ld4gACoJsbadJg=
+github.com/ryanuber/columnize v1.1.2-0.20190319233515-9e6335e58db3/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+golang.org/x/sync v0.0.0-20201207232520-09787c993a3a h1:DcqTD9SDLc+1P/r1EmRBwnVsrOwW+kk2vWf9n+1sGhs=
+golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

plugins/builder/plugin.toml

@@ -0,0 +1,4 @@
+[plugin]
+description = "dokku core builder plugin"
+version = "0.23.9"
+[plugin.config]

plugins/builder/report.go

@@ -0,0 +1,44 @@
+package builder
+
+import (
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// ReportSingleApp is an internal function that displays the builder report for one or more apps
+func ReportSingleApp(appName string, format string, infoFlag string) error {
+	if err := common.VerifyAppName(appName); err != nil {
+		return err
+	}
+
+	flags := map[string]common.ReportFunc{
+		"--builder-computed-selected": reportComputedSelected,
+		"--builder-global-selected":   reportGlobalSelected,
+		"--builder-selected":          reportSelected,
+	}
+
+	flagKeys := []string{}
+	for flagKey := range flags {
+		flagKeys = append(flagKeys, flagKey)
+	}
+
+	trimPrefix := false
+	uppercaseFirstCharacter := true
+	infoFlags := common.CollectReport(appName, infoFlag, flags)
+	return common.ReportSingleApp("builder", appName, infoFlag, infoFlags, flagKeys, format, trimPrefix, uppercaseFirstCharacter)
+}
+
+func reportComputedSelected(appName string) string {
+	value := reportSelected(appName)
+	if value == "" {
+		value = reportGlobalSelected(appName)
+	}
+
+	return value
+}
+func reportGlobalSelected(appName string) string {
+	return common.PropertyGet("builder", "--global", "selected")
+}
+
+func reportSelected(appName string) string {
+	return common.PropertyGet("builder", appName, "selected")
+}

plugins/builder/src/commands/commands.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/dokku/dokku/plugins/common"
+)
+
+const (
+	helpHeader = `Usage: dokku builder[:COMMAND]
+
+Manage builder settings for an app
+
+Additional commands:`
+
+	helpContent = `
+    builder:report [<app>] [<flag>], Displays a builder report for one or more apps
+    builder:set <app> <property> (<value>), Set or clear a builder property for an app
+`
+)
+
+func main() {
+	flag.Usage = usage
+	flag.Parse()
+
+	cmd := flag.Arg(0)
+	switch cmd {
+	case "builder", "builder:help":
+		usage()
+	case "help":
+		command := common.NewShellCmd(fmt.Sprintf("ps -o command= %d", os.Getppid()))
+		command.ShowOutput = false
+		output, err := command.Output()
+
+		if err == nil && strings.Contains(string(output), "--all") {
+			fmt.Println(helpContent)
+		} else {
+			fmt.Print("\n    builder, Manage builder settings for an app\n")
+		}
+	default:
+		dokkuNotImplementExitCode, err := strconv.Atoi(os.Getenv("DOKKU_NOT_IMPLEMENTED_EXIT"))
+		if err != nil {
+			fmt.Println("failed to retrieve DOKKU_NOT_IMPLEMENTED_EXIT environment variable")
+			dokkuNotImplementExitCode = 10
+		}
+		os.Exit(dokkuNotImplementExitCode)
+	}
+}
+
+func usage() {
+	common.CommandUsage(helpHeader, helpContent)
+}

plugins/builder/src/subcommands/subcommands.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/dokku/dokku/plugins/builder"
+	"github.com/dokku/dokku/plugins/common"
+
+	flag "github.com/spf13/pflag"
+)
+
+// main entrypoint to all subcommands
+func main() {
+	parts := strings.Split(os.Args[0], "/")
+	subcommand := parts[len(parts)-1]
+
+	var err error
+	switch subcommand {
+	case "report":
+		args := flag.NewFlagSet("builder:report", flag.ExitOnError)
+		format := args.String("format", "stdout", "format: [ stdout | json ]")
+		osArgs, infoFlag, flagErr := common.ParseReportArgs("builder", os.Args[2:])
+		if flagErr == nil {
+			args.Parse(osArgs)
+			appName := args.Arg(0)
+			err = builder.CommandReport(appName, *format, infoFlag)
+		}
+	case "set":
+		args := flag.NewFlagSet("builder:set", flag.ExitOnError)
+		global := args.Bool("global", false, "--global: set a global property")
+		args.Parse(os.Args[2:])
+		appName := args.Arg(0)
+		property := args.Arg(1)
+		value := args.Arg(2)
+		if *global {
+			appName = "--global"
+			property = args.Arg(0)
+			value = args.Arg(1)
+		}
+		err = builder.CommandSet(appName, property, value)
+	default:
+		err = fmt.Errorf("Invalid plugin subcommand call: %s", subcommand)
+	}
+
+	if err != nil {
+		common.LogFailWithError(err)
+	}
+}

plugins/builder/src/triggers/triggers.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/dokku/dokku/plugins/builder"
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// main entrypoint to all triggers
+func main() {
+	parts := strings.Split(os.Args[0], "/")
+	trigger := parts[len(parts)-1]
+	flag.Parse()
+
+	var err error
+	switch trigger {
+	case "builder-detect":
+		appName := flag.Arg(0)
+		err = builder.TriggerBuilderDetect(appName)
+	case "install":
+		err = builder.TriggerInstall()
+	case "post-delete":
+		appName := flag.Arg(0)
+		err = builder.TriggerPostDelete(appName)
+	case "report":
+		appName := flag.Arg(0)
+		err = builder.ReportSingleApp(appName, "", "")
+	default:
+		err = fmt.Errorf("Invalid plugin trigger call: %s", trigger)
+	}
+
+	if err != nil {
+		common.LogFailWithError(err)
+	}
+}

plugins/builder/subcommands.go

@@ -0,0 +1,29 @@
+package builder
+
+import (
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// CommandReport displays a network report for one or more apps
+func CommandReport(appName string, format string, infoFlag string) error {
+	if len(appName) == 0 {
+		apps, err := common.DokkuApps()
+		if err != nil {
+			return err
+		}
+		for _, appName := range apps {
+			if err := ReportSingleApp(appName, format, infoFlag); err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+
+	return ReportSingleApp(appName, format, infoFlag)
+}
+
+// CommandSet set or clear a builder property for an app
+func CommandSet(appName string, property string, value string) error {
+	common.CommandPropertySet("builder", appName, property, value, DefaultProperties, GlobalProperties)
+	return nil
+}

plugins/builder/triggers.go

@@ -0,0 +1,36 @@
+package builder
+
+import (
+	"fmt"
+
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// TriggerBuilderDetect outputs a manually selected builder for the app
+func TriggerBuilderDetect(appName string) error {
+	if builder := common.PropertyGet("builder", appName, "selected"); builder != "" {
+		fmt.Println(builder)
+		return nil
+	}
+
+	if builder := common.PropertyGet("builder", "--global", "selected"); builder != "" {
+		fmt.Println(builder)
+		return nil
+	}
+
+	return nil
+}
+
+// TriggerInstall runs the install step for the builder plugin
+func TriggerInstall() error {
+	if err := common.PropertySetup("builder"); err != nil {
+		return fmt.Errorf("Unable to install the builder plugin: %s", err.Error())
+	}
+
+	return nil
+}
+
+// TriggerPostDelete destroys the builder property for a given app container
+func TriggerPostDelete(appName string) error {
+	return common.PropertyDestroy("builder", appName)
+}