Skip to content

Return client errors for invalid process and file paths #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chruffins wants to merge 2 commits into
base: main
Choose a base branch
from
+222 −195
Open

Return client errors for invalid process and file paths #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6382bc4
Return client errors for invalid process and file paths
chruffins Oct 15, 2026
5395966
Return not found for unknown resize process IDs
chruffins Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions server/cmd/api/api/fs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"path/filepath"
"strconv"
"strings"
"syscall"

"sync"

Expand Down Expand Up @@ -205,6 +206,9 @@ func (s *ApiService) ListFiles(ctx context.Context, req oapi.ListFilesRequestObj
if errors.Is(err, os.ErrNotExist) {
return oapi.ListFiles404JSONResponse{NotFoundErrorJSONResponse: oapi.NotFoundErrorJSONResponse{Message: "directory not found"}}, nil
}
if errors.Is(err, syscall.ENOTDIR) {
return oapi.ListFiles400JSONResponse{BadRequestErrorJSONResponse: oapi.BadRequestErrorJSONResponse{Message: "path is not a directory"}}, nil
}
log.Error("failed to read directory", "err", err, "path", path)
return oapi.ListFiles500JSONResponse{InternalErrorJSONResponse: oapi.InternalErrorJSONResponse{Message: "failed to read directory"}}, nil
}
Expand Down
8 changes: 8 additions & 0 deletions server/cmd/api/api/fs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,14 @@ func TestFileDirOperations(t *testing.T) {
t.Fatalf("ListFiles unexpected content: %+v", lf200)
}

listFileResp, err := svc.ListFiles(ctx, oapi.ListFilesRequestObject{Params: oapi.ListFilesParams{Path: filePath}})
if err != nil {
t.Fatalf("ListFiles on file error: %v", err)
}
if _, ok := listFileResp.(oapi.ListFiles400JSONResponse); !ok {
t.Fatalf("expected 400 when listing a file, got %T", listFileResp)
}

// FileInfo
fiResp, err := svc.FileInfo(ctx, oapi.FileInfoRequestObject{Params: oapi.FileInfoParams{Path: filePath}})
if err != nil {
Expand Down
10 changes: 5 additions & 5 deletions server/cmd/api/api/process.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ func (s *ApiService) ProcessSpawn(ctx context.Context, request oapi.ProcessSpawn
// (POST /process/{process_id}/kill)
func (s *ApiService) ProcessKill(ctx context.Context, request oapi.ProcessKillRequestObject) (oapi.ProcessKillResponseObject, error) {
log := logger.FromContext(ctx)
id := request.ProcessId.String()
id := request.ProcessId
s.procMu.RLock()
h, ok := s.procs[id]
s.procMu.RUnlock()
Expand Down Expand Up @@ -498,7 +498,7 @@ func (s *ApiService) ProcessKill(ctx context.Context, request oapi.ProcessKillRe
// Get process status
// (GET /process/{process_id}/status)
func (s *ApiService) ProcessStatus(ctx context.Context, request oapi.ProcessStatusRequestObject) (oapi.ProcessStatusResponseObject, error) {
id := request.ProcessId.String()
id := request.ProcessId
s.procMu.RLock()
h, ok := s.procs[id]
s.procMu.RUnlock()
Expand Down Expand Up @@ -545,7 +545,7 @@ func (s *ApiService) ProcessStatus(ctx context.Context, request oapi.ProcessStat
// Write to process stdin
// (POST /process/{process_id}/stdin)
func (s *ApiService) ProcessStdin(ctx context.Context, request oapi.ProcessStdinRequestObject) (oapi.ProcessStdinResponseObject, error) {
id := request.ProcessId.String()
id := request.ProcessId
s.procMu.RLock()
h, ok := s.procs[id]
s.procMu.RUnlock()
Expand All @@ -570,7 +570,7 @@ func (s *ApiService) ProcessStdin(ctx context.Context, request oapi.ProcessStdin
// (GET /process/{process_id}/stdout/stream)
func (s *ApiService) ProcessStdoutStream(ctx context.Context, request oapi.ProcessStdoutStreamRequestObject) (oapi.ProcessStdoutStreamResponseObject, error) {
log := logger.FromContext(ctx)
id := request.ProcessId.String()
id := request.ProcessId
s.procMu.RLock()
h, ok := s.procs[id]
s.procMu.RUnlock()
Expand Down Expand Up @@ -615,7 +615,7 @@ func ptrOf[T any](v T) *T { return &v }
// Resize PTY-backed process
// (POST /process/{process_id}/resize)
func (s *ApiService) ProcessResize(ctx context.Context, request oapi.ProcessResizeRequestObject) (oapi.ProcessResizeResponseObject, error) {
id := request.ProcessId.String()
id := request.ProcessId
if request.Body == nil {
return oapi.ProcessResize400JSONResponse{BadRequestErrorJSONResponse: oapi.BadRequestErrorJSONResponse{Message: "request body required"}}, nil
}
Expand Down
60 changes: 40 additions & 20 deletions server/cmd/api/api/process_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ import (
"testing"
"time"

"github.com/google/uuid"
oapi "github.com/kernel/kernel-images/server/lib/oapi"
"github.com/kernel/kernel-images/server/lib/scaletozero"
openapi_types "github.com/oapi-codegen/runtime/types"
"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -58,13 +56,13 @@ func TestProcessSpawnStatusAndStream(t *testing.T) {
require.NotNil(t, s200.Pid, "missing Pid in spawn resp")

// Status should be running initially (may race to exited; tolerate both by not asserting)
statusResp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: *s200.ProcessId})
statusResp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: s200.ProcessId.String()})
require.NoError(t, err, "ProcessStatus error")
_, ok = statusResp.(oapi.ProcessStatus200JSONResponse)
require.True(t, ok, "unexpected status resp: %T", statusResp)

// Start stream reader and collect at least two data events and one exit event
streamResp, err := svc.ProcessStdoutStream(ctx, oapi.ProcessStdoutStreamRequestObject{ProcessId: *s200.ProcessId})
streamResp, err := svc.ProcessStdoutStream(ctx, oapi.ProcessStdoutStreamRequestObject{ProcessId: s200.ProcessId.String()})
require.NoError(t, err, "StdoutStream error")
st200, ok := streamResp.(oapi.ProcessStdoutStream200TexteventStreamResponse)
require.True(t, ok, "unexpected stream resp: %T", streamResp)
Expand Down Expand Up @@ -126,7 +124,7 @@ func TestProcessStdinAndExit(t *testing.T) {

// Write 3 bytes
data := base64.StdEncoding.EncodeToString([]byte("xyz"))
stdinResp, err := svc.ProcessStdin(ctx, oapi.ProcessStdinRequestObject{ProcessId: *s200.ProcessId, Body: &oapi.ProcessStdinRequest{DataB64: data}})
stdinResp, err := svc.ProcessStdin(ctx, oapi.ProcessStdinRequestObject{ProcessId: s200.ProcessId.String(), Body: &oapi.ProcessStdinRequest{DataB64: data}})
require.NoError(t, err, "ProcessStdin error")
st200, ok := stdinResp.(oapi.ProcessStdin200JSONResponse)
require.True(t, ok, "unexpected stdin resp type: %T", stdinResp)
Expand All @@ -136,7 +134,7 @@ func TestProcessStdinAndExit(t *testing.T) {
// Wait for exit via status polling
deadline := time.Now().Add(3 * time.Second)
for time.Now().Before(deadline) {
resp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: *s200.ProcessId})
resp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: s200.ProcessId.String()})
require.NoError(t, err, "ProcessStatus error")
sr, ok := resp.(oapi.ProcessStatus200JSONResponse)
require.True(t, ok, "unexpected status resp: %T", resp)
Expand Down Expand Up @@ -164,15 +162,15 @@ func TestProcessKill(t *testing.T) {

// Send KILL
killBody := &oapi.ProcessKillRequest{Signal: "KILL"}
killResp, err := svc.ProcessKill(ctx, oapi.ProcessKillRequestObject{ProcessId: *s200.ProcessId, Body: killBody})
killResp, err := svc.ProcessKill(ctx, oapi.ProcessKillRequestObject{ProcessId: s200.ProcessId.String(), Body: killBody})
require.NoError(t, err, "ProcessKill error")
_, ok = killResp.(oapi.ProcessKill200JSONResponse)
require.True(t, ok, "unexpected kill resp: %T", killResp)

// Verify exited
deadline := time.Now().Add(3 * time.Second)
for time.Now().Before(deadline) {
resp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: *s200.ProcessId})
resp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: s200.ProcessId.String()})
require.NoError(t, err, "ProcessStatus error")
sr, ok := resp.(oapi.ProcessStatus200JSONResponse)
require.True(t, ok, "unexpected status resp: %T", resp)
Expand All @@ -188,19 +186,41 @@ func TestProcessNotFoundRoutes(t *testing.T) {
t.Parallel()
ctx := context.Background()
svc := &ApiService{procs: make(map[string]*processHandle)}
id := "no-such-id"

// random id that will not exist
id := openapi_types.UUID(uuid.New())
if resp, _ := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: id}); true {
require.NotNil(t, resp, "expected a response")
_, ok := resp.(oapi.ProcessStatus404JSONResponse)
require.True(t, ok, "expected 404, got %T", resp)
}
if resp, _ := svc.ProcessStdoutStream(ctx, oapi.ProcessStdoutStreamRequestObject{ProcessId: id}); true {
require.NotNil(t, resp, "expected a response")
_, ok := resp.(oapi.ProcessStdoutStream404JSONResponse)
require.True(t, ok, "expected 404, got %T", resp)
}
statusResp, err := svc.ProcessStatus(ctx, oapi.ProcessStatusRequestObject{ProcessId: id})
require.NoError(t, err)
_, ok := statusResp.(oapi.ProcessStatus404JSONResponse)
require.True(t, ok, "expected 404, got %T", statusResp)

streamResp, err := svc.ProcessStdoutStream(ctx, oapi.ProcessStdoutStreamRequestObject{ProcessId: id})
require.NoError(t, err)
_, ok = streamResp.(oapi.ProcessStdoutStream404JSONResponse)
require.True(t, ok, "expected 404, got %T", streamResp)

stdinResp, err := svc.ProcessStdin(ctx, oapi.ProcessStdinRequestObject{
ProcessId: id,
Body: &oapi.ProcessStdinRequest{DataB64: base64.StdEncoding.EncodeToString(nil)},
})
require.NoError(t, err)
_, ok = stdinResp.(oapi.ProcessStdin404JSONResponse)
require.True(t, ok, "expected 404, got %T", stdinResp)

killResp, err := svc.ProcessKill(ctx, oapi.ProcessKillRequestObject{
ProcessId: id,
Body: &oapi.ProcessKillRequest{Signal: "TERM"},
})
require.NoError(t, err)
_, ok = killResp.(oapi.ProcessKill404JSONResponse)
require.True(t, ok, "expected 404, got %T", killResp)

resizeResp, err := svc.ProcessResize(ctx, oapi.ProcessResizeRequestObject{
ProcessId: id,
Body: &oapi.ProcessResizeRequest{Rows: 1, Cols: 1},
})
require.NoError(t, err)
_, ok = resizeResp.(oapi.ProcessResize404JSONResponse)
require.True(t, ok, "expected 404, got %T", resizeResp)
}

func TestProcessExec_CommandNotFound(t *testing.T) {
Expand Down
Loading
Loading