Skip to content
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

Jump to bottom

devshell: Don't output status if not on a tty #3624

Merged
merged 1 commit into from
Sep 19, 2023
Merged

devshell: Don't output status if not on a tty #3624

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 21 additions & 11 deletions mantle/cmd/kola/devshell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ func stripControlCharacters(s string) string {
}, s)
}

func displayStatusMsg(status, msg string, termMaxWidth int) {
func displayStatusMsg(ontty bool, status, msg string, termMaxWidth int) {
if !ontty {
return
}
s := strings.TrimSpace(msg)
if s == "" {
return
Expand All @@ -63,8 +66,11 @@ func displayStatusMsg(status, msg string, termMaxWidth int) {
}

func runDevShellSSH(ctx context.Context, builder *platform.QemuBuilder, conf *conf.Conf, sshCommand string) error {
if !term.IsTerminal(0) {
return fmt.Errorf("stdin is not a tty")
ontty := term.IsTerminal(0)
if sshCommand == "" {
if !ontty {
return fmt.Errorf("stdin is not a tty")
}
}
termMaxWidth, _, err := term.GetSize(0)
if err != nil {
Expand Down Expand Up @@ -170,6 +176,7 @@ func runDevShellSSH(ctx context.Context, builder *platform.QemuBuilder, conf *co

// Start the SSH client
sc := newSshClient(ip, agent.Socket, sshCommand)
sc.ontty = ontty
go sc.controlStartStop()

ready := false
Expand All @@ -187,7 +194,7 @@ func runDevShellSSH(ctx context.Context, builder *platform.QemuBuilder, conf *co
// a status message on the console.
case serialMsg := <-serialChan:
if !ready {
displayStatusMsg(statusMsg, serialMsg, termMaxWidth)
displayStatusMsg(ontty, statusMsg, serialMsg, termMaxWidth)
}
lastMsg = serialMsg
// monitor the err channel
Expand All @@ -201,7 +208,7 @@ func runDevShellSSH(ctx context.Context, builder *platform.QemuBuilder, conf *co

// monitor the instance state
case <-qemuWaitChan:
displayStatusMsg("DONE", "QEMU instance terminated", termMaxWidth)
displayStatusMsg(ontty, "DONE", "QEMU instance terminated", termMaxWidth)
return nil

// monitor the machine state events from console/serial logs
Expand Down Expand Up @@ -232,17 +239,17 @@ func runDevShellSSH(ctx context.Context, builder *platform.QemuBuilder, conf *co
statusMsg = "QEMU guest is booting"
}
}
displayStatusMsg(fmt.Sprintf("EVENT | %s", statusMsg), lastMsg, termMaxWidth)
displayStatusMsg(ontty, fmt.Sprintf("EVENT | %s", statusMsg), lastMsg, termMaxWidth)

// monitor the SSH connection
case err := <-sc.errChan:
if err == nil {
sc.controlChan <- sshNotReady
displayStatusMsg("SESSION", "Clean exit from SSH, terminating instance", termMaxWidth)
displayStatusMsg(ontty, "SESSION", "Clean exit from SSH, terminating instance", termMaxWidth)
return nil
} else if sshCommand != "" {
sc.controlChan <- sshNotReady
displayStatusMsg("SESSION", "SSH command exited, terminating instance", termMaxWidth)
displayStatusMsg(ontty, "SESSION", "SSH command exited, terminating instance", termMaxWidth)
return err
}
if ready {
Expand Down Expand Up @@ -455,6 +462,7 @@ type sshClient struct {
port string
agent string
cmd string
ontty bool
controlChan chan sshControlMessage
errChan chan error
sshCmd *exec.Cmd
Expand Down Expand Up @@ -511,8 +519,10 @@ func (sc *sshClient) start() {
if sc.cmd != "" {
sshArgs = append(sshArgs, "--", sc.cmd)
}
fmt.Printf("\033[2K\r") // clear serial console line
fmt.Printf("[SESSION] Starting SSH\r") // and stage a status msg which will be erased
if sc.ontty {
fmt.Printf("\033[2K\r") // clear serial console line
fmt.Printf("[SESSION] Starting SSH\r") // and stage a status msg which will be erased
}
sshCmd := exec.Command(sshArgs[0], sshArgs[1:]...)
sshCmd.Stdin = os.Stdin
sshCmd.Stdout = os.Stdout
Expand All @@ -531,7 +541,7 @@ func (sc *sshClient) start() {
for scanner.Scan() {
msg := scanner.Text()
if strings.Contains(msg, "Connection to 127.0.0.1 closed") {
displayStatusMsg("SSH", "connection closed", 0)
displayStatusMsg(sc.ontty, "SSH", "connection closed", 0)
}
}
}()
Expand Down
Loading