Files
LocalAI/pkg/mcp/localaitools/fakes_test.go
LocalAI [bot] 8cec22c3b7 feat(vram): per-node VRAM allocation budget (LOCALAI_VRAM_BUDGET) (#10833)
* feat(vram): add vrambudget primitive for per-node VRAM caps

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

* feat(vram): apply default VRAM budget in xsysinfo aggregate getters

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

* feat(vram): wire LOCALAI_VRAM_BUDGET flag to xsysinfo default budget

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

* feat(vram): persist VRAM budget via runtime settings with live apply

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

* test(vram): reset process-global VRAM budget after runtime-settings spec

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

* feat(vram): add VRAM budget field to Settings page

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

* feat(vram): store and enforce per-node VRAM budget in the node registry

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

* feat(vram): apply per-node VRAM budget in router hardware defaults

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

* feat(vram): report worker VRAM budget in node registration

The distributed worker now reports its operator-set VRAM budget string
(LOCALAI_VRAM_BUDGET) to the server on registration. The worker keeps
reporting RAW total/available VRAM and never sets the xsysinfo
process-global budget (that stays standalone-only); the server resolves
and enforces the budget uniformly (Task 6).

Also closes a Task 6 gap: on re-registration, a struct Updates zero-skips
an empty budget, so a worker that dropped LOCALAI_VRAM_BUDGET left the
stale cap in place. For non-admin-override nodes the budget columns are
now force-written (map Updates) even when empty, so removing the env var
clears the cap; admin overrides are preserved unchanged.

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

* style(vram): drop em dash from worker-clear comment

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

* feat(vram): add node VRAM budget admin endpoints

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

* feat(vram): add node VRAM budget control to the node UI

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

* feat(vram): expose set_node_vram_budget MCP admin tool

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

* docs(vram): document LOCALAI_VRAM_BUDGET and node VRAM budget UI

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

* fix(vram): avoid double-applying VRAM budget in GetResourceAggregateInfo

The GPU-branch aggregate returned by GetResourceInfo is sourced from
GetGPUAggregateInfo, which already caps total/free/used against the
process-wide VRAM budget. GetResourceAggregateInfo then applied the
budget a second time. For an absolute budget this is idempotent, but for
a percentage budget b.Apply resolves the ceiling as a fraction of its
input total, so a second pass yields P*(P*T) instead of P*T and distorts
UsagePercent (read by the memory reclaimer in pkg/model/watchdog.go).

Remove the redundant second application so the budget is applied exactly
once, against the raw physical totals, upstream in GetGPUAggregateInfo.

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

* fix(vram): implement SetNodeVRAMBudget on mcp assistant test stub

The LocalAIClient interface gained SetNodeVRAMBudget; the stubClient in
core/http/endpoints/mcp used by the assistant tests is a separate
implementer and needs the method too (broke golangci-lint typecheck and
both test jobs).

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-07-15 09:58:45 +02:00

345 lines
10 KiB
Go

package localaitools
import (
"context"
"errors"
"sync"
"github.com/mudler/LocalAI/core/config"
"github.com/mudler/LocalAI/core/gallery"
"github.com/mudler/LocalAI/core/schema"
"github.com/mudler/LocalAI/core/services/modeladmin"
"github.com/mudler/LocalAI/pkg/vram"
)
// fakeClient is a recording, configurable LocalAIClient for unit tests.
// Each method records the args it was called with and returns whatever the
// matching field on the struct is configured to return. Methods are guarded
// by a mutex so tests can run with -race.
type fakeClient struct {
mu sync.Mutex
// Recorded calls (in order).
calls []fakeCall
// Per-method overrides. Tests set these.
gallerySearch func(GallerySearchQuery) ([]gallery.Metadata, error)
listInstalledModels func(Capability) ([]InstalledModel, error)
listGalleries func() ([]config.Gallery, error)
getJobStatus func(string) (*JobStatus, error)
getModelConfig func(string) (*ModelConfigView, error)
installModel func(InstallModelRequest) (string, error)
importModelURI func(ImportModelURIRequest) (*ImportModelURIResponse, error)
deleteModel func(string) error
editModelConfig func(string, map[string]any) error
setAlias func(string, string) error
listAliases func() ([]AliasInfo, error)
reloadModels func() error
loadModel func(string) ([]string, error)
listBackends func() ([]Backend, error)
listKnownBackends func() ([]schema.KnownBackend, error)
installBackend func(InstallBackendRequest) (string, error)
upgradeBackend func(string) (string, error)
systemInfo func() (*SystemInfo, error)
listNodes func() ([]Node, error)
setNodeVRAMBudget func(string, string) error
vramEstimate func(VRAMEstimateRequest) (*vram.EstimateResult, error)
toggleModelState func(string, modeladmin.Action) error
toggleModelPinned func(string, modeladmin.Action) error
getBranding func() (*Branding, error)
setBranding func(SetBrandingRequest) (*Branding, error)
listVoiceProfiles func() ([]VoiceProfile, error)
createVoiceProfile func(CreateVoiceProfileRequest) (*VoiceProfile, error)
deleteVoiceProfile func(string) error
getUsageStats func(UsageStatsQuery) (*UsageStats, error)
getPIIEvents func(PIIEventsQuery) ([]PIIEvent, error)
getMiddlewareStatus func() (*MiddlewareStatus, error)
getRouterDecisions func(RouterDecisionsQuery) ([]RouterDecision, error)
}
type fakeCall struct {
method string
args any
}
func (f *fakeClient) record(method string, args any) {
f.mu.Lock()
defer f.mu.Unlock()
f.calls = append(f.calls, fakeCall{method: method, args: args})
}
func (f *fakeClient) recorded() []fakeCall {
f.mu.Lock()
defer f.mu.Unlock()
out := make([]fakeCall, len(f.calls))
copy(out, f.calls)
return out
}
var errNotConfigured = errors.New("fakeClient method not configured")
func (f *fakeClient) GallerySearch(_ context.Context, q GallerySearchQuery) ([]gallery.Metadata, error) {
f.record("GallerySearch", q)
if f.gallerySearch != nil {
return f.gallerySearch(q)
}
return nil, nil
}
func (f *fakeClient) ListInstalledModels(_ context.Context, capability Capability) ([]InstalledModel, error) {
f.record("ListInstalledModels", capability)
if f.listInstalledModels != nil {
return f.listInstalledModels(capability)
}
return nil, nil
}
func (f *fakeClient) ListGalleries(_ context.Context) ([]config.Gallery, error) {
f.record("ListGalleries", nil)
if f.listGalleries != nil {
return f.listGalleries()
}
return nil, nil
}
func (f *fakeClient) GetJobStatus(_ context.Context, jobID string) (*JobStatus, error) {
f.record("GetJobStatus", jobID)
if f.getJobStatus != nil {
return f.getJobStatus(jobID)
}
return nil, errNotConfigured
}
func (f *fakeClient) GetModelConfig(_ context.Context, name string) (*ModelConfigView, error) {
f.record("GetModelConfig", name)
if f.getModelConfig != nil {
return f.getModelConfig(name)
}
return nil, errNotConfigured
}
func (f *fakeClient) InstallModel(_ context.Context, req InstallModelRequest) (string, error) {
f.record("InstallModel", req)
if f.installModel != nil {
return f.installModel(req)
}
return "", errNotConfigured
}
func (f *fakeClient) DeleteModel(_ context.Context, name string) error {
f.record("DeleteModel", name)
if f.deleteModel != nil {
return f.deleteModel(name)
}
return nil
}
func (f *fakeClient) ImportModelURI(_ context.Context, req ImportModelURIRequest) (*ImportModelURIResponse, error) {
f.record("ImportModelURI", req)
if f.importModelURI != nil {
return f.importModelURI(req)
}
return &ImportModelURIResponse{JobID: "fake-import-job"}, nil
}
func (f *fakeClient) EditModelConfig(_ context.Context, name string, patch map[string]any) error {
f.record("EditModelConfig", []any{name, patch})
if f.editModelConfig != nil {
return f.editModelConfig(name, patch)
}
return nil
}
func (f *fakeClient) SetAlias(_ context.Context, name, target string) error {
f.record("SetAlias", []any{name, target})
if f.setAlias != nil {
return f.setAlias(name, target)
}
return nil
}
func (f *fakeClient) ListAliases(_ context.Context) ([]AliasInfo, error) {
f.record("ListAliases", nil)
if f.listAliases != nil {
return f.listAliases()
}
return []AliasInfo{}, nil
}
func (f *fakeClient) ReloadModels(_ context.Context) error {
f.record("ReloadModels", nil)
if f.reloadModels != nil {
return f.reloadModels()
}
return nil
}
func (f *fakeClient) LoadModel(_ context.Context, model string) ([]string, error) {
f.record("LoadModel", model)
if f.loadModel != nil {
return f.loadModel(model)
}
return []string{model}, nil
}
func (f *fakeClient) ListBackends(_ context.Context) ([]Backend, error) {
f.record("ListBackends", nil)
if f.listBackends != nil {
return f.listBackends()
}
return nil, nil
}
func (f *fakeClient) ListKnownBackends(_ context.Context) ([]schema.KnownBackend, error) {
f.record("ListKnownBackends", nil)
if f.listKnownBackends != nil {
return f.listKnownBackends()
}
return nil, nil
}
func (f *fakeClient) InstallBackend(_ context.Context, req InstallBackendRequest) (string, error) {
f.record("InstallBackend", req)
if f.installBackend != nil {
return f.installBackend(req)
}
return "", errNotConfigured
}
func (f *fakeClient) UpgradeBackend(_ context.Context, name string) (string, error) {
f.record("UpgradeBackend", name)
if f.upgradeBackend != nil {
return f.upgradeBackend(name)
}
return "", errNotConfigured
}
func (f *fakeClient) SystemInfo(_ context.Context) (*SystemInfo, error) {
f.record("SystemInfo", nil)
if f.systemInfo != nil {
return f.systemInfo()
}
return &SystemInfo{Version: "test"}, nil
}
func (f *fakeClient) ListNodes(_ context.Context) ([]Node, error) {
f.record("ListNodes", nil)
if f.listNodes != nil {
return f.listNodes()
}
return nil, nil
}
func (f *fakeClient) SetNodeVRAMBudget(_ context.Context, nodeID, budget string) error {
f.record("SetNodeVRAMBudget", []any{nodeID, budget})
if f.setNodeVRAMBudget != nil {
return f.setNodeVRAMBudget(nodeID, budget)
}
return nil
}
func (f *fakeClient) VRAMEstimate(_ context.Context, req VRAMEstimateRequest) (*vram.EstimateResult, error) {
f.record("VRAMEstimate", req)
if f.vramEstimate != nil {
return f.vramEstimate(req)
}
return nil, errNotConfigured
}
func (f *fakeClient) ToggleModelState(_ context.Context, name string, action modeladmin.Action) error {
f.record("ToggleModelState", []any{name, action})
if f.toggleModelState != nil {
return f.toggleModelState(name, action)
}
return nil
}
func (f *fakeClient) ToggleModelPinned(_ context.Context, name string, action modeladmin.Action) error {
f.record("ToggleModelPinned", []any{name, action})
if f.toggleModelPinned != nil {
return f.toggleModelPinned(name, action)
}
return nil
}
func (f *fakeClient) GetBranding(_ context.Context) (*Branding, error) {
f.record("GetBranding", nil)
if f.getBranding != nil {
return f.getBranding()
}
return &Branding{InstanceName: "LocalAI"}, nil
}
func (f *fakeClient) SetBranding(_ context.Context, req SetBrandingRequest) (*Branding, error) {
f.record("SetBranding", req)
if f.setBranding != nil {
return f.setBranding(req)
}
return &Branding{InstanceName: "LocalAI"}, nil
}
func (f *fakeClient) ListVoiceProfiles(_ context.Context) ([]VoiceProfile, error) {
f.record("ListVoiceProfiles", nil)
if f.listVoiceProfiles != nil {
return f.listVoiceProfiles()
}
return []VoiceProfile{}, nil
}
func (f *fakeClient) CreateVoiceProfile(_ context.Context, req CreateVoiceProfileRequest) (*VoiceProfile, error) {
f.record("CreateVoiceProfile", req)
if f.createVoiceProfile != nil {
return f.createVoiceProfile(req)
}
return &VoiceProfile{ID: "00000000-0000-0000-0000-000000000001", Name: req.Name}, nil
}
func (f *fakeClient) DeleteVoiceProfile(_ context.Context, id string) error {
f.record("DeleteVoiceProfile", id)
if f.deleteVoiceProfile != nil {
return f.deleteVoiceProfile(id)
}
return nil
}
func (f *fakeClient) GetUsageStats(_ context.Context, q UsageStatsQuery) (*UsageStats, error) {
f.record("GetUsageStats", q)
if f.getUsageStats != nil {
return f.getUsageStats(q)
}
return &UsageStats{
Viewer: UsageViewer{ID: "fake-user", Name: "fake", Role: "user"},
Period: "month",
}, nil
}
func (f *fakeClient) GetPIIEvents(_ context.Context, q PIIEventsQuery) ([]PIIEvent, error) {
f.record("GetPIIEvents", q)
if f.getPIIEvents != nil {
return f.getPIIEvents(q)
}
return []PIIEvent{}, nil
}
func (f *fakeClient) GetRouterDecisions(_ context.Context, q RouterDecisionsQuery) ([]RouterDecision, error) {
f.record("GetRouterDecisions", q)
if f.getRouterDecisions != nil {
return f.getRouterDecisions(q)
}
return []RouterDecision{}, nil
}
func (f *fakeClient) GetMiddlewareStatus(_ context.Context) (*MiddlewareStatus, error) {
f.record("GetMiddlewareStatus", nil)
if f.getMiddlewareStatus != nil {
return f.getMiddlewareStatus()
}
return &MiddlewareStatus{
PII: MiddlewarePIIStatus{
EnabledGlobally: true,
Models: []MiddlewarePIIModel{},
},
Router: MiddlewareRouterStatus{Configured: false, Models: []string{}},
}, nil
}