feat(mysqldatabase): add commands

Author: 9marco

create/create.go

@@ -28,6 +28,7 @@ type Cmd struct {
 	Config              configCmd            `cmd:"" group:"deplo.io" name:"config"  help:"Create a new deplo.io Project Configuration."`
 	Application         applicationCmd       `cmd:"" group:"deplo.io" name:"application" aliases:"app,application" help:"Create a new deplo.io Application."`
 	MySQL               mySQLCmd             `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Create a new MySQL instance."`
+	MySQLDatabase       mysqlDatabaseCmd     `cmd:"" group:"storage.nine.ch" name:"mysqldatabase" help:"Create a new MySQL database."`
 	Postgres            postgresCmd          `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Create a new PostgreSQL instance."`
 	PostgresDatabase    postgresDatabaseCmd  `cmd:"" group:"storage.nine.ch" name:"postgresdatabase" help:"Create a new PostgreSQL database."`
 	KeyValueStore       keyValueStoreCmd     `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Create a new KeyValueStore instance"`

create/mysqldatabase.go

@@ -0,0 +1,94 @@
+package create
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/watch"
+
+	"github.com/alecthomas/kong"
+	runtimev1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
+	meta "github.com/ninech/apis/meta/v1alpha1"
+	storage "github.com/ninech/apis/storage/v1alpha1"
+
+	"github.com/ninech/nctl/api"
+)
+
+type mysqlDatabaseCmd struct {
+	resourceCmd
+	Location             string               `placeholder:"${mysqldatabase_location_default}" help:"Location where the MySQL database is created. Available locations are: ${mysqldatabase_location_options}"`
+	MySQLDatabaseVersion storage.MySQLVersion `placeholder:"${mysqldatabase_version_default}" help:"Release version with which the MySQL database is created. Available versions: ${mysqldatabase_versions}"`
+	CharacterSet         string               `placeholder:"${mysqldatabase_characterset_default}" help:"Character set for the MySQL database. Available character sets: ${mysqldatabase_characterset_options}"`
+}
+
+func (cmd *mysqlDatabaseCmd) Run(ctx context.Context, client *api.Client) error {
+	fmt.Printf("Creating new MySQLDatabase. (waiting up to %s).\n", cmd.WaitTimeout)
+	mysqlDatabase := cmd.newMySQLDatabase(client.Project)
+
+	c := newCreator(client, mysqlDatabase, "mysqldatabase")
+	ctx, cancel := context.WithTimeout(ctx, cmd.WaitTimeout)
+	defer cancel()
+
+	if err := c.createResource(ctx); err != nil {
+		return err
+	}
+
+	if !cmd.Wait {
+		return nil
+	}
+
+	return c.wait(ctx, waitStage{
+		objectList: &storage.MySQLDatabaseList{},
+		onResult: func(event watch.Event) (bool, error) {
+			if mdb, ok := event.Object.(*storage.MySQLDatabase); ok {
+				return isAvailable(mdb), nil
+			}
+			return false, nil
+		},
+	},
+	)
+}
+
+func (cmd *mysqlDatabaseCmd) newMySQLDatabase(namespace string) *storage.MySQLDatabase {
+	name := getName(cmd.Name)
+
+	mysqlDatabase := &storage.MySQLDatabase{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      name,
+			Namespace: namespace,
+		},
+		Spec: storage.MySQLDatabaseSpec{
+			ResourceSpec: runtimev1.ResourceSpec{
+				WriteConnectionSecretToReference: &runtimev1.SecretReference{
+					Name:      "mysqldatabase-" + name,
+					Namespace: namespace,
+				},
+			},
+			ForProvider: storage.MySQLDatabaseParameters{
+				Location: meta.LocationName(cmd.Location),
+				Version:  cmd.MySQLDatabaseVersion,
+				CharacterSet: storage.MySQLCharacterSet{
+					Name: cmd.CharacterSet,
+				},
+			},
+		},
+	}
+
+	return mysqlDatabase
+}
+
+// MySQLDatabaseKongVars returns all variables which are used in the MySQLDatabase
+// create command
+func MySQLDatabaseKongVars() kong.Vars {
+	result := make(kong.Vars)
+	result["mysqldatabase_location_default"] = string(storage.MySQLDatabaseLocationDefault)
+	result["mysqldatabase_location_options"] = strings.Join(stringSlice(storage.MySQLDatabaseLocationOptions), ", ")
+	result["mysqldatabase_version_default"] = string(storage.MySQLDatabaseVersionDefault)
+	result["mysqldatabase_versions"] = strings.Join(stringSlice(storage.MySQLDatabaseVersions), ", ")
+	result["mysqldatabase_characterset_default"] = "utf8mb4"
+	result["mysqldatabase_characterset_options"] = strings.Join([]string{"utf8mb4"}, ", ")
+
+	return result
+}

create/mysqldatabase_test.go

@@ -0,0 +1,78 @@
+package create
+
+import (
+	"context"
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/google/go-cmp/cmp"
+	storage "github.com/ninech/apis/storage/v1alpha1"
+	"github.com/ninech/nctl/api"
+	"github.com/ninech/nctl/internal/test"
+	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
+)
+
+func TestMySQLDatabase(t *testing.T) {
+	ctx := context.Background()
+
+	tests := []struct {
+		name             string
+		create           mysqlDatabaseCmd
+		want             storage.MySQLDatabaseParameters
+		wantErr          bool
+		interceptorFuncs *interceptor.Funcs
+	}{
+		{
+			name:   "simple",
+			create: mysqlDatabaseCmd{},
+			want:   storage.MySQLDatabaseParameters{},
+		},
+		{
+			name:    "simpleErrorOnCreation",
+			create:  mysqlDatabaseCmd{},
+			wantErr: true,
+			interceptorFuncs: &interceptor.Funcs{
+				Create: func(_ context.Context, _ client.WithWatch, _ client.Object, _ ...client.CreateOption) error {
+					return errors.New("error on creation")
+				},
+			},
+		},
+		{
+			name:   "version and character set",
+			create: mysqlDatabaseCmd{MySQLDatabaseVersion: storage.MySQLDatabaseVersionDefault, CharacterSet: "ascii"},
+			want:   storage.MySQLDatabaseParameters{Version: storage.MySQLDatabaseVersionDefault, CharacterSet: storage.MySQLCharacterSet{Name: "ascii"}},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.create.Name = "test-" + t.Name()
+			tt.create.Wait = false
+			tt.create.WaitTimeout = time.Second
+
+			opts := []test.ClientSetupOption{}
+			if tt.interceptorFuncs != nil {
+				opts = append(opts, test.WithInterceptorFuncs(*tt.interceptorFuncs))
+			}
+			apiClient, err := test.SetupClient(opts...)
+			require.NoError(t, err)
+
+			if err := tt.create.Run(ctx, apiClient); (err != nil) != tt.wantErr {
+				t.Errorf("mysqlDatabaseCmd.Run() error = %v, wantErr %v", err, tt.wantErr)
+			}
+
+			created := &storage.MySQLDatabase{ObjectMeta: metav1.ObjectMeta{Name: tt.create.Name, Namespace: apiClient.Project}}
+			if err := apiClient.Get(ctx, api.ObjectName(created), created); (err != nil) != tt.wantErr {
+				t.Fatalf("expected mysqldatabase to exist, got: %s", err)
+			}
+			if tt.wantErr {
+				return
+			}
+
+			require.True(t, cmp.Equal(tt.want, created.Spec.ForProvider))
+		})
+	}
+}

delete/delete.go

@@ -20,6 +20,7 @@ type Cmd struct {
 	Config              configCmd            `cmd:"" group:"deplo.io" name:"config" help:"Delete a deplo.io Project Configuration."`
 	Application         applicationCmd       `cmd:"" group:"deplo.io" name:"application" aliases:"app,application" help:"Delete a deplo.io Application."`
 	MySQL               mySQLCmd             `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Delete a MySQL instance."`
+	MySQLDatabase       mysqlDatabaseCmd     `cmd:"" group:"storage.nine.ch" name:"mysqldatabase" help:"Delete a MySQL database."`
 	Postgres            postgresCmd          `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Delete a PostgreSQL instance."`
 	PostgresDatabase    postgresDatabaseCmd  `cmd:"" group:"storage.nine.ch" name:"postgresdatabase" help:"Delete a PostgreSQL database."`
 	KeyValueStore       keyValueStoreCmd     `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Delete a KeyValueStore instance."`

delete/mysqldatabase.go

@@ -0,0 +1,21 @@
+package delete
+
+import (
+	"context"
+
+	storage "github.com/ninech/apis/storage/v1alpha1"
+	"github.com/ninech/nctl/api"
+)
+
+type mysqlDatabaseCmd struct {
+	resourceCmd
+}
+
+func (cmd *mysqlDatabaseCmd) Run(ctx context.Context, client *api.Client) error {
+	mysqlDatabase := &storage.MySQLDatabase{}
+	mysqlDatabase.SetName(cmd.Name)
+	mysqlDatabase.SetNamespace(client.Project)
+
+	return newDeleter(mysqlDatabase, storage.MySQLDatabaseKind).
+		deleteResource(ctx, client, cmd.WaitTimeout, cmd.Wait, cmd.Force)
+}

delete/mysqldatabase_test.go

@@ -0,0 +1,46 @@
+package delete
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/ninech/nctl/api"
+	"github.com/ninech/nctl/internal/test"
+	"github.com/stretchr/testify/require"
+	"k8s.io/apimachinery/pkg/api/errors"
+)
+
+func TestMySQLDatabase(t *testing.T) {
+	ctx := context.Background()
+	cmd := mysqlDatabaseCmd{
+		resourceCmd: resourceCmd{
+			Name:        "test",
+			Force:       true,
+			Wait:        false,
+			WaitTimeout: time.Second,
+		},
+	}
+
+	mysqlDatabase := test.MySQLDatabase("test", test.DefaultProject, "nine-es34")
+
+	apiClient, err := test.SetupClient()
+	require.NoError(t, err)
+
+	if err := apiClient.Create(ctx, mysqlDatabase); err != nil {
+		t.Fatalf("mysqldatabase create error, got: %s", err)
+	}
+	if err := apiClient.Get(ctx, api.ObjectName(mysqlDatabase), mysqlDatabase); err != nil {
+		t.Fatalf("expected mysqldatabase to exist, got: %s", err)
+	}
+	if err := cmd.Run(ctx, apiClient); err != nil {
+		t.Fatal(err)
+	}
+	err = apiClient.Get(ctx, api.ObjectName(mysqlDatabase), mysqlDatabase)
+	if err == nil {
+		t.Fatalf("expected mysqldatabase to be deleted, but exists")
+	}
+	if !errors.IsNotFound(err) {
+		t.Fatalf("expected mysqldatabase to be deleted, got: %s", err.Error())
+	}
+}

get/get.go

@@ -24,6 +24,7 @@ type Cmd struct {
 	Releases            releasesCmd           `cmd:"" group:"deplo.io" name:"releases" aliases:"release" help:"Get deplo.io Releases."`
 	Configs             configsCmd            `cmd:"" group:"deplo.io" name:"configs" aliases:"config" help:"Get deplo.io Project Configuration."`
 	MySQL               mySQLCmd              `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Get MySQL instances."`
+	MySQLDatabase       mysqlDatabaseCmd      `cmd:"" group:"storage.nine.ch" name:"mysqldatabase" help:"Get MySQL databases."`
 	Postgres            postgresCmd           `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Get PostgreSQL instances."`
 	PostgresDatabase    postgresDatabaseCmd   `cmd:"" group:"storage.nine.ch" name:"postgresdatabase" help:"Get PostgreSQL databases."`
 	KeyValueStore       keyValueStoreCmd      `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Get KeyValueStore instances."`

get/mysqldatabase.go

@@ -0,0 +1,90 @@
+package get
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/crossplane/crossplane-runtime/pkg/resource"
+	storage "github.com/ninech/apis/storage/v1alpha1"
+	"github.com/ninech/nctl/api"
+)
+
+type mysqlDatabaseCmd struct {
+	databaseCmd
+	PrintCharacterSet bool `help:"Print the character set of the MySQL database. Requires name to be set." xor:"print"`
+}
+
+func (cmd *mysqlDatabaseCmd) Run(ctx context.Context, client *api.Client, get *Cmd) error {
+	databaseList := &storage.MySQLDatabaseList{}
+	databaseResources := make([]resource.Managed, 0)
+
+	if err := get.list(ctx, client, databaseList, api.MatchName(cmd.Name)); err != nil {
+		return err
+	}
+
+	for i := range databaseList.Items {
+		databaseResources = append(databaseResources, &databaseList.Items[i])
+	}
+
+	if cmd.Name != "" && cmd.PrintCharacterSet {
+		return cmd.printMySQLCharacterSet(databaseResources[0].(*storage.MySQLDatabase))
+	}
+
+	return cmd.runDatabaseCmd(ctx, client, get,
+		databaseList, databaseResources, storage.MySQLDatabaseKind,
+		func(ctx context.Context, client *api.Client, mg resource.Managed) error {
+			return cmd.printConnectionString(ctx, client, mg.(*storage.MySQLDatabase))
+		},
+		func(res []resource.Managed, get *Cmd, header bool) error {
+			dbs := make([]storage.MySQLDatabase, len(res))
+			for i, r := range res {
+				dbs[i] = *r.(*storage.MySQLDatabase)
+			}
+
+			return cmd.printMySQLDatabases(dbs, get, header)
+		},
+	)
+}
+
+func (cmd *mysqlDatabaseCmd) printMySQLDatabases(list []storage.MySQLDatabase, get *Cmd, header bool) error {
+	databases := make([]Database, len(list))
+	for i, db := range list {
+		databases[i] = Database{
+			Namespace:   db.Namespace,
+			Name:        db.Name,
+			FQDN:        db.Status.AtProvider.FQDN,
+			Location:    string(db.Spec.ForProvider.Location),
+			Size:        db.Status.AtProvider.Size.String(),
+			Connections: fmt.Sprintf("%d", db.Status.AtProvider.Connections),
+		}
+	}
+
+	return printDatabases(cmd.out, get, databases, header)
+}
+
+// printConnectionString according to the MySQL documentation:
+// https://dev.mysql.com/doc/refman/8.4/en/connecting-using-uri-or-key-value-pairs.html#connecting-using-uri
+func (cmd *mysqlDatabaseCmd) printConnectionString(ctx context.Context, client *api.Client, mdb *storage.MySQLDatabase) error {
+	secrets, err := getConnectionSecretMap(ctx, client, mdb)
+	if err != nil {
+		return err
+	}
+
+	for db, pw := range secrets {
+		fmt.Fprintf(cmd.out, "mysql://%s:%s@%s/%s",
+			db,
+			pw,
+			mdb.Status.AtProvider.FQDN,
+			db,
+		)
+		break
+	}
+
+	return nil
+}
+
+func (cmd *mysqlDatabaseCmd) printMySQLCharacterSet(mdb *storage.MySQLDatabase) error {
+	fmt.Fprintln(defaultOut(cmd.out), mdb.Spec.ForProvider.CharacterSet.Name)
+
+	return nil
+}