spreadlab/internal/api/api_test.go

package api

import (
	"bytes"
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"strings"
	"testing"

	"github.com/JustinZeus/spreadlab/internal/engine"
)

// httptest exercises handlers fully in memory: no port, no network, just
// a recorded response to assert on.

func serve(t *testing.T, method, path string, body []byte) *httptest.ResponseRecorder {
	t.Helper()
	request := httptest.NewRequest(method, path, bytes.NewReader(body))
	recorder := httptest.NewRecorder()
	NewServer().ServeHTTP(recorder, request)
	return recorder
}

func TestWriteJSONEncodingFailureStaysJSON(t *testing.T) {
	// Channels cannot be marshaled, forcing the otherwise unreachable
	// last-resort branch. Even there the error contract must stay JSON.
	recorder := httptest.NewRecorder()
	writeJSON(recorder, http.StatusOK, make(chan int))

	if recorder.Code != http.StatusInternalServerError {
		t.Errorf("status = %d, want %d", recorder.Code, http.StatusInternalServerError)
	}
	if got := recorder.Header().Get("Content-Type"); got != "application/json" {
		t.Errorf("Content-Type = %q, want application/json", got)
	}
	var response struct {
		Error string `json:"error"`
	}
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatalf("fallback body is not JSON: %v (body: %s)", err, recorder.Body)
	}
	if response.Error == "" {
		t.Error("fallback body has an empty error field")
	}
}

func TestDefaultConfigEndpoint(t *testing.T) {
	recorder := serve(t, http.MethodGet, "/api/config/default", nil)

	if recorder.Code != http.StatusOK {
		t.Fatalf("status = %d, want %d", recorder.Code, http.StatusOK)
	}
	var response DefaultConfigResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	if response.Config != engine.DefaultConfig() {
		t.Errorf("served config %+v, want %+v", response.Config, engine.DefaultConfig())
	}
	if response.Bounds != engine.ConfigBounds() {
		t.Errorf("served bounds %+v, want %+v", response.Bounds, engine.ConfigBounds())
	}
}

func TestComparisonEndpointMatchesGoldenValues(t *testing.T) {
	body, err := json.Marshal(engine.DefaultConfig())
	if err != nil {
		t.Fatal(err)
	}
	recorder := serve(t, http.MethodPost, "/api/comparison", body)

	if recorder.Code != http.StatusOK {
		t.Fatalf("status = %d, want %d; body: %s", recorder.Code, http.StatusOK, recorder.Body)
	}
	var comparison ComparisonResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &comparison); err != nil {
		t.Fatal(err)
	}

	// The same golden values the engine tests pin; the API must not
	// change them in transit.
	wantReached := map[engine.Strategy]int{
		engine.StrategyNone:          100,
		engine.StrategyRandom:        83,
		engine.StrategyMostConnected: 21,
	}
	if len(comparison.Results) != len(wantReached) {
		t.Fatalf("got %d results, want %d", len(comparison.Results), len(wantReached))
	}
	for _, result := range comparison.Results {
		if want := wantReached[result.Strategy]; result.NumReached != want {
			t.Errorf("%s: NumReached = %d, want %d", result.Strategy, result.NumReached, want)
		}
	}
}

func TestComparisonEndpointRejectsBadRequests(t *testing.T) {
	invalidValues, err := json.Marshal(func() engine.Config {
		config := engine.DefaultConfig()
		config.ForwardProb = 2.0
		return config
	}())
	if err != nil {
		t.Fatal(err)
	}

	tests := []struct {
		name string
		body []byte
	}{
		{name: "not json", body: []byte("not json")},
		{name: "unknown field", body: []byte(`{"numStudentz": 5}`)},
		{name: "invalid parameter values", body: invalidValues},
	}
	for _, testCase := range tests {
		t.Run(testCase.name, func(t *testing.T) {
			recorder := serve(t, http.MethodPost, "/api/comparison", testCase.body)
			if recorder.Code != http.StatusBadRequest {
				t.Errorf("status = %d, want %d", recorder.Code, http.StatusBadRequest)
			}
			if !strings.Contains(recorder.Body.String(), `"error"`) {
				t.Errorf("body %q is not an error response", recorder.Body)
			}
		})
	}

	t.Run("wrong method", func(t *testing.T) {
		recorder := serve(t, http.MethodGet, "/api/comparison", nil)
		if recorder.Code != http.StatusMethodNotAllowed {
			t.Errorf("status = %d, want %d", recorder.Code, http.StatusMethodNotAllowed)
		}
	})
}