S3 (#3)

dump file to a S3 bucket.

dump/dump.go

@@ -0,0 +1,112 @@
+package dump
+
+import (
+	"bytes"
+	"compress/gzip"
+	"errors"
+	"fmt"
+	"log"
+	"os"
+	"os/exec"
+	"strings"
+	"time"
+
+	"github.com/liweiyi88/onedump/storage"
+	"golang.org/x/crypto/ssh"
+)
+
+// The core function that dump db content to a file (locally or remotely).
+// It checks the filename to determine if we need to upload the file to remote storage or keep it locally.
+// For uploading file to S3 bucket, the filename shold follow the pattern: s3://<bucket_name>/<key> .
+// For any remote upload, we try to cache it in a local dir then upload it to the remote storage.
+func dump(runner any, dumpFile string, shouldGzip bool, command string) error {
+	dumpFilename := ensureFileSuffix(dumpFile, shouldGzip)
+	store, err := storage.CreateStorage(dumpFilename)
+	if err != nil {
+		return fmt.Errorf("failed to create storage: %w", err)
+	}
+
+	file, err := store.CreateDumpFile()
+	if err != nil {
+		return fmt.Errorf("failed to create storage dump file: %w", err)
+	}
+
+	var gzipWriter *gzip.Writer
+	if shouldGzip {
+		gzipWriter = gzip.NewWriter(file)
+	}
+
+	defer func() {
+		if gzipWriter != nil {
+			gzipWriter.Close()
+		}
+
+		file.Close()
+	}()
+
+	switch runner := runner.(type) {
+	case *exec.Cmd:
+		runner.Stderr = os.Stderr
+		if gzipWriter != nil {
+			runner.Stdout = gzipWriter
+		} else {
+			runner.Stdout = file
+		}
+
+		if err := runner.Run(); err != nil {
+			return fmt.Errorf("remote command error: %v", err)
+		}
+	case *ssh.Session:
+		var remoteErr bytes.Buffer
+		runner.Stderr = &remoteErr
+		if gzipWriter != nil {
+			runner.Stdout = gzipWriter
+		} else {
+			runner.Stdout = file
+		}
+
+		if err := runner.Run(command); err != nil {
+			return fmt.Errorf("remote command error: %s, %v", remoteErr.String(), err)
+		}
+	default:
+		return errors.New("unsupport runner type")
+	}
+
+	cloudStore, ok := store.(storage.CloudStorage)
+
+	if ok {
+		err := cloudStore.Upload()
+		if err != nil {
+			return fmt.Errorf("failed to upload file to cloud storage: %w", err)
+		}
+
+		log.Printf("successfully upload dump file to %s", cloudStore.CloudFilePath())
+	} else {
+		log.Printf("successfully dump file to %s", file.Name())
+	}
+
+	return nil
+}
+
+// Ensure a file has proper file extension.
+func ensureFileSuffix(filename string, shouldGzip bool) string {
+	if !shouldGzip {
+		return filename
+	}
+
+	if strings.HasSuffix(filename, ".gz") {
+		return filename
+	}
+
+	return filename + ".gz"
+}
+
+// Performanece debug function.
+func trace(name string) func() {
+	start := time.Now()
+
+	return func() {
+		elapsed := time.Since(start)
+		log.Printf("%s took %s", name, elapsed)
+	}
+}

dump/mysqldumper.go

@@ -9,15 +9,8 @@ import (
 	"strings"
 
 	"github.com/go-sql-driver/mysql"
-	"golang.org/x/crypto/ssh"
 )
 
-type Executor interface {
-	*exec.Cmd | *ssh.Session
-	Run() error
-	Close() error
-}
-
 const CredentialFilePrefix = "mysqldumpcred-"
 
 type Mysql struct {
@@ -131,34 +124,10 @@ func (mysql *Mysql) Dump(dumpFile string, shouldGzip bool) error {
 
 	cmd := exec.Command(mysqldumpBinaryPath, args...)
 
-	file, gzipWriter, err := dumpWriters(dumpFile, shouldGzip)
-
-	if err != nil {
-		return fmt.Errorf("failed to get dump writers %w", err)
-	}
-
-	if shouldGzip {
-		cmd.Stdout = gzipWriter
-	} else {
-		cmd.Stdout = file
-	}
-
-	// by assigning os.Stderr to cmd.Stderr, if it fails to run the command, os.Stderr will also output the error details.
-	cmd.Stderr = os.Stderr
-	err = cmd.Run()
-
+	dump(cmd, dumpFile, shouldGzip, "")
 	if err != nil {
-		return fmt.Errorf("failed to run dump command %w", err)
+		return err
 	}
 
-	// If it is gzip, we should firstly close the gzipWriter then close the file.
-	if gzipWriter != nil {
-		gzipWriter.Close()
-	}
-
-	file.Close()
-
-	fmt.Println("db dump succeed, dump file: ", file.Name())
-
 	return nil
 }

dump/sshdumper.go

@@ -1,9 +1,7 @@
 package dump
 
 import (
-	"bytes"
 	"fmt"
-	"log"
 	"net"
 	"os"
 
@@ -47,45 +45,23 @@ func (sshDumper *SshDumper) Dump(dumpFile, command string, shouldGzip bool) erro
 
 	client, err := ssh.Dial("tcp", host, conf)
 	if err != nil {
-		return fmt.Errorf("failed to dial remote server via ssh %w", err)
+		return fmt.Errorf("failed to dial remote server via ssh: %w", err)
 	}
 
 	defer client.Close()
 
 	session, err := client.NewSession()
 	if err != nil {
-		log.Fatalln("failed to start session: ", err)
+		return fmt.Errorf("failed to start ssh session: %w", err)
 	}
 
 	defer session.Close()
 
-	file, gzipWriter, err := dumpWriters(dumpFile, shouldGzip)
+	err = dump(session, dumpFile, shouldGzip, command)
 	if err != nil {
-		return fmt.Errorf("failed to get dump writers %w", err)
+		return err
 	}
 
-	if shouldGzip {
-		session.Stdout = gzipWriter
-	} else {
-		session.Stdout = file
-	}
-
-	var remoteErr bytes.Buffer
-	session.Stderr = &remoteErr
-
-	if err := session.Run(command); err != nil {
-		return fmt.Errorf("remote command error: %s, %v", remoteErr.String(), err)
-	}
-
-	// If it is gzip, we should firstly close the gzipWriter then close the file.
-	if gzipWriter != nil {
-		gzipWriter.Close()
-	}
-
-	file.Close()
-
-	log.Printf("file has been successfully dumped to %s", file.Name())
-
 	return nil
 }
 

go.mod

@@ -3,12 +3,16 @@ module github.com/liweiyi88/onedump
 go 1.19
 
 require (
+	github.com/aws/aws-sdk-go v1.44.151
 	github.com/go-sql-driver/mysql v1.6.0
 	github.com/spf13/cobra v1.5.0
 	golang.org/x/exp v0.0.0-20220921164117-439092de6870
 )
 
-require golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
+require (
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
+	golang.org/x/sys v0.1.0 // indirect
+)
 
 require (
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect

go.sum

@@ -1,20 +1,62 @@
+github.com/aws/aws-sdk-go v1.44.151 h1:2FrJZm3kTcyTtfpE7LEQT9XW+jkoi4KEvBhFWqHEZmo=
+github.com/aws/aws-sdk-go v1.44.151/go.mod h1:aVsgQcEevwlmQ7qHE9I3h+dtQgpqhFB+i8Phjh7fkwI=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE=
 github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc=
 github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
+github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
+github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
+github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
 github.com/spf13/cobra v1.5.0/go.mod h1:dWXEIy2H428czQCjInthrTRUg7yKbok+2Qi/yBIJoUM=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20221005025214-4161e89ecf1b h1:huxqepDufQpLLIRXiVkTvnxrzJlpwmIWAObmcCcUFr0=
 golang.org/x/crypto v0.0.0-20221005025214-4161e89ecf1b/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp v0.0.0-20220921164117-439092de6870 h1:j8b6j9gzSigH28O5SjSpQSSh9lFd6f5D/q0aHjNTulc=
 golang.org/x/exp v0.0.0-20220921164117-439092de6870/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
-golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.1.0 h1:hZ/3BUoy5aId7sCpA/Tc5lt8DkFgdVS2onTpJsZ/fl0=
+golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=
+golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
+golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.1.0 h1:g6Z6vPFA9dYBAF7DWcH6sCcOntplXsDKcliusYijMlw=
+golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.4.0 h1:BrVqGRd7+k1DiOgtnFvAkoQEWQvBc25ouMJM6429SFg=
+golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

storage/local.go

@@ -0,0 +1,19 @@
+package storage
+
+import (
+	"fmt"
+	"os"
+)
+
+type LocalStorage struct {
+	Filename string
+}
+
+func (local *LocalStorage) CreateDumpFile() (*os.File, error) {
+	file, err := os.Create(local.Filename)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create dump file")
+	}
+
+	return file, err
+}