Function TestViewSubsetWorkspaceBuild

coderd/database/gentest/models_test.go:58–85

TestViewSubsetWorkspaceBuild ensures WorkspaceBuildTable is a subset of WorkspaceBuild, with the exception of ProvisionerState which is intentionally excluded from the workspace_build_with_user view to avoid loading the large Terraform state blob on hot paths.

(t *testing.T)

// intentionally excluded from the workspace_build_with_user view to avoid
// loading the large Terraform state blob on hot paths.
func TestViewSubsetWorkspaceBuild(t *testing.T) {
	t.Parallel()
	table := reflect.TypeOf(database.WorkspaceBuildTable{})
	joined := reflect.TypeOf(database.WorkspaceBuild{})

	tableFields := fieldNames(allFields(table))
	joinedFields := fieldNames(allFields(joined))

	// ProvisionerState is intentionally excluded from the
	// workspace_build_with_user view to avoid loading multi-MB Terraform
	// state blobs on hot paths. Callers that need it use
	// GetWorkspaceBuildProvisionerStateByID instead.
	excludedFields := map[string]bool{
		"ProvisionerState": true,
	}

	var filtered []string
	for _, name := range tableFields {
		if !excludedFields[name] {
			filtered = append(filtered, name)
		}
	}

	if !assert.Subset(t, joinedFields, filtered, "table is not subset") {
		t.Log("Some fields were added to the WorkspaceBuild Table without updating the 'workspace_build_with_user' view.")
		t.Log("See migration 000141_join_users_build_version.up.sql to create the view.")
	}
}

// TestViewSubsetWorkspace ensures WorkspaceTable is a subset of Workspace
func TestViewSubsetWorkspace(t *testing.T) {