Skip to content

Commit 7a788f2

Browse files
committed
docs: enhance test file comments for clarity on upgrade test setup and validation
1 parent 8e232e5 commit 7a788f2

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

test/upgrade/main_test.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
//go:build upgrade
22

3+
//
4+
// This file (main_test.go) contains TestMain and cluster setup logic for all upgrade tests.
5+
// It performs the following initialization:
6+
// - Creates a kind cluster with Crossplane and the CloudFoundry provider
7+
// - Configures the provider with DeploymentRuntimeConfig for debug logging
8+
// - Handles both "local" (development) and registry (release) provider images
9+
// - Sets up CloudFoundry credentials as a Kubernetes secret
10+
// - Discovers and loads test resources from testdata directories
11+
//
12+
// The setup happens once before all tests run, ensuring consistent test environment
13+
// across both baseline and custom upgrade tests.
14+
315
package upgrade
416

517
import (

test/upgrade/space_external_name_upgrade_test.go

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
//go:build upgrade
22

3+
//
4+
// This file (space_external_name_upgrade_test.go) contains Test_Space_External_Name,
5+
// which validates that Space resources maintain proper external-name formatting
6+
// during provider upgrades. Specifically, it verifies:
7+
// - External-name annotation exists and follows UUID format
8+
// - External-name value remains unchanged after provider upgrade
9+
//
10+
// This test demonstrates the use of CustomUpgradeTestBuilder for creating
11+
// specialized upgrade tests with custom pre/post-upgrade validation logic.
12+
313
package upgrade
414

515
import (

0 commit comments

Comments
 (0)