feat: add config pkg for commands (#12)

Signed-off-by: Gaius <[email protected]>

Author: gaius-qi

cmd/modctl/build.go

@@ -20,18 +20,14 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/config"
 	"github.com/CloudNativeAI/modctl/pkg/oci"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-var buildOpts = buildOptions{}
-
-type buildOptions struct {
-	target    string
-	modelfile string
-}
+var buildConfig = config.NewBuild()
 
 // buildCmd represents the modctl command for build.
 var buildCmd = &cobra.Command{
@@ -42,15 +38,19 @@ var buildCmd = &cobra.Command{
 	SilenceUsage:       true,
 	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
 	RunE: func(cmd *cobra.Command, args []string) error {
+		if err := buildConfig.Validate(); err != nil {
+			return err
+		}
+
 		return runBuild(context.Background(), args[0])
 	},
 }
 
 // init initializes build command.
 func init() {
 	flags := buildCmd.Flags()
-	flags.StringVarP(&buildOpts.target, "target", "t", "", "target model artifact name")
-	flags.StringVarP(&buildOpts.modelfile, "modelfile", "f", "", "model file path")
+	flags.StringVarP(&buildConfig.Target, "target", "t", "", "target model artifact name")
+	flags.StringVarP(&buildConfig.Modelfile, "modelfile", "f", "", "model file path")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache list flags to viper: %w", err))
@@ -59,18 +59,10 @@ func init() {
 
 // runBuild runs the build modctl.
 func runBuild(ctx context.Context, workDir string) error {
-	if len(buildOpts.target) == 0 {
-		return fmt.Errorf("target model artifact name is required")
-	}
-
-	if len(buildOpts.modelfile) == 0 {
-		buildOpts.modelfile = "Modelfile"
-	}
-
-	if err := oci.Build(ctx, buildOpts.modelfile, workDir, buildOpts.target); err != nil {
+	if err := oci.Build(ctx, buildConfig.Modelfile, workDir, buildConfig.Target); err != nil {
 		return err
 	}
 
-	fmt.Printf("Successfully built model artifact: %s\n", buildOpts.target)
+	fmt.Printf("Successfully built model artifact: %s\n", buildConfig.Target)
 	return nil
 }

cmd/modctl/cmd

@@ -23,12 +23,13 @@ import (
 	"os"
 	"strings"
 
+	"github.com/CloudNativeAI/modctl/pkg/config"
 	"github.com/CloudNativeAI/modctl/pkg/oci"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-var loginOpts = loginOptions{}
+var loginConfig = config.NewLogin()
 
 type loginOptions struct {
 	username      string
@@ -45,16 +46,20 @@ var loginCmd = &cobra.Command{
 	SilenceUsage:       true,
 	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
 	RunE: func(cmd *cobra.Command, args []string) error {
+		if err := loginConfig.Validate(); err != nil {
+			return err
+		}
+
 		return runLogin(context.Background(), args[0])
 	},
 }
 
 // init initializes login command.
 func init() {
 	flags := loginCmd.Flags()
-	flags.StringVarP(&loginOpts.username, "username", "u", "", "Username for login")
-	flags.StringVarP(&loginOpts.password, "password", "p", "", "Password for login")
-	flags.BoolVar(&loginOpts.passwordStdin, "password-stdin", false, "Take the password from stdin")
+	flags.StringVarP(&loginConfig.Username, "username", "u", "", "Username for login")
+	flags.StringVarP(&loginConfig.Password, "password", "p", "", "Password for login")
+	flags.BoolVar(&loginConfig.PasswordStdin, "password-stdin", false, "Take the password from stdin")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache login flags to viper: %w", err))
@@ -63,26 +68,19 @@ func init() {
 
 // runLogin runs the login modctl.
 func runLogin(ctx context.Context, registry string) error {
-	if len(loginOpts.username) == 0 {
-		return fmt.Errorf("missing username")
-	}
 	// read password from stdin if password-stdin is set
-	if loginOpts.passwordStdin {
+	if loginConfig.PasswordStdin {
 		fmt.Print("Enter password: ")
 		reader := bufio.NewReader(os.Stdin)
 		password, err := reader.ReadString('\n')
 		if err != nil {
 			return err
 		}
 
-		loginOpts.password = strings.TrimSpace(password)
-	}
-
-	if len(loginOpts.password) == 0 {
-		return fmt.Errorf("missing password")
+		loginConfig.Password = strings.TrimSpace(password)
 	}
 
-	if err := oci.Login(ctx, registry, loginOpts.username, loginOpts.password); err != nil {
+	if err := oci.Login(ctx, registry, loginConfig.Username, loginConfig.Password); err != nil {
 		return err
 	}
 

cmd/modctl/login.go

@@ -20,16 +20,13 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/config"
 	"github.com/CloudNativeAI/modctl/pkg/oci"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-var pullOpts = &pullOptions{}
-
-type pullOptions struct {
-	plainHTTP bool
-}
+var pullConfig = config.NewPull()
 
 // pullCmd represents the modctl command for pull.
 var pullCmd = &cobra.Command{
@@ -47,7 +44,7 @@ var pullCmd = &cobra.Command{
 // init initializes pull command.
 func init() {
 	flags := pullCmd.Flags()
-	flags.BoolVarP(&pullOpts.plainHTTP, "plain-http", "p", false, "use plain HTTP instead of HTTPS")
+	flags.BoolVarP(&pullConfig.PlainHTTP, "plain-http", "p", false, "use plain HTTP instead of HTTPS")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache pull flags to viper: %w", err))
@@ -61,7 +58,7 @@ func runPull(ctx context.Context, target string) error {
 	}
 
 	opts := []oci.Option{}
-	if pullOpts.plainHTTP {
+	if pullConfig.PlainHTTP {
 		opts = append(opts, oci.WithPlainHTTP())
 	}
 

cmd/modctl/pull.go

@@ -20,16 +20,13 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/CloudNativeAI/modctl/pkg/config"
 	"github.com/CloudNativeAI/modctl/pkg/oci"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-var pushOpts = &pushOptions{}
-
-type pushOptions struct {
-	plainHTTP bool
-}
+var pushConfig = config.NewPull()
 
 // pushCmd represents the modctl command for push.
 var pushCmd = &cobra.Command{
@@ -47,7 +44,7 @@ var pushCmd = &cobra.Command{
 // init initializes push command.
 func init() {
 	flags := pushCmd.Flags()
-	flags.BoolVarP(&pushOpts.plainHTTP, "plain-http", "p", false, "use plain HTTP instead of HTTPS")
+	flags.BoolVarP(&pushConfig.PlainHTTP, "plain-http", "p", false, "use plain HTTP instead of HTTPS")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache push flags to viper: %w", err))
@@ -57,7 +54,7 @@ func init() {
 // runPush runs the push modctl.
 func runPush(ctx context.Context, target string) error {
 	opts := []oci.Option{}
-	if pushOpts.plainHTTP {
+	if pushConfig.PlainHTTP {
 		opts = append(opts, oci.WithPlainHTTP())
 	}
 

cmd/modctl/push.go

@@ -0,0 +1,43 @@
+/*
+ *     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 config
+
+import "fmt"
+
+type Build struct {
+	Target    string
+	Modelfile string
+}
+
+func NewBuild() *Build {
+	return &Build{
+		Target:    "",
+		Modelfile: "Modelfile",
+	}
+}
+
+func (b *Build) Validate() error {
+	if len(b.Target) == 0 {
+		return fmt.Errorf("target model artifact name is required")
+	}
+
+	if len(b.Modelfile) == 0 {
+		return fmt.Errorf("model file path is required")
+	}
+
+	return nil
+}

pkg/config/build.go

@@ -0,0 +1,45 @@
+/*
+ *     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 config
+
+import "fmt"
+
+type Login struct {
+	Username      string
+	Password      string
+	PasswordStdin bool
+}
+
+func NewLogin() *Login {
+	return &Login{
+		Username:      "",
+		Password:      "",
+		PasswordStdin: false,
+	}
+}
+
+func (l *Login) Validate() error {
+	if len(l.Username) == 0 {
+		return fmt.Errorf("missing username")
+	}
+
+	if len(l.Password) == 0 {
+		return fmt.Errorf("missing password")
+	}
+
+	return nil
+}

pkg/config/login.go

@@ -0,0 +1,27 @@
+/*
+ *     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 config
+
+type Pull struct {
+	PlainHTTP bool
+}
+
+func NewPull() *Pull {
+	return &Pull{
+		PlainHTTP: false,
+	}
+}

pkg/config/pull.go

@@ -0,0 +1,27 @@
+/*
+ *     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 config
+
+type Push struct {
+	PlainHTTP bool
+}
+
+func NewPush() *Pull {
+	return &Pull{
+		PlainHTTP: false,
+	}
+}

pkg/config/push.go

@@ -36,7 +36,7 @@ func NewReadmeProcessor() Processor {
 type readmeProcessor struct{}
 
 func (p *readmeProcessor) Identify(_ context.Context, path string, info os.FileInfo) bool {
-	return info.Name() == "README.md"
+	return info.Name() == "README.md" || info.Name() == "README"
 }
 
 func (p *readmeProcessor) Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error) {