mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: add link for viewing raw build logs in workspace and template build jobs (#21727)
* Adds support for parameter `format=text` in the following API routes: * `/api/v2/workspaceagents/:id/logs` * `/api/v2/workspacebuilds/:id/logs` * `/api/v2/templateversions/:id/logs` * `/api/v2/templateversions/:id/dry-run/:id/logs` * Adds links to view raw logs on the following pages: * Workspace build page * Template editor page * Template version page * Refactors existing log formatting in `cli/logs.go` to live in `codersdk`. 🤖 Generated with Claude Opus 4.5, reviewed by me. --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -6,6 +6,7 @@ import (
|
||||
"database/sql"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"slices"
|
||||
"strconv"
|
||||
@@ -25,6 +26,7 @@ import (
|
||||
"github.com/coder/coder/v2/coderd/coderdtest"
|
||||
"github.com/coder/coder/v2/coderd/coderdtest/oidctest"
|
||||
"github.com/coder/coder/v2/coderd/database"
|
||||
"github.com/coder/coder/v2/coderd/database/db2sdk"
|
||||
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
||||
"github.com/coder/coder/v2/coderd/database/dbfake"
|
||||
"github.com/coder/coder/v2/coderd/database/dbgen"
|
||||
@@ -1092,6 +1094,96 @@ func TestWorkspaceBuildLogs(t *testing.T) {
|
||||
require.Fail(t, "example message never happened")
|
||||
}
|
||||
|
||||
func TestWorkspaceBuildLogsFormat(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Setup: Create workspace build with logs using dbfake.
|
||||
client, db := coderdtest.NewWithDatabase(t, nil)
|
||||
user := coderdtest.CreateFirstUser(t, client)
|
||||
|
||||
r := dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{
|
||||
OrganizationID: user.OrganizationID,
|
||||
OwnerID: user.UserID,
|
||||
}).Do()
|
||||
|
||||
// Insert test log directly into database.
|
||||
jl := dbgen.ProvisionerJobLog(t, db, database.ProvisionerJobLog{
|
||||
JobID: r.Build.JobID,
|
||||
Stage: "Planning",
|
||||
Source: database.LogSourceProvisioner,
|
||||
Level: database.LogLevelInfo,
|
||||
Output: "test log output",
|
||||
})
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
queryParams string
|
||||
expectedStatus int
|
||||
expectedContentType string
|
||||
checkBody func(t *testing.T, body string)
|
||||
}{
|
||||
{
|
||||
name: "JSON",
|
||||
queryParams: "",
|
||||
expectedStatus: http.StatusOK,
|
||||
expectedContentType: "application/json",
|
||||
checkBody: func(t *testing.T, body string) {
|
||||
require.NotEmpty(t, body)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Text",
|
||||
queryParams: "?format=text",
|
||||
expectedStatus: http.StatusOK,
|
||||
expectedContentType: "text/plain",
|
||||
checkBody: func(t *testing.T, body string) {
|
||||
expected := db2sdk.ProvisionerJobLog(jl).Text()
|
||||
require.Contains(t, body, expected)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "InvalidFormat",
|
||||
queryParams: "?format=invalid",
|
||||
expectedStatus: http.StatusBadRequest,
|
||||
checkBody: func(t *testing.T, body string) {
|
||||
require.Contains(t, body, "Invalid format")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "TextWithFollowFails",
|
||||
queryParams: "?format=text&follow",
|
||||
expectedStatus: http.StatusBadRequest,
|
||||
checkBody: func(t *testing.T, body string) {
|
||||
require.Contains(t, body, "not supported with follow mode")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
ctx := testutil.Context(t, testutil.WaitLong)
|
||||
|
||||
urlPath := fmt.Sprintf("/api/v2/workspacebuilds/%s/logs%s", r.Build.ID, tt.queryParams)
|
||||
|
||||
res, err := client.Request(ctx, http.MethodGet, urlPath, nil)
|
||||
require.NoError(t, err)
|
||||
defer res.Body.Close()
|
||||
|
||||
require.Equal(t, tt.expectedStatus, res.StatusCode)
|
||||
if tt.expectedContentType != "" {
|
||||
require.Contains(t, res.Header.Get("Content-Type"), tt.expectedContentType)
|
||||
}
|
||||
|
||||
if assert.NotNil(t, tt.checkBody) {
|
||||
body, err := io.ReadAll(res.Body)
|
||||
require.NoError(t, err)
|
||||
tt.checkBody(t, string(body))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestWorkspaceBuildState(t *testing.T) {
|
||||
t.Parallel()
|
||||
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
||||
|
||||
Reference in New Issue
Block a user