Log a warning when SSH user cleanup fails

There might be situations (like network connectivity loss) during the
SSH command that could fail the SSH user cleanup. Log a warning when
that happens to notify that there might be artifacts left over on the
VM.

Author: Rajath Agasthya

cmd/cmd.go

@@ -391,7 +391,7 @@ func (c Cmd) Execute() (cmdErr error) {
 
 		if opts.TargetDirector {
 			agentClientFactory := bihttpagent.NewAgentClientFactory(1*time.Second, deps.Logger)
-			return NewEnvSSHCmd(agentClientFactory, intSSHRunner, nonIntSSHRunner, resultsSSHRunner, deps.UI).Run(*opts)
+			return NewEnvSSHCmd(agentClientFactory, intSSHRunner, nonIntSSHRunner, resultsSSHRunner, deps.UI, deps.Logger).Run(*opts)
 		} else {
 			sshHostBuilder := boshssh.NewHostBuilder()
 			return NewSSHCmd(intSSHRunner, nonIntSSHRunner, resultsSSHRunner, deps.UI, sshHostBuilder).Run(*opts, c.getDeployment)

cmd/ssh.go

@@ -2,9 +2,11 @@ package cmd
 
 import (
 	"errors"
+	"fmt"
 
 	bihttpagent "github.com/cloudfoundry/bosh-agent/v2/agentclient/http"
 	bosherr "github.com/cloudfoundry/bosh-utils/errors"
+	boshlog "github.com/cloudfoundry/bosh-utils/logger"
 
 	. "github.com/cloudfoundry/bosh-cli/v7/cmd/opts" //nolint:staticcheck
 	boshdir "github.com/cloudfoundry/bosh-cli/v7/director"
@@ -113,6 +115,7 @@ type EnvSSHCmd struct {
 	nonIntSSHRunner    boshssh.Runner
 	resultsSSHRunner   boshssh.Runner
 	ui                 boshui.UI
+	logger             boshlog.Logger
 }
 
 func NewEnvSSHCmd(
@@ -121,13 +124,15 @@ func NewEnvSSHCmd(
 	nonIntSSHRunner boshssh.Runner,
 	resultsSSHRunner boshssh.Runner,
 	ui boshui.UI,
+	logger boshlog.Logger,
 ) EnvSSHCmd {
 	return EnvSSHCmd{
 		agentClientFactory: agentClientFactory,
 		intSSHRunner:       intSSHRunner,
 		nonIntSSHRunner:    nonIntSSHRunner,
 		resultsSSHRunner:   resultsSSHRunner,
 		ui:                 ui,
+		logger:             logger,
 	}
 }
 
@@ -167,7 +172,10 @@ func (c EnvSSHCmd) Run(opts SSHOpts) error {
 	}
 
 	defer func() {
-		_, _ = agentClient.CleanUpSSH(sshOpts.Username) //nolint:errcheck
+		_, err1 := agentClient.CleanUpSSH(sshOpts.Username)
+		if err1 != nil {
+			c.logger.Warn("SSH", fmt.Sprintf("SSH cleanup failed for user %s. Artifacts may be left over on the VM: %v", sshOpts.Username, err1))
+		}
 	}()
 
 	// host key will be returned by agent over HTTPS

cmd/ssh_test.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/cloudfoundry/bosh-agent/v2/agentclient"
 	mockhttpagent "github.com/cloudfoundry/bosh-agent/v2/agentclient/http/mocks"
+	boshlog "github.com/cloudfoundry/bosh-utils/logger"
 	fakeuuid "github.com/cloudfoundry/bosh-utils/uuid/fakes"
 	"github.com/golang/mock/gomock"
 	. "github.com/onsi/ginkgo/v2"
@@ -352,6 +353,7 @@ var _ = Describe("SSH", func() {
 			nonIntSSHRunner    *fakessh.FakeRunner
 			resultsSSHRunner   *fakessh.FakeRunner
 			ui                 *fakeui.FakeUI
+			logger             boshlog.Logger
 
 			uuidGen *fakeuuid.FakeGenerator
 
@@ -367,10 +369,11 @@ var _ = Describe("SSH", func() {
 			nonIntSSHRunner = &fakessh.FakeRunner{}
 			resultsSSHRunner = &fakessh.FakeRunner{}
 			ui = &fakeui.FakeUI{}
+			logger = boshlog.NewLogger(boshlog.LevelNone)
 
 			uuidGen = &fakeuuid.FakeGenerator{}
 
-			command = cmd.NewEnvSSHCmd(agentClientFactory, intSSHRunner, nonIntSSHRunner, resultsSSHRunner, ui)
+			command = cmd.NewEnvSSHCmd(agentClientFactory, intSSHRunner, nonIntSSHRunner, resultsSSHRunner, ui, logger)
 		})
 
 		AfterEach(func() {