Add Kopia repository connect server command (#2663)

* Add safecli dependency * add new flag implementations based on the safecli package for the Kopia CLI * apply go fmt Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add common Kopia args and flags * Add Kopia storage core flags * Add kopia filesystem storage flags * cleanup storage tests * Add kopia GCS storage flags * add gcs flag tests * Add kopia azure storage flags * Add kopia s3 and s3 compliant storage flags * Use test.FlagSuite for storage tests * Fix typo * Add kopia CLI repository connect command * Add kopia CLI repository connect command * Add kopia CLI repository connect server command * Fix Apply and test.Suit Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Remove variadic args for Common and Cache flags Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * pkg/kopia/cli/internal/flag is implemented in the safecli@v0.0.4 now Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add pkg/kopia/cli package Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * go mod tidy Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia storage helpers Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Implement Kopia storage Filesystem opts Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add (c) headers Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Remove unused error Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Reorganize imports Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia GCS storage opts Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Reorganize imports Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia Azure storage opts Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix gcs test Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia S3 and S3 compliant storage opts Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia S3 and S3 compliant storage opts Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Cleanup tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia repository create command Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Cleanup Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Reorganize tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Kopia repository connect command Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add opts tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add opts tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Convert common flags from vars to funcs Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add safecli dependency * add new flag implementations based on the safecli package for the Kopia CLI * apply go fmt Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix Apply and test.Suit Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * pkg/kopia/cli/internal/flag is implemented in the safecli@v0.0.4 now Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add pkg/kopia/cli package Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * go mod tidy Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Update safecli to v0.0.5 Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Update safecli to v0.0.6 Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add Location.IsPointInTypeSupported Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Add tests for Location.IsPointInTypeSupported Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix s3 options Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix s3 options Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix options to return errors for empty args Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix options to return errors for empty args Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix options to return errors for empty args Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support empty prefix Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support empty prefix Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support empty prefix Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support empty prefix Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support empty argument for hostname and username options Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Support PIT option for Azure and S3 only Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Server URL option is required Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix formatting Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * organize imports Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * organize imports Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * organize imports Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> * Fix s3 tests Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> --------- Signed-off-by: pavel.larkin <pavel.larkin@veeam.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
kanisterio · Mar 5, 2024 · dd90c25 · dd90c25
1 parent a0585c8
commit dd90c25
Show file tree

Hide file tree

Showing 5 changed files with 141 additions and 0 deletions.
diff --git a/pkg/kopia/cli/errors.go b/pkg/kopia/cli/errors.go
@@ -38,4 +38,6 @@ var (
 	ErrInvalidCredentialsFile = errors.New("credentials file cannot be empty")
 	// ErrInvalidContainerName is returned when the containerName is empty.
 	ErrInvalidContainerName = errors.New("container name cannot be empty")
+	// ErrInvalidServerURL is returned when the serverURL is empty.
+	ErrInvalidServerURL = errors.New("server URL cannot be empty")
 )
diff --git a/pkg/kopia/cli/repository/opts.go b/pkg/kopia/cli/repository/opts.go
@@ -36,6 +36,7 @@ var (
 
 	subcmdCreate  = command.NewArgument("create")
 	subcmdConnect = command.NewArgument("connect")
+	subcmdServer  = command.NewArgument("server")
 )
 
 // optHostname creates a new option for the hostname of the repository.
@@ -104,3 +105,19 @@ func optPointInTime(l internal.Location, pit strfmt.DateTime) command.Applier {
 	}
 	return command.NewOptionWithArgument("--point-in-time", pit.String())
 }
+
+// optServerURL creates a new server URL flag with a given server URL.
+func optServerURL(serverURL string) command.Applier {
+	if serverURL == "" {
+		return command.NewErrorArgument(cli.ErrInvalidServerURL)
+	}
+	return command.NewOptionWithArgument("--url", serverURL)
+}
+
+// optServerCertFingerprint creates a new server certificate fingerprint flag with a given fingerprint.
+func optServerCertFingerprint(fingerprint string) command.Applier {
+	if fingerprint == "" {
+		return command.NewNoopArgument()
+	}
+	return command.NewOptionWithRedactedArgument("--server-cert-fingerprint", fingerprint)
+}
diff --git a/pkg/kopia/cli/repository/opts_test.go b/pkg/kopia/cli/repository/opts_test.go
@@ -112,4 +112,22 @@ var _ = check.Suite(&test.ArgumentSuite{Cmd: "cmd", Arguments: []test.ArgumentTe
 			"--point-in-time=2021-02-04T01:02:03.000Z",
 		},
 	},
+	{
+		Name:        "optServerURL with ServerURL should return option",
+		Argument:    optServerURL("http://test-server"),
+		ExpectedCLI: []string{"cmd", "--url=http://test-server"},
+	},
+	{
+		Name:        "optServerURL with empty ServerURL should return error",
+		Argument:    optServerURL(""),
+		ExpectedErr: cli.ErrInvalidServerURL,
+	},
+	{
+		Name: "optServerCertFingerprint",
+		Argument: command.NewArguments(
+			optServerCertFingerprint("fingerprint"),
+			optServerCertFingerprint(""), // no output
+		),
+		ExpectedCLI: []string{"cmd", "--server-cert-fingerprint=fingerprint"},
+	},
 }})
diff --git a/pkg/kopia/cli/repository/repository_connect_server.go b/pkg/kopia/cli/repository/repository_connect_server.go
@@ -0,0 +1,54 @@
+// Copyright 2024 The Kanister Authors.
+//
+// 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 repository
+
+import (
+	"github.com/kanisterio/safecli"
+
+	"github.com/kanisterio/kanister/pkg/kopia/cli/args"
+	"github.com/kanisterio/kanister/pkg/kopia/cli/internal"
+	"github.com/kanisterio/kanister/pkg/kopia/cli/internal/opts"
+	"github.com/kanisterio/kanister/pkg/log"
+)
+
+// ConnectServerArgs defines the arguments for the `kopia repository connect server` command.
+type ConnectServerArgs struct {
+	args.Common
+	args.Cache
+
+	Hostname    string // hostname of the repository
+	Username    string // username of the repository
+	ServerURL   string // URL of the Kopia Repository API server
+	Fingerprint string // fingerprint of the server's TLS certificate
+	ReadOnly    bool   // connect to a repository in read-only mode
+
+	Logger log.Logger
+}
+
+// ConnectServer creates a new `kopia repository connect server...` command.
+func ConnectServer(args ConnectServerArgs) (*safecli.Builder, error) {
+	return internal.NewKopiaCommand(
+		opts.Common(args.Common),
+		cmdRepository, subcmdConnect, subcmdServer,
+		opts.CheckForUpdates(false),
+		opts.GRPC(false),
+		optReadOnly(args.ReadOnly),
+		opts.Cache(args.Cache),
+		optHostname(args.Hostname),
+		optUsername(args.Username),
+		optServerURL(args.ServerURL),
+		optServerCertFingerprint(args.Fingerprint),
+	)
+}
diff --git a/pkg/kopia/cli/repository/repository_connect_server_test.go b/pkg/kopia/cli/repository/repository_connect_server_test.go
@@ -0,0 +1,50 @@
+package repository
+
+import (
+	"testing"
+
+	"github.com/kanisterio/safecli"
+	"gopkg.in/check.v1"
+
+	"github.com/kanisterio/kanister/pkg/kopia/cli/internal/test"
+)
+
+func TestRepositoryConnectServerCommand(t *testing.T) { check.TestingT(t) }
+
+// Test Repository Connect Server command
+var _ = check.Suite(test.NewCommandSuite([]test.CommandTest{
+	{
+		Name: "repository connect server",
+		Command: func() (*safecli.Builder, error) {
+			args := ConnectServerArgs{
+				Common:      common,
+				Cache:       cache,
+				Hostname:    "test-hostname",
+				Username:    "test-username",
+				ServerURL:   "http://test-server",
+				Fingerprint: "test-fingerprint",
+				ReadOnly:    true,
+			}
+			return ConnectServer(args)
+		},
+		ExpectedCLI: []string{"kopia",
+			"--config-file=path/kopia.config",
+			"--log-dir=cache/log",
+			"--log-level=error",
+			"--password=encr-key",
+			"repository",
+			"connect",
+			"server",
+			"--no-check-for-updates",
+			"--no-grpc",
+			"--readonly",
+			"--cache-directory=/tmp/cache.dir",
+			"--content-cache-size-limit-mb=0",
+			"--metadata-cache-size-limit-mb=0",
+			"--override-hostname=test-hostname",
+			"--override-username=test-username",
+			"--url=http://test-server",
+			"--server-cert-fingerprint=test-fingerprint",
+		},
+	},
+}))