refactor: move out the storage initialize from function internal (#14)

Author: chlins

README.md

@@ -1,6 +1,6 @@
 # modctl
 
-Modctl is a user-friendly CLI tool for managing OCI model artifacts, which are bundled based on Model Spec V1(https://github.com/CloudNativeAI/model-spec).
+Modctl is a user-friendly CLI tool for managing OCI model artifacts, which are bundled based on [Model Spec V1](https://github.com/CloudNativeAI/model-spec).
 It offers commands such as `build`, `pull`, `push`, and more, making it easy for users to convert their AI models into OCI artifacts.
 
 ## Usage

cmd/modctl/build.go

@@ -20,8 +20,8 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/backend"
 	"github.com/CloudNativeAI/modctl/pkg/config"
-	"github.com/CloudNativeAI/modctl/pkg/oci"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -59,7 +59,12 @@ func init() {
 
 // runBuild runs the build modctl.
 func runBuild(ctx context.Context, workDir string) error {
-	if err := oci.Build(ctx, buildConfig.Modelfile, workDir, buildConfig.Target); err != nil {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	if err := b.Build(ctx, buildConfig.Modelfile, workDir, buildConfig.Target); err != nil {
 		return err
 	}
 

cmd/modctl/list.go

@@ -22,7 +22,8 @@ import (
 	"os"
 	"text/tabwriter"
 
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+	"github.com/CloudNativeAI/modctl/pkg/backend"
+
 	humanize "github.com/dustin/go-humanize"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -52,7 +53,12 @@ func init() {
 
 // runList runs the list modctl.
 func runList(ctx context.Context) error {
-	artifacts, err := oci.List(ctx)
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	artifacts, err := b.List(ctx)
 	if err != nil {
 		return err
 	}

cmd/modctl/login.go

@@ -23,8 +23,9 @@ import (
 	"os"
 	"strings"
 
+	"github.com/CloudNativeAI/modctl/pkg/backend"
 	"github.com/CloudNativeAI/modctl/pkg/config"
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -68,6 +69,11 @@ func init() {
 
 // runLogin runs the login modctl.
 func runLogin(ctx context.Context, registry string) error {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
 	// read password from stdin if password-stdin is set
 	if loginConfig.PasswordStdin {
 		fmt.Print("Enter password: ")
@@ -80,7 +86,7 @@ func runLogin(ctx context.Context, registry string) error {
 		loginConfig.Password = strings.TrimSpace(password)
 	}
 
-	if err := oci.Login(ctx, registry, loginConfig.Username, loginConfig.Password); err != nil {
+	if err := b.Login(ctx, registry, loginConfig.Username, loginConfig.Password); err != nil {
 		return err
 	}
 

cmd/modctl/logout.go

@@ -20,7 +20,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+	"github.com/CloudNativeAI/modctl/pkg/backend"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -49,7 +50,12 @@ func init() {
 
 // runLogout runs the logout modctl.
 func runLogout(ctx context.Context, registry string) error {
-	if err := oci.Logout(ctx, registry); err != nil {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	if err := b.Logout(ctx, registry); err != nil {
 		return err
 	}
 

cmd/modctl/prune.go

@@ -20,7 +20,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+	"github.com/CloudNativeAI/modctl/pkg/backend"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -49,7 +50,12 @@ func init() {
 
 // runPrune runs the prune modctl.
 func runPrune(ctx context.Context) error {
-	prunedBlobs, err := oci.Prune(ctx)
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	prunedBlobs, err := b.Prune(ctx)
 	if err != nil {
 		return err
 	}

cmd/modctl/pull.go

@@ -20,8 +20,9 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/backend"
 	"github.com/CloudNativeAI/modctl/pkg/config"
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -53,16 +54,21 @@ func init() {
 
 // runPull runs the pull modctl.
 func runPull(ctx context.Context, target string) error {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
 	if target == "" {
 		return fmt.Errorf("target is required")
 	}
 
-	opts := []oci.Option{}
+	opts := []backend.Option{}
 	if pullConfig.PlainHTTP {
-		opts = append(opts, oci.WithPlainHTTP())
+		opts = append(opts, backend.WithPlainHTTP())
 	}
 
-	if err := oci.Pull(ctx, target, opts...); err != nil {
+	if err := b.Pull(ctx, target, opts...); err != nil {
 		return err
 	}
 

cmd/modctl/push.go

@@ -20,8 +20,9 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/backend"
 	"github.com/CloudNativeAI/modctl/pkg/config"
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -53,12 +54,17 @@ func init() {
 
 // runPush runs the push modctl.
 func runPush(ctx context.Context, target string) error {
-	opts := []oci.Option{}
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	opts := []backend.Option{}
 	if pushConfig.PlainHTTP {
-		opts = append(opts, oci.WithPlainHTTP())
+		opts = append(opts, backend.WithPlainHTTP())
 	}
 
-	if err := oci.Push(ctx, target, opts...); err != nil {
+	if err := b.Push(ctx, target, opts...); err != nil {
 		return err
 	}
 

cmd/modctl/rm.go

@@ -20,7 +20,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/CloudNativeAI/modctl/pkg/oci"
+	"github.com/CloudNativeAI/modctl/pkg/backend"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -49,11 +50,16 @@ func init() {
 
 // runRm runs the rm modctl.
 func runRm(ctx context.Context, target string) error {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
 	if target == "" {
 		return fmt.Errorf("target is required")
 	}
 
-	digest, err := oci.Remove(ctx, target)
+	digest, err := b.Remove(ctx, target)
 	if err != nil {
 		return err
 	}

pkg/backend/backend.go

@@ -0,0 +1,67 @@
+/*
+ *     Copyright 2024 The CNAI 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 backend
+
+import (
+	"context"
+
+	"github.com/CloudNativeAI/modctl/pkg/storage"
+)
+
+// Backend is the interface to represent the backend.
+type Backend interface {
+	// Login logs into a registry.
+	Login(ctx context.Context, registry, username, password string) error
+
+	// Logout logs out from a registry.
+	Logout(ctx context.Context, registry string) error
+
+	// Build builds the user materials into the OCI image which follows the Model Spec.
+	Build(ctx context.Context, modelfilePath, workDir, target string) error
+
+	// Pull pulls an artifact from a registry.
+	Pull(ctx context.Context, target string, opts ...Option) error
+
+	// Push pushes the image to the registry.
+	Push(ctx context.Context, target string, opts ...Option) error
+
+	// List lists all the model artifacts.
+	List(ctx context.Context) ([]*ModelArtifact, error)
+
+	// Remove deletes the model artifact.
+	Remove(ctx context.Context, target string) (string, error)
+
+	// Prune prunes the unused blobs and clean up the storage.
+	Prune(ctx context.Context) ([]string, error)
+}
+
+// backend is the implementation of Backend.
+type backend struct {
+	store storage.Storage
+}
+
+// New creates a new backend.
+func New() (Backend, error) {
+	store, err := storage.New("")
+	if err != nil {
+		return nil, err
+	}
+
+	return &backend{
+		store: store,
+	}, nil
+}