Skip to content

Read password from terminal in automatic tag script #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vicentepinto98 merged 2 commits into from
Feb 27, 2024
Merged

Read password from terminal in automatic tag script #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea01fc2
Read password from terminal
vicentepinto98 Feb 26, 2024
caa2940
Update scripts/automatic_tag.go
vicentepinto98 Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,9 @@ test:

# AUTOMATIC TAG
sdk-tag-services:
@if [ "${password}" = "" ]; then \
go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path}; \
else \
go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path} --password ${password}; \
fi
@go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path};


sdk-tag-core:
@if [ "${password}" = "" ]; then \
go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path} --target core; \
else \
go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path} --target core --password ${password}; \
fi
@go run $(SCRIPTS_BASE)/automatic_tag.go --update-type ${update-type} --ssh-private-key-file-path ${ssh-private-key-file-path} --target core;

27 changes: 22 additions & 5 deletions scripts/automatic_tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ import (
"os"
"strconv"
"strings"
"syscall"

"github.com/go-git/go-git/v5"
"github.com/go-git/go-git/v5/config"
"github.com/go-git/go-git/v5/plumbing"
"github.com/go-git/go-git/v5/plumbing/transport/ssh"
"golang.org/x/mod/semver"
"golang.org/x/term"
)

const (
Expand All @@ -24,14 +26,13 @@ const (

updateTypeFlag = "update-type"
sshPrivateKeyFilePathFlag = "ssh-private-key-file-path"
passwordFlag = "password"
targetFlag = "target"
)

var (
updateTypes = []string{minor, patch}
targets = []string{allServices, core}
usage = "go run automatic_tag.go --update-type [minor|patch] --ssh-private-key-file-path path/to/private-key --password password --target [all-services|core]"
usage = "go run automatic_tag.go --update-type [minor|patch] --ssh-private-key-file-path path/to/private-key --target [all-services|core]"
)

func main() {
Expand All @@ -44,12 +45,10 @@ func main() {
func run() error {
var updateType string
var sshPrivateKeyFilePath string
var password string
var target string

flag.StringVar(&updateType, updateTypeFlag, "", fmt.Sprintf("Update type, must be one of: %s (required)", strings.Join(updateTypes, ",")))
flag.StringVar(&sshPrivateKeyFilePath, sshPrivateKeyFilePathFlag, "", "Path to the ssh private key (required)")
flag.StringVar(&password, passwordFlag, "", "Password of the ssh private key (optional)")
flag.StringVar(&target, targetFlag, allServices, fmt.Sprintf("Create tags for this target, must be one of %s (optional, default is %s)", strings.Join(targets, ","), allServices))

flag.Parse()
Expand Down Expand Up @@ -81,13 +80,31 @@ func run() error {
return fmt.Errorf("the provided private key file path %s is not valid: %w\nUsage: %s", sshPrivateKeyFilePath, err, usage)
}

password, err := promptForPassword()
if err != nil {
return fmt.Errorf("prompt for password: %s", err.Error())
}

fmt.Println("Starting automatic tag update...")

err = automaticTagUpdate(updateType, sshPrivateKeyFilePath, password, target)
if err != nil {
return fmt.Errorf("updating tags: %s", err.Error())
return fmt.Errorf("update tags: %s", err.Error())
}
return nil
}

// Prompts the user for the ssh key password.
func promptForPassword() (string, error) {
fmt.Print("Enter SSH key passphrase (empty for no passphrase): ")
defer fmt.Print("\n")
bytePassword, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
return "", fmt.Errorf("read password: %w", err)
}
return string(bytePassword), nil
}

// automaticTagUpdate goes through all of the existing tags, gets the latest for the target, creates a new one according to the updateType and pushes them
func automaticTagUpdate(updateType, sshPrivateKeyFilePath, password, target string) error {
tempDir, err := os.MkdirTemp("", "")
Expand Down
5 changes: 4 additions & 1 deletion scripts/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ module github.com/stackitcloud/stackit-sdk-go/scripts

go 1.18

require github.com/go-git/go-git/v5 v5.11.0
require (
github.com/go-git/go-git/v5 v5.11.0
golang.org/x/term v0.17.0
)

require (
dario.cat/mergo v1.0.0 // indirect
Expand Down
1 change: 1 addition & 0 deletions scripts/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U=
golang.org/x/term v0.17.0 h1:mkTF7LCd6WGJNL3K1Ad7kwxNfYAW6a8a8QqtMblp/4U=
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand Down