Implement Kopia storage filesystem opts

go.mod

@@ -216,6 +216,8 @@ require (
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 )
 
+require github.com/kanisterio/safecli v0.0.3
+
 require (
 	github.com/Azure/go-autorest/autorest v0.11.27 // indirect
 	github.com/Azure/go-autorest/autorest/adal v0.9.18 // indirect

go.sum

@@ -359,6 +359,8 @@ github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnr
 github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
 github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
 github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
+github.com/kanisterio/safecli v0.0.3 h1:ts3oRVSoRexFBv9pOdWYZsN4k068pWx5Cl4zN54mQro=
+github.com/kanisterio/safecli v0.0.3/go.mod h1:fK3Mcbeiso+NtkUdhGugK0Vf4S2l8ObvFf564ry1W5A=
 github.com/kastenhq/check v0.0.0-20180626002341-0264cfcea734 h1:qulsCaCv+O2y9/sQ9nd5KChnAgFOWakTHQ9ZADjs6DQ=
 github.com/kastenhq/check v0.0.0-20180626002341-0264cfcea734/go.mod h1:rdqSnvOJuKCPFW/h2rVLuXOAkRnHHdp9PZcKx4HCoDM=
 github.com/kastenhq/stow v0.2.6-kasten.1.0.20231101232131-9321daa23aae h1:2cl4yuAJpdmLCx7G8eIsfNlQBLEfw0JDj6mTTyqc5qg=

pkg/kopia/cli/args.go

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

pkg/kopia/cli/errors.go

@@ -0,0 +1,39 @@
+// 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"
+)
+
+// flag errors
+var (
+	// ErrInvalidFlag is returned when the flag name is empty.
+	ErrInvalidFlag = errors.New("invalid flag")
+	// ErrInvalidCommonArgs is returned when the common flag expects at most one cli.CommonArgs argument.
+	ErrInvalidCommonArgs = errors.New("common flag expects at most one cli.CommonArgs argument")
+	// ErrInvalidCacheArgs is returned when the cache flag expects at most one cli.CacheArgs argument.
+	ErrInvalidCacheArgs = errors.New("cache flag expects at most one cli.CacheArgs argument")
+	// ErrInvalidID is returned when the ID is empty.
+	ErrInvalidID = errors.New("invalid ID")
+	// ErrInvalidCommand is returned when the command is empty.
+	ErrInvalidCommand = errors.New("invalid command")
+)
+
+// storage errors
+var (
+	// ErrUnsupportedStorage is returned when the storage is not supported.
+	ErrUnsupportedStorage = errors.New("unsupported storage")
+)

pkg/kopia/cli/internal/command/command.go

@@ -0,0 +1,45 @@
+// 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 command
+
+import (
+	"github.com/kanisterio/safecli"
+
+	clierrors "github.com/kanisterio/kanister/pkg/kopia/cli"
+	"github.com/kanisterio/kanister/pkg/kopia/cli/internal/flag"
+)
+
+// Command is a CLI command/subcommand.
+type Command struct {
+	name string
+}
+
+// Apply applies the command to the CLI.
+func (c Command) Apply(cli safecli.CommandAppender) error {
+	if len(c.name) == 0 {
+		return clierrors.ErrInvalidCommand
+	}
+	cli.AppendLoggable(c.name)
+	return nil
+}
+
+// NewCommandBuilder returns a new safecli.Builder for the storage sub command.
+func NewCommandBuilder(cmd flag.Applier, flags ...flag.Applier) (*safecli.Builder, error) {
+	b := safecli.NewBuilder()
+	if err := flag.Apply(b, append([]flag.Applier{cmd}, flags...)...); err != nil {
+		return nil, err
+	}
+	return b, nil
+}

pkg/kopia/cli/internal/command/command_test.go

@@ -0,0 +1,97 @@
+// 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 command
+
+import (
+	"errors"
+	"testing"
+
+	"gopkg.in/check.v1"
+
+	"github.com/kanisterio/kanister/pkg/kopia/cli"
+	"github.com/kanisterio/safecli"
+)
+
+func TestCommand(t *testing.T) { check.TestingT(t) }
+
+type CommandSuite struct{}
+
+var _ = check.Suite(&CommandSuite{})
+
+var (
+	errInvalidCommand = errors.New("invalid command")
+	errInvalidFlag    = errors.New("invalid flag")
+)
+
+type mockCommandAndFlag struct {
+	flagName string
+	err      error
+}
+
+func (m *mockCommandAndFlag) Apply(cli safecli.CommandAppender) error {
+	if m.err == nil {
+		cli.AppendLoggable(m.flagName)
+	}
+	return m.err
+}
+
+func (s *CommandSuite) TestCommand(c *check.C) {
+	b := safecli.NewBuilder()
+	cmd := Command{"cmd"}
+	err := cmd.Apply(b)
+	c.Assert(err, check.IsNil)
+	c.Check(b.Build(), check.DeepEquals, []string{"cmd"})
+}
+
+func (s *CommandSuite) TestEmptyCommand(c *check.C) {
+	b := safecli.NewBuilder()
+	cmd := Command{}
+	err := cmd.Apply(b)
+	c.Assert(err, check.Equals, cli.ErrInvalidCommand)
+}
+
+func (s *CommandSuite) TestNewCommandBuilderWithFailedCommand(c *check.C) {
+	// test if command is invalid
+	b, err := NewCommandBuilder(
+		&mockCommandAndFlag{err: errInvalidCommand},
+	)
+	c.Assert(b, check.IsNil)
+	c.Assert(err, check.Equals, errInvalidCommand)
+}
+
+func (s *CommandSuite) TestNewCommandBuilderWithFailedFlag(c *check.C) {
+	// test if flag is invalid
+	b, err := NewCommandBuilder(
+		&mockCommandAndFlag{flagName: "cmd"},
+		&mockCommandAndFlag{err: errInvalidFlag},
+	)
+	c.Assert(b, check.IsNil)
+	c.Assert(err, check.Equals, errInvalidFlag)
+}
+
+func (s *CommandSuite) TestNewCommandBuilder(c *check.C) {
+	// test if command and flag are valid
+	b, err := NewCommandBuilder(
+		&mockCommandAndFlag{flagName: "cmd"},
+		&mockCommandAndFlag{flagName: "--flag1"},
+		&mockCommandAndFlag{flagName: "--flag2"},
+	)
+	c.Assert(err, check.IsNil)
+	c.Check(b.Build(), check.DeepEquals, []string{
+		"cmd",
+		"--flag1",
+		"--flag2",
+	})
+}

pkg/kopia/cli/internal/command/commands.go

@@ -0,0 +1,6 @@
+package command
+
+// Repository storage sub commands.
+var (
+	FileSystem = Command{"filesystem"}
+)

pkg/kopia/cli/internal/flag/bool_flag.go

@@ -0,0 +1,45 @@
+// 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 flag
+
+import (
+	"github.com/kanisterio/safecli"
+
+	"github.com/kanisterio/kanister/pkg/kopia/cli"
+)
+
+// boolFlag defines a boolean flag with a given flag name.
+// If enabled is set to true, the flag is applied; otherwise, it is not.
+type boolFlag struct {
+	flag    string
+	enabled bool
+}
+
+// Apply appends the flag to the command if the flag is enabled.
+func (f boolFlag) Apply(cli safecli.CommandAppender) error {
+	if f.enabled {
+		cli.AppendLoggable(f.flag)
+	}
+	return nil
+}
+
+// NewBoolFlag creates a new bool flag with a given flag name.
+// If the flag name is empty, cli.ErrInvalidFlag is returned.
+func NewBoolFlag(flag string, enabled bool) Applier {
+	if flag == "" {
+		return ErrorFlag(cli.ErrInvalidFlag)
+	}
+	return boolFlag{flag, enabled}
+}