Method Mocked

coderd/database/dbauthz/setup_test.go:136–175

Mocked runs a subtest with a mocked database. Removing the overhead of a real postgres database resulting in much faster tests.

(testCaseF func(dmb *dbmock.MockStore, faker *gofakeit.Faker, check *expects))

// Mocked runs a subtest with a mocked database. Removing the overhead of a real
// postgres database resulting in much faster tests.
func (s *MethodTestSuite) Mocked(testCaseF func(dmb *dbmock.MockStore, faker *gofakeit.Faker, check *expects)) func() {
	t := s.T()
	mDB := dbmock.NewMockStore(gomock.NewController(t))
	mDB.EXPECT().Wrappers().Return([]string{}).AnyTimes()
	// dbauthz now expands DB-backed system roles (e.g. organization-member)
	// during role-assignment validation, which triggers a CustomRoles lookup
	// with IncludeSystemRoles=true.
	mDB.EXPECT().CustomRoles(gomock.Any(), includeSystemRolesMatcher{}).DoAndReturn(func(_ context.Context, arg database.CustomRolesParams) ([]database.CustomRole, error) {
		if len(arg.LookupRoles) == 0 {
			return []database.CustomRole{}, nil
		}

		out := make([]database.CustomRole, 0, len(arg.LookupRoles))

		for _, pair := range arg.LookupRoles {
			// Minimal set of fields that the tested code uses.
			out = append(out, database.CustomRole{
				Name: pair.Name,
				OrganizationID: uuid.NullUUID{
					UUID:  pair.OrganizationID,
					Valid: pair.OrganizationID != uuid.Nil,
				},
				IsSystem: rolestore.IsSystemRoleName(pair.Name),
				ID:       uuid.New(),
			})
		}

		return out, nil
	}).AnyTimes()

	// Use a constant seed to prevent flakes from random data generation.
	faker := gofakeit.New(0)

	// The usual Subtest assumes the test setup will use a real database to populate
	// with data. In this mocked case, we want to pass the underlying mocked database
	// to the test case instead.
	return s.SubtestWithDB(mDB, func(_ database.Store, check *expects) {
		testCaseF(mDB, faker, check)
	})
}

// Subtest starts up a real postgres database for each test case.
// Deprecated: Use 'Mocked' instead for much faster tests.