[k8s] Fix panic in WaitUntilDeploymentAvailable

[antoninbas]

Description

Fixes #1329

The func (err DeploymentNotAvailable) Error() method should not assume that Status.Conditions[0] is always valid for the Deployment.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs. N/A
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable. N/A
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Fixed panic in WaitUntilDeploymentAvailable in the k8s module.

Migration Guide

N/A

[antoninbas]

Relevant tests:

$ go test -v -run=.*DeploymentAvailable.* --tags=kubeall ./modules/k8s/...
=== RUN   TestWaitUntilDeploymentAvailable
=== PAUSE TestWaitUntilDeploymentAvailable
=== RUN   TestTestIsDeploymentAvailable
=== RUN   TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithProgressingNewReplicaSetAvailable
=== PAUSE TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithProgressingNewReplicaSetAvailable
=== RUN   TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithoutProgressingNewReplicaSetAvailable
=== PAUSE TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithoutProgressingNewReplicaSetAvailable
=== CONT  TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithProgressingNewReplicaSetAvailable
=== CONT  TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithoutProgressingNewReplicaSetAvailable
--- PASS: TestTestIsDeploymentAvailable (0.00s)
    --- PASS: TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithoutProgressingNewReplicaSetAvailable (0.00s)
    --- PASS: TestTestIsDeploymentAvailable/TestIsDeploymentAvailableWithProgressingNewReplicaSetAvailable (0.00s)
=== CONT  TestWaitUntilDeploymentAvailable
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:00-07:00 logger.go:66: Running command kubectl with args [--namespace ph2leb apply -f /var/folders/9q/0_7t6cs557d_v8mfkhcw5r780000gp/T/TestWaitUntilDeploymentAvailable1824699040]
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:01-07:00 logger.go:66: namespace/ph2leb created
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:01-07:00 logger.go:66: deployment.apps/nginx-deployment created
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:01-07:00 retry.go:91: Wait for deployment nginx-deployment to be provisioned.
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:01-07:00 client.go:42: Configuring Kubernetes client using config file /Users/abas/vmware/antrea/test/e2e/infra/vagrant/playbook/kube/config with context
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:01-07:00 retry.go:103: Wait for deployment nginx-deployment to be provisioned. returned an error: Deployment nginx-deployment is not available as 'Progressing' condition indicates that the Deployment is not complete, status: True, reason: NewReplicaSetCreated, message: Created new replica set "nginx-deployment-dc56b9db4". Sleeping for 1s and will try again.
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:02-07:00 retry.go:91: Wait for deployment nginx-deployment to be provisioned.
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:02-07:00 client.go:42: Configuring Kubernetes client using config file /Users/abas/vmware/antrea/test/e2e/infra/vagrant/playbook/kube/config with context
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:02-07:00 retry.go:103: Wait for deployment nginx-deployment to be provisioned. returned an error: Deployment nginx-deployment is not available as 'Progressing' condition indicates that the Deployment is not complete, status: True, reason: ReplicaSetUpdated, message: ReplicaSet "nginx-deployment-dc56b9db4" is progressing.. Sleeping for 1s and will try again.
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 retry.go:91: Wait for deployment nginx-deployment to be provisioned.
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 client.go:42: Configuring Kubernetes client using config file /Users/abas/vmware/antrea/test/e2e/infra/vagrant/playbook/kube/config with context
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 deployment.go:95: Deployment is now available
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 logger.go:66: Running command kubectl with args [--namespace ph2leb delete -f /var/folders/9q/0_7t6cs557d_v8mfkhcw5r780000gp/T/TestWaitUntilDeploymentAvailable57124874]
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 logger.go:66: Warning: deleting cluster-scoped resources, not scoped to the provided namespace
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 logger.go:66: namespace "ph2leb" deleted
TestWaitUntilDeploymentAvailable 2023-08-09T14:27:03-07:00 logger.go:66: deployment.apps "nginx-deployment" deleted
--- PASS: TestWaitUntilDeploymentAvailable (7.74s)
PASS
ok  	github.com/gruntwork-io/terratest/modules/k8s	8.170s

Pre-commit hooks:

goimports................................................................Passed
Terraform fmt........................................(no files to check)Skipped
test-interfaces-used.....................................................Passed

[denis256]

I was wondering if it's possible to implement a test case that would generate such a situation.

[antoninbas]

Which situation are you referring to? The panic?
Won't be possible to reproduce with a real K8s apiserver. However, I just updated the commit to add unit tests.