Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: Add support for MOTD file in coder agents #5147

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
merged 12 commits into from
Nov 24, 2022
Merged

feat: Add support for MOTD file in coder agents #5147

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
60953f2
feat: Add plumbing for motd file
mafredri Nov 22, 2022
797001b
feat: Print motd on SSH login sessions
mafredri Nov 22, 2022
5657cb0
chore: Unify homedir lookup in agent
mafredri Nov 22, 2022
df9bd37
chore: Add terraform test for motd_file
mafredri Nov 22, 2022
36dc446
Add motd and hushlogin test
mafredri Nov 22, 2022
80d35eb
Start session Shell vs Run
mafredri Nov 22, 2022
eabc6bd
Add migrations
mafredri Nov 22, 2022
2d7c6af
fix: Set HOME for motd test as well
mafredri Nov 23, 2022
5dba999
Rename migrations
mafredri Nov 23, 2022
073544f
Amend PR comments
mafredri Nov 24, 2022
9e6ca99
s/getHomeDir/userHomeDir/ get is less idiomatic
mafredri Nov 24, 2022
2e49654
Merge branch 'main' into mafredri/feat-motd
mafredri Nov 24, 2022
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
Prev Previous commit
Next Next commit
Add motd and hushlogin test
  • Loading branch information
@mafredri
mafredri committed Nov 23, 2022
commit 36dc4461e7d60237a2ddba33105d96bcef2e22c6
81 changes: 81 additions & 0 deletions agent/agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package agent_test

import (
"bufio"
"bytes"
"context"
"encoding/json"
"fmt"
Expand Down Expand Up @@ -193,6 +194,86 @@ func TestAgent(t *testing.T) {
}
})

t.Run("Session TTY MOTD", func(t *testing.T) {
t.Parallel()

if runtime.GOOS == "windows" {
// This might be our implementation, or ConPTY itself.
// It's difficult to find extensive tests for it, so
// it seems like it could be either.
t.Skip("ConPTY appears to be inconsistent on Windows.")
}

wantMOTD := "Welcome to your Coder workspace!"

name := filepath.Join(t.TempDir(), "motd")
err := os.WriteFile(name, []byte(wantMOTD), 0o600)
require.NoError(t, err, "write motd file")

session := setupSSHSession(t, codersdk.WorkspaceAgentMetadata{
MOTDFile: name,
})
err = session.RequestPty("xterm", 128, 128, ssh.TerminalModes{})
require.NoError(t, err)

ptty := ptytest.New(t)
var stdout bytes.Buffer
session.Stdout = &stdout
session.Stderr = ptty.Output()
session.Stdin = ptty.Input()
err = session.Start("")
require.NoError(t, err)

ptty.WriteLine("exit")
err = session.Wait()
require.NoError(t, err)

require.Contains(t, stdout.String(), wantMOTD, "should show motd")
})

//nolint:paralleltest // This test sets an environment variable.
t.Run("Session TTY Hushlogin", func(t *testing.T) {
if runtime.GOOS == "windows" {
// This might be our implementation, or ConPTY itself.
// It's difficult to find extensive tests for it, so
// it seems like it could be either.
t.Skip("ConPTY appears to be inconsistent on Windows.")
}

wantNotMOTD := "Welcome to your Coder workspace!"

tmpdir := t.TempDir()
name := filepath.Join(tmpdir, "motd")
err := os.WriteFile(name, []byte(wantNotMOTD), 0o600)
require.NoError(t, err, "write motd file")
f, err := os.Create(filepath.Join(tmpdir, ".hushlogin"))
require.NoError(t, err, "create .hushlogin file")
err = f.Close()
require.NoError(t, err, "close .hushlogin file")

t.Setenv("HOME", tmpdir)

session := setupSSHSession(t, codersdk.WorkspaceAgentMetadata{
MOTDFile: name,
})
err = session.RequestPty("xterm", 128, 128, ssh.TerminalModes{})
require.NoError(t, err)

ptty := ptytest.New(t)
var stdout bytes.Buffer
session.Stdout = &stdout
session.Stderr = ptty.Output()
session.Stdin = ptty.Input()
err = session.Start("")
require.NoError(t, err)

ptty.WriteLine("exit")
err = session.Wait()
require.NoError(t, err)

require.NotContains(t, stdout.String(), wantNotMOTD, "should not show motd")
})

t.Run("LocalForwarding", func(t *testing.T) {
t.Parallel()
random, err := net.Listen("tcp", "127.0.0.1:0")
Expand Down