@shortlink-org/portolan 0.1.0 → 0.2.0

package/plugins/extract-go/extract_test.go

@@ -1,261 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"io"
-	"os"
-	"path/filepath"
-	"strings"
-	"testing"
-
-	"github.com/shortlink-org/portolan/catalog"
-	"github.com/shortlink-org/portolan/plugin"
-)
-
-// The extractor's own golden is examples/auth/portolan/domain.json, which is
-// committed and checked by `npm run gen:check`. What is worth testing here is
-// the handful of judgements it makes on the way: what a name becomes, what
-// counts as a command, and which prose is worth keeping.
-
-func TestSlug(t *testing.T) {
-	cases := map[string]string{
-		"User":          "user",
-		"PriceList":     "price-list",
-		"OrderLine":     "order-line",
-		"email.Address": "email-address",
-		"ID":            "id",
-		"HTTPServer":    "http-server",
-	}
-
-	for in, want := range cases {
-		if got := slug(in); got != want {
-			t.Errorf("slug(%q) = %q, want %q", in, got, want)
-		}
-	}
-}
-
-func TestCamelAndTitle(t *testing.T) {
-	if got := camel("end_after_credential_change"); got != "EndAfterCredentialChange" {
-		t.Errorf("camel = %q", got)
-	}
-	if got := title("price_list"); got != "Price List" {
-		t.Errorf("title = %q", got)
-	}
-}
-
-// token.Token adds nothing over Token; password.Hash says which Hash.
-func TestQualified(t *testing.T) {
-	if got := qualified("token", "Token"); got != "Token" {
-		t.Errorf("qualified = %q", got)
-	}
-	if got := qualified("password", "Hash"); got != "password.Hash" {
-		t.Errorf("qualified = %q", got)
-	}
-}
-
-func TestWithoutPackagePrefix(t *testing.T) {
-	got := withoutPackagePrefix("user", "Package user holds the User aggregate: a person.")
-	if got != "Holds the User aggregate: a person." {
-		t.Errorf("withoutPackagePrefix = %q", got)
-	}
-
-	// A comment that does not follow the convention is left exactly as written.
-	unchanged := "The User aggregate."
-	if got := withoutPackagePrefix("user", unchanged); got != unchanged {
-		t.Errorf("withoutPackagePrefix rewrote %q", got)
-	}
-}
-
-func TestFirstParagraphAfterTitle(t *testing.T) {
-	md := "# register\n\nCreates a user from an email address and a password.\n\n## What it does\n\n1. Normalises.\n"
-	if got := firstParagraphAfterTitle(md); got != "Creates a user from an email address and a password." {
-		t.Errorf("firstParagraphAfterTitle = %q", got)
-	}
-}
-
-// The classification a reader most depends on: a use case that writes is a
-// command even when the write happens in a helper rather than in Handle.
-func TestOperationKindFollowsHelpers(t *testing.T) {
-	pkg := mustParse(t, `package usecase
-
-type UseCase struct{ repo Repository }
-type Repository interface{ Save(any, string) error }
-
-func (uc *UseCase) Handle(ctx any, in any) error {
-	for _, id := range uc.list() {
-		if err := uc.end(ctx, id); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-func (uc *UseCase) end(ctx any, id string) error { return uc.repo.Save(ctx, id) }
-`)
-
-	if got := operationKind(pkg); got != catalog.OperationCommand {
-		t.Errorf("a use case that saves in a helper is a command, got %q", got)
-	}
-}
-
-func TestOperationKindReadOnlyIsQuery(t *testing.T) {
-	pkg := mustParse(t, `package usecase
-
-type UseCase struct{}
-
-func (uc *UseCase) Handle(ctx any, in any) (any, error) { return uc.repo.ByID(ctx, "id") }
-`)
-
-	if got := operationKind(pkg); got != catalog.OperationQuery {
-		t.Errorf("a use case that only reads is a query, got %q", got)
-	}
-}
-
-func TestOperationKindIgnoresWriteNamedCallsOutsidePorts(t *testing.T) {
-	pkg := mustParse(t, `package usecase
-
-type helper struct{}
-func (helper) Save() {}
-type UseCase struct{ repo Repository }
-type Repository interface{ ByID(any, string) (any, error) }
-func (uc *UseCase) Handle(ctx any) (any, error) {
-  helper{}.Save()
-  return uc.repo.ByID(ctx, "id")
-}
-`)
-
-	if got := operationKind(pkg); got != catalog.OperationQuery {
-		t.Errorf("a Save call outside a use-case port must not make a command, got %q", got)
-	}
-}
-
-// An extractor with nothing to read must say so rather than answer with an
-// empty service that looks like a service with no model.
-func TestExtractRefusesAnEmptyRoot(t *testing.T) {
-	request := `{"portolanVersion":"0.1.0","input":{"root":""}}`
-	if err := run(strings.NewReader(request), io.Discard); err == nil {
-		t.Error("a request with no input root should be refused")
-	}
-}
-
-func TestEventsNeedAName(t *testing.T) {
-	pkg := mustParse(t, `package event
-
-// Envelope wraps a published event. It is not one.
-type Envelope struct{ payload string }
-
-// UserRegistered is published once per user.
-type UserRegistered struct{ userID string }
-
-func (UserRegistered) Name() string { return "auth.UserRegistered" }
-`)
-
-	events := eventsIn(pkg, "auth.auth.user", "auth_user")
-	if len(events) != 1 || events[0].Name != "UserRegistered" {
-		t.Fatalf("expected only UserRegistered, got %v", names(events))
-	}
-	wire := events[0].Wire
-	if wire == nil || wire.Name != "auth.UserRegistered" || wire.Channel != "auth_user" {
-		t.Errorf("the name on the message and the channel should be the wire, got %+v", wire)
-	}
-	if got := events[0].Versions[0].Doc; got != "UserRegistered is published once per user." {
-		t.Errorf("the doc should be the struct's own, got %q", got)
-	}
-}
-
-func TestEventsWithoutAChannel(t *testing.T) {
-	pkg := mustParse(t, `package event
-
-type Registered struct{}
-
-func (Registered) Name() string { return "auth.Registered" }
-`)
-
-	events := eventsIn(pkg, "auth.auth.user", "")
-	if len(events) != 1 || events[0].Wire == nil || events[0].Wire.Channel != "" {
-		t.Fatalf("a named event with no dto.Topic keeps its name and no channel, got %+v", events)
-	}
-}
-
-func names(events []catalog.Event) []string {
-	out := make([]string, len(events))
-	for i := range events {
-		out[i] = events[i].Name
-	}
-
-	return out
-}
-
-func mustParse(t *testing.T, src string) *pkg {
-	t.Helper()
-
-	parsed, err := parseSource("source.go", src)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	return parsed
-}
-
-// A domain package with a README is described by it; one without falls back
-// to the package comment, headed so the page does not start mid-paragraph.
-func TestAggregateReadmePrefersTheFile(t *testing.T) {
-	root := t.TempDir()
-	dir := filepath.Join(root, "internal", "domain", "session")
-	if err := os.MkdirAll(dir, 0o755); err != nil {
-		t.Fatal(err)
-	}
-
-	if got := aggregateReadme(root, "internal/domain/session", "session", "Session", "Package session holds the Session aggregate."); got != "# Session\n\nHolds the Session aggregate." {
-		t.Errorf("without a README = %q", got)
-	}
-
-	md := "# Session\n\n## States\n\n- Live\n"
-	if err := os.WriteFile(filepath.Join(dir, "README.md"), []byte(md+"\n"), 0o644); err != nil {
-		t.Fatal(err)
-	}
-	if got := aggregateReadme(root, "internal/domain/session", "session", "Session", "Package session holds the Session aggregate."); got != strings.TrimSpace(md) {
-		t.Errorf("with a README = %q", got)
-	}
-}
-
-// A package under internal/domain with no struct named after it is not an
-// aggregate, whatever else it declares. Taking the first struct as the root
-// would document a package of error types as a model, and a wrong table is
-// worse than no page.
-func TestAPackageWithoutItsRootIsNotAnAggregate(t *testing.T) {
-	root := t.TempDir()
-	dir := filepath.Join(root, "internal", "domain", "domainerrors")
-	if err := os.MkdirAll(dir, 0o755); err != nil {
-		t.Fatal(err)
-	}
-	src := "package domainerrors\n\n// WithNotifyError carries what to tell the user.\ntype WithNotifyError struct {\n\tCode  string\n\tTitle string\n}\n"
-	if err := os.WriteFile(filepath.Join(dir, "errors.go"), []byte(src), 0o644); err != nil {
-		t.Fatal(err)
-	}
-	if err := os.WriteFile(filepath.Join(root, "go.mod"), []byte("module example.com/svc\n"), 0o644); err != nil {
-		t.Fatal(err)
-	}
-
-	resp, err := extract(plugin.Input{Root: root, Commit: "abc1234", GeneratedAt: "2026-01-01T00:00:00Z"}, Options{Context: "avia", Service: "svc"})
-	if err != nil {
-		t.Fatal(err)
-	}
-	var out catalog.Catalog
-	if err := json.Unmarshal([]byte(resp.Files[0].Contents), &out); err != nil {
-		t.Fatal(err)
-	}
-	if got := out.Contexts[0].Services[0].Aggregates; len(got) != 0 {
-		t.Errorf("read as aggregates: %+v", got)
-	}
-
-	var said bool
-	for _, warning := range resp.Warnings() {
-		if strings.Contains(warning.Message, "has no struct called Domainerrors, so it is not read as an aggregate") {
-			said = true
-		}
-	}
-	if !said {
-		t.Errorf("nothing said why; warnings = %+v", resp.Warnings())
-	}
-}