add UT

Signed-off-by: Lyndon-Li <lyonghui@vmware.com>

changelogs/unreleased/5142-lyndon

@@ -0,0 +1,4 @@
+Kopia Integration: Add the Unified Repository Interface definition.
+Kopia Integration: Add the changes for Unified Repository storage config.
+
+Related Issues; #5076, #5080

pkg/controller/restic_repository_controller.go

@@ -31,7 +31,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
-	"github.com/vmware-tanzu/velero/pkg/repository/repoconfig"
+	repoconfig "github.com/vmware-tanzu/velero/pkg/repository/config"
 	"github.com/vmware-tanzu/velero/pkg/restic"
 	"github.com/vmware-tanzu/velero/pkg/util/kube"
 )

pkg/repository/repoconfig/aws.go → pkg/repository/config/aws.go

@@ -17,10 +17,14 @@ limitations under the License.
 package repoconfig
 
 import (
-	"errors"
+	"context"
 	"os"
 
 	"github.com/aws/aws-sdk-go/aws/credentials"
+	"github.com/aws/aws-sdk-go/aws/endpoints"
+	"github.com/aws/aws-sdk-go/aws/session"
+	"github.com/aws/aws-sdk-go/service/s3/s3manager"
+	"github.com/pkg/errors"
 )
 
 const (
@@ -67,3 +71,29 @@ func GetS3Credentials(config map[string]string) (credentials.Value, error) {
 
 	return credValue, nil
 }
+
+// GetAWSBucketRegion returns the AWS region that a bucket is in, or an error
+// if the region cannot be determined.
+func GetAWSBucketRegion(bucket string) (string, error) {
+	var region string
+
+	sess, err := session.NewSession()
+	if err != nil {
+		return "", errors.WithStack(err)
+	}
+
+	for _, partition := range endpoints.DefaultPartitions() {
+		for regionHint := range partition.Regions() {
+			region, _ = s3manager.GetBucketRegion(context.Background(), sess, bucket, regionHint)
+
+			// we only need to try a single region hint per partition, so break after the first
+			break
+		}
+
+		if region != "" {
+			return region, nil
+		}
+	}
+
+	return "", errors.New("unable to determine bucket's region")
+}

pkg/repository/repoconfig/config.go → pkg/repository/config/config.go

@@ -17,14 +17,10 @@ limitations under the License.
 package repoconfig
 
 import (
-	"context"
 	"fmt"
 	"path"
 	"strings"
 
-	"github.com/aws/aws-sdk-go/aws/endpoints"
-	"github.com/aws/aws-sdk-go/aws/session"
-	"github.com/aws/aws-sdk-go/service/s3/s3manager"
 	"github.com/pkg/errors"
 
 	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
@@ -78,7 +74,7 @@ func getRepoPrefix(location *velerov1api.BackupStorageLocation) (string, error)
 			var err error
 			region := location.Spec.Config["region"]
 			if region == "" {
-				region, err = GetAWSBucketRegion(bucket)
+				region, err = getAWSBucketRegion(bucket)
 			}
 			if err != nil {
 				return "", errors.Wrapf(err, "failed to detect the region via bucket: %s", bucket)
@@ -104,6 +100,10 @@ func GetBackendType(provider string) BackendType {
 	return BackendType(provider)
 }
 
+func IsBackendTypeValid(backendType BackendType) bool {
+	return (backendType == AWSBackend || backendType == AzureBackend || backendType == GCPBackend || backendType == FSBackend)
+}
+
 // GetRepoIdentifier returns the string to be used as the value of the --repo flag in
 // restic commands for the given repository.
 func GetRepoIdentifier(location *velerov1api.BackupStorageLocation, name string) (string, error) {
@@ -114,29 +114,3 @@ func GetRepoIdentifier(location *velerov1api.BackupStorageLocation, name string)
 
 	return fmt.Sprintf("%s/%s", strings.TrimSuffix(prefix, "/"), name), nil
 }
-
-// GetBucketRegion returns the AWS region that a bucket is in, or an error
-// if the region cannot be determined.
-func GetAWSBucketRegion(bucket string) (string, error) {
-	var region string
-
-	sess, err := session.NewSession()
-	if err != nil {
-		return "", errors.WithStack(err)
-	}
-
-	for _, partition := range endpoints.DefaultPartitions() {
-		for regionHint := range partition.Regions() {
-			region, _ = s3manager.GetBucketRegion(context.Background(), sess, bucket, regionHint)
-
-			// we only need to try a single region hint per partition, so break after the first
-			break
-		}
-
-		if region != "" {
-			return region, nil
-		}
-	}
-
-	return "", errors.New("unable to determine bucket's region")
-}

pkg/repository/provider/provider.go

@@ -0,0 +1,54 @@
+/*
+Copyright 2020 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 repoprovider
+
+import (
+	"context"
+
+	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
+)
+
+type RepoInfo struct {
+	Name           string
+	BackupLocation *velerov1api.BackupStorageLocation
+}
+
+type Provider interface {
+	//InitRepo is to initialize a repository from a new storage place
+	InitRepo(ctx context.Context, info RepoInfo) error
+
+	//ConnectToRepo is to establish the connection to a
+	//storage place that a repository is already initialized
+	ConnectToRepo(ctx context.Context, info RepoInfo) error
+
+	//PrepareRepo is a combination of InitRepo and ConnectToRepo,
+	//it may do initializing + connecting, connecting only if the repository
+	//is already initialized, or do nothing if the repository is already connected
+	PrepareRepo(ctx context.Context, info RepoInfo) error
+
+	//PruneRepo does a full prune/maintenance of the repository
+	PruneRepo(ctx context.Context, info RepoInfo) error
+
+	//PruneRepoQuick does a quick prune/maintenance of the repository if available
+	PruneRepoQuick(ctx context.Context, info RepoInfo) error
+
+	//EnsureUnlockRepo esures to remove any stale file locks in the storage
+	EnsureUnlockRepo(ctx context.Context, info RepoInfo) error
+
+	//Forget is to delete a snapshot from the repository
+	Forget(ctx context.Context, snapshotID string, info RepoInfo) error
+}