Files
LocalAI/core/services/modeladmin/config_test.go
LocalAI [bot] 9565db5f94 feat(models): model aliases - redirect a model name to another configured model (#10414)
* feat(config): add model alias field and self-validation

Add ModelConfig.Alias (yaml: alias), IsAlias(), and an alias
short-circuit at the top of Validate() that rejects self-reference and
forbids setting backend/parameters.model on a pure-redirect alias.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(config): resolve and validate model alias targets in the loader

Assisted-by: Claude:opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(middleware): resolve model aliases and stamp requested/served identity

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(modeladmin): reject alias configs with invalid targets on create/edit

Validate alias targets at create/swap entry points (ImportModelEndpoint,
EditYAML, PatchConfig) so a dangling, chained, or disabled alias target is
rejected at save time rather than surfacing as a runtime error.

Assisted-by: Claude:opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(api): add GET /api/aliases to list model aliases

Adds an admin-gated read-only endpoint that lists every model alias
config as {name, target} pairs, backed by the loader's existing
GetAllModelsConfigs().

Assisted-by: Claude:opus-4.8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(mcp): add set_alias and list_aliases tools

Expose model-alias management over the LocalAI Assistant MCP surface:
list_aliases (read-only, GET /api/aliases) and set_alias (mutating).
SetAlias is swap-first: PATCH /api/models/config-json/:name swaps an
existing alias's target (validated, non-destructive) and a 404 falls
back to POST /models/import to create a fresh {name, alias} config. The
inproc client mirrors this via ConfigService.PatchConfig + a create path
modeled on ImportModelEndpoint. Deletion reuses delete_model.

Assisted-by: Claude:claude-opus-4 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* style(mcp): replace em dashes in alias tool comments

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(config-meta): expose alias as a model-select field

Add an 'alias' section to DefaultSections() and an 'alias' field override
in DefaultRegistry() so the schema-driven React editor renders the new
top-level ModelConfig.Alias field as a model picker in its own section.

Assisted-by: Claude:opus-4.8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(ui): add alias template card and Manage alias badge

Add an 'Alias / Routing' template to the create-flow gallery that seeds a
minimal name + alias config, and a read-only 'alias -> target' badge on the
Manage Models tab. The capabilities row payload does not carry the alias
field, so the badge resolves targets from GET /api/aliases looked up by name.

Assisted-by: Claude:claude-opus-4 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* docs: document model aliases

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* docs(swagger): regenerate for GET /api/aliases

Adds the /api/aliases path and AliasInfo schema generated from the
ListAliasesEndpoint annotation.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* test(localai): check os.RemoveAll error in aliases_test

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* fix: correct alias conversion docs and advertise /api/aliases in instructions

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* fix(mcp): write alias config 0600 to satisfy gosec G306

The inproc createAlias path wrote the alias YAML with 0644, which gosec
flags as a new G306 finding on the PR. The LocalAI process is the sole
reader/writer of model configs, so 0600 is correct and keeps the scan clean.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

---------

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
2026-06-20 22:38:42 +02:00

234 lines
8.1 KiB
Go

package modeladmin
import (
"context"
"os"
"path/filepath"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"gopkg.in/yaml.v3"
"github.com/mudler/LocalAI/core/config"
"github.com/mudler/LocalAI/pkg/system"
)
// newTestService stands up a ConfigService backed by a tmp dir so the file IO
// is real but isolated. The model loader is loaded against the same tmp path
// so GetModelConfig works.
func newTestService() (*ConfigService, string) {
dir := GinkgoT().TempDir()
loader := config.NewModelConfigLoader(dir)
appConfig := &config.ApplicationConfig{
SystemState: &system.SystemState{Model: system.Model{ModelsPath: dir}},
}
return NewConfigService(loader, appConfig), dir
}
// writeModelYAML creates a model YAML on disk and reloads the loader so the
// new entry is visible.
func writeModelYAML(svc *ConfigService, dir, name string, body map[string]any) {
body["name"] = name
data, err := yaml.Marshal(body)
Expect(err).ToNot(HaveOccurred())
path := filepath.Join(dir, name+".yaml")
Expect(os.WriteFile(path, data, 0644)).To(Succeed())
Expect(svc.Loader.LoadModelConfigsFromPath(dir, svc.AppConfig.ToConfigLoaderOptions()...)).To(Succeed())
}
var _ = Describe("ConfigService", func() {
var (
svc *ConfigService
dir string
ctx context.Context
)
BeforeEach(func() {
svc, dir = newTestService()
ctx = context.Background()
})
Describe("GetConfig", func() {
It("round-trips YAML from disk and exposes the parsed JSON", func() {
writeModelYAML(svc, dir, "qwen", map[string]any{"backend": "llama-cpp", "context_size": 4096})
view, err := svc.GetConfig(ctx, "qwen")
Expect(err).ToNot(HaveOccurred())
Expect(view.Name).To(Equal("qwen"))
Expect(view.JSON).To(HaveKeyWithValue("backend", "llama-cpp"))
})
It("returns ErrNotFound for an unknown model", func() {
_, err := svc.GetConfig(ctx, "missing")
Expect(err).To(MatchError(ErrNotFound))
})
It("returns ErrNameRequired when name is empty", func() {
_, err := svc.GetConfig(ctx, "")
Expect(err).To(MatchError(ErrNameRequired))
})
})
Describe("PatchConfig", func() {
It("deep-merges the patch and preserves untouched siblings", func() {
writeModelYAML(svc, dir, "qwen", map[string]any{
"backend": "llama-cpp",
"context_size": 4096,
"parameters": map[string]any{"temperature": 0.7, "top_p": 0.9},
})
updated, err := svc.PatchConfig(ctx, "qwen", map[string]any{
"context_size": 8192,
"parameters": map[string]any{"temperature": 0.5},
})
Expect(err).ToNot(HaveOccurred())
Expect(updated.Name).To(Equal("qwen"))
raw, err := os.ReadFile(filepath.Join(dir, "qwen.yaml"))
Expect(err).ToNot(HaveOccurred())
var got map[string]any
Expect(yaml.Unmarshal(raw, &got)).To(Succeed())
Expect(got).To(HaveKeyWithValue("context_size", 8192))
params, ok := got["parameters"].(map[string]any)
Expect(ok).To(BeTrue())
Expect(params).To(HaveKeyWithValue("temperature", 0.5))
// top_p must still be there: deep-merge should NOT clobber siblings.
Expect(params).To(HaveKeyWithValue("top_p", 0.9))
})
It("returns ErrNotFound for an unknown model", func() {
_, err := svc.PatchConfig(ctx, "ghost", map[string]any{"x": 1})
Expect(err).To(MatchError(ErrNotFound))
})
It("rejects an empty patch with ErrEmptyBody", func() {
writeModelYAML(svc, dir, "qwen", map[string]any{"backend": "llama-cpp"})
_, err := svc.PatchConfig(ctx, "qwen", map[string]any{})
Expect(err).To(MatchError(ErrEmptyBody))
})
It("replaces a map field wholesale so deleted entries do not survive", func() {
// A detector model with a populated entity_actions map. The editor
// removes SSN and re-sends the remaining map; a naive deep-merge
// would re-add SSN (it only adds/overrides keys, never deletes).
writeModelYAML(svc, dir, "ner", map[string]any{
"backend": "llama-cpp",
"known_usecases": []any{"token_classify"},
"pii_detection": map[string]any{
"default_action": "mask",
"entity_actions": map[string]any{"SSN": "block", "EMAIL": "mask"},
},
})
_, err := svc.PatchConfig(ctx, "ner", map[string]any{
"pii_detection": map[string]any{
"default_action": "mask",
"entity_actions": map[string]any{"EMAIL": "mask"},
},
})
Expect(err).ToNot(HaveOccurred())
raw, err := os.ReadFile(filepath.Join(dir, "ner.yaml"))
Expect(err).ToNot(HaveOccurred())
var got map[string]any
Expect(yaml.Unmarshal(raw, &got)).To(Succeed())
pii := got["pii_detection"].(map[string]any)
ea := pii["entity_actions"].(map[string]any)
Expect(ea).To(HaveKeyWithValue("EMAIL", "mask"))
Expect(ea).NotTo(HaveKey("SSN"), "deleted map entry must not survive the patch")
// The scalar sibling in the same nested block is still preserved.
Expect(pii).To(HaveKeyWithValue("default_action", "mask"))
})
It("drops a map field entirely when the patch empties it", func() {
writeModelYAML(svc, dir, "ner", map[string]any{
"backend": "llama-cpp",
"known_usecases": []any{"token_classify"},
"pii_detection": map[string]any{
"default_action": "mask",
"entity_actions": map[string]any{"SSN": "block"},
},
})
_, err := svc.PatchConfig(ctx, "ner", map[string]any{
"pii_detection": map[string]any{
"entity_actions": map[string]any{},
},
})
Expect(err).ToNot(HaveOccurred())
raw, err := os.ReadFile(filepath.Join(dir, "ner.yaml"))
Expect(err).ToNot(HaveOccurred())
var got map[string]any
Expect(yaml.Unmarshal(raw, &got)).To(Succeed())
pii := got["pii_detection"].(map[string]any)
Expect(pii).NotTo(HaveKey("entity_actions"))
})
})
Describe("EditYAML", func() {
It("renames the on-disk file and reindexes the loader", func() {
writeModelYAML(svc, dir, "old-name", map[string]any{"backend": "llama-cpp"})
body := []byte("name: new-name\nbackend: llama-cpp\n")
result, err := svc.EditYAML(ctx, "old-name", body, nil)
Expect(err).ToNot(HaveOccurred())
Expect(result.Renamed).To(BeTrue())
Expect(result.OldName).To(Equal("old-name"))
Expect(result.NewName).To(Equal("new-name"))
_, err = os.Stat(filepath.Join(dir, "old-name.yaml"))
Expect(os.IsNotExist(err)).To(BeTrue(), "old YAML should be removed")
_, err = os.Stat(filepath.Join(dir, "new-name.yaml"))
Expect(err).ToNot(HaveOccurred(), "new YAML should exist")
_, ok := svc.Loader.GetModelConfig("new-name")
Expect(ok).To(BeTrue(), "loader should have the renamed model")
_, ok = svc.Loader.GetModelConfig("old-name")
Expect(ok).To(BeFalse(), "loader should not retain the old name")
})
It("refuses a rename that would clobber an existing model", func() {
writeModelYAML(svc, dir, "alpha", map[string]any{"backend": "llama-cpp"})
writeModelYAML(svc, dir, "beta", map[string]any{"backend": "llama-cpp"})
body := []byte("name: beta\nbackend: llama-cpp\n")
_, err := svc.EditYAML(ctx, "alpha", body, nil)
Expect(err).To(MatchError(ErrConflict))
})
It("rejects path-separator characters in the new name", func() {
writeModelYAML(svc, dir, "alpha", map[string]any{"backend": "llama-cpp"})
body := []byte("name: ../escape\nbackend: llama-cpp\n")
_, err := svc.EditYAML(ctx, "alpha", body, nil)
Expect(err).To(MatchError(ErrPathSeparator))
})
It("returns ErrEmptyBody when the body is nil", func() {
writeModelYAML(svc, dir, "alpha", map[string]any{"backend": "llama-cpp"})
_, err := svc.EditYAML(ctx, "alpha", nil, nil)
Expect(err).To(MatchError(ErrEmptyBody))
})
It("rejects editing a config into an alias with a missing target", func() {
writeModelYAML(svc, dir, "base", map[string]any{"backend": "llama-cpp"})
body := []byte("name: base\nalias: ghost\n")
_, err := svc.EditYAML(ctx, "base", body, nil)
Expect(err).To(MatchError(ErrInvalidConfig))
Expect(err.Error()).To(ContainSubstring("ghost"))
})
It("accepts editing a config into an alias with a real target", func() {
writeModelYAML(svc, dir, "base", map[string]any{"backend": "llama-cpp"})
writeModelYAML(svc, dir, "target", map[string]any{"backend": "llama-cpp"})
body := []byte("name: base\nalias: target\n")
_, err := svc.EditYAML(ctx, "base", body, nil)
Expect(err).ToNot(HaveOccurred())
})
})
})