Add timeout method

Signed-off-by: Md. Ishtiaq Islam <[email protected]>

apis/constant.go

@@ -75,7 +75,10 @@ const (
 	KubeStashAppRefKind      = "kubestash.com/app-ref-kind"
 	KubeStashAppRefNamespace = "kubestash.com/app-ref-namespace"
 	KubeStashAppRefName      = "kubestash.com/app-ref-name"
-	KubeDBAppVersion         = "kubedb.com/db-version"
+)
+
+const (
+	AnnKubeDBAppVersion = "kubedb.com/db-version"
 )
 
 // Keys for structure logging

apis/core/v1alpha1/backupconfiguration_types.go

@@ -132,10 +132,10 @@ type SessionConfig struct {
 	// +optional
 	RetryConfig *RetryConfig `json:"retryConfig,omitempty"`
 
-	// Timeout specifies the maximum duration of backup. BackupSession will be considered Failed
+	// BackupTimeout specifies the maximum duration of backup. Backup will be considered Failed
 	// if backup does not complete within this time limit. By default, KubeStash don't set any timeout for backup.
 	// +optional
-	Timeout *metav1.Duration `json:"timeout,omitempty"`
+	BackupTimeout *metav1.Duration `json:"backupTimeout,omitempty"`
 
 	// SessionHistoryLimit specifies how many backup Jobs and associate resources KubeStash should keep for debugging purpose.
 	// The default value is 1.

apis/core/v1alpha1/backupsession_types.go

@@ -64,10 +64,10 @@ type BackupSessionSpec struct {
 	// +optional
 	RetryLeft int32 `json:"retryLeft,omitempty"`
 
-	// Timeout specifies the maximum duration of backup. Backup will be considered Failed
+	// BackupTimeout specifies the maximum duration of backup. Backup will be considered Failed
 	// if backup does not complete within this time limit. By default, KubeStash don't set any timeout for backup.
 	// +optional
-	Timeout *metav1.Duration `json:"timeout,omitempty"`
+	BackupTimeout *metav1.Duration `json:"timeout,omitempty"`
 }
 
 // BackupSessionStatus defines the observed state of BackupSession

apis/core/v1alpha1/restoresession_types.go

@@ -64,10 +64,10 @@ type RestoreSessionSpec struct {
 	// +optional
 	Hooks *RestoreHooks `json:"hooks,omitempty"`
 
-	// Timeout specifies a duration that KubeStash should wait for the restore to be completed.
+	// RestoreTimeout specifies a duration that KubeStash should wait for the restore to be completed.
 	// If the restore does not finish within this time period, KubeStash will consider this restore as a failure.
 	// +optional
-	Timeout *metav1.Duration `json:"timeout,omitempty"`
+	RestoreTimeout *metav1.Duration `json:"restoreTimeout,omitempty"`
 
 	// ManifestOptions provide options to select particular manifest object to restore
 	// +optional

apis/storage/v1alpha1/snapshot_helpers.go

@@ -18,6 +18,7 @@ package v1alpha1
 
 import (
 	"fmt"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"kmodules.xyz/client-go/apiextensions"
 	cutil "kmodules.xyz/client-go/conditions"
 	"kmodules.xyz/client-go/meta"
@@ -187,3 +188,15 @@ func (s *Snapshot) OffshootLabels() map[string]string {
 func (s *Snapshot) GetComponentPath(componentName string) string {
 	return filepath.Join(apis.DirRepository, s.Spec.Version, s.Spec.Session, componentName)
 }
+
+func (s *Snapshot) GetRemainingTimeoutDuration(timeout *metav1.Duration) (*metav1.Duration, error) {
+	if timeout == nil {
+		return nil, nil
+	}
+
+	diff := metav1.Now().Sub(s.GetCreationTimestamp().Time)
+	if diff < timeout.Duration {
+		return &metav1.Duration{Duration: timeout.Duration - diff}, nil
+	}
+	return nil, fmt.Errorf("deadline exceeded")
+}

crds/core.kubestash.com_backupbatches.yaml

@@ -110,6 +110,12 @@ spec:
                   description: BatchSession specifies the session configuration for
                     the targets.
                   properties:
+                    backupTimeout:
+                      description: BackupTimeout specifies the maximum duration of
+                        backup. Backup will be considered Failed if backup does not
+                        complete within this time limit. By default, KubeStash don't
+                        set any timeout for backup.
+                      type: string
                     hooks:
                       description: Hooks specifies the backup hooks that should be
                         executed before and/or after the backup.
@@ -36194,12 +36200,6 @@ spec:
                             type: array
                         type: object
                       type: array
-                    timeout:
-                      description: Timeout specifies the maximum duration of backup.
-                        BackupSession will be considered Failed if backup does not
-                        complete within this time limit. By default, KubeStash don't
-                        set any timeout for backup.
-                      type: string
                   type: object
                 type: array
               targets:

crds/core.kubestash.com_backupblueprints.yaml

@@ -15716,6 +15716,12 @@ spec:
                                 type: object
                               type: array
                           type: object
+                        backupTimeout:
+                          description: BackupTimeout specifies the maximum duration
+                            of backup. Backup will be considered Failed if backup
+                            does not complete within this time limit. By default,
+                            KubeStash don't set any timeout for backup.
+                          type: string
                         hooks:
                           description: Hooks specifies the backup hooks that should
                             be executed before and/or after the backup.
@@ -37239,12 +37245,6 @@ spec:
                             debugging purpose. The default value is 1.
                           format: int32
                           type: integer
-                        timeout:
-                          description: Timeout specifies the maximum duration of backup.
-                            BackupSession will be considered Failed if backup does
-                            not complete within this time limit. By default, KubeStash
-                            don't set any timeout for backup.
-                          type: string
                       type: object
                     type: array
                 type: object

crds/core.kubestash.com_backupconfigurations.yaml

@@ -14554,6 +14554,12 @@ spec:
                             type: object
                           type: array
                       type: object
+                    backupTimeout:
+                      description: BackupTimeout specifies the maximum duration of
+                        backup. Backup will be considered Failed if backup does not
+                        complete within this time limit. By default, KubeStash don't
+                        set any timeout for backup.
+                      type: string
                     hooks:
                       description: Hooks specifies the backup hooks that should be
                         executed before and/or after the backup.
@@ -34373,12 +34379,6 @@ spec:
                         purpose. The default value is 1.
                       format: int32
                       type: integer
-                    timeout:
-                      description: Timeout specifies the maximum duration of backup.
-                        BackupSession will be considered Failed if backup does not
-                        complete within this time limit. By default, KubeStash don't
-                        set any timeout for backup.
-                      type: string
                   type: object
                 type: array
               target:

crds/core.kubestash.com_backupsessions.yaml

@@ -88,9 +88,10 @@ spec:
                   this backup
                 type: string
               timeout:
-                description: Timeout specifies the maximum duration of backup. Backup
-                  will be considered Failed if backup does not complete within this
-                  time limit. By default, KubeStash don't set any timeout for backup.
+                description: BackupTimeout specifies the maximum duration of backup.
+                  Backup will be considered Failed if backup does not complete within
+                  this time limit. By default, KubeStash don't set any timeout for
+                  backup.
                 type: string
             type: object
           status:

crds/core.kubestash.com_restoresessions.yaml

@@ -24312,6 +24312,12 @@ spec:
                       restored files will be applied
                     type: string
                 type: object
+              restoreTimeout:
+                description: RestoreTimeout specifies a duration that KubeStash should
+                  wait for the restore to be completed. If the restore does not finish
+                  within this time period, KubeStash will consider this restore as
+                  a failure.
+                type: string
               target:
                 description: Target indicates the target application where the data
                   will be restored. The target must be in the same namespace as the
@@ -24330,12 +24336,6 @@ spec:
                 required:
                 - name
                 type: object
-              timeout:
-                description: Timeout specifies a duration that KubeStash should wait
-                  for the restore to be completed. If the restore does not finish
-                  within this time period, KubeStash will consider this restore as
-                  a failure.
-                type: string
             type: object
           status:
             description: RestoreSessionStatus defines the observed state of RestoreSession

pkg/restic/restic_test.go

@@ -35,6 +35,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"testing"
+	"time"
 )
 
 var (
@@ -462,6 +463,38 @@ func TestBackupRestoreWithArgs(t *testing.T) {
 	}
 }
 
+func TestBackupWithTimeout(t *testing.T) {
+	tempDir, err := os.MkdirTemp("", "stash-unit-test-")
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	w, err := setupTest(tempDir)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+	defer cleanup(tempDir)
+
+	// Initialize Repository
+	err = w.InitializeRepository()
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	duration := metav1.Duration{Duration: 10 * time.Millisecond}
+	w.config.Timeout = &duration
+
+	backupOpt := BackupOptions{
+		StdinPipeCommands: []Command{stdinPipeCommand},
+		StdinFileName:     fileName,
+	}
+	_, err = w.RunBackup(backupOpt)
+	assert.Error(t, err, "Timeout error")
+}
+
 func TestVerifyRepositoryIntegrity(t *testing.T) {
 	tempDir, err := os.MkdirTemp("", "stash-unit-test-")
 	if err != nil {