mirror of
https://github.com/coder/coder.git
synced 2026-10-31 11:02:50 +08:00
dylanhuff-at-coder
952c0ce5e6
`TestUserSecretAuditDiffRedaction` flakes when create and update audit rows receive equal timestamps and `GetAuditLogsOffset` returns the tied rows in either order. Identify audit rows by action, or by diff content when both actions are writes, instead of relying on slice position. Fixes coder/internal#1625. Reviewed and updated by Coder Agents on behalf of @dylanhuff-at-coder.
112 lines
4.0 KiB
Go
112 lines
4.0 KiB
Go
package coderd_test
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/audit"
|
|
"github.com/coder/coder/v2/coderd/coderdtest"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
"github.com/coder/coder/v2/coderd/database/dbtestutil"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
entaudit "github.com/coder/coder/v2/enterprise/audit"
|
|
"github.com/coder/coder/v2/enterprise/audit/backends"
|
|
"github.com/coder/coder/v2/enterprise/coderd/coderdenttest"
|
|
"github.com/coder/coder/v2/enterprise/coderd/license"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
func TestUserSkillAuditDiffTracksContent(t *testing.T) {
|
|
// User skill content is user-authored instruction text, not secret material.
|
|
// The enterprise auditor needs to be used because it writes actual diffs.
|
|
t.Parallel()
|
|
|
|
db, ps := dbtestutil.NewDB(t)
|
|
auditor := entaudit.NewAuditor(
|
|
db,
|
|
entaudit.DefaultFilter,
|
|
backends.NewPostgres(db, true),
|
|
)
|
|
|
|
ownerClient, owner := coderdenttest.New(t, &coderdenttest.Options{
|
|
AuditLogging: true,
|
|
Options: &coderdtest.Options{
|
|
Database: db,
|
|
Pubsub: ps,
|
|
Auditor: auditor,
|
|
},
|
|
LicenseOptions: &coderdenttest.LicenseOptions{
|
|
Features: license.Features{
|
|
codersdk.FeatureAuditLog: 1,
|
|
},
|
|
},
|
|
})
|
|
memberClient, _ := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)
|
|
member := codersdk.NewExperimentalClient(memberClient)
|
|
ctx := testutil.Context(t, testutil.WaitMedium)
|
|
|
|
initialContent := userSkillMarkdown("audit-tracking", "initial", "initial body")
|
|
skill, err := member.CreateUserSkill(ctx, codersdk.Me, codersdk.CreateUserSkillRequest{
|
|
Content: initialContent,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
newContent := userSkillMarkdown("audit-tracking", "after", "new body")
|
|
_, err = member.UpdateUserSkill(ctx, codersdk.Me, skill.Name, codersdk.UpdateUserSkillRequest{
|
|
Content: newContent,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
rows, err := db.GetAuditLogsOffset(
|
|
dbauthz.AsSystemRestricted(ctx),
|
|
database.GetAuditLogsOffsetParams{
|
|
ResourceType: string(database.ResourceTypeUserSkill),
|
|
LimitOpt: 10,
|
|
},
|
|
)
|
|
require.NoError(t, err)
|
|
require.Len(t, rows, 2, "expected exactly two rows")
|
|
byAction := auditLogsByAction(t, rows)
|
|
createLog := byAction[database.AuditActionCreate]
|
|
updateLog := byAction[database.AuditActionWrite]
|
|
require.Equal(t, database.AuditActionCreate, createLog.Action, "missing create audit log")
|
|
require.Equal(t, database.AuditActionWrite, updateLog.Action, "missing update audit log")
|
|
|
|
var createDiff audit.Map
|
|
require.NoError(t, json.Unmarshal(createLog.Diff, &createDiff))
|
|
if assert.Contains(t, createDiff, "description", "tracked field missing from create diff") {
|
|
assert.Equal(t, "", createDiff["description"].Old)
|
|
assert.Equal(t, "initial", createDiff["description"].New)
|
|
assert.False(t, createDiff["description"].Secret)
|
|
}
|
|
if assert.Contains(t, createDiff, "content", "content field missing from create diff") {
|
|
assert.False(t, createDiff["content"].Secret)
|
|
assert.Equal(t, "", createDiff["content"].Old)
|
|
assert.Equal(t, initialContent, createDiff["content"].New)
|
|
}
|
|
|
|
var updateDiff audit.Map
|
|
require.NoError(t, json.Unmarshal(updateLog.Diff, &updateDiff))
|
|
if assert.Contains(t, updateDiff, "description", "tracked field missing from update diff") {
|
|
assert.Equal(t, "initial", updateDiff["description"].Old)
|
|
assert.Equal(t, "after", updateDiff["description"].New)
|
|
assert.False(t, updateDiff["description"].Secret)
|
|
}
|
|
if assert.Contains(t, updateDiff, "content", "content field missing from update diff") {
|
|
assert.False(t, updateDiff["content"].Secret)
|
|
assert.Equal(t, initialContent, updateDiff["content"].Old)
|
|
assert.Equal(t, newContent, updateDiff["content"].New)
|
|
}
|
|
assert.NotContains(t, updateDiff, "created_at")
|
|
assert.NotContains(t, updateDiff, "updated_at")
|
|
}
|
|
|
|
func userSkillMarkdown(name string, description string, body string) string {
|
|
return fmt.Sprintf("---\nname: %s\ndescription: %s\n---\n\n%s\n", name, description, body)
|
|
}
|