Merge pull request #7988 from Lyndon-Li/data-mover-ms-new-exposer

New exposer for data mover ms

changelogs/unreleased/7955-Lyndon-Li

@@ -1 +1 @@
-New data path for data mover ms according to design #7574
+New data path for data mover ms according to design #7576

changelogs/unreleased/7988-Lyndon-Li

@@ -0,0 +1 @@
+New data path for data mover ms according to design #7576

pkg/cmd/cli/datamover/backup.go

@@ -0,0 +1,92 @@
+/*
+Copyright The Velero Contributors.
+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 datamover
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"github.com/vmware-tanzu/velero/pkg/buildinfo"
+	"github.com/vmware-tanzu/velero/pkg/client"
+	"github.com/vmware-tanzu/velero/pkg/util/logging"
+)
+
+type dataMoverBackupConfig struct {
+	volumePath      string
+	volumeMode      string
+	duName          string
+	resourceTimeout time.Duration
+}
+
+func NewBackupCommand(f client.Factory) *cobra.Command {
+	config := dataMoverBackupConfig{}
+
+	logLevelFlag := logging.LogLevelFlag(logrus.InfoLevel)
+	formatFlag := logging.NewFormatFlag()
+
+	command := &cobra.Command{
+		Use:    "backup",
+		Short:  "Run the velero data-mover backup",
+		Long:   "Run the velero data-mover backup",
+		Hidden: true,
+		Run: func(c *cobra.Command, args []string) {
+			logLevel := logLevelFlag.Parse()
+			logrus.Infof("Setting log-level to %s", strings.ToUpper(logLevel.String()))
+
+			logger := logging.DefaultLogger(logLevel, formatFlag.Parse())
+			logger.Infof("Starting Velero data-mover backup %s (%s)", buildinfo.Version, buildinfo.FormattedGitSHA())
+
+			f.SetBasename(fmt.Sprintf("%s-%s", c.Parent().Name(), c.Name()))
+			s := newdataMoverBackup(logger, config)
+
+			s.run()
+		},
+	}
+
+	command.Flags().Var(logLevelFlag, "log-level", fmt.Sprintf("The level at which to log. Valid values are %s.", strings.Join(logLevelFlag.AllowedValues(), ", ")))
+	command.Flags().Var(formatFlag, "log-format", fmt.Sprintf("The format for log output. Valid values are %s.", strings.Join(formatFlag.AllowedValues(), ", ")))
+	command.Flags().StringVar(&config.volumePath, "volume-path", config.volumePath, "The full path of the volume to be backed up")
+	command.Flags().StringVar(&config.volumeMode, "volume-mode", config.volumeMode, "The mode of the volume to be backed up")
+	command.Flags().StringVar(&config.duName, "data-upload", config.duName, "The data upload name")
+	command.Flags().DurationVar(&config.resourceTimeout, "resource-timeout", config.resourceTimeout, "How long to wait for resource processes which are not covered by other specific timeout parameters.")
+
+	_ = command.MarkFlagRequired("volume-path")
+	_ = command.MarkFlagRequired("volume-mode")
+	_ = command.MarkFlagRequired("data-upload")
+	_ = command.MarkFlagRequired("resource-timeout")
+
+	return command
+}
+
+type dataMoverBackup struct {
+	logger logrus.FieldLogger
+	config dataMoverBackupConfig
+}
+
+func newdataMoverBackup(logger logrus.FieldLogger, config dataMoverBackupConfig) *dataMoverBackup {
+	s := &dataMoverBackup{
+		logger: logger,
+		config: config,
+	}
+
+	return s
+}
+
+func (s *dataMoverBackup) run() {
+	time.Sleep(time.Duration(1<<63 - 1))
+}

pkg/cmd/cli/datamover/data_mover.go

@@ -0,0 +1,67 @@
+/*
+Copyright The Velero Contributors.
+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 datamover
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"github.com/vmware-tanzu/velero/pkg/client"
+)
+
+func NewCommand(f client.Factory) *cobra.Command {
+	command := &cobra.Command{
+		Use:    "data-mover",
+		Short:  "Run the velero data-mover",
+		Long:   "Run the velero data-mover",
+		Hidden: true,
+	}
+
+	command.AddCommand(
+		NewBackupCommand(f),
+		NewRestoreCommand(f),
+	)
+
+	return command
+}
+
+var funcExit = os.Exit
+var funcCreateFile = os.Create
+
+func exitWithMessage(logger logrus.FieldLogger, succeed bool, message string, a ...any) {
+	exitCode := 0
+	if !succeed {
+		exitCode = 1
+	}
+
+	toWrite := fmt.Sprintf(message, a...)
+
+	podFile, err := funcCreateFile("/dev/termination-log")
+	if err != nil {
+		logger.WithError(err).Error("Failed to create termination log file")
+		exitCode = 1
+	} else {
+		if _, err := podFile.WriteString(toWrite); err != nil {
+			logger.WithError(err).Error("Failed to write error to termination log file")
+			exitCode = 1
+		}
+
+		podFile.Close()
+	}
+
+	funcExit(exitCode)
+}

pkg/cmd/cli/datamover/data_mover_test.go

@@ -0,0 +1,131 @@
+/*
+Copyright The Velero Contributors.
+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 datamover
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	velerotest "github.com/vmware-tanzu/velero/pkg/test"
+)
+
+type exitWithMessageMock struct {
+	createErr error
+	writeFail bool
+	filePath  string
+	exitCode  int
+}
+
+func (em *exitWithMessageMock) Exit(code int) {
+	em.exitCode = code
+}
+
+func (em *exitWithMessageMock) CreateFile(name string) (*os.File, error) {
+	if em.createErr != nil {
+		return nil, em.createErr
+	}
+
+	if em.writeFail {
+		return os.OpenFile(em.filePath, os.O_CREATE|os.O_RDONLY, 0500)
+	} else {
+		return os.Create(em.filePath)
+	}
+}
+
+func TestExitWithMessage(t *testing.T) {
+	tests := []struct {
+		name             string
+		message          string
+		succeed          bool
+		args             []interface{}
+		createErr        error
+		writeFail        bool
+		expectedExitCode int
+		expectedMessage  string
+	}{
+		{
+			name:             "create pod file failed",
+			createErr:        errors.New("fake-create-file-error"),
+			succeed:          true,
+			expectedExitCode: 1,
+		},
+		{
+			name:             "write pod file failed",
+			writeFail:        true,
+			succeed:          true,
+			expectedExitCode: 1,
+		},
+		{
+			name:    "not succeed",
+			message: "fake-message-1, arg-1 %s, arg-2 %v, arg-3 %v",
+			args: []interface{}{
+				"arg-1-1",
+				10,
+				false,
+			},
+			expectedExitCode: 1,
+			expectedMessage:  fmt.Sprintf("fake-message-1, arg-1 %s, arg-2 %v, arg-3 %v", "arg-1-1", 10, false),
+		},
+		{
+			name:    "not succeed",
+			message: "fake-message-2, arg-1 %s, arg-2 %v, arg-3 %v",
+			args: []interface{}{
+				"arg-1-2",
+				20,
+				true,
+			},
+			succeed:         true,
+			expectedMessage: fmt.Sprintf("fake-message-2, arg-1 %s, arg-2 %v, arg-3 %v", "arg-1-2", 20, true),
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			podFile := filepath.Join(os.TempDir(), uuid.NewString())
+
+			em := exitWithMessageMock{
+				createErr: test.createErr,
+				writeFail: test.writeFail,
+				filePath:  podFile,
+			}
+
+			funcExit = em.Exit
+			funcCreateFile = em.CreateFile
+
+			exitWithMessage(velerotest.NewLogger(), test.succeed, test.message, test.args...)
+
+			assert.Equal(t, test.expectedExitCode, em.exitCode)
+
+			if test.createErr == nil && !test.writeFail {
+				reader, err := os.Open(podFile)
+				require.NoError(t, err)
+
+				message, err := io.ReadAll(reader)
+				require.NoError(t, err)
+
+				reader.Close()
+
+				assert.Equal(t, test.expectedMessage, string(message))
+			}
+		})
+	}
+}

pkg/cmd/cli/datamover/restore.go

@@ -0,0 +1,92 @@
+/*
+Copyright The Velero Contributors.
+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 datamover
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"github.com/vmware-tanzu/velero/pkg/buildinfo"
+	"github.com/vmware-tanzu/velero/pkg/client"
+	"github.com/vmware-tanzu/velero/pkg/util/logging"
+)
+
+type dataMoverRestoreConfig struct {
+	volumePath      string
+	volumeMode      string
+	ddName          string
+	resourceTimeout time.Duration
+}
+
+func NewRestoreCommand(f client.Factory) *cobra.Command {
+	logLevelFlag := logging.LogLevelFlag(logrus.InfoLevel)
+	formatFlag := logging.NewFormatFlag()
+
+	config := dataMoverRestoreConfig{}
+
+	command := &cobra.Command{
+		Use:    "restore",
+		Short:  "Run the velero data-mover restore",
+		Long:   "Run the velero data-mover restore",
+		Hidden: true,
+		Run: func(c *cobra.Command, args []string) {
+			logLevel := logLevelFlag.Parse()
+			logrus.Infof("Setting log-level to %s", strings.ToUpper(logLevel.String()))
+
+			logger := logging.DefaultLogger(logLevel, formatFlag.Parse())
+			logger.Infof("Starting Velero data-mover restore %s (%s)", buildinfo.Version, buildinfo.FormattedGitSHA())
+
+			f.SetBasename(fmt.Sprintf("%s-%s", c.Parent().Name(), c.Name()))
+			s := newdataMoverRestore(logger, config)
+
+			s.run()
+		},
+	}
+
+	command.Flags().Var(logLevelFlag, "log-level", fmt.Sprintf("The level at which to log. Valid values are %s.", strings.Join(logLevelFlag.AllowedValues(), ", ")))
+	command.Flags().Var(formatFlag, "log-format", fmt.Sprintf("The format for log output. Valid values are %s.", strings.Join(formatFlag.AllowedValues(), ", ")))
+	command.Flags().StringVar(&config.volumePath, "volume-path", config.volumePath, "The full path of the volume to be restored")
+	command.Flags().StringVar(&config.volumeMode, "volume-mode", config.volumeMode, "The mode of the volume to be restored")
+	command.Flags().StringVar(&config.ddName, "data-download", config.ddName, "The data download name")
+	command.Flags().DurationVar(&config.resourceTimeout, "resource-timeout", config.resourceTimeout, "How long to wait for resource processes which are not covered by other specific timeout parameters.")
+
+	_ = command.MarkFlagRequired("volume-path")
+	_ = command.MarkFlagRequired("volume-mode")
+	_ = command.MarkFlagRequired("data-download")
+	_ = command.MarkFlagRequired("resource-timeout")
+
+	return command
+}
+
+type dataMoverRestore struct {
+	logger logrus.FieldLogger
+	config dataMoverRestoreConfig
+}
+
+func newdataMoverRestore(logger logrus.FieldLogger, config dataMoverRestoreConfig) *dataMoverRestore {
+	s := &dataMoverRestore{
+		logger: logger,
+		config: config,
+	}
+
+	return s
+}
+
+func (s *dataMoverRestore) run() {
+	time.Sleep(time.Duration(1<<63 - 1))
+}