feat: add 22 Example tests — documentation seeds + coverage + godoc
Go Example functions serve triple duty: - Run as tests (count toward coverage) - Show in godoc (usage documentation) - Seed for Sonnet to write user guides Covers: New, Options, Result, Action (register/invoke/list), Task, Registry (Set/Get/Lock/Seal), Entitlement (default/custom/NearLimit), Process (permission model), JSON, ID, ValidateName, SanitisePath, Command, Config, Error. 512 tests total, 84.8% coverage. Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Snider
parent
0911d5ad7b
commit
ecf6485f95
1 changed files with 324 additions and 0 deletions
324
example_test.go
Normal file
324
example_test.go
Normal file
|
|
@ -0,0 +1,324 @@
|
|||
package core_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
. "dappco.re/go/core"
|
||||
)
|
||||
|
||||
// --- Core Creation ---
|
||||
|
||||
func ExampleNew() {
|
||||
c := New(
|
||||
WithOption("name", "my-app"),
|
||||
WithServiceLock(),
|
||||
)
|
||||
fmt.Println(c.App().Name)
|
||||
// Output: my-app
|
||||
}
|
||||
|
||||
func ExampleNew_withService() {
|
||||
c := New(
|
||||
WithOption("name", "example"),
|
||||
WithService(func(c *Core) Result {
|
||||
return c.Service("greeter", Service{
|
||||
OnStart: func() Result {
|
||||
Info("greeter started", "app", c.App().Name)
|
||||
return Result{OK: true}
|
||||
},
|
||||
})
|
||||
}),
|
||||
)
|
||||
c.ServiceStartup(context.Background(), nil)
|
||||
fmt.Println(c.Services())
|
||||
c.ServiceShutdown(context.Background())
|
||||
// Output is non-deterministic (map order), so no Output comment
|
||||
}
|
||||
|
||||
// --- Options ---
|
||||
|
||||
func ExampleNewOptions() {
|
||||
opts := NewOptions(
|
||||
Option{Key: "name", Value: "brain"},
|
||||
Option{Key: "port", Value: 8080},
|
||||
Option{Key: "debug", Value: true},
|
||||
)
|
||||
fmt.Println(opts.String("name"))
|
||||
fmt.Println(opts.Int("port"))
|
||||
fmt.Println(opts.Bool("debug"))
|
||||
// Output:
|
||||
// brain
|
||||
// 8080
|
||||
// true
|
||||
}
|
||||
|
||||
// --- Result ---
|
||||
|
||||
func ExampleResult() {
|
||||
r := Result{Value: "hello", OK: true}
|
||||
if r.OK {
|
||||
fmt.Println(r.Value)
|
||||
}
|
||||
// Output: hello
|
||||
}
|
||||
|
||||
// --- Action ---
|
||||
|
||||
func ExampleCore_Action_register() {
|
||||
c := New()
|
||||
c.Action("greet", func(_ context.Context, opts Options) Result {
|
||||
name := opts.String("name")
|
||||
return Result{Value: "hello " + name, OK: true}
|
||||
})
|
||||
fmt.Println(c.Action("greet").Exists())
|
||||
// Output: true
|
||||
}
|
||||
|
||||
func ExampleCore_Action_invoke() {
|
||||
c := New()
|
||||
c.Action("add", func(_ context.Context, opts Options) Result {
|
||||
a := opts.Int("a")
|
||||
b := opts.Int("b")
|
||||
return Result{Value: a + b, OK: true}
|
||||
})
|
||||
|
||||
r := c.Action("add").Run(context.Background(), NewOptions(
|
||||
Option{Key: "a", Value: 3},
|
||||
Option{Key: "b", Value: 4},
|
||||
))
|
||||
fmt.Println(r.Value)
|
||||
// Output: 7
|
||||
}
|
||||
|
||||
func ExampleCore_Actions() {
|
||||
c := New()
|
||||
c.Action("process.run", func(_ context.Context, _ Options) Result { return Result{OK: true} })
|
||||
c.Action("brain.recall", func(_ context.Context, _ Options) Result { return Result{OK: true} })
|
||||
|
||||
fmt.Println(c.Actions())
|
||||
// Output: [process.run brain.recall]
|
||||
}
|
||||
|
||||
// --- Task ---
|
||||
|
||||
func ExampleCore_Task() {
|
||||
c := New()
|
||||
order := ""
|
||||
|
||||
c.Action("step.a", func(_ context.Context, _ Options) Result {
|
||||
order += "a"
|
||||
return Result{Value: "from-a", OK: true}
|
||||
})
|
||||
c.Action("step.b", func(_ context.Context, opts Options) Result {
|
||||
order += "b"
|
||||
return Result{OK: true}
|
||||
})
|
||||
|
||||
c.Task("pipeline", Task{
|
||||
Steps: []Step{
|
||||
{Action: "step.a"},
|
||||
{Action: "step.b", Input: "previous"},
|
||||
},
|
||||
})
|
||||
|
||||
c.Task("pipeline").Run(context.Background(), c, NewOptions())
|
||||
fmt.Println(order)
|
||||
// Output: ab
|
||||
}
|
||||
|
||||
// --- Registry ---
|
||||
|
||||
func ExampleNewRegistry() {
|
||||
r := NewRegistry[string]()
|
||||
r.Set("alpha", "first")
|
||||
r.Set("bravo", "second")
|
||||
|
||||
fmt.Println(r.Has("alpha"))
|
||||
fmt.Println(r.Names())
|
||||
fmt.Println(r.Len())
|
||||
// Output:
|
||||
// true
|
||||
// [alpha bravo]
|
||||
// 2
|
||||
}
|
||||
|
||||
func ExampleRegistry_Lock() {
|
||||
r := NewRegistry[string]()
|
||||
r.Set("alpha", "first")
|
||||
r.Lock()
|
||||
|
||||
result := r.Set("beta", "second")
|
||||
fmt.Println(result.OK)
|
||||
// Output: false
|
||||
}
|
||||
|
||||
func ExampleRegistry_Seal() {
|
||||
r := NewRegistry[string]()
|
||||
r.Set("alpha", "first")
|
||||
r.Seal()
|
||||
|
||||
// Can update existing
|
||||
fmt.Println(r.Set("alpha", "updated").OK)
|
||||
// Can't add new
|
||||
fmt.Println(r.Set("beta", "new").OK)
|
||||
// Output:
|
||||
// true
|
||||
// false
|
||||
}
|
||||
|
||||
// --- Entitlement ---
|
||||
|
||||
func ExampleCore_Entitled_default() {
|
||||
c := New()
|
||||
e := c.Entitled("anything")
|
||||
fmt.Println(e.Allowed)
|
||||
fmt.Println(e.Unlimited)
|
||||
// Output:
|
||||
// true
|
||||
// true
|
||||
}
|
||||
|
||||
func ExampleCore_Entitled_custom() {
|
||||
c := New()
|
||||
c.SetEntitlementChecker(func(action string, qty int, _ context.Context) Entitlement {
|
||||
if action == "premium" {
|
||||
return Entitlement{Allowed: false, Reason: "upgrade required"}
|
||||
}
|
||||
return Entitlement{Allowed: true, Unlimited: true}
|
||||
})
|
||||
|
||||
fmt.Println(c.Entitled("basic").Allowed)
|
||||
fmt.Println(c.Entitled("premium").Allowed)
|
||||
fmt.Println(c.Entitled("premium").Reason)
|
||||
// Output:
|
||||
// true
|
||||
// false
|
||||
// upgrade required
|
||||
}
|
||||
|
||||
func ExampleEntitlement_NearLimit() {
|
||||
e := Entitlement{Allowed: true, Limit: 100, Used: 85, Remaining: 15}
|
||||
fmt.Println(e.NearLimit(0.8))
|
||||
fmt.Println(e.UsagePercent())
|
||||
// Output:
|
||||
// true
|
||||
// 85
|
||||
}
|
||||
|
||||
// --- Process ---
|
||||
|
||||
func ExampleCore_Process() {
|
||||
c := New()
|
||||
// No go-process registered — permission by registration
|
||||
fmt.Println(c.Process().Exists())
|
||||
|
||||
// Register a mock process handler
|
||||
c.Action("process.run", func(_ context.Context, opts Options) Result {
|
||||
return Result{Value: "output of " + opts.String("command"), OK: true}
|
||||
})
|
||||
fmt.Println(c.Process().Exists())
|
||||
|
||||
r := c.Process().Run(context.Background(), "echo", "hello")
|
||||
fmt.Println(r.Value)
|
||||
// Output:
|
||||
// false
|
||||
// true
|
||||
// output of echo
|
||||
}
|
||||
|
||||
// --- JSON ---
|
||||
|
||||
func ExampleJSONMarshal() {
|
||||
type config struct {
|
||||
Host string `json:"host"`
|
||||
Port int `json:"port"`
|
||||
}
|
||||
r := JSONMarshal(config{Host: "localhost", Port: 8080})
|
||||
fmt.Println(string(r.Value.([]byte)))
|
||||
// Output: {"host":"localhost","port":8080}
|
||||
}
|
||||
|
||||
func ExampleJSONUnmarshalString() {
|
||||
type config struct {
|
||||
Host string `json:"host"`
|
||||
Port int `json:"port"`
|
||||
}
|
||||
var cfg config
|
||||
JSONUnmarshalString(`{"host":"localhost","port":8080}`, &cfg)
|
||||
fmt.Println(cfg.Host, cfg.Port)
|
||||
// Output: localhost 8080
|
||||
}
|
||||
|
||||
// --- Utilities ---
|
||||
|
||||
func ExampleID() {
|
||||
id := ID()
|
||||
fmt.Println(HasPrefix(id, "id-"))
|
||||
// Output: true
|
||||
}
|
||||
|
||||
func ExampleValidateName() {
|
||||
fmt.Println(ValidateName("brain").OK)
|
||||
fmt.Println(ValidateName("").OK)
|
||||
fmt.Println(ValidateName("..").OK)
|
||||
fmt.Println(ValidateName("path/traversal").OK)
|
||||
// Output:
|
||||
// true
|
||||
// false
|
||||
// false
|
||||
// false
|
||||
}
|
||||
|
||||
func ExampleSanitisePath() {
|
||||
fmt.Println(SanitisePath("../../etc/passwd"))
|
||||
fmt.Println(SanitisePath(""))
|
||||
fmt.Println(SanitisePath("/some/path/file.txt"))
|
||||
// Output:
|
||||
// passwd
|
||||
// invalid
|
||||
// file.txt
|
||||
}
|
||||
|
||||
// --- Command ---
|
||||
|
||||
func ExampleCore_Command() {
|
||||
c := New()
|
||||
c.Command("deploy/to/homelab", Command{
|
||||
Action: func(opts Options) Result {
|
||||
return Result{Value: "deployed to " + opts.String("_arg"), OK: true}
|
||||
},
|
||||
})
|
||||
|
||||
r := c.Cli().Run("deploy", "to", "homelab")
|
||||
fmt.Println(r.OK)
|
||||
// Output: true
|
||||
}
|
||||
|
||||
// --- Config ---
|
||||
|
||||
func ExampleConfig() {
|
||||
c := New()
|
||||
c.Config().Set("database.host", "localhost")
|
||||
c.Config().Set("database.port", 5432)
|
||||
c.Config().Enable("dark-mode")
|
||||
|
||||
fmt.Println(c.Config().String("database.host"))
|
||||
fmt.Println(c.Config().Int("database.port"))
|
||||
fmt.Println(c.Config().Enabled("dark-mode"))
|
||||
// Output:
|
||||
// localhost
|
||||
// 5432
|
||||
// true
|
||||
}
|
||||
|
||||
// --- Error ---
|
||||
|
||||
func ExampleE() {
|
||||
err := E("service.Start", "database connection failed", nil)
|
||||
fmt.Println(Operation(err))
|
||||
fmt.Println(ErrorMessage(err))
|
||||
// Output:
|
||||
// service.Start
|
||||
// database connection failed
|
||||
}
|
||||
Loading…
Add table
Reference in a new issue