@@ -3,7 +3,6 @@ package prebuilds_test
33import (
44"context"
55"database/sql"
6- "encoding/json"
76"fmt"
87"sync"
98"testing"
@@ -653,6 +652,7 @@ func TestSkippingHardLimitedPresets(t *testing.T) {
653652t .Skip ("This test requires postgres" )
654653}
655654
655+ // Test cases verify the behavior of prebuild creation depending on configured failure limits
656656testCases := []struct {
657657name string
658658hardLimit int64
@@ -687,13 +687,16 @@ func TestSkippingHardLimitedPresets(t *testing.T) {
687687db ,pubSub := dbtestutil .NewDB (t )
688688controller := prebuilds .NewStoreReconciler (db ,pubSub ,cfg ,logger ,clock ,prometheus .NewRegistry ())
689689
690+ // Set up test environment with a template, version, and preset
690691ownerID := uuid .New ()
691692dbgen .User (t ,db , database.User {
692693ID :ownerID ,
693694})
694695org ,template := setupTestDBTemplate (t ,db ,ownerID ,templateDeleted )
695696templateVersionID := setupTestDBTemplateVersion (ctx ,t ,clock ,db ,pubSub ,org .ID ,ownerID ,template .ID )
696697preset := setupTestDBPreset (t ,db ,templateVersionID ,1 ,uuid .New ().String ())
698+
699+ // Create a failed prebuild workspace that counts toward the hard failure limit.
697700prebuiltWorkspace := setupTestDBPrebuild (
698701t ,
699702clock ,
@@ -708,36 +711,32 @@ func TestSkippingHardLimitedPresets(t *testing.T) {
708711)
709712_ = prebuiltWorkspace
710713
711- //Make sure we have only oneworkspace. Corresponding job has failedstatus.
714+ //Verify initial state: one failedworkspace exists
712715workspaces ,err := db .GetWorkspacesByTemplateID (ctx ,template .ID )
713716require .NoError (t ,err )
714717workspaceCount := len (workspaces )
715718require .Equal (t ,1 ,workspaceCount )
716719
717- // Advance clock toavoid backoff.
720+ // Advance clock tobypass backoff mechanisms
718721clock .Advance (time .Second ).MustWait (ctx )
719722
720- // ReconcileAll won't have any effect because we hit hard limit.
721-
722- // ReconcileAll tries to create 1 desired instance, because previous build is failed.
723- // But it maybe hard-limited depending on test configuration.
723+ // Trigger reconciliation to attempt creating a new prebuild
724+ // The outcome depends on whether the hard limit has been reached
724725require .NoError (t ,controller .ReconcileAll (ctx ))
725726
727+ // Verify the final state after reconciliation
726728workspaces ,err = db .GetWorkspacesByTemplateID (ctx ,template .ID )
727729require .NoError (t ,err )
728730
729731if tc .isHardLimitHit {
730- //We didn't try to create 2nd workspace, because we hit hard limit before.
732+ //When hard limit is reached, no new workspace should be created
731733workspaceCount = len (workspaces )
732734require .Equal (t ,1 ,workspaceCount )
733735}else {
734- //We created 2nd workspace, hard limit wasn't hit.
736+ //When hard limit is not reached, a new workspace should be created
735737workspaceCount = len (workspaces )
736738require .Equal (t ,2 ,workspaceCount )
737739}
738-
739- workspacesInJSON ,err := json .Marshal (workspaces )
740- fmt .Printf ("workspacesInJSON: %s\n " ,workspacesInJSON )
741740})
742741}
743742}