Running End-to-End Tests
cert-manager has an extensive end-to-end (e2e) test suite that verifies functionality against a real Kubernetes cluster.
The full end-to-end test suite can take a long time to complete and is run against every pull request made to the cert-manager project.
Unless you’ve made huge changes to the cert-manager codebase — or to the end-to-end tests themselves — you probably don’t need to run the tests locally. If you do want to run the tests, though, this document explains how.
TestGrid AlertsThe status of each commit on the master branch is reported on
testgrid.k8s.io. Join the
cert-manager-dev-alertsGoogle group to receive email notifications when tests fail.
There are a small number of required tools which must be installed on your machine to run the tests:
bazel: Builds cert-manager and the end-to-end tests themselves
kind: Provisions a Kubernetes cluster inside docker.
docker: Required by kind.
kubectl: A relatively new version of
kubectlshould be available on your
Set up End-to-End Tests
The test requires a kind cluster to run against. Note that the tests assume a certain configuration for the kind cluster, and you should be sure to use this script rather than creating a cluster manually unless you’re sure you’ve mimicked the required configuration:
$ export K8S_VERSION=1.19 # optional: this allows you to test different Kubernetes versions $ ./devel/cluster/create-kind.sh ...
There are also certain dependencies which the test requires, which can also be installed using a helper script:
TIP: If you only need to update one dependency in the testing cluster, you can instead run
./devel/addon/<name>/install.sh to save some time.
Run End-to-End Tests
The following script will run the tests. Note that the tests produce a lot of output, and take some time (often well over 30 minutes) to complete:
$ ./devel/run-e2e.sh ... lots of output ...
NB: If you don’t use
create-kind.sh to create the kind cluster, the ACME HTTP01 end-to-end tests will fail,
as they require the ‘service CIDR’ to be set to
This is because the ingress controller is deployed with the fixed IP
10.0.0.15 to allow
Pebble to access it on a predictable address for end-to-end tests; our
test DNS name
certmanager.kubernetes.network points to
If you don’t want to run every test, you can focus on specific parts using
$ ./devel/run-e2e.sh --ginkgo.focus "<text regex>" # example: run any test which has "basicConstraint" in the description $ ./devel/run-e2e.sh --ginkgo.focus "basicConstraint"
More info on how to use this can be found in the Ginkgo focused-specs documentation
End-to-End Test Structure
The end-to-end tests consist of 2 big parts: the issuer specific tests and the conformance suite. Both parts use Ginkgo to run their tests.
This suite tests all RBAC permissions granted to cert-manager on the cluster to check that it is able to operate correctly.
This suite tests certificate functionality against all issuers.
Some issuers don’t support certain features, such as for example issuing Ed25519 certificates or adding an email address to the X.509 SAN extension.
Each test specifies a used feature using
s.checkFeatures(feature), which is then checked against the issuer’s
UnsupportedFeatures list. Tests which use a feature unsupported by an issuer are skipped for that issuer.
Cloud Provider Tests
The master branch of cert-manager can also be tested against different cloud providers. Currently, tests for EKS are present which run as a periodic job once every two days.
Extending The Cloud Provider Tests
The infrastructure used to run the e2e tests on cloud providers is present in the cert-manager/test-infra repository. More cloud providers can be added by creating infrastructure for them using Terraform.
Apart from that, tests for the existing infrastructure can be customized by editing their respective prow jobs present in the Jetstack testing repository repository. Values like the cert-manager version or the cloud provider version are present as variables in Terraform so their values can be changed when using
terraform apply in the prow jobs, for example, for the EKS prow job the cert-manager version being tested can be changed using
terraform apply -var="cert_manager_version=v1.3.3" -auto-approve
To see a list of all configurable variables present for a particular infrastructure you can see the
variables.tf file for that cloud provider’s infrastructure.
Please note that the cloud provider tests run the e2e tests present in the master branch of cert-manager on a predefined version of cert-manager (can be changed in the prow job). Currently, they do not test code in a PR, but we have an issue tracking that request.