Skip to content

feat: Add database data generator to make fakedbs easier to populate #5922

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

Merged
merged 21 commits into from
Jan 31, 2023
Merged

feat: Add database data generator to make fakedbs easier to populate #5922

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
50ea251
feat: Add database data generator to make fakedbs easier to populate
Emyrk Jan 30, 2023
722194b
Add resources and jobS
Emyrk Jan 30, 2023
38eb88e
Support api keys in generator
Emyrk Jan 30, 2023
d4fe6b7
Begin refactoring api key tests with generator
Emyrk Jan 30, 2023
d423ba2
Refactor api tests to use fake generator
Emyrk Jan 30, 2023
fac054a
Refactor workspace apps test
Emyrk Jan 30, 2023
387c1bd
Remove unused function
Emyrk Jan 30, 2023
50cba39
Refactor provsionerdserver tests
Emyrk Jan 30, 2023
396aa4a
Refactor prom metrics test
Emyrk Jan 30, 2023
5648499
Add unit tests for generator
Emyrk Jan 30, 2023
298ca3e
Remove takeFirstTime
Emyrk Jan 31, 2023
3bfd4d6
Add more randomness to names
Emyrk Jan 31, 2023
7fc8ead
Use fatal over panic
Emyrk Jan 31, 2023
5ba3463
Remove use of panics
Emyrk Jan 31, 2023
bc88e41
Remove all state from generator
Emyrk Jan 31, 2023
1113d8f
Move generate functions and no more generics
Emyrk Jan 31, 2023
5cd9acd
Move to database gen package
Emyrk Jan 31, 2023
e7d2b5f
Fix all refactored tests to use new methods
Emyrk Jan 31, 2023
5e12b78
Remove unused ctx
Emyrk Jan 31, 2023
144ef40
Add comment about unused fields
Emyrk Jan 31, 2023
61ca1ca
rename to dbgen
Emyrk Jan 31, 2023
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
Prev Previous commit
Next Next commit
Add resources and jobS
  • Loading branch information
@Emyrk
Emyrk committed Jan 30, 2023
commit 722194bd11194fa1fc6bcfa2f0507f04a9f33c4b
106 changes: 89 additions & 17 deletions coderd/database/databasefake/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package databasefake

import (
"context"
"database/sql"
"testing"
"time"

Expand Down Expand Up @@ -57,6 +58,14 @@ func populate[DBType any](ctx context.Context, g *Generator, name string, seed D
return out[name].(DBType)
}

func (g *Generator) WorkspaceResource(ctx context.Context, name string, seed database.WorkspaceResource) database.WorkspaceResource {
return populate(ctx, g, name, seed)
}

func (g *Generator) Job(ctx context.Context, name string, seed database.ProvisionerJob) database.ProvisionerJob {
return populate(ctx, g, name, seed)
}

func (g *Generator) Group(ctx context.Context, name string, seed database.Group) database.Group {
return populate(ctx, g, name, seed)
}
Expand Down Expand Up @@ -94,8 +103,8 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
case database.Template:
template, err := db.InsertTemplate(ctx, database.InsertTemplateParams{
ID: g.Lookup(name),
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
OrganizationID: takeFirst(orig.OrganizationID, g.PrimaryOrg(ctx).ID),
Name: takeFirst(orig.Name, namesgenerator.GetRandomName(1)),
Provisioner: takeFirst(orig.Provisioner, database.ProvisionerTypeEcho),
Expand All @@ -115,8 +124,8 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
case database.Workspace:
workspace, err := db.InsertWorkspace(ctx, database.InsertWorkspaceParams{
ID: g.Lookup(name),
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
OrganizationID: takeFirst(orig.OrganizationID, g.PrimaryOrg(ctx).ID),
TemplateID: takeFirst(orig.TemplateID, uuid.New()),
Name: takeFirst(orig.Name, namesgenerator.GetRandomName(1)),
Expand All @@ -129,16 +138,16 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
case database.WorkspaceBuild:
build, err := db.InsertWorkspaceBuild(ctx, database.InsertWorkspaceBuildParams{
ID: g.Lookup(name),
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
WorkspaceID: takeFirst(orig.WorkspaceID, uuid.New()),
TemplateVersionID: takeFirst(orig.TemplateVersionID, uuid.New()),
BuildNumber: takeFirst(orig.BuildNumber, 0),
Transition: takeFirst(orig.Transition, database.WorkspaceTransitionStart),
InitiatorID: takeFirst(orig.InitiatorID, uuid.New()),
JobID: takeFirst(orig.InitiatorID, uuid.New()),
ProvisionerState: []byte{},
Deadline: time.Now(),
JobID: takeFirst(orig.JobID, uuid.New()),
ProvisionerState: takeFirstBytes(orig.ProvisionerState, []byte{}),
Deadline: takeFirstTime(orig.CreatedAt, time.Now().Add(time.Hour)),
Reason: takeFirst(orig.Reason, database.BuildReasonInitiator),
})
require.NoError(t, err, "insert workspace build")
Expand All @@ -149,9 +158,9 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
ID: g.Lookup(name),
Email: takeFirst(orig.Email, namesgenerator.GetRandomName(1)),
Username: takeFirst(orig.Username, namesgenerator.GetRandomName(1)),
HashedPassword: []byte{},
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
HashedPassword: takeFirstBytes(orig.HashedPassword, []byte{}),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
RBACRoles: []string{},
LoginType: takeFirst(orig.LoginType, database.LoginTypePassword),
})
Expand All @@ -164,8 +173,8 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
ID: g.Lookup(name),
Name: takeFirst(orig.Name, namesgenerator.GetRandomName(1)),
Description: takeFirst(orig.Name, namesgenerator.GetRandomName(1)),
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
})
require.NoError(t, err, "insert organization")

Expand All @@ -182,12 +191,55 @@ func (g *Generator) Populate(ctx context.Context, seed map[string]interface{}) m
require.NoError(t, err, "insert organization")

seed[name] = org

case database.ProvisionerJob:
job, err := db.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
ID: g.Lookup(name),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
UpdatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
OrganizationID: takeFirst(orig.OrganizationID, g.PrimaryOrg(ctx).ID),
InitiatorID: takeFirst(orig.InitiatorID, uuid.New()),
Provisioner: takeFirst(orig.Provisioner, database.ProvisionerTypeEcho),
StorageMethod: takeFirst(orig.StorageMethod, database.ProvisionerStorageMethodFile),
FileID: takeFirst(orig.FileID, uuid.New()),
Type: takeFirst(orig.Type, database.ProvisionerJobTypeWorkspaceBuild),
Input: takeFirstBytes(orig.Input, []byte("{}")),
Tags: orig.Tags,
})
require.NoError(t, err, "insert job")

seed[name] = job

case database.WorkspaceResource:
resource, err := db.InsertWorkspaceResource(ctx, database.InsertWorkspaceResourceParams{
ID: g.Lookup(name),
CreatedAt: takeFirstTime(orig.CreatedAt, time.Now()),
JobID: takeFirst(orig.JobID, uuid.New()),
Transition: takeFirst(orig.Transition, database.WorkspaceTransitionStart),
// TODO: What type to put here?
Type: takeFirst(orig.Type, ""),
Name: takeFirst(orig.Name, namesgenerator.GetRandomName(1)),
Hide: takeFirst(orig.Hide, false),
Icon: takeFirst(orig.Name, ""),
InstanceType: sql.NullString{
String: takeFirst(orig.InstanceType.String, ""),
Valid: takeFirst(orig.InstanceType.Valid, false),
},
DailyCost: takeFirst(orig.DailyCost, 0),
})
require.NoError(t, err, "insert resource")

seed[name] = resource
}
}
return seed
}

func (tc *Generator) Lookup(name string) uuid.UUID {
if name == "" {
// No name means the caller doesn't care about the ID.
return uuid.New()
}
if tc.names == nil {
tc.names = make(map[string]uuid.UUID)
}
Expand All @@ -199,14 +251,34 @@ func (tc *Generator) Lookup(name string) uuid.UUID {
return id
}

// takeFirst will take the first non-empty value.
func takeFirst[Value comparable](values ...Value) Value {
func takeFirstTime(values ...time.Time) time.Time {
return takeFirstF(values, func(v time.Time) bool {
return !v.IsZero()
})
}

func takeFirstBytes(values ...[]byte) []byte {
return takeFirstF(values, func(v []byte) bool {
return len(v) != 0
})
}

// takeFirstF takes the first value that returns true
func takeFirstF[Value any](values []Value, take func(v Value) bool) Value {
var empty Value
for _, v := range values {
if v != empty {
if take(v) {
return v
}
}
// If all empty, return empty
return empty
}

// takeFirst will take the first non-empty value.
func takeFirst[Value comparable](values ...Value) Value {
var empty Value
return takeFirstF(values, func(v Value) bool {
return v != empty
})
}
1 change: 1 addition & 0 deletions coderd/httpmw/groupparam_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ func TestGroupParam(t *testing.T) {
ctx, _ := testutil.Context(t)
db := databasefake.New()
gen := databasefake.NewGenerator(t, db)

group := gen.Group(ctx, "group", database.Group{})

return db, group
Expand Down
32 changes: 15 additions & 17 deletions coderd/httpmw/workspaceresourceparam_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,30 @@ import (
func TestWorkspaceResourceParam(t *testing.T) {
t.Parallel()

setup := func(db database.Store, jobType database.ProvisionerJobType) (*http.Request, database.WorkspaceResource) {
setup := func(t *testing.T, db database.Store, jobType database.ProvisionerJobType) (*http.Request, database.WorkspaceResource) {
r := httptest.NewRequest("GET", "/", nil)
job, err := db.InsertProvisionerJob(context.Background(), database.InsertProvisionerJobParams{
ID: uuid.New(),
ctx := context.Background()
gen := databasefake.NewGenerator(t, db)
job := gen.Job(ctx, "", database.ProvisionerJob{
Type: jobType,
Provisioner: database.ProvisionerTypeEcho,
StorageMethod: database.ProvisionerStorageMethodFile,
})
require.NoError(t, err)
workspaceBuild, err := db.InsertWorkspaceBuild(context.Background(), database.InsertWorkspaceBuildParams{
ID: uuid.New(),

build := gen.WorkspaceBuild(ctx, "", database.WorkspaceBuild{
JobID: job.ID,
Transition: database.WorkspaceTransitionStart,
Reason: database.BuildReasonInitiator,
})
require.NoError(t, err)
resource, err := db.InsertWorkspaceResource(context.Background(), database.InsertWorkspaceResourceParams{
ID: uuid.New(),

resource := gen.WorkspaceResource(ctx, "", database.WorkspaceResource{
JobID: job.ID,
Transition: database.WorkspaceTransitionStart,
})
require.NoError(t, err)

ctx := chi.NewRouteContext()
ctx.URLParams.Add("workspacebuild", workspaceBuild.ID.String())
r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, ctx))
routeCtx := chi.NewRouteContext()
routeCtx.URLParams.Add("workspacebuild", build.ID.String())
r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx))
return r, resource
}

Expand All @@ -53,7 +51,7 @@ func TestWorkspaceResourceParam(t *testing.T) {
rtr := chi.NewRouter()
rtr.Use(httpmw.ExtractWorkspaceResourceParam(db))
rtr.Get("/", nil)
r, _ := setup(db, database.ProvisionerJobTypeWorkspaceBuild)
r, _ := setup(t, db, database.ProvisionerJobTypeWorkspaceBuild)
rw := httptest.NewRecorder()
rtr.ServeHTTP(rw, r)

Expand All @@ -71,7 +69,7 @@ func TestWorkspaceResourceParam(t *testing.T) {
)
rtr.Get("/", nil)

r, _ := setup(db, database.ProvisionerJobTypeWorkspaceBuild)
r, _ := setup(t, db, database.ProvisionerJobTypeWorkspaceBuild)
chi.RouteContext(r.Context()).URLParams.Add("workspaceresource", uuid.NewString())
rw := httptest.NewRecorder()
rtr.ServeHTTP(rw, r)
Expand All @@ -93,7 +91,7 @@ func TestWorkspaceResourceParam(t *testing.T) {
rw.WriteHeader(http.StatusOK)
})

r, job := setup(db, database.ProvisionerJobTypeTemplateVersionImport)
r, job := setup(t, db, database.ProvisionerJobTypeTemplateVersionImport)
chi.RouteContext(r.Context()).URLParams.Add("workspaceresource", job.ID.String())
rw := httptest.NewRecorder()
rtr.ServeHTTP(rw, r)
Expand All @@ -115,7 +113,7 @@ func TestWorkspaceResourceParam(t *testing.T) {
rw.WriteHeader(http.StatusOK)
})

r, job := setup(db, database.ProvisionerJobTypeWorkspaceBuild)
r, job := setup(t, db, database.ProvisionerJobTypeWorkspaceBuild)
chi.RouteContext(r.Context()).URLParams.Add("workspaceresource", job.ID.String())
rw := httptest.NewRecorder()
rtr.ServeHTTP(rw, r)
Expand Down