Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1cf3101f78 |
@@ -61,10 +61,6 @@ linters:
|
|||||||
desc: >-
|
desc: >-
|
||||||
Test-support code belongs in test files and in packages whose
|
Test-support code belongs in test files and in packages whose
|
||||||
directory name ends in test, not in the shipped binary.
|
directory name ends in test, not in the shipped binary.
|
||||||
- pkg: sneak.berlin/go/neoirc/internal/dbtest
|
|
||||||
desc: >-
|
|
||||||
Test-support code belongs in test files and in packages whose
|
|
||||||
directory name ends in test, not in the shipped binary.
|
|
||||||
# Only decisions already recorded in the Go package defaults are
|
# Only decisions already recorded in the Go package defaults are
|
||||||
# listed here. Every entry matches the module path exactly.
|
# listed here. Every entry matches the module path exactly.
|
||||||
gomodguard_v2:
|
gomodguard_v2:
|
||||||
|
|||||||
@@ -1,73 +1,55 @@
|
|||||||
# Rules for coding agents
|
# AGENTS.md — Rules for AI Agents
|
||||||
|
|
||||||
This file holds the rules for coding agents working in this repository.
|
## Before Every Commit
|
||||||
`CONVENTIONS.md` defines the architecture. `REPO_POLICIES.md` defines the
|
|
||||||
repository standards. Both are copies of shared documents. Do not edit them
|
|
||||||
here.
|
|
||||||
|
|
||||||
## Before every commit
|
1. **Format**: `make fmt`
|
||||||
|
2. **Check**: `make check` — the tests and the linter, which run in Docker, and
|
||||||
|
the format check: all passing, zero issues
|
||||||
|
|
||||||
1. Run `make fmt`.
|
Never run `go test`, `golangci-lint` or `gofmt` directly; use the `make`
|
||||||
2. Run `make check`. It runs the tests and the linter in Docker, then the format
|
targets.
|
||||||
check. All three must pass with no findings.
|
|
||||||
|
|
||||||
Never run `go test`, `golangci-lint` or `gofmt` directly. Use the `make` targets
|
No commit lands on main with lint errors, test failures, or formatting issues.
|
||||||
instead, such as `make test` and `make lint`.
|
|
||||||
|
|
||||||
## Branches and pull requests
|
## Code Style
|
||||||
|
|
||||||
- Never commit to `main` or `next` directly. Every change is a pull request from
|
- Follow CONVENTIONS.md exactly — it defines the architecture
|
||||||
a feature branch into `next`.
|
- All exported types, functions, methods, and vars must have doc comments
|
||||||
- Only the owner merges `next` into `main`.
|
- All packages must have a package doc comment
|
||||||
- A pull request that closes an issue has the title `Description (closes #N)`.
|
- JSON tags use camelCase (not snake_case)
|
||||||
- One logical change per commit.
|
- No magic numbers — use named constants
|
||||||
- Commit messages are in the imperative mood and short.
|
- No inline error handling (`if err := ...; err != nil`) — use plain assignment
|
||||||
|
- Blank line before every `return` statement
|
||||||
|
- Blank line separating embedded fields from regular fields in structs
|
||||||
|
- Blank imports must have a justification comment
|
||||||
|
|
||||||
## Code style
|
## Git Workflow
|
||||||
|
|
||||||
- Follow `CONVENTIONS.md`.
|
- **Never commit directly to main** — all changes go on feature branches
|
||||||
- Outside test files, every package has a package doc comment.
|
- Merge to main only when ready and passing all checks
|
||||||
- Outside test files, every exported type, function and variable has a doc
|
- PR titles: `Description (closes #N)` when closing an issue
|
||||||
comment.
|
- One logical change per commit
|
||||||
- JSON tags are camelCase. The HTTP API's `last_id`, `pow_token` and
|
- Commit messages: imperative mood, concise
|
||||||
`hashcash_bits` stay as they are, each with a `//nolint:tagliatelle` comment.
|
|
||||||
- Prefer named constants to magic numbers. The `mnd` linter checks for them
|
|
||||||
outside test files.
|
|
||||||
- No inline error handling such as `if err := f(); err != nil`. Assign the error
|
|
||||||
on its own line, then test it.
|
|
||||||
- A `return` that follows another statement in its block has a blank line before
|
|
||||||
it.
|
|
||||||
- A blank line between the embedded fields of a struct and its other fields.
|
|
||||||
- Outside test files, every blank import has a comment saying why it is there.
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
- The server uses `go.uber.org/fx` for dependency injection.
|
- Dependency injection via Uber fx — all components are fx providers
|
||||||
`cmd/neoircd/main.go` lists its `fx` providers, such as `db.New` and
|
- `internal/` for all application packages — one package per concern
|
||||||
`handlers.New`.
|
- Handlers return `http.HandlerFunc` using the closure pattern
|
||||||
- Application packages live under `internal/`, one package per concern.
|
- Request/response structs defined inside handler closures
|
||||||
- `pkg/irc` holds the IRC command names and numeric reply codes.
|
- Models embed `models.Base` for database access to relation methods
|
||||||
- The `web` package embeds the built web client.
|
- Database migrations in `internal/db/schema/` — embedded via `go:embed`
|
||||||
- Each exported `Handle…` method of `Handlers` returns an `http.HandlerFunc`.
|
- SQLite by default (pure Go driver: modernc.org/sqlite)
|
||||||
- A request struct is defined inside the method that decodes it.
|
|
||||||
- The server uses the database only through the methods of `db.Database`.
|
|
||||||
- The database migrations live in `internal/db/schema/` and are embedded with
|
|
||||||
`go:embed`.
|
|
||||||
- The database is SQLite, through the pure Go driver `modernc.org/sqlite`.
|
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
- Prefer table-driven tests.
|
- Table-driven tests preferred
|
||||||
- Use `testing.T` helpers, not assertion libraries.
|
- Use `testing.T` helpers, not assertion libraries
|
||||||
- A test file lives next to the code it tests and ends in `_test.go`.
|
- Test files live next to the code they test
|
||||||
- The linter requires each test file to be in the package's external test
|
- `_test.go` suffix, same package for white-box testing
|
||||||
package, such as `handlers_test`. It allows `export_test.go` and files ending
|
|
||||||
in `_internal_test.go` in the package itself.
|
|
||||||
- An `export_test.go` file gives the external tests access to the package's
|
|
||||||
unexported code.
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
- The required libraries are listed in `CONVENTIONS.md` §1.
|
- Required libraries are listed in CONVENTIONS.md §1
|
||||||
- No new dependency without a reason given in the pull request.
|
- No new dependencies without justification
|
||||||
- Prefer dependencies written in pure Go, which build without cgo.
|
- Pure Go preferred (no CGO)
|
||||||
|
|||||||
@@ -3342,7 +3342,6 @@ neoirc/
|
|||||||
│ │ └── schema/
|
│ │ └── schema/
|
||||||
│ │ ├── 000.sql # schema_migrations bootstrap
|
│ │ ├── 000.sql # schema_migrations bootstrap
|
||||||
│ │ └── 001_initial.sql
|
│ │ └── 001_initial.sql
|
||||||
│ ├── dbtest/ # Gives each test its own database; only tests import it
|
|
||||||
│ ├── globals/ # Application-wide metadata
|
│ ├── globals/ # Application-wide metadata
|
||||||
│ │ └── globals.go
|
│ │ └── globals.go
|
||||||
│ ├── handlers/ # HTTP request handlers
|
│ ├── handlers/ # HTTP request handlers
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ import (
|
|||||||
"go.uber.org/fx/fxtest"
|
"go.uber.org/fx/fxtest"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
)
|
)
|
||||||
@@ -156,52 +155,6 @@ func TestForeignKeysOnAfterCancelledQuery(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestNewURLKeepsDataAfterCancelledQuery cancels a query on a test
|
|
||||||
// database while it runs, which makes the pool close its only
|
|
||||||
// connection and open a new one. A TEMP table lasts only as long as
|
|
||||||
// its connection, so its absence shows the connection was replaced.
|
|
||||||
// The database must still have its tables and rows.
|
|
||||||
func TestNewURLKeepsDataAfterCancelledQuery(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
database, err := startDatabase(t, dbtest.NewURL(t))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = database.GetOrCreateChannel(t.Context(), "#test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(
|
|
||||||
t.Context(), "CREATE TEMP TABLE first_connection (x)",
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(t.Context(), endlessQueryTimeout)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(ctx, endlessQuery)
|
|
||||||
if !errors.Is(err, context.DeadlineExceeded) {
|
|
||||||
t.Fatalf("endless query: err = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tempTables := queryInt(
|
|
||||||
t, database, "SELECT COUNT(*) FROM sqlite_temp_schema",
|
|
||||||
)
|
|
||||||
if tempTables != 0 {
|
|
||||||
t.Fatal("the pool kept its first connection")
|
|
||||||
}
|
|
||||||
|
|
||||||
channels := queryInt(t, database, "SELECT COUNT(*) FROM channels")
|
|
||||||
if channels != 1 {
|
|
||||||
t.Errorf("channels = %d, want 1", channels)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDBURLSettingForeignKeysFailsStartup checks that the database
|
// TestDBURLSettingForeignKeysFailsStartup checks that the database
|
||||||
// refuses to start when DBURL sets foreign_keys itself, however it
|
// refuses to start when DBURL sets foreign_keys itself, however it
|
||||||
// is spelled.
|
// is spelled.
|
||||||
|
|||||||
@@ -5,16 +5,21 @@ import (
|
|||||||
"database/sql"
|
"database/sql"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"testing"
|
"sync/atomic"
|
||||||
|
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// NewTestDatabase creates an in-memory database for testing.
|
//nolint:gochecknoglobals // test counter
|
||||||
func NewTestDatabase(tb testing.TB) (*Database, error) {
|
var testDBCounter atomic.Int64
|
||||||
tb.Helper()
|
|
||||||
|
|
||||||
dsn := dbtest.NewURL(tb) + "&_pragma=foreign_keys(1)"
|
// NewTestDatabase creates an in-memory database for testing.
|
||||||
|
func NewTestDatabase() (*Database, error) {
|
||||||
|
counter := testDBCounter.Add(1)
|
||||||
|
|
||||||
|
dsn := fmt.Sprintf(
|
||||||
|
"file:testdb%d?mode=memory"+
|
||||||
|
"&cache=shared&_pragma=foreign_keys(1)",
|
||||||
|
counter,
|
||||||
|
)
|
||||||
|
|
||||||
conn, err := sql.Open("sqlite", dsn)
|
conn, err := sql.Open("sqlite", dsn)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
func setupTestDB(t *testing.T) *db.Database {
|
func setupTestDB(t *testing.T) *db.Database {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
database, err := db.NewTestDatabase(t)
|
database, err := db.NewTestDatabase()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
// Package dbtest gives each test a database of its own. Only tests
|
|
||||||
// may import it.
|
|
||||||
package dbtest
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/rand"
|
|
||||||
"database/sql"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
_ "modernc.org/sqlite" // registers the sqlite driver
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewURL returns the URL of a new, empty in-memory database for one
|
|
||||||
// test. SQLite deletes an in-memory database when its last connection
|
|
||||||
// closes. A pool closes a connection when a query on it is cancelled
|
|
||||||
// while it runs. So this function holds a connection of its own open
|
|
||||||
// until the test ends.
|
|
||||||
func NewURL(tb testing.TB) string {
|
|
||||||
tb.Helper()
|
|
||||||
|
|
||||||
// A random name, so that no other test can share the database.
|
|
||||||
dbURL := "file:" + rand.Text() + "?mode=memory&cache=shared"
|
|
||||||
|
|
||||||
pool, err := sql.Open("sqlite", dbURL)
|
|
||||||
if err != nil {
|
|
||||||
tb.Fatalf("open test database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tb.Cleanup(func() { _ = pool.Close() })
|
|
||||||
|
|
||||||
conn, err := pool.Conn(tb.Context())
|
|
||||||
if err != nil {
|
|
||||||
tb.Fatalf("connect to test database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tb.Cleanup(func() { _ = conn.Close() })
|
|
||||||
|
|
||||||
return dbURL
|
|
||||||
}
|
|
||||||
@@ -3,6 +3,7 @@ package handlers_test
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
@@ -27,7 +28,6 @@ import (
|
|||||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
api "sneak.berlin/go/neoirc/internal/cli/api"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/handlers"
|
"sneak.berlin/go/neoirc/internal/handlers"
|
||||||
"sneak.berlin/go/neoirc/internal/hashcash"
|
"sneak.berlin/go/neoirc/internal/hashcash"
|
||||||
@@ -164,7 +164,13 @@ func newTestServerWith(
|
|||||||
viperMu.Lock()
|
viperMu.Lock()
|
||||||
defer viperMu.Unlock()
|
defer viperMu.Unlock()
|
||||||
|
|
||||||
dbURL := dbtest.NewURL(t)
|
// A random name, so that no other test can share it, not
|
||||||
|
// even one that has finished but still holds its database
|
||||||
|
// open.
|
||||||
|
dbURL := fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared",
|
||||||
|
rand.Text(),
|
||||||
|
)
|
||||||
copyTemplateDB(t, dbURL)
|
copyTemplateDB(t, dbURL)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package ircserver_test
|
|||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
@@ -19,7 +20,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
@@ -107,7 +107,14 @@ func newTestEnvWithResolver(
|
|||||||
) *testEnv {
|
) *testEnv {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
conn, err := sql.Open("sqlite", dbtest.NewURL(t))
|
// A random name, so that no other test environment, not
|
||||||
|
// even an earlier run of the same test, can share it.
|
||||||
|
dsn := fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared",
|
||||||
|
rand.Text(),
|
||||||
|
)
|
||||||
|
|
||||||
|
conn, err := sql.Open("sqlite", dsn)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("open db: %v", err)
|
t.Fatalf("open db: %v", err)
|
||||||
}
|
}
|
||||||
@@ -137,6 +144,20 @@ func newTestEnvWithResolver(
|
|||||||
|
|
||||||
brk := broker.New()
|
brk := broker.New()
|
||||||
|
|
||||||
|
var listenConfig net.ListenConfig
|
||||||
|
|
||||||
|
listener, err := listenConfig.Listen(t.Context(), "tcp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("listen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
addr := listener.Addr().String()
|
||||||
|
|
||||||
|
err = listener.Close()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("close listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
os.Stderr,
|
os.Stderr,
|
||||||
&slog.HandlerOptions{Level: slog.LevelError}, //nolint:exhaustruct
|
&slog.HandlerOptions{Level: slog.LevelError}, //nolint:exhaustruct
|
||||||
@@ -146,9 +167,7 @@ func newTestEnvWithResolver(
|
|||||||
log, cfg, database, brk, interval, deadline, resolve,
|
log, cfg, database, brk, interval, deadline, resolve,
|
||||||
)
|
)
|
||||||
|
|
||||||
// Port 0 makes the system pick a free port. dial reads it
|
err = srv.Start(addr)
|
||||||
// back from the server's listener.
|
|
||||||
err = srv.Start("127.0.0.1:0")
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("start irc server: %v", err)
|
t.Fatalf("start irc server: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,12 +15,6 @@ func NewTestSPAServer() *Server {
|
|||||||
return srv
|
return srv
|
||||||
}
|
}
|
||||||
|
|
||||||
// Listener returns the listener the start hook bound for the
|
|
||||||
// HTTP server.
|
|
||||||
func (srv *Server) Listener() net.Listener {
|
|
||||||
return srv.listener
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServeUntilShutdown runs serveUntilShutdown, which serves the
|
// ServeUntilShutdown runs serveUntilShutdown, which serves the
|
||||||
// HTTP server on listener, and returns when it does.
|
// HTTP server on listener, and returns when it does.
|
||||||
func (srv *Server) ServeUntilShutdown(listener net.Listener) {
|
func (srv *Server) ServeUntilShutdown(listener net.Listener) {
|
||||||
|
|||||||
@@ -50,7 +50,6 @@ type Server struct {
|
|||||||
sentryEnabled bool
|
sentryEnabled bool
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
httpServer *http.Server
|
httpServer *http.Server
|
||||||
listener net.Listener
|
|
||||||
router *chi.Mux
|
router *chi.Mux
|
||||||
params Params
|
params Params
|
||||||
mw *middleware.Middleware
|
mw *middleware.Middleware
|
||||||
@@ -180,8 +179,6 @@ func (srv *Server) startHTTP(ctx context.Context) error {
|
|||||||
return fmt.Errorf("http listen: %w", err)
|
return fmt.Errorf("http listen: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
srv.listener = listener
|
|
||||||
|
|
||||||
srv.httpServer = &http.Server{ //nolint:exhaustruct // optional fields
|
srv.httpServer = &http.Server{ //nolint:exhaustruct // optional fields
|
||||||
Addr: listenAddr,
|
Addr: listenAddr,
|
||||||
ReadTimeout: httpReadTimeout,
|
ReadTimeout: httpReadTimeout,
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
package server_test
|
package server_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"crypto/rand"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -18,7 +19,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/handlers"
|
"sneak.berlin/go/neoirc/internal/handlers"
|
||||||
"sneak.berlin/go/neoirc/internal/healthcheck"
|
"sneak.berlin/go/neoirc/internal/healthcheck"
|
||||||
@@ -45,9 +45,10 @@ const (
|
|||||||
// for a long poll the HTTP server is serving to finish, and
|
// for a long poll the HTTP server is serving to finish, and
|
||||||
// that the poll gets its response.
|
// that the poll gets its response.
|
||||||
func TestStopWaitsForRequestInProgress(t *testing.T) {
|
func TestStopWaitsForRequestInProgress(t *testing.T) {
|
||||||
var srv *server.Server
|
port := freePort(t)
|
||||||
|
addr := net.JoinHostPort("127.0.0.1", strconv.Itoa(port))
|
||||||
|
|
||||||
app, brk, database := startApp(t, fx.Populate(&srv))
|
app, brk, database := startApp(t, port)
|
||||||
|
|
||||||
sessionID, _, token, err := database.CreateSession(
|
sessionID, _, token, err := database.CreateSession(
|
||||||
t.Context(), "poller", "poller", "", "",
|
t.Context(), "poller", "poller", "", "",
|
||||||
@@ -56,12 +57,9 @@ func TestStopWaitsForRequestInProgress(t *testing.T) {
|
|||||||
t.Fatalf("create session: %v", err)
|
t.Fatalf("create session: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
tcpAddr, ok := srv.Listener().Addr().(*net.TCPAddr)
|
waitUntil(t, "the HTTP server to listen", func() bool {
|
||||||
if !ok {
|
return canConnect(t, addr)
|
||||||
t.Fatalf("listener address %v is not TCP", srv.Listener().Addr())
|
})
|
||||||
}
|
|
||||||
|
|
||||||
addr := net.JoinHostPort("127.0.0.1", strconv.Itoa(tcpAddr.Port))
|
|
||||||
|
|
||||||
statuses := make(chan int, 1)
|
statuses := make(chan int, 1)
|
||||||
|
|
||||||
@@ -147,7 +145,7 @@ func TestStartFailsWhenHTTPPortIsTaken(t *testing.T) {
|
|||||||
func TestServeFailureStopsApp(t *testing.T) {
|
func TestServeFailureStopsApp(t *testing.T) {
|
||||||
var srv *server.Server
|
var srv *server.Server
|
||||||
|
|
||||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
app, _, _ := startApp(t, freePort(t), fx.Populate(&srv))
|
||||||
|
|
||||||
shutdowns := app.Wait()
|
shutdowns := app.Wait()
|
||||||
|
|
||||||
@@ -170,7 +168,7 @@ func TestServeFailureStopsApp(t *testing.T) {
|
|||||||
func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
||||||
var srv *server.Server
|
var srv *server.Server
|
||||||
|
|
||||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
app, _, _ := startApp(t, freePort(t), fx.Populate(&srv))
|
||||||
|
|
||||||
shutdowns := app.Wait()
|
shutdowns := app.Wait()
|
||||||
|
|
||||||
@@ -188,15 +186,16 @@ func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// startApp starts the app newApp builds, with the HTTP port
|
// startApp starts the app newApp builds, with the HTTP server
|
||||||
// set to 0, so the system gives the server a free port.
|
// listening on port.
|
||||||
func startApp(
|
func startApp(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
|
port int,
|
||||||
options ...fx.Option,
|
options ...fx.Option,
|
||||||
) (*fxtest.App, *broker.Broker, *db.Database) {
|
) (*fxtest.App, *broker.Broker, *db.Database) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
app, brk, database := newApp(t, 0, options...)
|
app, brk, database := newApp(t, port, options...)
|
||||||
|
|
||||||
app.RequireStart()
|
app.RequireStart()
|
||||||
|
|
||||||
@@ -242,7 +241,10 @@ func newApp(
|
|||||||
stats.New,
|
stats.New,
|
||||||
),
|
),
|
||||||
fx.Decorate(func(cfg *config.Config) *config.Config {
|
fx.Decorate(func(cfg *config.Config) *config.Config {
|
||||||
cfg.DBURL = dbtest.NewURL(t)
|
// A random name, so that no other test can share it.
|
||||||
|
cfg.DBURL = fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared", rand.Text(),
|
||||||
|
)
|
||||||
cfg.Port = port
|
cfg.Port = port
|
||||||
|
|
||||||
return cfg
|
return cfg
|
||||||
@@ -255,6 +257,21 @@ func newApp(
|
|||||||
return app, brk, database
|
return app, brk, database
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// freePort returns a TCP port that nothing was listening on a
|
||||||
|
// moment ago.
|
||||||
|
func freePort(t *testing.T) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
listener := closedListener(t)
|
||||||
|
|
||||||
|
tcpAddr, ok := listener.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("listener address %v is not TCP", listener.Addr())
|
||||||
|
}
|
||||||
|
|
||||||
|
return tcpAddr.Port
|
||||||
|
}
|
||||||
|
|
||||||
// closedListener returns a TCP listener that has already been
|
// closedListener returns a TCP listener that has already been
|
||||||
// closed, so that accepting a connection on it fails.
|
// closed, so that accepting a connection on it fails.
|
||||||
func closedListener(t *testing.T) net.Listener {
|
func closedListener(t *testing.T) net.Listener {
|
||||||
@@ -277,6 +294,22 @@ func closedListener(t *testing.T) net.Listener {
|
|||||||
return listener
|
return listener
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// canConnect reports whether addr accepts a TCP connection.
|
||||||
|
func canConnect(t *testing.T, addr string) bool {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var dialer net.Dialer
|
||||||
|
|
||||||
|
conn, err := dialer.DialContext(t.Context(), "tcp", addr)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = conn.Close()
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// waitUntil calls done every checkStep until it returns true,
|
// waitUntil calls done every checkStep until it returns true,
|
||||||
// and fails the test if it does not within testTimeout.
|
// and fails the test if it does not within testTimeout.
|
||||||
func waitUntil(t *testing.T, what string, done func() bool) {
|
func waitUntil(t *testing.T, what string, done func() bool) {
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ package service_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
@@ -22,7 +23,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/hashcash"
|
"sneak.berlin/go/neoirc/internal/hashcash"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
@@ -46,7 +46,13 @@ type testEnv struct {
|
|||||||
func newTestEnv(t *testing.T) *testEnv {
|
func newTestEnv(t *testing.T) *testEnv {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
dbURL := dbtest.NewURL(t)
|
// A random name, so that no other test can share it, not
|
||||||
|
// even one that has finished but still holds its database
|
||||||
|
// open.
|
||||||
|
dbURL := fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared",
|
||||||
|
rand.Text(),
|
||||||
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
database *db.Database
|
database *db.Database
|
||||||
|
|||||||
Reference in New Issue
Block a user