helper

Documentation

Index

• Constants
• func GetPodCondition(status *corev1.PodStatus, conditionType corev1.PodConditionType) (int, *corev1.PodCondition)
• func GetPodReadyCondition(status corev1.PodStatus) *corev1.PodCondition
• func IsPodReady(pod *corev1.Pod) bool
• func IsPodReadyConditionTrue(status corev1.PodStatus) bool
• type Helper
  • func NewHelper(cfg *config.Config) *Helper
  • func (h *Helper) DefaultValidationSet() []ValidationFunc
  • func (h *Helper) Kubectl(ns string) *Kubectl
  • func (h *Helper) ValidateCertificate(ns, name string, validations ...ValidationFunc) error
  • func (h *Helper) ValidateIssuedCertificate(certificate *cmapi.Certificate, rootCAPEM []byte) (*x509.Certificate, error)
  • func (h *Helper) ValidateIssuedCertificateRequest(cr *cmapi.CertificateRequest, key crypto.Signer, rootCAPEM []byte) (*x509.Certificate, error)
  • func (h *Helper) ValidationSetForUnsupportedFeatureSet(fs featureset.FeatureSet) []ValidationFunc
  • func (h *Helper) WaitCertificateIssued(ns, name string, timeout time.Duration) error
  • func (h *Helper) WaitCertificateRequestIssuedValid(ns, name string, timeout time.Duration, key crypto.Signer) error
  • func (h *Helper) WaitCertificateRequestIssuedValidTLS(ns, name string, timeout time.Duration, key crypto.Signer, rootCAPEM []byte) error
  • func (h *Helper) WaitForAllPodsRunningInNamespace(ns string) error
  • func (h *Helper) WaitForAllPodsRunningInNamespaceTimeout(ns string, timeout time.Duration) error
  • func (h *Helper) WaitForCertificateNotReady(ns, name string, timeout time.Duration) (*cmapi.Certificate, error)
  • func (h *Helper) WaitForCertificateReady(ns, name string, timeout time.Duration) (*cmapi.Certificate, error)
  • func (h *Helper) WaitForCertificateRequestReady(ns, name string, timeout time.Duration) (*cmapi.CertificateRequest, error)
  • func (h *Helper) WaitForSecretCertificateData(ns, name string, timeout time.Duration) (*corev1.Secret, error)
• type Kubectl
  • func (k *Kubectl) Describe(resources ...string) error
  • func (k *Kubectl) DescribeResource(resource, name string) error
  • func (k *Kubectl) Run(args ...string) error
• type ValidationFunc

Constants

const (
	// Poll is how often the API is polled in Wait operations by default
	Poll = time.Second * 2

	// PodStartTimeout is the default amount of time to wait in pod start operations
	PodStartTimeout = time.Minute * 2
)

Functions

func GetPodCondition

func GetPodCondition(status *corev1.PodStatus, conditionType corev1.PodConditionType) (int, *corev1.PodCondition)

GetPodCondition extracts the provided condition from the given status and returns that. Returns nil and -1 if the condition is not present, and the index of the located condition.

func GetPodReadyCondition

func GetPodReadyCondition(status corev1.PodStatus) *corev1.PodCondition

GetPodReadyCondition extracts the pod ready condition from the given status and returns that. Returns nil if the condition is not present.

func IsPodReady

func IsPodReady(pod *corev1.Pod) bool

IsPodReady returns true if a pod is ready; false otherwise.

func IsPodReadyConditionTrue

func IsPodReadyConditionTrue(status corev1.PodStatus) bool

IsPodReadyConditionTrue returns true if a pod is ready; false otherwise.

Types

type Helper

type Helper struct {
	KubeClient kubernetes.Interface
	CMClient   cmclient.Interface
	// contains filtered or unexported fields
}

Helper provides methods for common operations needed during tests.

func NewHelper

func NewHelper(cfg *config.Config) *Helper

func (*Helper) DefaultValidationSet

func (h *Helper) DefaultValidationSet() []ValidationFunc

func (*Helper) Kubectl

func (h *Helper) Kubectl(ns string) *Kubectl

func (*Helper) ValidateCertificate

func (h *Helper) ValidateCertificate(ns, name string, validations ...ValidationFunc) error

ValidateCertificate retrieves the issued certificate and runs all validation functions

func (*Helper) ValidateIssuedCertificate

func (h *Helper) ValidateIssuedCertificate(certificate *cmapi.Certificate, rootCAPEM []byte) (*x509.Certificate, error)

ValidateIssuedCertificate will ensure that the given Certificate has a certificate issued for it, and that the details on the x509 certificate are correct as defined by the Certificate's spec.

func (*Helper) ValidateIssuedCertificateRequest

func (h *Helper) ValidateIssuedCertificateRequest(cr *cmapi.CertificateRequest, key crypto.Signer, rootCAPEM []byte) (*x509.Certificate, error)

ValidateIssuedCertificateRequest will ensure that the given CertificateRequest has a certificate issued for it, and that the details on the x509 certificate are correct as defined by the CertificateRequest's spec.

func (*Helper) ValidationSetForUnsupportedFeatureSet

func (h *Helper) ValidationSetForUnsupportedFeatureSet(fs featureset.FeatureSet) []ValidationFunc

func (*Helper) WaitCertificateIssued

func (h *Helper) WaitCertificateIssued(ns, name string, timeout time.Duration) error

func (*Helper) WaitCertificateRequestIssuedValid

func (h *Helper) WaitCertificateRequestIssuedValid(ns, name string, timeout time.Duration, key crypto.Signer) error

func (*Helper) WaitCertificateRequestIssuedValidTLS

func (h *Helper) WaitCertificateRequestIssuedValidTLS(ns, name string, timeout time.Duration, key crypto.Signer, rootCAPEM []byte) error

func (*Helper) WaitForAllPodsRunningInNamespace

func (h *Helper) WaitForAllPodsRunningInNamespace(ns string) error

WaitForAllPodsRunningInNamespace waits default amount of time (PodStartTimeout) for all pods in the specified namespace to become running.

func (*Helper) WaitForAllPodsRunningInNamespaceTimeout

func (h *Helper) WaitForAllPodsRunningInNamespaceTimeout(ns string, timeout time.Duration) error

func (*Helper) WaitForCertificateNotReady

func (h *Helper) WaitForCertificateNotReady(ns, name string, timeout time.Duration) (*cmapi.Certificate, error)

WaitForCertificateNotReady waits for the certificate resource to enter a non-Ready state.

func (*Helper) WaitForCertificateReady

func (h *Helper) WaitForCertificateReady(ns, name string, timeout time.Duration) (*cmapi.Certificate, error)

WaitForCertificateReady waits for the certificate resource to enter a Ready state.

func (*Helper) WaitForCertificateRequestReady

func (h *Helper) WaitForCertificateRequestReady(ns, name string, timeout time.Duration) (*cmapi.CertificateRequest, error)

WaitForCertificateRequestReady waits for the CertificateRequest resource to enter a Ready state.

func (*Helper) WaitForSecretCertificateData

func (h *Helper) WaitForSecretCertificateData(ns, name string, timeout time.Duration) (*corev1.Secret, error)

WaitForSecretCertificateData waits for the certificate data to be ready inside a Secret created by cert-manager.

type Kubectl

type Kubectl struct {
	// contains filtered or unexported fields
}

func (*Kubectl) Describe

func (k *Kubectl) Describe(resources ...string) error

func (*Kubectl) DescribeResource

func (k *Kubectl) DescribeResource(resource, name string) error

func (*Kubectl) Run

func (k *Kubectl) Run(args ...string) error

type ValidationFunc

type ValidationFunc func(certificate *cmapi.Certificate, secret *v1.Secret) error

ValidationFunc describes a certificate validation helper function