68f18424f5
Hard gate #4: codified module boundaries as Go tests, so a new contributor (or AI agent) can't silently land an import that crosses a layer. Boundaries enforced (one architecture_test.go per package): - wsauth has no internal/* deps — auth leaf, must be unit-testable in isolation - models has no internal/* deps — pure-types leaf, reverse dep would create cycles since most packages depend on models - db has no internal/* deps — DB layer below business logic, must be testable with sqlmock without spinning up handlers/provisioner - provisioner does not import handlers or router — unidirectional layering: handlers wires provisioner into HTTP routes; the reverse is a cycle Each test parses .go files in its package via go/parser (no x/tools dep needed) and asserts forbidden import paths don't appear. Failure messages name the rule, the offending file, and explain WHY the boundary exists so the diff reviewer learns the rule. Note: the original issue's first two proposed boundaries (provisioner-no-DB, handlers-no-docker) don't match the codebase today — provisioner already imports db (PR #2276 runtime-image lookup) and handlers hold *docker.Client directly (terminal, plugins, bundle, templates). I picked the four boundaries that actually hold; the first two are aspirational and would need a refactor before they could be codified. Hand-tested by injecting a deliberate wsauth -> orgtoken violation: the gate fires red with the rule message before merge. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
81 lines
2.4 KiB
Go
81 lines
2.4 KiB
Go
package provisioner_test
|
|
|
|
// Architecture test (#2344): provisioner is below handlers/router in
|
|
// the layer hierarchy. handlers wires provisioner into HTTP routes;
|
|
// the reverse direction (provisioner reaching back into handlers or
|
|
// the router) creates a cycle and tangles infra-orchestration with
|
|
// transport.
|
|
//
|
|
// Note: provisioner CURRENTLY imports db (for the runtime-image
|
|
// lookup). That's a known coupling — see PR #2276 review thread on
|
|
// where image resolution should live. The narrower rule we enforce
|
|
// here is "no upward import to handlers/router," which is the harder
|
|
// rule to keep clean.
|
|
//
|
|
// If this test fails: you reached "up" the stack. Pass whatever you
|
|
// need from handlers down through a constructor parameter or a
|
|
// function-typed callback instead of importing the package directly.
|
|
|
|
import (
|
|
"go/parser"
|
|
"go/token"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
const moduleInternalPrefix = "github.com/Molecule-AI/molecule-monorepo/platform/internal/"
|
|
|
|
var provisionerForbiddenImports = []string{
|
|
moduleInternalPrefix + "handlers",
|
|
moduleInternalPrefix + "router",
|
|
}
|
|
|
|
func TestProvisionerDoesNotImportUpstreamLayers(t *testing.T) {
|
|
t.Parallel()
|
|
imports := listImports(t, ".")
|
|
for path, file := range imports {
|
|
for _, forbidden := range provisionerForbiddenImports {
|
|
if path == forbidden || strings.HasPrefix(path, forbidden+"/") {
|
|
t.Errorf(
|
|
"provisioner must not import %q (found in %s) — "+
|
|
"provisioner sits below handlers/router in the layer "+
|
|
"hierarchy and a reverse dep creates a cycle. Pass "+
|
|
"what you need down via constructor params or "+
|
|
"function-typed callbacks. See workspace-server/internal/"+
|
|
"provisioner/architecture_test.go.",
|
|
path, file,
|
|
)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func listImports(t *testing.T, dir string) map[string]string {
|
|
t.Helper()
|
|
fset := token.NewFileSet()
|
|
entries, err := os.ReadDir(dir)
|
|
if err != nil {
|
|
t.Fatalf("read %s: %v", dir, err)
|
|
}
|
|
out := make(map[string]string)
|
|
for _, e := range entries {
|
|
name := e.Name()
|
|
if e.IsDir() || !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") {
|
|
continue
|
|
}
|
|
f, err := parser.ParseFile(fset, filepath.Join(dir, name), nil, parser.ImportsOnly)
|
|
if err != nil {
|
|
t.Fatalf("parse %s: %v", name, err)
|
|
}
|
|
for _, imp := range f.Imports {
|
|
path := strings.Trim(imp.Path.Value, "\"")
|
|
if _, seen := out[path]; !seen {
|
|
out[path] = name
|
|
}
|
|
}
|
|
}
|
|
return out
|
|
}
|