Add Druid e2e tests (I)

[timuthy]

How to categorize this PR?

/area testing
/kind enhancement

What this PR does / why we need it:
This PR adds e2e tests for Etcd-Druid. It uses the foundation of #195 with additional automation.

Please see docs/development/local-e2e-tests.md for more information about how to run those tests.

Which issue(s) this PR fixes:
Fixes #194
Fixes parts of #286

Special notes for your reviewer:
Co-authored-by: Shreyas Rao shreyas.sriganesh.rao@sap.com

ℹ️ Test machinery integration is not part of this PR and will follow as soon as the credential rotation feature is implemented in TM.

Release note:

A Helm chart for deploying Etcd-Druid is now available in `charts/druid`.

Developers can now run Druid e2e tests via `make test-e2e`. Please see `docs/development/local-e2e-tests.md` for detailed information.

[gitguardian]

⚠️ GitGuardian has uncovered 8 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
-	RSA Private Key	fdccd30	test/e2e/resources/certs/ca.key	View secret
-	RSA Private Key	fdccd30	test/e2e/resources/certs/client.key	View secret
-	RSA Private Key	fdccd30	test/e2e/resources/certs/server.key	View secret
-	RSA Private Key	ed35a92	test/e2e/resources/certs/client.key	View secret
-	RSA Private Key	ed35a92	test/e2e/resources/certs/server.key	View secret
-	Generic Private Key	ed35a92	test/e2e/resources/tls/client.key	View secret
-	Generic Private Key	ed35a92	test/e2e/resources/tls/server.key	View secret
-	Generic Private Key	f1f6ae2	test/e2e/resources/tls/server.key	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

<sup>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sup>

[timuthy]

/ping @gardener/etcd-druid-maintainers

[gardener-robot]

@gardener/etcd-druid-maintainers

Message

/ping @gardener/etcd-druid-maintainers

[ishan16696]

Hi @timuthy ,
When e2e-tests fails they don't do the cleanup of resources like secrets, config-map etc .... Manually doing the cleanup of resources locally won't be an issue but it might be an issue if we gonna use this as TM test in ci pipeline ... right ?
Can we try to do the cleanup of resources irrespective of e2e tests fails or succeeds?

[ishan16696]

Hi @timuthy ,
I have retested this PR after you rebased on master.
The e2e tests fails with this error:

# github.com/gardener/etcd-druid/test/e2e [github.com/gardener/etcd-druid/test/e2e.test]
test/e2e/utils.go:127:3: cannot use "k8s.io/api/core/v1".SecretReference{...} (type "k8s.io/api/core/v1".SecretReference) as type "github.com/gardener/etcd-druid/api/v1alpha1".SecretReference in field value
test/e2e/utils.go:208:3: unknown field 'TLS' in struct literal of type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig
test/e2e/druid_test.go:59:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
test/e2e/druid_test.go:60:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
test/e2e/druid_test.go:61:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
test/e2e/druid_test.go:698:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
test/e2e/druid_test.go:699:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
test/e2e/druid_test.go:700:19: etcd.Spec.Etcd.TLS undefined (type "github.com/gardener/etcd-druid/api/v1alpha1".EtcdConfig has no field or method TLS)
FAIL	github.com/gardener/etcd-druid/test/e2e [build failed]
FAIL
make: *** [test-e2e] Error 2

[timuthy]

Thanks for the feedback @ishan16696. I'll have a 👀

[timuthy]

The errors have been fixed with 350cc47. PTAL @ishan16696.

[ishan16696]

GitGuardian Security Checks is not having a green tick .... Is this expected ?

[ishan16696]

Is this #296 (comment) has been addressed now or should we create a follow-up issue to track this just to delete the orphan resources if this has been enable it in a CI pipeline?

[timuthy]

GitGuardian Security Checks is not having a green tick .... Is this expected ?

Yes, here it's because of the test TLS certificates and keys.

Is this #296 (comment) has been addressed now or should we create a follow-up issue to track this just to delete the orphan resources if this has been enable it in a CI pipeline?

I think it's quite helpful that the cleanup does not happen when tests fail because it gives developers the opportunity to troubleshoot the system, e.g. checking the logs of etcd-druid. For the pipeline this shouldn't be a problem either because we can define a separate make steps="cleanup" test-e2e step that is executed in any case.

[ishan16696]

For the pipeline this shouldn't be a problem either because we can define a separate make steps="cleanup" test-e2e step that is executed in any case.

ok, make sense

[timuthy]

As discussed @ishan16696, some improvements were required through f1f6ae2. PTAL.

[ishan16696]

Overrall, looks good to me. Couple of nitpicks.
And Can you also mention in docs/development/local-e2e-tests.md about cleaning up your existing resources of cluster-scope like CRD,clusterroles before running these e2e-tests.

[ishan16696]

Hey @timuthy ,
I have run the e2e-tests for Azure and AWS providers, so e2e-tests are running fine for both of the providers but one thing I noticed is shoot namespace is not getting deleted after cleanup step.
It also left some orphans resources in shoot namespace:

k -n shoot get secrets                                                                                                                 
NAME                  TYPE                DATA   AGE
ca-etcd-az            Opaque              2      2m36s
etcd-backup-az        Opaque              3      2m33s
etcd-client-tls-az    kubernetes.io/tls   3      2m36s
etcd-server-cert-az   kubernetes.io/tls   3      2m36s

[timuthy]

Thanks for noticing @ishan16696. Unfortunately, that was due to a left-over I forgot. It's fixed now 🙂

[ishan16696]

yes, now it's getting cleanup, thanks for quick fix.
Would you like to address this as well #296 (review) ?

[timuthy]

Thanks for the feedback @ishan16696 🚀 I addressed all comments.

[ishan16696]

LGTM!!