Initial commit: move files from kanisterio/kanister

.gitignore

@@ -7,6 +7,7 @@
 *.dll
 *.so
 *.dylib
+coverage.txt
 
 # Test binary, built with `go test -c`
 *.test
@@ -20,3 +21,5 @@
 # Go workspace file
 go.work
 go.work.sum
+
+/.go

args/cache_args.go

@@ -0,0 +1,26 @@
+// 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 args
+
+// Cache provides the cache arguments for Kopia CLI.
+type Cache struct {
+	CacheDirectory           string // the directory where cache is stored. Default is "/tmp/kopia-cache".
+	ContentCacheSizeLimitMB  int    // the maximum size of the content cache in MB.
+	MetadataCacheSizeLimitMB int    // the maximum size of the metadata cache in MB.
+
+	// unused?
+	ContentCacheSizeMB  int // the size of the content cache in MB.
+	MetadataCacheSizeMB int // the size of the metadata cache in MB.
+}

args/common_args.go

@@ -0,0 +1,23 @@
+// 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 args
+
+// Common provides the common arguments for Kopia CLI.
+type Common struct {
+	ConfigFilePath string // the path to the config file.
+	LogDirectory   string // the directory where logs are stored.
+	LogLevel       string // the level of logging. Default is "error".
+	RepoPassword   string // the password for the repository.
+}

args/ephemeral_args.go

@@ -0,0 +1,48 @@
+// 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 args
+
+import (
+	"fmt"
+	"github.com/kanisterio/safecli/command"
+)
+
+var (
+	RepositoryCreate        Args
+	RepositoryConnectServer Args
+	UserAddSet              Args
+)
+
+type Args struct {
+	args map[string]string
+}
+
+func (a *Args) Set(key, value string) {
+	if a.args == nil {
+		a.args = make(map[string]string)
+	}
+	if _, ok := a.args[key]; ok {
+		panic(fmt.Sprintf("key %q already registered", key))
+	}
+	a.args[key] = value
+}
+
+func (a *Args) CommandAppliers() []command.Applier {
+	appliers := make([]command.Applier, len(a.args))
+	for k, v := range a.args {
+		appliers = append(appliers, command.NewOptionWithArgument(k, v))
+	}
+	return appliers
+}

doc.go

@@ -0,0 +1,21 @@
+// 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.
+
+// This package contains the implementation of the Kopia CLI using github.com/kanisterio/safecli.
+
+package cli
+
+import (
+	_ "github.com/kanisterio/safecli"
+)

errors.go

@@ -0,0 +1,43 @@
+// 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 cli
+
+import (
+	"github.com/pkg/errors"
+)
+
+// Common errors
+var (
+	// ErrInvalidID is returned when the ID is empty.
+	ErrInvalidID = errors.New("invalid ID")
+)
+
+// storage errors
+var (
+	// ErrUnsupportedStorage is returned when the storage is not supported.
+	ErrUnsupportedStorage = errors.New("unsupported storage")
+	// ErrInvalidRepoPath is returned when the repoPath is empty.
+	ErrInvalidRepoPath = errors.New("repository path cannot be empty")
+	// ErrInvalidPrefix is returned when the prefix is empty.
+	ErrInvalidPrefix = errors.New("prefix cannot be empty")
+	// ErrInvalidBucketName is returned when the bucketName is empty.
+	ErrInvalidBucketName = errors.New("bucket name cannot be empty")
+	// ErrInvalidCredentialsFile is returned when the credentials file is empty.
+	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")
+)

go.mod

@@ -0,0 +1,25 @@
+module github.com/kanisterio/safecli-kopia
+
+go 1.22
+
+toolchain go1.22.2
+
+require (
+	github.com/go-openapi/strfmt v0.23.0
+	github.com/kanisterio/safecli v0.0.8
+	github.com/pkg/errors v0.9.1
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
+)
+
+require (
+	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
+	github.com/go-openapi/errors v0.22.0 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/oklog/ulid v1.3.1 // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
+	go.mongodb.org/mongo-driver v1.14.0 // indirect
+)

go.sum

@@ -0,0 +1,42 @@
+github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so=
+github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-openapi/errors v0.22.0 h1:c4xY/OLxUBSTiepAg3j/MHuAv5mJhnf53LLMWFB+u/w=
+github.com/go-openapi/errors v0.22.0/go.mod h1:J3DmZScxCDufmIMsdOuDHxJbdOGC0xtUynjIx092vXE=
+github.com/go-openapi/strfmt v0.23.0 h1:nlUS6BCqcnAk0pyhi9Y+kdDVZdZMHfEKQiS4HaMgO/c=
+github.com/go-openapi/strfmt v0.23.0/go.mod h1:NrtIpfKtWIygRkKVsxh7XQMDQW5HKQl6S5ik2elW+K4=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/kanisterio/safecli v0.0.8 h1:flvTiGksy/a0+zvqjaBSJwxESu/nFcG65yttmR0XwiA=
+github.com/kanisterio/safecli v0.0.8/go.mod h1:KBraqj8mdv2cwAr9wecknGUb8jztTzUik0r7uE6yRA8=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
+github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
+github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+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/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
+github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+go.mongodb.org/mongo-driver v1.14.0 h1:P98w8egYRjYe3XDjxhYJagTokP/H6HzlsnojRgZRd80=
+go.mongodb.org/mongo-driver v1.14.0/go.mod h1:Vzb0Mk/pa7e6cWw85R4F/endUC3u0U9jGcNU603k65c=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/args/args.go

@@ -0,0 +1,29 @@
+// 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 args
+
+import (
+	"github.com/kanisterio/safecli/command"
+
+	"github.com/kanisterio/safecli-kopia"
+)
+
+// ID creates a new ID argument.
+func ID(id string) command.Applier {
+	if id == "" {
+		return command.NewErrorArgument(cli.ErrInvalidID)
+	}
+	return command.NewArgument(id)
+}

internal/args/args_test.go

@@ -0,0 +1,40 @@
+// 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 args_test
+
+import (
+	"testing"
+
+	"github.com/kanisterio/safecli/test"
+	"gopkg.in/check.v1"
+
+	"github.com/kanisterio/safecli-kopia"
+	"github.com/kanisterio/safecli-kopia/internal/args"
+)
+
+func TestArgs(t *testing.T) { check.TestingT(t) }
+
+var _ = check.Suite(&test.ArgumentSuite{Cmd: "cmd", Arguments: []test.ArgumentTest{
+	{
+		Name:        "Invalid ID",
+		Argument:    args.ID(""),
+		ExpectedErr: cli.ErrInvalidID,
+	},
+	{
+		Name:        "ID",
+		Argument:    args.ID("id12345"),
+		ExpectedCLI: []string{"cmd", "id12345"},
+	},
+}})

internal/kopia.go

@@ -0,0 +1,29 @@
+// 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 internal
+
+import (
+	"github.com/kanisterio/safecli"
+	"github.com/kanisterio/safecli/command"
+)
+
+const (
+	kopiaBinName = "kopia"
+)
+
+// NewKopiaCommand creates a new safecli.Builder for the kopia command.
+func NewKopiaCommand(args ...command.Applier) (*safecli.Builder, error) {
+	return command.New(kopiaBinName, args...)
+}

internal/kopia_test.go

@@ -0,0 +1,36 @@
+// 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 internal_test
+
+import (
+	"testing"
+
+	"gopkg.in/check.v1"
+
+	"github.com/kanisterio/safecli-kopia/internal"
+	"github.com/kanisterio/safecli-kopia/internal/opts"
+)
+
+func TestNewKopiaCommand(t *testing.T) { check.TestingT(t) }
+
+type KopiaCommandSuite struct{}
+
+var _ = check.Suite(&KopiaCommandSuite{})
+
+func (s *KopiaCommandSuite) TestNewKopiaCommandSuite(c *check.C) {
+	cmd, err := internal.NewKopiaCommand(opts.JSON(true))
+	c.Check(err, check.IsNil)
+	c.Check(cmd.Build(), check.DeepEquals, []string{"kopia", "--json"})
+}