Skip to content

tests: retry k8s ops related to env vars #15486

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
porridge merged 3 commits into from
Jul 28, 2025
Merged

tests: retry k8s ops related to env vars #15486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b64b3a5
tests: retry k8s ops related to env vars
porridge May 29, 2025
f203615
retain getDeploymentEnvVal
porridge Jul 22, 2025
05977d7
test panicked: errors: target must be a non-nil pointer
porridge Jul 22, 2025
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
34 changes: 28 additions & 6 deletions tests/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,9 +579,12 @@ func waitUntilCentralSensorConnectionIs(t *testing.T, ctx context.Context, statu
func (ks *KubernetesSuite) mustSetDeploymentEnvVal(ctx context.Context, namespace string, deployment string, container string, envVar string, value string) {
patch := []byte(fmt.Sprintf(`{"spec":{"template":{"spec":{"containers":[{"name":%q,"env":[{"name":%q,"value":%q}]}]}}}}`,
container, envVar, value))
ks.logf("Setting variable %q on deployment %q in namespace %q to %q", envVar, deployment, namespace, value)
_, err := ks.k8s.AppsV1().Deployments(namespace).Patch(ctx, deployment, types.StrategicMergePatchType, patch, metaV1.PatchOptions{})
ks.Require().NoError(err, "cannot patch deployment %q in namespace %q", deployment, namespace)
whatVar := fmt.Sprintf("variable %q on deployment %q in namespace %q to %q", envVar, deployment, namespace, value)
ks.logf("Setting %s", whatVar)
mustEventually(ks.T(), ctx, func() error {
_, err := ks.k8s.AppsV1().Deployments(namespace).Patch(ctx, deployment, types.StrategicMergePatchType, patch, metaV1.PatchOptions{})
return err
}, 5*time.Second, fmt.Sprintf("cannot set %s", whatVar))
}

// mustGetDeploymentEnvVal retrieves the value of environment variable in a deployment, or fails the test.
Expand All @@ -592,9 +595,15 @@ func (ks *KubernetesSuite) mustGetDeploymentEnvVal(ctx context.Context, namespac
}

// getDeploymentEnvVal returns the value of an environment variable or the empty string if not found.
// Fails the test if deployment or container are missing, or API call fails repeatedly.
// Please use mustGetDeploymentEnvVal instead, unless you must tolerate a missing env var definition in the container.
func (ks *KubernetesSuite) getDeploymentEnvVal(ctx context.Context, namespace string, deployment string, container string, envVar string) (string, error) {
d, err := ks.k8s.AppsV1().Deployments(namespace).Get(ctx, deployment, metaV1.GetOptions{})
ks.Require().NoError(err, "cannot retrieve deployment %q in namespace %q", deployment, namespace)
var d *appsV1.Deployment
mustEventually(ks.T(), ctx, func() error {
var err error
d, err = ks.k8s.AppsV1().Deployments(namespace).Get(ctx, deployment, metaV1.GetOptions{})
return err
}, 5*time.Second, fmt.Sprintf("cannot retrieve deployment %q in namespace %q", deployment, namespace))
c, err := getContainer(d, container)
ks.Require().NoError(err, "cannot find container %q in deployment %q in namespace %q", container, deployment, namespace)
return getEnvVal(c, envVar)
Expand Down Expand Up @@ -733,6 +742,19 @@ func deleteRole(t *testing.T, ctx context.Context, name string) {
}
}

type EnvVarNotFound []string

func (e EnvVarNotFound) Error() string {
return fmt.Sprintf("actual vars are: %q", []string(e))
}

func requireNoErrorOrEnvVarNotFound(t require.TestingT, err error) {
if err == nil {
return
}
require.ErrorAs(t, err, &EnvVarNotFound{})
}

// getEnvVal returns the value of envVar from a given container or returns a helpful error.
func getEnvVal(c *coreV1.Container, envVar string) (string, error) {
var vars []string
Expand All @@ -742,7 +764,7 @@ func getEnvVal(c *coreV1.Container, envVar string) (string, error) {
}
vars = append(vars, v.Name)
}
return "", fmt.Errorf("actual vars are %q", vars)
return "", EnvVarNotFound(vars)
}

// getContainer returns the given container from a deployment or returns a helpful error.
Expand Down
6 changes: 4 additions & 2 deletions tests/delegated_scanning_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,8 @@ func (ts *DelegatedScanningSuite) SetupSuite() {
// Get a reference to the Secured Cluster to send delegated scans too.
// If a valid remote cluster is NOT available all tests in this suite will fail.
logf(t, "Getting remote StackRox cluster details")
envVal, _ := ts.getDeploymentEnvVal(ctx, ts.namespace, sensorDeployment, sensorContainer, env.LocalImageScanningEnabled.EnvVar())
envVal, err := ts.getDeploymentEnvVal(ctx, ts.namespace, sensorDeployment, sensorContainer, env.LocalImageScanningEnabled.EnvVar())
requireNoErrorOrEnvVarNotFound(t, err)

// Verify the StackRox installation supports delegated scanning, Central and Sensor
// must have an active connection for this check to succeed, so wait for that connection.
Expand All @@ -194,7 +195,8 @@ func (ts *DelegatedScanningSuite) SetupSuite() {
ts.remoteCluster = cluster

// Enable Sensor debug logs, some tests need this to accurately validate expected behaviors.
ts.origSensorLogLevel, _ = ts.getDeploymentEnvVal(ctx, ts.namespace, sensorDeployment, sensorContainer, deleScanLogLevelEnvVar)
ts.origSensorLogLevel, err = ts.getDeploymentEnvVal(ctx, ts.namespace, sensorDeployment, sensorContainer, deleScanLogLevelEnvVar)
requireNoErrorOrEnvVarNotFound(t, err)
if ts.origSensorLogLevel != deleScanDesiredLogLevel {
ts.mustSetDeploymentEnvVal(ctx, ts.namespace, sensorDeployment, sensorContainer, deleScanLogLevelEnvVar, deleScanDesiredLogLevel)
logf(t, "Log level env var changed from %q to %q on Sensor", ts.origSensorLogLevel, deleScanDesiredLogLevel)
Expand Down
Loading