Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add backup take and backup wait commands #201

Merged
merged 4 commits into from
Oct 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 140 additions & 0 deletions go-chaos/cmd/backup.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
// Copyright 2022 Camunda Services GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cmd

import (
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"strconv"
"time"

"github.com/spf13/cobra"
"github.com/zeebe-io/zeebe-chaos/go-chaos/internal"
)

var (
backupId string
)

func init() {
rootCmd.AddCommand(backupCommand)

backupCommand.AddCommand(takeBackupCommand)
takeBackupCommand.Flags().StringVar(&backupId, "backupId", strconv.FormatInt(time.Now().UnixMilli(), 10), "optionally specify the backup id to use, uses the current timestamp by default")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔧 Unless we plan to have commands without the flag, it could simply be on the general backupCommand, and the child commands will inherit it I think.

backupCommand.AddCommand(waitForBackupCommand)
waitForBackupCommand.Flags().StringVar(&backupId, "backupId", strconv.FormatInt(time.Now().UnixMilli(), 10), "optionally specify the backup id to use, uses the current timestamp by default")
}

var backupCommand = &cobra.Command{
Use: "backup",
Short: "Controls Zeebe backups",
Long: "Can be used to take backups and query their status",
}

var takeBackupCommand = &cobra.Command{
Use: "take",
Short: "Trigger a backup",
RunE: takeBackup,
}

var waitForBackupCommand = &cobra.Command{
Use: "wait",
Short: "Wait for a backup to complete or fail",
RunE: waitForBackup,
}

func takeBackup(cmd *cobra.Command, args []string) error {
k8Client, err := internal.CreateK8Client()
if err != nil {
panic(err)
}

port := 9600
closePortForward, err := k8Client.GatewayPortForward(port, port)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💭 I think almost everywhere we act the same (e.g. panic when we can't port forward). Wondering if it's useful to have it return an error at all, or if we should just have a function MustForwardGatewayPort which returns either a close function or explodes anyway.

if err != nil {
panic(err.Error())
}
defer closePortForward()
url := fmt.Sprintf("http://localhost:%d/actuator/backups/%s", port, backupId)
resp, err := http.Post(url, "", nil)
if err != nil {
return err
}
defer resp.Body.Close()
return err
}

func waitForBackup(cmd *cobra.Command, args []string) error {
k8Client, err := internal.CreateK8Client()
if err != nil {
panic(err)
}

port := 9600
closePortForward, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err.Error())
}
defer closePortForward()

for {
backup, err := getBackupStatus(port, backupId)
if err != nil {
time.Sleep(5 * time.Second)
continue
}

switch backup.Status {
case "COMPLETED":
return nil
case "FAILED":
return errors.New("backup failed")
case "DOES_NOT_EXIST":
return errors.New("backup does not exist")
}
time.Sleep(5 * time.Second)
}

}

func getBackupStatus(port int, backupId string) (*BackupStatus, error) {
url := fmt.Sprintf("http://localhost:%d/actuator/backups/%s", port, backupId)
resp, err := http.Get(url)
if err != nil {
return nil, err
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}

var backup BackupStatus
err = json.Unmarshal(body, &backup)
if err != nil {
return nil, err
}

fmt.Printf("Found backup %s with status: %s\n", backupId, backup.Status)

return &backup, nil
}

type BackupStatus struct {
Status string
}
2 changes: 1 addition & 1 deletion go-chaos/cmd/disconnect.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ var disconnectBrokers = &cobra.Command{
}

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err.Error())
}
Expand Down
2 changes: 1 addition & 1 deletion go-chaos/cmd/publish.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var publishCmd = &cobra.Command{
panicOnError(err)

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
panicOnError(err)
defer closeFn()

Expand Down
2 changes: 1 addition & 1 deletion go-chaos/cmd/restart.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ var restartCmd = &cobra.Command{
}

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err)
}
Expand Down
2 changes: 1 addition & 1 deletion go-chaos/cmd/terminate.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ var terminateCmd = &cobra.Command{
}

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err.Error())
}
Expand Down
2 changes: 1 addition & 1 deletion go-chaos/cmd/topology.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var topologyCmd = &cobra.Command{
}

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err)
}
Expand Down
2 changes: 1 addition & 1 deletion go-chaos/cmd/verify.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ A process model will be deployed and process instances are created until the req
}

port := 26500
closeFn, err := k8Client.GatewayPortForward(port)
closeFn, err := k8Client.GatewayPortForward(port, port)
if err != nil {
panic(err.Error())
}
Expand Down
8 changes: 4 additions & 4 deletions go-chaos/internal/pods.go
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ func (c K8Client) RestartPod(podName string) error {
// GatewayPortForward creates a port forwarding to a zeebe gateway with the given port
// https://github.com/gruntwork-io/terratest/blob/master/modules/k8s/tunnel.go#L187-L196
// https://github.com/kubernetes/client-go/issues/51#issuecomment-436200428
func (c K8Client) GatewayPortForward(port int) (func(), error) {
func (c K8Client) GatewayPortForward(localPort int, remotePort int) (func(), error) {
names, err := c.GetGatewayPodNames()
if err != nil {
return nil, err
Expand All @@ -213,7 +213,7 @@ func (c K8Client) GatewayPortForward(port int) (func(), error) {
}

portForwardCreateURL := c.createPortForwardUrl(names)
portForwarder, err := c.createPortForwarder(port, portForwardCreateURL)
portForwarder, err := c.createPortForwarder(localPort, remotePort, portForwardCreateURL)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -245,7 +245,7 @@ func (c K8Client) GatewayPortForward(port int) (func(), error) {
}

// Create the k8 port forwarder, with the given port and k8 client
func (c K8Client) createPortForwarder(port int, portForwardCreateURL *url.URL) (*portforward.PortForwarder, error) {
func (c K8Client) createPortForwarder(localPort int, remotePort int, portForwardCreateURL *url.URL) (*portforward.PortForwarder, error) {
// Construct the spdy client required by the client-go portforward library
config, err := c.ClientConfig.ClientConfig()
if err != nil {
Expand All @@ -264,7 +264,7 @@ func (c K8Client) createPortForwarder(port int, portForwardCreateURL *url.URL) (
// Construct a new PortForwarder struct that manages the instructed port forward tunnel
stopChan, readyChan := make(chan struct{}, 1), make(chan struct{}, 1)
out, errOut := new(bytes.Buffer), new(bytes.Buffer)
ports := []string{fmt.Sprintf("%d:%d", port, 26500)}
ports := []string{fmt.Sprintf("%d:%d", localPort, remotePort)}
portforwarder, err := portforward.New(dialer, ports, stopChan, readyChan, out, errOut)
if err != nil {
if Verbosity {
Expand Down