Restore directory flag

ammario · ammario · commit 1ca5930c4a19 · 2023-06-06T22:12:45.000Z
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -50,7 +50,7 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 		identityAgent  string
 		wsPollInterval time.Duration
 		noWait         bool
-		logFilePath    string
+		logDirPath     string
 	)
 	client := new(codersdk.Client)
 	cmd := &clibase.Cmd{
@@ -73,11 +73,33 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 					logger.Error(ctx, "command exit", slog.Error(retErr))
 				}
 			}()
-			if logFilePath != "" {
-				logFile, err := os.OpenFile(logFilePath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o600)
+			if logDirPath != "" {
+				nonce, err := cryptorand.StringCharset(cryptorand.Lower, 5)
 				if err != nil {
-					return xerrors.Errorf("error opening %s for logging: %w", logFilePath, err)
+					panic(err)
 				}
+				logFilePath := filepath.Join(
+					logDirPath,
+					fmt.Sprintf(
+						"coder-ssh-%s-%s.log",
+						// The time portion makes it easier to find the right
+						// log file.
+						time.Now().Format("20060102-150405"),
+						// The nonce prevents collisions, as SSH invocations
+						// frequently happen in parallel.
+						nonce,
+					),
+				)
+				logFile, err := os.OpenFile(
+					logFilePath,
+					os.O_CREATE|os.O_APPEND|os.O_WRONLY|os.O_EXCL,
+					0o600,
+				)
+				if err != nil {
+					return xerrors.Errorf("error opening %s for logging: %w", logDirPath, err)
+				}
+				defer logFile.Close()
+
 				logger = slog.Make(sloghuman.Sink(logFile))
 				if r.verbose {
 					logger = logger.Leveled(slog.LevelDebug)
@@ -359,11 +381,11 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 			Value:       clibase.BoolOf(&noWait),
 		},
 		{
-			Flag:          "log-file",
-			Description:   "Specify the location of an SSH diagnostic log file.",
-			Env:           "CODER_SSH_LOG_FILE",
+			Flag:          "log-dir",
+			Description:   "Specify the directory containing SSH diagnostic log files.",
+			Env:           "CODER_SSH_LOG_DIR",
 			FlagShorthand: "l",
-			Value:         clibase.StringOf(&logFilePath),
+			Value:         clibase.StringOf(&logDirPath),
 		},
 	}
 	return cmd
diff --git a/cli/ssh_test.go b/cli/ssh_test.go
@@ -411,10 +411,10 @@ func TestSSH(t *testing.T) {
 	t.Run("FileLogging", func(t *testing.T) {
 		t.Parallel()
 
-		logFile := filepath.Join(t.TempDir(), "coder-ssh.log")
+		logDir := t.TempDir()
 
 		client, workspace, agentToken := setupWorkspaceForAgent(t, nil)
-		inv, root := clitest.New(t, "ssh", workspace.Name, "-l", logFile)
+		inv, root := clitest.New(t, "ssh", workspace.Name, "-l", logDir)
 		clitest.SetupConfig(t, client, root)
 		pty := ptytest.New(t).Attach(inv)
 
@@ -441,12 +441,10 @@ func TestSSH(t *testing.T) {
 		pty.WriteLine("exit")
 		<-cmdDone
 
-		info, err := os.Stat(logFile)
-		if err != nil {
-			t.Fatalf("failed to find ssh logfile: %v", err)
-		}
+		ents, err := os.ReadDir(t.TempDir())
+		require.NoError(t, err)
 
-		require.Greater(t, info.Size(), int64(0), "ssh logfile is empty")
+		require.Len(t, ents, 1, "expected one file in logdir")
 	})
 }
 
