feature(kumactl) add install postgres-schema command

Makefile

@@ -324,6 +324,7 @@ protoc/pkg/config/app/kumactl/v1alpha1:
 # Notice that this command is not include into `make generate` by intention (since generated code differes between dev host and ci server)
 generate/kumactl/install/control-plane:
 	go generate ./app/kumactl/pkg/install/k8s/control-plane/...
+	go generate ./app/kumactl/pkg/install/universal/control-plane/postgres/...
 
 fmt: fmt/go fmt/proto ## Dev: Run various format tools
 

app/kumactl/cmd/install/install.go

@@ -13,5 +13,6 @@ func NewInstallCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
 	}
 	// sub-commands
 	cmd.AddCommand(newInstallControlPlaneCmd(pctx))
+	cmd.AddCommand(newInstallDatabaseSchemaCmd())
 	return cmd
 }

app/kumactl/cmd/install/install_database_schema.go

@@ -0,0 +1,40 @@
+package install
+
+import (
+	"github.com/Kong/kuma/app/kumactl/pkg/install/data"
+	postgres_schema "github.com/Kong/kuma/app/kumactl/pkg/install/universal/control-plane/postgres"
+	kuma_cmd "github.com/Kong/kuma/pkg/cmd"
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+)
+
+func newInstallDatabaseSchemaCmd() *cobra.Command {
+	args := struct {
+		target string
+	}{}
+	cmd := &cobra.Command{
+		Use:   "database-schema",
+		Short: "Install Kuma schema on DB",
+		Long:  `Install Kuma schema on DB.`,
+		Example: `1. kumactl install database-schema --target=postgres | PGPASSWORD=mysecretpassword psql -h localhost -U postgres
+2. sql_file=$(mktemp) ; \ 
+kumactl install database-schema --target=postgres >$sql_file ; \
+psql --host=localhost --username=postgres --password --file=$sql_file ; \
+rm $sql_file`,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			switch args.target {
+			case "postgres":
+				file, err := data.ReadFile(postgres_schema.Schema, "resource.sql")
+				if err != nil {
+					return errors.Wrap(err, "could not read schema file")
+				}
+				_, err = cmd.OutOrStdout().Write(file)
+				return err
+			default:
+				return errors.Errorf("unknown target type: %s", args.target)
+			}
+		},
+	}
+	cmd.Flags().StringVar(&args.target, "target", "postgres", kuma_cmd.UsageOptions("Database type", "postgres"))
+	return cmd
+}

app/kumactl/cmd/install/install_database_schema_test.go

@@ -0,0 +1,30 @@
+package install_test
+
+import (
+	"bytes"
+	"github.com/Kong/kuma/app/kumactl/cmd"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"io/ioutil"
+	"path/filepath"
+)
+
+var _ = Describe("kumactl install database-schema", func() {
+	It("should give the schema postgres", func() {
+		// given
+		stdout := bytes.Buffer{}
+		rootCmd := cmd.DefaultRootCmd()
+		rootCmd.SetOut(&stdout)
+		rootCmd.SetArgs([]string{"install", "database-schema", "--target=postgres"})
+
+		expected, err := ioutil.ReadFile(filepath.Join("testdata", "postgres_schema.golden.sql"))
+		Expect(err).ToNot(HaveOccurred())
+
+		// when
+		err = rootCmd.Execute()
+
+		// then
+		Expect(err).ToNot(HaveOccurred())
+		Expect(string(stdout.Bytes())).To(Equal(string(expected)))
+	})
+})

app/kumactl/cmd/install/testdata/postgres_schema.golden.sql

@@ -0,0 +1,9 @@
+CREATE TABLE IF NOT EXISTS resources (
+    name        varchar(100) NOT NULL,
+    namespace   varchar(100) NOT NULL,
+    mesh        varchar(100) NOT NULL,
+    type        varchar(100) NOT NULL,
+    version     integer NOT NULL,
+    spec        text,
+    PRIMARY KEY (name, namespace, mesh, type)
+);

app/kumactl/data/install/universal/control-plane/postgres/resource.sql

@@ -0,0 +1,9 @@
+CREATE TABLE IF NOT EXISTS resources (
+    name        varchar(100) NOT NULL,
+    namespace   varchar(100) NOT NULL,
+    mesh        varchar(100) NOT NULL,
+    type        varchar(100) NOT NULL,
+    version     integer NOT NULL,
+    spec        text,
+    PRIMARY KEY (name, namespace, mesh, type)
+);

app/kumactl/pkg/install/data/files.go

@@ -39,3 +39,15 @@ func ReadFiles(fs http.FileSystem) ([]File, error) {
 	}
 	return files, nil
 }
+
+func ReadFile(fs http.FileSystem, file string) (File, error) {
+	f, err := fs.Open(file)
+	if err != nil {
+		return nil, err
+	}
+	b, err := ioutil.ReadAll(f)
+	if err != nil {
+		return nil, err
+	}
+	return b, nil
+}

app/kumactl/pkg/install/universal/control-plane/postgres/postgres_suite_test.go

@@ -0,0 +1,13 @@
+package postgres_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestControlPlane(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Postgres Suite")
+}

app/kumactl/pkg/install/universal/control-plane/postgres/schema.go

@@ -0,0 +1,11 @@
+package postgres
+
+//go:generate go run github.com/shurcooL/vfsgen/cmd/vfsgendev -source="github.com/Kong/kuma/app/kumactl/pkg/install/universal/control-plane/postgres".Schema
+
+import (
+	"path/filepath"
+)
+
+func SchemaDir(kumactlSrcDir string) string {
+	return filepath.Join(kumactlSrcDir, "data", "install", "universal", "control-plane", "postgres")
+}

app/kumactl/pkg/install/universal/control-plane/postgres/schema_dev.go

@@ -0,0 +1,19 @@
+// +build dev
+
+package postgres
+
+import (
+	"net/http"
+	"path/filepath"
+	"runtime"
+)
+
+var Schema http.FileSystem = http.Dir(SchemaDir(kumactlSrcDir()))
+
+func kumactlSrcDir() string {
+	_, thisFile, _, _ := runtime.Caller(1)
+
+	thisDir := filepath.Dir(thisFile)
+
+	return filepath.Join(thisDir, "..", "..", "..", "..", "..")
+}

app/kumactl/pkg/install/universal/control-plane/postgres/schema_vfsdata_test.go

@@ -0,0 +1,32 @@
+// +build !dev
+
+package postgres_test
+
+import (
+	"github.com/Kong/kuma/app/kumactl/pkg/install/universal/control-plane/postgres"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"io/ioutil"
+	"path/filepath"
+)
+
+var _ = Describe("Schema file", func() {
+
+	It("generated Go code must be in sync with the original schema file", func() {
+		// given compiled file
+		file, err := postgres.Schema.Open("resource.sql")
+		Expect(err).ToNot(HaveOccurred())
+		expectedContents, err := ioutil.ReadAll(file)
+		Expect(err).ToNot(HaveOccurred())
+
+		// and actual file
+		kumactlSrcDir := filepath.Join("..", "..", "..", "..", "..")
+		schemaDir := postgres.SchemaDir(kumactlSrcDir)
+		actualContents, err := ioutil.ReadFile(filepath.Join(schemaDir, "resource.sql"))
+
+		// then both files are identical
+		Expect(err).ToNot(HaveOccurred())
+		Expect(string(actualContents)).To(Equal(string(expectedContents)), "generated Go code is no longer in sync with the original schema file. To re-generate it, run `make generate/kumactl/install/control-plane`")
+	})
+
+})