Merge branch '117-observe' into 'master'

feat: CI observer, PoC ("dblab clone observe", "dblab clone observe-summary")

See merge request postgres-ai/database-lab!91

Author: astansler

.gitlab-ci.yml

@@ -33,7 +33,7 @@ build-binary-generic:
   stage: build-binary
   only:
     refs:
-      - master
+      - branches
       - tags
   artifacts:
     paths:
@@ -100,6 +100,19 @@ build-image-feature-client:
   before_script:
     - cp ./bin/dblab-alpine ./bin/dblab
 
+build-image-feature-client-extended:
+  <<: *build_image_definition
+  <<: *only_feature
+  variables:
+    REGISTRY_USER: "${CI_REGISTRY_USER}"
+    REGISTRY_PASSWORD: "${CI_REGISTRY_PASSWORD}"
+    REGISTRY: "${CI_REGISTRY}"
+    DOCKER_FILE: "Dockerfile.dblab-extended"
+    DOCKER_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab-extended"
+    TAGS: "${DOCKER_NAME}:${CI_COMMIT_REF_SLUG}"
+  before_script:
+    - cp ./bin/dblab-linux-amd64 ./bin/dblab
+
 build-image-master-server:
   <<: *build_image_definition
   <<: *only_master

Dockerfile.dblab

@@ -1,6 +1,6 @@
 FROM docker:19
 
-# Install dependecies.
+# Install dependencies.
 RUN apk update && apk add --no-cache bash jq
 
 WORKDIR /home/dblab

Dockerfile.dblab-extended

@@ -0,0 +1,15 @@
+# Currently (at PoC stage), the only DB migration tool that is supported is sqitch.org
+# This "extended" image is supposed to have many other tools in the future (liqubase, flyway, etc.)
+FROM sqitch/sqitch:1.0.0
+
+USER root
+
+# Install dependencies.
+RUN apt-get update && apt-get -y install bash jq
+
+WORKDIR /home/dblab
+COPY ./bin/dblab ./bin/dblab
+RUN mv ./bin/dblab /usr/local/bin/dblab 2> /dev/null
+
+ENTRYPOINT []
+CMD ./bin/dblab

cmd/cli/commands/clone/actions.go

@@ -8,12 +8,18 @@ package clone
 import (
 	"encoding/json"
 	"fmt"
+	"os"
 
 	"github.com/urfave/cli/v2"
 
 	"gitlab.com/postgres-ai/database-lab/cmd/cli/commands"
 	"gitlab.com/postgres-ai/database-lab/pkg/client/dblabapi/types"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
+	"gitlab.com/postgres-ai/database-lab/pkg/observer"
+)
+
+const (
+	errorExitStatus = 1
 )
 
 // list runs a request to list clones of an instance.
@@ -190,3 +196,56 @@ func destroy() func(*cli.Context) error {
 		return err
 	}
 }
+
+// observe runs a request to observe clone.
+func observe() func(*cli.Context) error {
+	return func(cliCtx *cli.Context) error {
+		dblabClient, err := commands.ClientByCLIContext(cliCtx)
+		if err != nil {
+			return err
+		}
+
+		cloneID := cliCtx.Args().First()
+
+		clone, err := dblabClient.GetClone(cliCtx.Context, cloneID)
+		if err != nil {
+			return err
+		}
+
+		obsConfig := observer.Config{
+			Follow:                 cliCtx.Bool("follow"),
+			IntervalSeconds:        cliCtx.Uint64("interval-seconds"),
+			MaxLockDurationSeconds: cliCtx.Uint64("max-lock-duration-seconds"),
+			MaxDurationSeconds:     cliCtx.Uint64("max-duration-seconds"),
+			SSLMode:                cliCtx.String("sslmode"),
+		}
+
+		obs := observer.NewObserver(obsConfig, cliCtx.App.Writer)
+
+		clone.DB.Password = cliCtx.String("password")
+
+		return obs.Start(clone)
+	}
+}
+
+// observeSummary shows observing summary and check satisfaction of performance requirements.
+func observeSummary() func(*cli.Context) error {
+	return func(cliCtx *cli.Context) error {
+		obs := observer.NewObserver(observer.Config{}, cliCtx.App.Writer)
+
+		if err := obs.LoadObserverState(); err != nil {
+			return err
+		}
+
+		if err := obs.PrintSummary(); err != nil {
+			return err
+		}
+
+		if err := obs.CheckPerformanceRequirements(); err != nil {
+			// Exit with error status without printing additional error logs.
+			os.Exit(errorExitStatus)
+		}
+
+		return nil
+	}
+}

cmd/cli/commands/clone/command_list.go

@@ -109,6 +109,52 @@ func CommandList() []*cli.Command {
 					},
 				},
 			},
+			{
+				Name:      "observe",
+				Usage:     "[EXPERIMENTAL] monitor clone state",
+				ArgsUsage: "CLONE_ID",
+				Before:    checkCloneIDBefore,
+				Action:    observe(),
+				Flags: []cli.Flag{
+					&cli.StringFlag{
+						Name:     "password",
+						Usage:    "clone database password",
+						EnvVars:  []string{"CLONE_PASSWORD"},
+						Required: true,
+					},
+					&cli.StringFlag{
+						Name:    "sslmode",
+						Usage:   "connection SSL mode",
+						EnvVars: []string{"SSLMODE"},
+						Value:   "disable",
+					},
+					&cli.BoolFlag{
+						Name:    "follow",
+						Usage:   "follow state monitor output",
+						Aliases: []string{"f"},
+					},
+					&cli.IntFlag{
+						Name:    "interval-seconds",
+						Usage:   "interval of metric gathering and output",
+						EnvVars: []string{"DBLAB_INTERVAL_SECONDS"},
+					},
+					&cli.IntFlag{
+						Name:    "max-lock-duration-seconds",
+						Usage:   "maximum allowed duration for locks",
+						EnvVars: []string{"DBLAB_MAX_LOCK_DURATION_SECONDS"},
+					},
+					&cli.IntFlag{
+						Name:    "max-duration-seconds",
+						Usage:   "maximum allowed duration for operation",
+						EnvVars: []string{"DBLAB_MAX_DURATION_SECONDS"},
+					},
+				},
+			},
+			{
+				Name:   "observe-summary",
+				Usage:  "[EXPERIMENTAL] summarize clone monitoring and check results",
+				Action: observeSummary(),
+			},
 		},
 	}}
 }