feat(cli): add kind and endpointHost to docker model status --json #499
+128
−24
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,15 +2,19 @@ package commands | |
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "strconv" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/docker/cli/cli-plugins/hooks" | ||
| "github.com/docker/model-runner/cmd/cli/desktop" | ||
| mockdesktop "github.com/docker/model-runner/cmd/cli/mocks" | ||
| "github.com/docker/model-runner/cmd/cli/pkg/standalone" | ||
| "github.com/docker/model-runner/cmd/cli/pkg/types" | ||
| "github.com/docker/model-runner/pkg/inference" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/mock/gomock" | ||
|
|
@@ -126,3 +130,78 @@ func TestStatus(t *testing.T) { | |
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestJsonStatus(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| engineKind types.ModelRunnerEngineKind | ||
| urlPrefix string | ||
| expectedKind string | ||
| expectedEndpoint string | ||
| expectedHostEnd string | ||
| }{ | ||
| { | ||
| name: "Docker Desktop", | ||
| engineKind: types.ModelRunnerEngineKindDesktop, | ||
| urlPrefix: "http://localhost" + inference.ExperimentalEndpointsPrefix, | ||
| expectedKind: "Docker Desktop", | ||
| expectedEndpoint: "http://model-runner.docker.internal/v1/", | ||
| expectedHostEnd: "http://localhost" + inference.ExperimentalEndpointsPrefix + "/v1/", | ||
| }, | ||
| { | ||
| name: "Docker Engine", | ||
| engineKind: types.ModelRunnerEngineKindMoby, | ||
| urlPrefix: "http://localhost:" + strconv.Itoa(standalone.DefaultControllerPortMoby), | ||
| expectedKind: "Docker Engine", | ||
| expectedEndpoint: makeEndpoint("host.docker.internal", standalone.DefaultControllerPortMoby), | ||
| expectedHostEnd: makeEndpoint("127.0.0.1", standalone.DefaultControllerPortMoby), | ||
| }, | ||
| { | ||
| name: "Docker Cloud", | ||
| engineKind: types.ModelRunnerEngineKindCloud, | ||
| urlPrefix: "http://localhost:" + strconv.Itoa(standalone.DefaultControllerPortCloud), | ||
| expectedKind: "Docker Cloud", | ||
| expectedEndpoint: makeEndpoint("127.0.0.1", standalone.DefaultControllerPortCloud), | ||
| expectedHostEnd: makeEndpoint("127.0.0.1", standalone.DefaultControllerPortCloud), | ||
| }, | ||
| { | ||
| name: "Docker Engine (Manual Install)", | ||
| engineKind: types.ModelRunnerEngineKindMobyManual, | ||
| urlPrefix: "http://localhost:8080", | ||
| expectedKind: "Docker Engine (Manual Install)", | ||
| expectedEndpoint: "http://localhost:8080/v1/", | ||
| expectedHostEnd: "http://localhost:8080/v1/", | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| modelRunner = desktop.NewContextForMockWithKind(nil, test.engineKind, test.urlPrefix) | ||
|
|
||
| var output string | ||
| printer := desktop.NewSimplePrinter(func(msg string) { | ||
| output = msg | ||
| }) | ||
| status := desktop.Status{Running: true} | ||
| backendStatus := map[string]string{"llama.cpp": "running"} | ||
|
|
||
| // Cloud kind needs a runner for gateway IP/port | ||
| var runner *standaloneRunner | ||
| if test.engineKind == types.ModelRunnerEngineKindCloud { | ||
| runner = &standaloneRunner{} | ||
| } | ||
|
|
||
| err := jsonStatus(printer, runner, status, backendStatus) | ||
| require.NoError(t, err) | ||
|
|
||
| var result map[string]any | ||
| err = json.Unmarshal([]byte(output), &result) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Equal(t, test.expectedKind, result["kind"]) | ||
| require.Equal(t, test.expectedEndpoint, result["endpoint"]) | ||
| require.Equal(t, test.expectedHostEnd, result["endpointHost"]) | ||
| require.Equal(t, true, result["running"]) | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -113,6 +113,20 @@ func NewContextForMock(client DockerHttpClient) *ModelRunnerContext { | |
| } | ||
| } | ||
|
|
||
| // NewContextForMockWithKind is a ModelRunnerContext constructor exposed only for the | ||
| // purposes of mock testing with a specific engine kind. | ||
| func NewContextForMockWithKind(client DockerHttpClient, kind types.ModelRunnerEngineKind, rawURLPrefix string) *ModelRunnerContext { | ||
|
Contributor
There was a problem hiding this comment. nit: we could update |
||
| urlPrefix, err := url.Parse(rawURLPrefix) | ||
| if err != nil { | ||
| panic("error occurred while parsing URL: " + err.Error()) | ||
| } | ||
| return &ModelRunnerContext{ | ||
| kind: kind, | ||
| urlPrefix: urlPrefix, | ||
| client: client, | ||
| } | ||
| } | ||
|
|
||
| // NewContextForTest creates a ModelRunnerContext for integration testing | ||
| // with a custom URL endpoint. This is intended for use in integration tests | ||
| // where the Model Runner endpoint is dynamically created (e.g., testcontainers). | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with other cases like
ModelRunnerEngineKindMobyManualand to avoid re-implementing the URL construction logic, it's better to usemodelRunner.URL("/v1/")to get the host endpoint URL. ThemodelRunnercontext is already configured with the correct base URL for host-to-model-runner communication in theDesktopcase. This change improves maintainability by centralizing URL construction.