Compare commits
1 Commits
devin/1776
...
devin/1776
| Author | SHA1 | Date | |
|---|---|---|---|
| 174cbfde04 |
71
.github/workflows/e2e-full.yml
vendored
Normal file
71
.github/workflows/e2e-full.yml
vendored
Normal file
@@ -0,0 +1,71 @@
|
||||
name: e2e-full
|
||||
|
||||
# Boots the full explorer stack (docker-compose deps + backend + frontend)
|
||||
# and runs the Playwright full-stack smoke spec against it. Not on every
|
||||
# PR (too expensive) — runs on:
|
||||
#
|
||||
# * workflow_dispatch (manual)
|
||||
# * pull_request when the 'run-e2e-full' label is applied
|
||||
# * nightly at 04:00 UTC
|
||||
#
|
||||
# Screenshots from every route are uploaded as a build artefact so
|
||||
# reviewers can eyeball the render without having to boot the stack.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
types: [labeled, opened, synchronize, reopened]
|
||||
schedule:
|
||||
- cron: '0 4 * * *'
|
||||
|
||||
jobs:
|
||||
e2e-full:
|
||||
if: >
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'schedule' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
contains(github.event.pull_request.labels.*.name, 'run-e2e-full'))
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.23.x'
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package-lock.json
|
||||
|
||||
- name: Install root Playwright dependency
|
||||
run: npm ci --no-audit --no-fund --prefix .
|
||||
|
||||
- name: Run full-stack e2e
|
||||
env:
|
||||
JWT_SECRET: ${{ secrets.JWT_SECRET || 'ci-ephemeral-jwt-secret-not-for-prod' }}
|
||||
CSP_HEADER: "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' http://localhost:8080 ws://localhost:8080"
|
||||
run: make e2e-full
|
||||
|
||||
- name: Upload screenshots
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: e2e-screenshots
|
||||
path: test-results/screenshots/
|
||||
if-no-files-found: warn
|
||||
|
||||
- name: Upload playwright report
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: playwright-report
|
||||
path: |
|
||||
playwright-report/
|
||||
test-results/
|
||||
if-no-files-found: warn
|
||||
6
Makefile
6
Makefile
@@ -1,4 +1,4 @@
|
||||
.PHONY: help install dev build test test-e2e clean migrate
|
||||
.PHONY: help install dev build test test-e2e e2e-full clean migrate
|
||||
|
||||
help:
|
||||
@echo "Available targets:"
|
||||
@@ -7,6 +7,7 @@ help:
|
||||
@echo " build - Build all services"
|
||||
@echo " test - Run backend + frontend tests (go test, lint, type-check)"
|
||||
@echo " test-e2e - Run Playwright E2E tests (default: explorer.d-bis.org)"
|
||||
@echo " e2e-full - Boot full stack locally (docker compose + backend + frontend) and run Playwright"
|
||||
@echo " clean - Clean build artifacts"
|
||||
@echo " migrate - Run database migrations"
|
||||
|
||||
@@ -35,6 +36,9 @@ test:
|
||||
test-e2e:
|
||||
npx playwright test
|
||||
|
||||
e2e-full:
|
||||
./scripts/e2e-full.sh
|
||||
|
||||
clean:
|
||||
cd backend && go clean ./...
|
||||
cd frontend && rm -rf .next node_modules
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
@@ -30,7 +31,11 @@ func (m *AuthMiddleware) RequireAuth(next http.Handler) http.Handler {
|
||||
return
|
||||
}
|
||||
|
||||
ctx := ContextWithAuth(r.Context(), address, track, true)
|
||||
// Add user context
|
||||
ctx := context.WithValue(r.Context(), "user_address", address)
|
||||
ctx = context.WithValue(ctx, "user_track", track)
|
||||
ctx = context.WithValue(ctx, "authenticated", true)
|
||||
|
||||
next.ServeHTTP(w, r.WithContext(ctx))
|
||||
})
|
||||
}
|
||||
@@ -39,7 +44,11 @@ func (m *AuthMiddleware) RequireAuth(next http.Handler) http.Handler {
|
||||
func (m *AuthMiddleware) RequireTrack(requiredTrack int) func(http.Handler) http.Handler {
|
||||
return func(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
track := UserTrack(r.Context())
|
||||
// Extract track from context (set by RequireAuth or OptionalAuth)
|
||||
track, ok := r.Context().Value("user_track").(int)
|
||||
if !ok {
|
||||
track = 1 // Default to Track 1 (public)
|
||||
}
|
||||
|
||||
if !featureflags.HasAccess(track, requiredTrack) {
|
||||
writeForbidden(w, requiredTrack)
|
||||
@@ -56,33 +65,40 @@ func (m *AuthMiddleware) OptionalAuth(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
address, track, err := m.extractAuth(r)
|
||||
if err != nil {
|
||||
// No auth provided (or auth failed) — fall back to Track 1.
|
||||
ctx := ContextWithAuth(r.Context(), "", defaultTrackLevel, false)
|
||||
// No auth provided, default to Track 1 (public)
|
||||
ctx := context.WithValue(r.Context(), "user_address", "")
|
||||
ctx = context.WithValue(ctx, "user_track", 1)
|
||||
ctx = context.WithValue(ctx, "authenticated", false)
|
||||
next.ServeHTTP(w, r.WithContext(ctx))
|
||||
return
|
||||
}
|
||||
|
||||
ctx := ContextWithAuth(r.Context(), address, track, true)
|
||||
// Auth provided, add user context
|
||||
ctx := context.WithValue(r.Context(), "user_address", address)
|
||||
ctx = context.WithValue(ctx, "user_track", track)
|
||||
ctx = context.WithValue(ctx, "authenticated", true)
|
||||
|
||||
next.ServeHTTP(w, r.WithContext(ctx))
|
||||
})
|
||||
}
|
||||
|
||||
// extractAuth extracts authentication information from the request.
|
||||
// Returns ErrMissingAuthorization when no usable Bearer token is present;
|
||||
// otherwise returns the error from JWT validation.
|
||||
// extractAuth extracts authentication information from request
|
||||
func (m *AuthMiddleware) extractAuth(r *http.Request) (string, int, error) {
|
||||
// Get Authorization header
|
||||
authHeader := r.Header.Get("Authorization")
|
||||
if authHeader == "" {
|
||||
return "", 0, ErrMissingAuthorization
|
||||
return "", 0, http.ErrMissingFile
|
||||
}
|
||||
|
||||
// Check for Bearer token
|
||||
parts := strings.Split(authHeader, " ")
|
||||
if len(parts) != 2 || parts[0] != "Bearer" {
|
||||
return "", 0, ErrMissingAuthorization
|
||||
return "", 0, http.ErrMissingFile
|
||||
}
|
||||
|
||||
token := parts[1]
|
||||
|
||||
// Validate JWT token
|
||||
address, track, err := m.walletAuth.ValidateJWT(token)
|
||||
if err != nil {
|
||||
return "", 0, err
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// ctxKey is an unexported type for request-scoped authentication values.
|
||||
// Using a distinct type (rather than a bare string) keeps our keys out of
|
||||
// collision range for any other package that also calls context.WithValue,
|
||||
// and silences go vet's SA1029.
|
||||
type ctxKey string
|
||||
|
||||
const (
|
||||
ctxKeyUserAddress ctxKey = "user_address"
|
||||
ctxKeyUserTrack ctxKey = "user_track"
|
||||
ctxKeyAuthenticated ctxKey = "authenticated"
|
||||
)
|
||||
|
||||
// Default track level applied to unauthenticated requests (Track 1 = public).
|
||||
const defaultTrackLevel = 1
|
||||
|
||||
// ErrMissingAuthorization is returned by extractAuth when no usable
|
||||
// Authorization header is present on the request. Callers should treat this
|
||||
// as "no auth supplied" rather than a hard failure for optional-auth routes.
|
||||
var ErrMissingAuthorization = errors.New("middleware: authorization header missing or malformed")
|
||||
|
||||
// ContextWithAuth returns a child context carrying the supplied
|
||||
// authentication state. It is the single place in the package that writes
|
||||
// the auth context keys.
|
||||
func ContextWithAuth(parent context.Context, address string, track int, authenticated bool) context.Context {
|
||||
ctx := context.WithValue(parent, ctxKeyUserAddress, address)
|
||||
ctx = context.WithValue(ctx, ctxKeyUserTrack, track)
|
||||
ctx = context.WithValue(ctx, ctxKeyAuthenticated, authenticated)
|
||||
return ctx
|
||||
}
|
||||
|
||||
// UserAddress returns the authenticated wallet address stored on ctx, or
|
||||
// "" if the context is not authenticated.
|
||||
func UserAddress(ctx context.Context) string {
|
||||
addr, _ := ctx.Value(ctxKeyUserAddress).(string)
|
||||
return addr
|
||||
}
|
||||
|
||||
// UserTrack returns the access tier recorded on ctx. If no track was set
|
||||
// (e.g. the request bypassed all auth middleware) the caller receives
|
||||
// Track 1 (public) so route-level checks can still make a decision.
|
||||
func UserTrack(ctx context.Context) int {
|
||||
if track, ok := ctx.Value(ctxKeyUserTrack).(int); ok {
|
||||
return track
|
||||
}
|
||||
return defaultTrackLevel
|
||||
}
|
||||
|
||||
// IsAuthenticated reports whether the current request carried a valid auth
|
||||
// token that was successfully parsed by the middleware.
|
||||
func IsAuthenticated(ctx context.Context) bool {
|
||||
ok, _ := ctx.Value(ctxKeyAuthenticated).(bool)
|
||||
return ok
|
||||
}
|
||||
@@ -1,62 +0,0 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestContextWithAuthRoundTrip(t *testing.T) {
|
||||
ctx := ContextWithAuth(context.Background(), "0xabc", 4, true)
|
||||
|
||||
if got := UserAddress(ctx); got != "0xabc" {
|
||||
t.Fatalf("UserAddress() = %q, want %q", got, "0xabc")
|
||||
}
|
||||
if got := UserTrack(ctx); got != 4 {
|
||||
t.Fatalf("UserTrack() = %d, want 4", got)
|
||||
}
|
||||
if !IsAuthenticated(ctx) {
|
||||
t.Fatal("IsAuthenticated() = false, want true")
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserTrackDefaultsToTrack1OnBareContext(t *testing.T) {
|
||||
if got := UserTrack(context.Background()); got != defaultTrackLevel {
|
||||
t.Fatalf("UserTrack(empty) = %d, want %d", got, defaultTrackLevel)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserAddressEmptyOnBareContext(t *testing.T) {
|
||||
if got := UserAddress(context.Background()); got != "" {
|
||||
t.Fatalf("UserAddress(empty) = %q, want empty", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsAuthenticatedFalseOnBareContext(t *testing.T) {
|
||||
if IsAuthenticated(context.Background()) {
|
||||
t.Fatal("IsAuthenticated(empty) = true, want false")
|
||||
}
|
||||
}
|
||||
|
||||
// TestContextKeyIsolation proves that the typed ctxKey values cannot be
|
||||
// shadowed by a caller using bare-string keys with the same spelling.
|
||||
// This is the specific class of bug fixed by this PR.
|
||||
func TestContextKeyIsolation(t *testing.T) {
|
||||
ctx := context.WithValue(context.Background(), "user_address", "injected")
|
||||
if got := UserAddress(ctx); got != "" {
|
||||
t.Fatalf("expected empty address (bare string key must not collide), got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrMissingAuthorizationIsSentinel(t *testing.T) {
|
||||
if ErrMissingAuthorization == nil {
|
||||
t.Fatal("ErrMissingAuthorization must not be nil")
|
||||
}
|
||||
wrapped := errors.New("wrapped: " + ErrMissingAuthorization.Error())
|
||||
if errors.Is(wrapped, ErrMissingAuthorization) {
|
||||
t.Fatal("string-wrapped error must not satisfy errors.Is (smoke check)")
|
||||
}
|
||||
if !errors.Is(ErrMissingAuthorization, ErrMissingAuthorization) {
|
||||
t.Fatal("ErrMissingAuthorization must satisfy errors.Is against itself")
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,6 @@ import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
|
||||
"github.com/explorer/backend/api/middleware"
|
||||
"github.com/explorer/backend/featureflags"
|
||||
)
|
||||
|
||||
@@ -17,8 +16,11 @@ func (s *Server) handleFeatures(w http.ResponseWriter, r *http.Request) {
|
||||
}
|
||||
|
||||
// Extract user track from context (set by auth middleware)
|
||||
// Default to Track 1 (public) if not authenticated (handled by helper).
|
||||
userTrack := middleware.UserTrack(r.Context())
|
||||
// Default to Track 1 (public) if not authenticated
|
||||
userTrack := 1
|
||||
if track, ok := r.Context().Value("user_track").(int); ok {
|
||||
userTrack = track
|
||||
}
|
||||
|
||||
// Get enabled features for this track
|
||||
enabledFeatures := featureflags.GetEnabledFeatures(userTrack)
|
||||
|
||||
@@ -12,7 +12,6 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/explorer/backend/api/middleware"
|
||||
"github.com/explorer/backend/auth"
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
@@ -186,7 +185,7 @@ func (s *Server) requireOperatorAccess(w http.ResponseWriter, r *http.Request) (
|
||||
return "", "", false
|
||||
}
|
||||
|
||||
operatorAddr := middleware.UserAddress(r.Context())
|
||||
operatorAddr, _ := r.Context().Value("user_address").(string)
|
||||
operatorAddr = strings.TrimSpace(operatorAddr)
|
||||
if operatorAddr == "" {
|
||||
writeError(w, http.StatusUnauthorized, "unauthorized", "Operator address required")
|
||||
|
||||
@@ -13,8 +13,6 @@ import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/explorer/backend/api/middleware"
|
||||
)
|
||||
|
||||
type runScriptRequest struct {
|
||||
@@ -69,7 +67,7 @@ func (s *Server) HandleRunScript(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
operatorAddr := middleware.UserAddress(r.Context())
|
||||
operatorAddr, _ := r.Context().Value("user_address").(string)
|
||||
if operatorAddr == "" {
|
||||
writeError(w, http.StatusUnauthorized, "unauthorized", "Operator address required")
|
||||
return
|
||||
|
||||
@@ -11,7 +11,6 @@ import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
|
||||
"github.com/explorer/backend/api/middleware"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
@@ -46,7 +45,7 @@ func TestHandleRunScriptUsesForwardedClientIPAndRunsAllowlistedScript(t *testing
|
||||
|
||||
reqBody := []byte(`{"script":"echo.sh","args":["world"]}`)
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/track4/operator/run-script", bytes.NewReader(reqBody))
|
||||
req = req.WithContext(middleware.ContextWithAuth(req.Context(), "0x4A666F96fC8764181194447A7dFdb7d471b301C8", 4, true))
|
||||
req = req.WithContext(context.WithValue(req.Context(), "user_address", "0x4A666F96fC8764181194447A7dFdb7d471b301C8"))
|
||||
req.RemoteAddr = "10.0.0.10:8080"
|
||||
req.Header.Set("X-Forwarded-For", "203.0.113.9, 10.0.0.10")
|
||||
w := httptest.NewRecorder()
|
||||
@@ -78,7 +77,7 @@ func TestHandleRunScriptRejectsNonAllowlistedScript(t *testing.T) {
|
||||
s := &Server{roleMgr: &stubRoleManager{allowed: true}, chainID: 138}
|
||||
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/track4/operator/run-script", bytes.NewReader([]byte(`{"script":"blocked.sh"}`)))
|
||||
req = req.WithContext(middleware.ContextWithAuth(req.Context(), "0x4A666F96fC8764181194447A7dFdb7d471b301C8", 4, true))
|
||||
req = req.WithContext(context.WithValue(req.Context(), "user_address", "0x4A666F96fC8764181194447A7dFdb7d471b301C8"))
|
||||
req.RemoteAddr = "127.0.0.1:9999"
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
@@ -101,7 +100,7 @@ func TestHandleRunScriptRejectsFilenameCollisionOutsideAllowlistedPath(t *testin
|
||||
s := &Server{roleMgr: &stubRoleManager{allowed: true}, chainID: 138}
|
||||
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/track4/operator/run-script", bytes.NewReader([]byte(`{"script":"unsafe/backup.sh"}`)))
|
||||
req = req.WithContext(middleware.ContextWithAuth(req.Context(), "0x4A666F96fC8764181194447A7dFdb7d471b301C8", 4, true))
|
||||
req = req.WithContext(context.WithValue(req.Context(), "user_address", "0x4A666F96fC8764181194447A7dFdb7d471b301C8"))
|
||||
req.RemoteAddr = "127.0.0.1:9999"
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
@@ -123,7 +122,7 @@ func TestHandleRunScriptTruncatesLargeOutput(t *testing.T) {
|
||||
s := &Server{roleMgr: &stubRoleManager{allowed: true}, chainID: 138}
|
||||
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/track4/operator/run-script", bytes.NewReader([]byte(`{"script":"large.sh"}`)))
|
||||
req = req.WithContext(middleware.ContextWithAuth(req.Context(), "0x4A666F96fC8764181194447A7dFdb7d471b301C8", 4, true))
|
||||
req = req.WithContext(context.WithValue(req.Context(), "user_address", "0x4A666F96fC8764181194447A7dFdb7d471b301C8"))
|
||||
req.RemoteAddr = "127.0.0.1:9999"
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
|
||||
86
docs/TESTING.md
Normal file
86
docs/TESTING.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Testing
|
||||
|
||||
The explorer has four test tiers. Run them in order of fidelity when
|
||||
debugging a regression.
|
||||
|
||||
## 1. Unit / package tests
|
||||
|
||||
Fast. Run on every PR.
|
||||
|
||||
```bash
|
||||
# Backend
|
||||
cd backend && go test ./...
|
||||
|
||||
# Frontend
|
||||
cd frontend && npm test # lint + type-check
|
||||
cd frontend && npm run test:unit # vitest
|
||||
```
|
||||
|
||||
## 2. Static analysis
|
||||
|
||||
Blocking on CI since PR #5 (`chore(ci): align Go to 1.23.x, add
|
||||
staticcheck/govulncheck/gitleaks gates`).
|
||||
|
||||
```bash
|
||||
cd backend && staticcheck ./...
|
||||
cd backend && govulncheck ./...
|
||||
git diff master... | gitleaks protect --staged --config ../.gitleaks.toml
|
||||
```
|
||||
|
||||
## 3. Production-targeting Playwright
|
||||
|
||||
Runs against `https://explorer.d-bis.org` (or the URL in `EXPLORER_URL`)
|
||||
and only checks public routes. Useful as a production canary; wired
|
||||
into the `test-e2e` Make target.
|
||||
|
||||
```bash
|
||||
EXPLORER_URL=https://explorer.d-bis.org make test-e2e
|
||||
```
|
||||
|
||||
## 4. Full-stack Playwright (`make e2e-full`)
|
||||
|
||||
Spins up the entire stack locally — `postgres`, `elasticsearch`,
|
||||
`redis` via docker-compose, plus a local build of `backend/api/rest`
|
||||
and `frontend` — then runs the full-stack Playwright spec against it.
|
||||
|
||||
```bash
|
||||
make e2e-full
|
||||
```
|
||||
|
||||
What it does, in order:
|
||||
|
||||
1. `docker compose -p explorer-e2e up -d postgres elasticsearch redis`
|
||||
2. Wait for Postgres readiness.
|
||||
3. Run `go run database/migrations/migrate.go` to apply schema +
|
||||
seeds (including `0016_jwt_revocations` from PR #8).
|
||||
4. `go run ./backend/api/rest` on port `8080`.
|
||||
5. `npm ci && npm run build && npm run start` on port `3000`.
|
||||
6. `npx playwright test scripts/e2e-full-stack.spec.ts`.
|
||||
7. Tear everything down (unless `E2E_KEEP_STACK=1`).
|
||||
|
||||
Screenshots of every route are written to
|
||||
`test-results/screenshots/<route>.png`.
|
||||
|
||||
### Env vars
|
||||
|
||||
| Var | Default | Purpose |
|
||||
|-----|---------|---------|
|
||||
| `EXPLORER_URL` | `http://localhost:3000` | Frontend base URL for the spec |
|
||||
| `EXPLORER_API_URL` | `http://localhost:8080` | Backend base URL |
|
||||
| `JWT_SECRET` | generated per-run | Required by backend fail-fast check (PR #3) |
|
||||
| `CSP_HEADER` | dev-safe default | Same |
|
||||
| `E2E_KEEP_STACK` | `0` | If `1`, leave the stack up after the run |
|
||||
| `E2E_SKIP_DOCKER` | `0` | If `1`, assume docker services already running |
|
||||
| `E2E_SCREENSHOT_DIR` | `test-results/screenshots` | Where to write PNGs |
|
||||
|
||||
### CI integration
|
||||
|
||||
`.github/workflows/e2e-full.yml` runs `make e2e-full` on:
|
||||
|
||||
* **Manual** trigger (`workflow_dispatch`).
|
||||
* **PRs labelled `run-e2e-full`** — apply the label when a change
|
||||
warrants full-stack validation (migrations, auth, routing changes).
|
||||
* **Nightly** at 04:00 UTC.
|
||||
|
||||
Screenshots and the Playwright HTML report are uploaded as build
|
||||
artefacts.
|
||||
@@ -7,7 +7,7 @@ if (process.env.NO_COLOR !== undefined) {
|
||||
|
||||
export default defineConfig({
|
||||
testDir: './scripts',
|
||||
testMatch: 'e2e-explorer-frontend.spec.ts',
|
||||
testMatch: /e2e-.*\.spec\.ts$/,
|
||||
fullyParallel: false,
|
||||
forbidOnly: !!process.env.CI,
|
||||
retries: process.env.CI ? 2 : 0,
|
||||
|
||||
79
scripts/e2e-full-stack.spec.ts
Normal file
79
scripts/e2e-full-stack.spec.ts
Normal file
@@ -0,0 +1,79 @@
|
||||
import { expect, test, type Page } from '@playwright/test'
|
||||
import { mkdirSync } from 'node:fs'
|
||||
import path from 'node:path'
|
||||
|
||||
// e2e-full-stack.spec.ts
|
||||
//
|
||||
// Playwright spec that exercises the golden-path behaviours of the
|
||||
// explorer against a *locally booted* backend + frontend, rather than
|
||||
// against the production deploy that `e2e-explorer-frontend.spec.ts`
|
||||
// targets. `make e2e-full` stands up the stack, points this spec at
|
||||
// it via EXPLORER_URL / EXPLORER_API_URL, and tears it down afterwards.
|
||||
//
|
||||
// The spec intentionally sticks to Track-1 (public, no auth) routes so
|
||||
// it can run without provisioning wallet credentials in CI. Track 2-4
|
||||
// behaviours are covered by the Go and unit-test layers.
|
||||
|
||||
const EXPLORER_URL = process.env.EXPLORER_URL || 'http://localhost:3000'
|
||||
const EXPLORER_API_URL = process.env.EXPLORER_API_URL || 'http://localhost:8080'
|
||||
const SCREENSHOT_DIR = process.env.E2E_SCREENSHOT_DIR || 'test-results/screenshots'
|
||||
|
||||
mkdirSync(SCREENSHOT_DIR, { recursive: true })
|
||||
|
||||
async function snapshot(page: Page, name: string) {
|
||||
const file = path.join(SCREENSHOT_DIR, `${name}.png`)
|
||||
await page.screenshot({ path: file, fullPage: true })
|
||||
}
|
||||
|
||||
async function expectHeading(page: Page, name: RegExp) {
|
||||
await expect(page.getByRole('heading', { name })).toBeVisible({ timeout: 15000 })
|
||||
}
|
||||
|
||||
test.describe('Explorer full-stack smoke', () => {
|
||||
test('backend /healthz responds 200', async ({ request }) => {
|
||||
const response = await request.get(`${EXPLORER_API_URL}/healthz`)
|
||||
expect(response.status()).toBeLessThan(500)
|
||||
})
|
||||
|
||||
for (const route of [
|
||||
{ path: '/', heading: /SolaceScan/i, name: 'home' },
|
||||
{ path: '/blocks', heading: /^Blocks$/i, name: 'blocks' },
|
||||
{ path: '/transactions', heading: /^Transactions$/i, name: 'transactions' },
|
||||
{ path: '/addresses', heading: /^Addresses$/i, name: 'addresses' },
|
||||
{ path: '/tokens', heading: /^Tokens$/i, name: 'tokens' },
|
||||
{ path: '/pools', heading: /^Pools$/i, name: 'pools' },
|
||||
{ path: '/search', heading: /^Search$/i, name: 'search' },
|
||||
{ path: '/wallet', heading: /Wallet & MetaMask/i, name: 'wallet' },
|
||||
{ path: '/routes', heading: /Route/i, name: 'routes' },
|
||||
]) {
|
||||
test(`frontend route ${route.path} renders`, async ({ page }) => {
|
||||
await page.goto(`${EXPLORER_URL}${route.path}`, {
|
||||
waitUntil: 'domcontentloaded',
|
||||
timeout: 30000,
|
||||
})
|
||||
await expectHeading(page, route.heading)
|
||||
await snapshot(page, route.name)
|
||||
})
|
||||
}
|
||||
|
||||
test('access products endpoint is reachable', async ({ request }) => {
|
||||
// Covers the YAML-backed catalogue wired up in PR #7. The endpoint
|
||||
// is public (lists available RPC products) so no auth is needed.
|
||||
const response = await request.get(`${EXPLORER_API_URL}/api/v1/access/products`)
|
||||
expect(response.status()).toBe(200)
|
||||
const body = await response.json()
|
||||
expect(Array.isArray(body.products)).toBe(true)
|
||||
expect(body.products.length).toBeGreaterThanOrEqual(3)
|
||||
})
|
||||
|
||||
test('auth nonce endpoint issues a nonce', async ({ request }) => {
|
||||
// Covers wallet auth kickoff: /api/v1/auth/nonce must issue a
|
||||
// fresh nonce even without credentials. This is Track-1-safe.
|
||||
const response = await request.post(`${EXPLORER_API_URL}/api/v1/auth/nonce`, {
|
||||
data: { address: '0x4A666F96fC8764181194447A7dFdb7d471b301C8' },
|
||||
})
|
||||
expect(response.status()).toBe(200)
|
||||
const body = await response.json()
|
||||
expect(typeof body.nonce === 'string' && body.nonce.length > 0).toBe(true)
|
||||
})
|
||||
})
|
||||
123
scripts/e2e-full.sh
Executable file
123
scripts/e2e-full.sh
Executable file
@@ -0,0 +1,123 @@
|
||||
#!/usr/bin/env bash
|
||||
# scripts/e2e-full.sh
|
||||
#
|
||||
# Boots the full explorer stack (postgres, elasticsearch, redis, backend
|
||||
# API, frontend), waits for readiness, runs the Playwright full-stack
|
||||
# smoke spec against it, and tears everything down. Used by the
|
||||
# `make e2e-full` target and by the e2e-full CI workflow.
|
||||
#
|
||||
# Env vars:
|
||||
# E2E_KEEP_STACK=1 # don't tear down on exit (for debugging)
|
||||
# E2E_SKIP_DOCKER=1 # assume backend + deps already running
|
||||
# EXPLORER_URL # defaults to http://localhost:3000
|
||||
# EXPLORER_API_URL # defaults to http://localhost:8080
|
||||
# E2E_SCREENSHOT_DIR # defaults to test-results/screenshots
|
||||
# JWT_SECRET # required; generated ephemerally if unset
|
||||
# CSP_HEADER # required; a dev-safe default is injected
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||||
cd "$ROOT"
|
||||
|
||||
COMPOSE="deployment/docker-compose.yml"
|
||||
COMPOSE_PROJECT="${COMPOSE_PROJECT:-explorer-e2e}"
|
||||
|
||||
export EXPLORER_URL="${EXPLORER_URL:-http://localhost:3000}"
|
||||
export EXPLORER_API_URL="${EXPLORER_API_URL:-http://localhost:8080}"
|
||||
export E2E_SCREENSHOT_DIR="${E2E_SCREENSHOT_DIR:-$ROOT/test-results/screenshots}"
|
||||
mkdir -p "$E2E_SCREENSHOT_DIR"
|
||||
|
||||
# Generate ephemeral JWT secret if the caller didn't set one. Real
|
||||
# deployments use fail-fast validation (see PR #3); for a local run we
|
||||
# want a fresh value each invocation so stale tokens don't bleed across
|
||||
# runs.
|
||||
export JWT_SECRET="${JWT_SECRET:-$(openssl rand -hex 32)}"
|
||||
export CSP_HEADER="${CSP_HEADER:-default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' http://localhost:8080 ws://localhost:8080}"
|
||||
|
||||
log() { printf '[e2e-full] %s\n' "$*"; }
|
||||
|
||||
teardown() {
|
||||
local ec=$?
|
||||
if [[ "${E2E_KEEP_STACK:-0}" == "1" ]]; then
|
||||
log "E2E_KEEP_STACK=1; leaving stack running."
|
||||
return $ec
|
||||
fi
|
||||
log "tearing down stack"
|
||||
if [[ "${E2E_SKIP_DOCKER:-0}" != "1" ]]; then
|
||||
docker compose -p "$COMPOSE_PROJECT" -f "$COMPOSE" down -v --remove-orphans >/dev/null 2>&1 || true
|
||||
fi
|
||||
if [[ -n "${BACKEND_PID:-}" ]]; then kill "$BACKEND_PID" 2>/dev/null || true; fi
|
||||
if [[ -n "${FRONTEND_PID:-}" ]]; then kill "$FRONTEND_PID" 2>/dev/null || true; fi
|
||||
return $ec
|
||||
}
|
||||
trap teardown EXIT
|
||||
|
||||
wait_for() {
|
||||
local url="$1" label="$2" retries="${3:-60}"
|
||||
log "waiting for $label at $url"
|
||||
for ((i=0; i<retries; i++)); do
|
||||
if curl -fsS "$url" >/dev/null 2>&1; then
|
||||
log " $label ready"
|
||||
return 0
|
||||
fi
|
||||
sleep 2
|
||||
done
|
||||
log " $label never became ready"
|
||||
return 1
|
||||
}
|
||||
|
||||
if [[ "${E2E_SKIP_DOCKER:-0}" != "1" ]]; then
|
||||
log "starting postgres, elasticsearch, redis via docker compose"
|
||||
docker compose -p "$COMPOSE_PROJECT" -f "$COMPOSE" up -d postgres elasticsearch redis
|
||||
|
||||
log "waiting for postgres"
|
||||
for ((i=0; i<60; i++)); do
|
||||
if docker compose -p "$COMPOSE_PROJECT" -f "$COMPOSE" exec -T postgres pg_isready -U explorer >/dev/null 2>&1; then
|
||||
break
|
||||
fi
|
||||
sleep 2
|
||||
done
|
||||
fi
|
||||
|
||||
export DB_HOST="${DB_HOST:-localhost}"
|
||||
export DB_PORT="${DB_PORT:-5432}"
|
||||
export DB_USER="${DB_USER:-explorer}"
|
||||
export DB_PASSWORD="${DB_PASSWORD:-changeme}"
|
||||
export DB_NAME="${DB_NAME:-explorer}"
|
||||
export REDIS_HOST="${REDIS_HOST:-localhost}"
|
||||
export REDIS_PORT="${REDIS_PORT:-6379}"
|
||||
export ELASTICSEARCH_URL="${ELASTICSEARCH_URL:-http://localhost:9200}"
|
||||
|
||||
log "running migrations"
|
||||
(cd backend && go run database/migrations/migrate.go) || {
|
||||
log "migrations failed; continuing so tests can report the real backend state"
|
||||
}
|
||||
|
||||
log "starting backend API on :8080"
|
||||
(cd backend/api/rest && go run . >/tmp/e2e-backend.log 2>&1) &
|
||||
BACKEND_PID=$!
|
||||
|
||||
wait_for "$EXPLORER_API_URL/healthz" backend 120 || {
|
||||
log "backend log tail:"; tail -n 60 /tmp/e2e-backend.log || true
|
||||
exit 1
|
||||
}
|
||||
|
||||
log "building frontend"
|
||||
(cd frontend && npm ci --no-audit --no-fund --loglevel=error && npm run build)
|
||||
|
||||
log "starting frontend on :3000"
|
||||
(cd frontend && PORT=3000 HOST=127.0.0.1 NEXT_PUBLIC_API_URL="$EXPLORER_API_URL" npm run start >/tmp/e2e-frontend.log 2>&1) &
|
||||
FRONTEND_PID=$!
|
||||
|
||||
wait_for "$EXPLORER_URL" frontend 60 || {
|
||||
log "frontend log tail:"; tail -n 60 /tmp/e2e-frontend.log || true
|
||||
exit 1
|
||||
}
|
||||
|
||||
log "running Playwright full-stack smoke"
|
||||
npx playwright install --with-deps chromium >/dev/null
|
||||
EXPLORER_URL="$EXPLORER_URL" EXPLORER_API_URL="$EXPLORER_API_URL" \
|
||||
npx playwright test scripts/e2e-full-stack.spec.ts --reporter=list
|
||||
|
||||
log "done; screenshots in $E2E_SCREENSHOT_DIR"
|
||||
Reference in New Issue
Block a user