Files
terdut-tui/internal/tui/login_test.go
T
Niklas Ye f4ca0059dc
CI / test (push) Successful in 12s
Release / test (push) Successful in 5s
Release / binaries (push) Successful in 12s
Sign in as a user instead of with an API key
The web UI signs in with a username and password and holds a session
cookie; the TUI was the only client still needing an API key pasted into
a config file. It now asks for the same credentials on a form at start.

What is kept between runs is the session token, not the password, in
session.json under the config directory, mode 0600 and keyed by server
URL so one server's token is never offered to another. It resumes on the
next start; the server's sessions last 30 days and slide with use. L
signs out, which ends the session on the server and deletes the saved
one even if the server cannot be reached.

The client attaches the cookie by hand instead of using a cookie jar:
the server marks it Secure behind https, and a jar drops a Secure cookie
it is given over plain http, which would break a local server for no
reason. It sends no Authorization header at all, since the server judges
a request carrying one on that alone and never falls back to the cookie.
Writes go through the server's cross-origin guard, which lets a client
that sends neither Origin nor Sec-Fetch-Site through; checked against a
real v0.20.1 server for both reads and writes.

A 401 from anything means the session is gone (expired, ended from the
web UI, or the account disabled), so the TUI returns to the form with the
reason, forgets the saved token, and drops what the last session loaded
rather than showing it to whoever signs in next. A 403 is a permission
and leaves the session alone. The refresh timer is started once, so
signing out and in does not leave two running.

An account with no password cannot sign in, and the server answers it
exactly like a wrong password, so the form's message says a password
must be set first. Users created only for API access hit this.

Breaking: api_key in config.yaml is no longer used. It is not an error
to leave it there; the form says it is ignored. API keys still exist on
the server and k in Users still manages them.
2026-09-23 22:15:14 +02:00

243 lines
8.1 KiB
Go

package tui
import (
"errors"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"git.ryuvia.com/niklas/terdut-tui/internal/api"
"git.ryuvia.com/niklas/terdut-tui/internal/session"
"git.ryuvia.com/niklas/terdut-tui/internal/theme"
tea "github.com/charmbracelet/bubbletea"
)
// signedOut is a model with no session, so it starts on the sign-in form.
func signedOut(serverURL string) Model {
m := NewModel(api.NewClient(serverURL), serverURL, time.Minute, theme.GruvboxDark)
m.width, m.height = 120, 40
return m
}
func TestStartsOnTheFormWithoutASession(t *testing.T) {
m := signedOut("http://test")
if m.mode != modeLogin {
t.Fatalf("expected the sign-in form, got mode %v", m.mode)
}
if m.Init() != nil {
t.Error("with no session there is nothing to connect with yet")
}
}
func TestStartsConnectedWithASavedSession(t *testing.T) {
c := api.NewClient("http://test")
c.SetSession("saved")
m := NewModel(c, "http://test", time.Minute, theme.GruvboxDark)
if m.mode == modeLogin {
t.Fatal("a saved session should be tried before asking for a password")
}
if m.Init() == nil {
t.Error("expected the saved session to be tried on start")
}
}
func TestLoginForm_ChecksBothFieldsBeforeSending(t *testing.T) {
m := signedOut("http://test")
m, cmd := press(t, m, "enter")
if cmd != nil || m.loggingIn || !strings.Contains(m.loginErr, "username") {
t.Errorf("an empty form must not be sent, got err %q", m.loginErr)
}
m = typeInto(t, m, "niklas")
m, cmd = press(t, m, "enter")
if cmd != nil || m.loggingIn || !strings.Contains(m.loginErr, "password") {
t.Errorf("a missing password must not be sent, got err %q", m.loginErr)
}
}
func TestLoginForm_QIsTypedNotQuit(t *testing.T) {
m := signedOut("http://test")
m = typeInto(t, m, "quentin")
if got := m.loginInputs[loginUsername].Value(); got != "quentin" {
t.Errorf("q is a letter in a username, got %q", got)
}
}
// The whole flow against a server: type both fields, submit, and the session is
// kept for the next run.
func TestLogin_SignsInAndSavesTheSession(t *testing.T) {
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
b, _ := io.ReadAll(r.Body)
if r.URL.Path != "/api/login" || string(b) != `{"username":"niklas","password":"secret-pass"}` {
t.Errorf("unexpected request %s %s", r.URL.Path, b)
}
http.SetCookie(w, &http.Cookie{Name: api.SessionCookie, Value: "tok-1", Path: "/"})
io.WriteString(w, `{}`)
}))
t.Cleanup(srv.Close)
m := signedOut(srv.URL)
m = typeInto(t, m, "niklas")
m, _ = press(t, m, "tab")
m = typeInto(t, m, "secret-pass")
m, cmd := press(t, m, "enter")
if !m.loggingIn || cmd == nil {
t.Fatal("expected the sign-in to be under way")
}
msg := cmd()
if _, ok := msg.(loginDoneMsg); !ok {
t.Fatalf("expected loginDoneMsg, got %#v", msg)
}
if got := session.Load(srv.URL); got != "tok-1" {
t.Errorf("expected the session saved for next time, got %q", got)
}
next, connect := m.Update(msg)
m = next.(Model)
if m.mode != modeDashboard || m.loggingIn || connect == nil {
t.Errorf("expected to move on and connect, got mode %v", m.mode)
}
if m.loginInputs[loginPassword].Value() != "" {
t.Error("the password must not be kept once it has been used")
}
}
func TestLogin_WrongPasswordStaysOnTheForm(t *testing.T) {
m := signedOut("http://test")
m.loggingIn = true
next, _ := m.Update(loginErrMsg{&api.StatusError{Code: 401, Message: "invalid username or password"}})
m = next.(Model)
if m.mode != modeLogin || m.loggingIn {
t.Fatalf("expected to be back on the form, got mode %v", m.mode)
}
// The server gives the same 401 for an account with no password, so the
// message has to say so or it reads as a typo.
if !strings.Contains(m.loginErr, "no password") {
t.Errorf("expected the no-password hint, got %q", m.loginErr)
}
if m.loginFocus != loginPassword {
t.Error("focus should return to the password to retry")
}
next, _ = m.Update(loginErrMsg{&api.StatusError{Code: 429, Message: "slow down"}})
if got := next.(Model).loginErr; !strings.Contains(got, "too many") {
t.Errorf("expected the rate limit explained, got %q", got)
}
next, _ = m.Update(loginErrMsg{errors.New("dial tcp: refused")})
if got := next.(Model).loginErr; !strings.Contains(got, "refused") {
t.Errorf("other errors should show as they are, got %q", got)
}
}
// A 401 anywhere means the session is gone. Every action would fail the same
// way, so it goes back to the form instead, without keeping the old data.
func TestUnauthorized_ReturnsToTheFormAndDropsTheData(t *testing.T) {
for name, msg := range map[string]tea.Msg{
"refresh": fetchDataErrMsg{&api.StatusError{Code: 401}},
"action": actionErrMsg{&api.StatusError{Code: 401}},
"schedule": scheduleActionErrMsg{&api.StatusError{Code: 401}},
"connect": connectErrMsg{&api.StatusError{Code: 401}},
} {
t.Run(name, func(t *testing.T) {
m := sized()
m.incidents = []api.Incident{{ID: 1, Title: "secret incident"}}
m.teams = twoTeams()
m.isAdmin = true
m.loginInputs[loginUsername].SetValue("niklas")
next, cmd := m.Update(msg)
m = next.(Model)
if m.mode != modeLogin || m.connected {
t.Fatalf("expected the sign-in form, got mode %v connected=%v", m.mode, m.connected)
}
if len(m.incidents) != 0 || len(m.teams) != 0 || m.isAdmin {
t.Error("the previous session's data must not survive into the next sign-in")
}
if cmd == nil {
t.Error("the dead session should be forgotten on disk")
}
if !strings.Contains(m.loginNote, "session") {
t.Errorf("expected the reason, got %q", m.loginNote)
}
if m.loginInputs[loginUsername].Value() != "niklas" || m.loginFocus != loginPassword {
t.Error("the username should be kept so only the password is retyped")
}
if strings.Contains(m.View(), "secret incident") {
t.Error("nothing from the old session may still be on screen")
}
})
}
}
// A 403 is a permission, not a lost session: it must not sign anybody out.
func TestForbidden_DoesNotSignOut(t *testing.T) {
m := sized()
next, _ := m.Update(actionErrMsg{&api.StatusError{Code: 403, Message: "administrator access required"}})
if got := next.(Model); got.mode == modeLogin || !got.connected {
t.Error("a 403 must leave the session alone")
}
}
func TestLogout(t *testing.T) {
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
m := sized()
m.teams = twoTeams()
m.incidents = []api.Incident{{ID: 1}}
m, cmd := press(t, m, "L")
if cmd == nil {
t.Fatal("L should sign out")
}
next, _ := m.Update(logoutDoneMsg{})
m = next.(Model)
if m.mode != modeLogin || m.connected || len(m.incidents) != 0 {
t.Errorf("expected the form with nothing loaded, got mode %v", m.mode)
}
if !strings.Contains(m.loginNote, "signed out") {
t.Errorf("expected it to say so, got %q", m.loginNote)
}
}
// Signing out and in again must not leave two refresh timers running, each
// re-arming itself for ever.
func TestSigningInAgainStartsNoSecondTimer(t *testing.T) {
m := sized()
next, _ := m.Update(connectedMsg{})
m = next.(Model)
if !m.ticking {
t.Fatal("the first connect starts the refresh timer")
}
m = m.requireLogin("x")
if !m.ticking {
t.Fatal("the timer is still running while signed out")
}
// Ticks while signed out must do nothing rather than fetch.
if _, cmd := m.Update(tickMsg(time.Now())); cmd == nil {
t.Error("the timer keeps ticking")
}
if cmd := m.refreshActiveSection(); cmd != nil {
t.Error("no refresh should be attempted while signed out")
}
}
func TestLoginView_HidesThePasswordAndShowsTheNote(t *testing.T) {
m := signedOut("https://terdut.example.com").WithLogin("niklas", "api_key in config.yaml is no longer used")
if m.loginFocus != loginPassword {
t.Error("with the username known the cursor should start on the password")
}
m = typeInto(t, m, "hunter2-hunter2")
view := m.View()
for _, want := range []string{"Sign in to https://terdut.example.com", "niklas", "api_key in config.yaml is no longer used"} {
if !strings.Contains(view, want) {
t.Errorf("expected %q on the form:\n%s", want, view)
}
}
if strings.Contains(view, "hunter2") {
t.Error("the password must be masked")
}
}