AutoGenerate credential name in login (#250)

* generate credential name Signed-off-by: bupd <[email protected]> * feat: add support for the password-stdin flag in login flow Signed-off-by: karanngi <[email protected]> * fix deps - fixes dependencies Signed-off-by: bupd <[email protected]> * return stdout for tests Signed-off-by: bupd <[email protected]> * update workflow Signed-off-by: bupd <[email protected]> --------- Signed-off-by: bupd <[email protected]> Signed-off-by: karanngi <[email protected]> Co-authored-by: karanngi <[email protected]>
goharbor · Nov 14, 2024 · b2fb70f · b2fb70f
1 parent cc8d1c8
commit b2fb70f
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 38 deletions.
diff --git a/.github/workflows/default.yaml b/.github/workflows/default.yaml
@@ -49,14 +49,14 @@ jobs:
         with:
           version: ${{ steps.dagger_version.outputs.version }}
           verb: call
-          args: test
+          args: test export --path=./testResults
 
       - name: Build Binary
         uses: dagger/dagger-for-github@v6
         with:
           version: ${{ steps.dagger_version.outputs.version }}
           verb: call
-          args: build-dev --platform linux/amd64
+          args: build-dev --platform linux/amd64 export --path=./harbor-dev
 
   push-latest-images:
     if: github.event.pull_request == null && !startsWith(github.ref, 'refs/tags/v')

diff --git a/cmd/harbor/root/login.go b/cmd/harbor/root/login.go
@@ -3,20 +3,22 @@ package root
 import (
 	"context"
 	"fmt"
-	"strings"
+	"os"
 
 	"github.com/goharbor/go-client/pkg/harbor"
 	"github.com/goharbor/go-client/pkg/sdk/v2.0/client/user"
 	"github.com/goharbor/harbor-cli/pkg/utils"
 	"github.com/goharbor/harbor-cli/pkg/views/login"
 	"github.com/spf13/cobra"
+	"golang.org/x/term"
 )
 
 var (
 	serverAddress string
 	Username      string
 	Password      string
 	Name          string
+	passwordStdin bool
 )
 
 // LoginCommand creates a new `harbor login` command
@@ -31,17 +33,31 @@ func LoginCommand() *cobra.Command {
 				serverAddress = args[0]
 			}
 
+			if passwordStdin {
+				fmt.Print("Password: ")
+				passwordBytes, err := term.ReadPassword(int(os.Stdin.Fd()))
+				if err != nil {
+					return fmt.Errorf("failed to read password from stdin: %v", err)
+				}
+				fmt.Println()
+				Password = string(passwordBytes)
+			}
+
 			loginView := login.LoginView{
 				Server:   serverAddress,
 				Username: Username,
 				Password: Password,
 				Name:     Name,
 			}
 
+			// autogenerate name
+			if loginView.Name == "" && loginView.Server != "" && loginView.Username != "" {
+				loginView.Name = fmt.Sprintf("%s@%s", loginView.Username, utils.SanitizeServerAddress(loginView.Server))
+			}
+
 			var err error
 
-			if loginView.Server != "" && loginView.Username != "" && loginView.Password != "" &&
-				loginView.Name != "" {
+			if loginView.Server != "" && loginView.Username != "" && loginView.Password != "" {
 				err = runLogin(loginView)
 			} else {
 				err = createLoginView(&loginView)
@@ -58,24 +74,11 @@ func LoginCommand() *cobra.Command {
 	flags.StringVarP(&Name, "name", "", "", "name for the set of credentials")
 	flags.StringVarP(&Username, "username", "u", "", "Username")
 	flags.StringVarP(&Password, "password", "p", "", "Password")
+	flags.BoolVar(&passwordStdin, "password-stdin", false, "Take the password from stdin")
 
 	return cmd
 }
 
-// generateCredentialName creates a default credential name based on server and username
-func generateCredentialName(server, username string) string {
-	if strings.HasPrefix(server, "http://") {
-		server = strings.ReplaceAll(server, "http://", "")
-	}
-	if strings.HasPrefix(server, "https://") {
-		server = strings.ReplaceAll(server, "https://", "")
-	}
-	if username != "" {
-		return fmt.Sprintf("%s@%s", username, server)
-	}
-	return server
-}
-
 func createLoginView(loginView *login.LoginView) error {
 	if loginView == nil {
 		loginView = &login.LoginView{
@@ -86,6 +89,7 @@ func createLoginView(loginView *login.LoginView) error {
 		}
 	}
 	login.CreateView(loginView)
+
 	return runLogin(*loginView)
 }
 
@@ -104,9 +108,6 @@ func runLogin(opts login.LoginView) error {
 	if err != nil {
 		return fmt.Errorf("login failed, please check your credentials: %s", err)
 	}
-	if opts.Name == "" {
-		opts.Name = generateCredentialName(opts.Server, opts.Username)
-	}
 
 	cred := utils.Credential{
 		Name:          opts.Name,

diff --git a/dagger.json b/dagger.json
@@ -9,5 +9,5 @@
     }
   ],
   "source": "dagger",
-  "engineVersion": "v0.13.6"
+  "engineVersion": "v0.14.0"
 }
diff --git a/dagger/main.go b/dagger/main.go
@@ -16,9 +16,9 @@ const (
 )
 
 func New(
-// Local or remote directory with source code, defaults to "./"
-// +optional
-// +defaultPath="./"
+	// Local or remote directory with source code, defaults to "./"
+	// +optional
+	// +defaultPath="./"
 	source *dagger.Directory,
 ) *HarborCli {
 	return &HarborCli{Source: source}
@@ -122,8 +122,8 @@ func (m *HarborCli) lint(ctx context.Context) *dagger.Container {
 func (m *HarborCli) PublishImage(
 	ctx context.Context,
 	registry, registryUsername string,
-// +optional
-// +default=["latest"]
+	// +optional
+	// +default=["latest"]
 	imageTags []string,
 	registryPassword *dagger.Secret) []string {
 	builders := m.build(ctx)
@@ -234,7 +234,7 @@ func (m *HarborCli) Test(ctx context.Context) *dagger.Directory {
 		WithEnvVariable("GOCACHE", "/go/build-cache").
 		WithMountedDirectory("/src", m.Source).
 		WithWorkdir("/src").
-		WithExec([]string{"go", "test", "-v", "./..."}).
+		WithExec([]string{"go", "test", "./..."}).
 		Directory("/src")
 }
 
@@ -254,11 +254,11 @@ func (m *HarborCli) PublishImageAndSign(
 	registryUsername string,
 	registryPassword *dagger.Secret,
 	imageTags []string,
-// +optional
+	// +optional
 	githubToken *dagger.Secret,
-// +optional
+	// +optional
 	actionsIdTokenRequestToken *dagger.Secret,
-// +optional
+	// +optional
 	actionsIdTokenRequestUrl string,
 ) (string, error) {
 
@@ -282,11 +282,11 @@ func (m *HarborCli) PublishImageAndSign(
 
 // Sign signs a container image using Cosign, works also with GitHub Actions
 func (m *HarborCli) Sign(ctx context.Context,
-// +optional
+	// +optional
 	githubToken *dagger.Secret,
-// +optional
+	// +optional
 	actionsIdTokenRequestUrl string,
-// +optional
+	// +optional
 	actionsIdTokenRequestToken *dagger.Secret,
 	registryUsername string,
 	registryPassword *dagger.Secret,

diff --git a/go.mod b/go.mod
@@ -11,6 +11,7 @@ require (
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0
+	golang.org/x/term v0.6.0
 )
 
 require (

diff --git a/go.sum b/go.sum
@@ -179,6 +179,8 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
 golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw=
+golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U=
 golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
 golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

diff --git a/pkg/utils/utils.go b/pkg/utils/utils.go
@@ -3,6 +3,7 @@ package utils
 import (
 	"encoding/json"
 	"fmt"
+	"regexp"
 	"strings"
 
 	log "github.com/sirupsen/logrus"
@@ -38,3 +39,11 @@ func ParseProjectRepoReference(projectRepoReference string) (string, string, str
 	}
 	return split[0], split[1], split[2]
 }
+
+func SanitizeServerAddress(server string) string {
+	re := regexp.MustCompile(`^https?://`)
+	server = re.ReplaceAllString(server, "")
+	re = regexp.MustCompile(`[^a-zA-Z0-9]`)
+	server = re.ReplaceAllString(server, "-")
+	return server
+}
diff --git a/pkg/views/login/create.go b/pkg/views/login/create.go
@@ -2,6 +2,7 @@ package login
 
 import (
 	"errors"
+	"fmt"
 	"net/url"
 	"strings"
 
@@ -19,10 +20,12 @@ type LoginView struct {
 
 func CreateView(loginView *LoginView) {
 	theme := huh.ThemeCharm()
+
 	err := huh.NewForm(
 		huh.NewGroup(
 			huh.NewInput().
 				Title("Server").
+				Description("Server address eg. demo.goharbor.io").
 				Value(&loginView.Server).
 				Validate(func(str string) error {
 					if strings.TrimSpace(str) == "" {
@@ -62,17 +65,25 @@ func CreateView(loginView *LoginView) {
 			huh.NewInput().
 				Title("Name of Credential").
 				Value(&loginView.Name).
+				Description("Name of credential to be stored in the harbor config file.").
+				PlaceholderFunc(func() string {
+					return fmt.Sprintf("%s@%s", loginView.Username, utils.SanitizeServerAddress(loginView.Server))
+				}, &loginView).
+				SuggestionsFunc(func() []string {
+					return []string{
+						fmt.Sprintf("%s@%s", loginView.Username, utils.SanitizeServerAddress(loginView.Server)),
+					}
+				}, &loginView).
 				Validate(func(str string) error {
 					if str == "" {
-						return errors.New("credential name cannot be empty")
+						loginView.Name = fmt.Sprintf("%s@%s", loginView.Username, utils.SanitizeServerAddress(loginView.Server))
+						return nil
 					}
 					return nil
 				}),
 		),
 	).WithTheme(theme).Run()
-
 	if err != nil {
 		log.Fatal(err)
 	}
-
 }