cert-manager/pkg/controller/acmeorders/controller.go
James Munnelly d323a1df0d Add unit tests for acmeorders and acmechallenges
Signed-off-by: James Munnelly <james@munnelly.eu>
2018-10-12 12:40:39 +01:00

217 lines
7.0 KiB
Go

package acmeorders
import (
"context"
"fmt"
"sync"
"time"
"github.com/golang/glog"
k8sErrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
corelisters "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/utils/clock"
"github.com/jetstack/cert-manager/pkg/acme"
cmlisters "github.com/jetstack/cert-manager/pkg/client/listers/certmanager/v1alpha1"
controllerpkg "github.com/jetstack/cert-manager/pkg/controller"
"github.com/jetstack/cert-manager/pkg/util"
)
type Controller struct {
controllerpkg.Context
helper controllerpkg.Helper
acmeHelper acme.Helper
// To allow injection for testing.
syncHandler func(ctx context.Context, key string) error
orderLister cmlisters.OrderLister
challengeLister cmlisters.ChallengeLister
issuerLister cmlisters.IssuerLister
clusterIssuerLister cmlisters.ClusterIssuerLister
secretLister corelisters.SecretLister
watchedInformers []cache.InformerSynced
queue workqueue.RateLimitingInterface
// used for testing
clock clock.Clock
}
func New(ctx *controllerpkg.Context) *Controller {
ctrl := &Controller{Context: *ctx}
ctrl.syncHandler = ctrl.processNextWorkItem
ctrl.queue = workqueue.NewNamedRateLimitingQueue(workqueue.NewItemExponentialFailureRateLimiter(time.Second*2, time.Minute*1), "orders")
orderInformer := ctrl.SharedInformerFactory.Certmanager().V1alpha1().Orders()
orderInformer.Informer().AddEventHandler(&controllerpkg.QueuingEventHandler{Queue: ctrl.queue})
ctrl.watchedInformers = append(ctrl.watchedInformers, orderInformer.Informer().HasSynced)
ctrl.orderLister = orderInformer.Lister()
// issuerInformer.Informer().AddEventHandler(&controllerpkg.QueuingEventHandler{Queue: ctrl.queue})
issuerInformer := ctrl.SharedInformerFactory.Certmanager().V1alpha1().Issuers()
ctrl.watchedInformers = append(ctrl.watchedInformers, issuerInformer.Informer().HasSynced)
ctrl.issuerLister = issuerInformer.Lister()
// clusterIssuerInformer.Informer().AddEventHandler(&controllerpkg.QueuingEventHandler{Queue: ctrl.queue})
clusterIssuerInformer := ctrl.SharedInformerFactory.Certmanager().V1alpha1().ClusterIssuers()
ctrl.watchedInformers = append(ctrl.watchedInformers, clusterIssuerInformer.Informer().HasSynced)
ctrl.clusterIssuerLister = clusterIssuerInformer.Lister()
// TODO: the same problem here as with Certificates creating Orders occurs.
// The informer notices the new challenge resources which causes a resync
// of the owning Order resource before the order.status.url field is set.
// we need to detect this and not sync the order again automatically to
// prevent another order being created with the acme server.
challengeInformer := ctrl.SharedInformerFactory.Certmanager().V1alpha1().Challenges()
challengeInformer.Informer().AddEventHandler(&controllerpkg.BlockingEventHandler{WorkFunc: ctrl.handleOwnedResource})
ctrl.watchedInformers = append(ctrl.watchedInformers, challengeInformer.Informer().HasSynced)
ctrl.challengeLister = challengeInformer.Lister()
secretInformer := ctrl.KubeSharedInformerFactory.Core().V1().Secrets()
ctrl.watchedInformers = append(ctrl.watchedInformers, secretInformer.Informer().HasSynced)
ctrl.secretLister = secretInformer.Lister()
ctrl.helper = controllerpkg.NewHelper(ctrl.issuerLister, ctrl.clusterIssuerLister)
ctrl.acmeHelper = acme.NewHelper(ctrl.secretLister, ctrl.Context.ClusterResourceNamespace)
return ctrl
}
func (c *Controller) handleOwnedResource(obj interface{}) {
metaobj, ok := obj.(metav1.Object)
if !ok {
glog.Errorf("item passed to handleOwnedResource does not implement ObjectMetaAccessor")
return
}
ownerRefs := metaobj.GetOwnerReferences()
for _, ref := range ownerRefs {
// Parse the Group out of the OwnerReference to compare it to what was parsed out of the requested OwnerType
refGV, err := schema.ParseGroupVersion(ref.APIVersion)
if err != nil {
glog.Errorf("Could not parse OwnerReference GroupVersion: %v", err)
continue
}
if refGV.Group == orderGvk.Group && ref.Kind == orderGvk.Kind {
// TODO: how to handle namespace of owner references?
order, err := c.orderLister.Orders(metaobj.GetNamespace()).Get(ref.Name)
if err != nil {
glog.Errorf("Error getting Order %q referenced by resource %q", ref.Name, metaobj.GetName())
continue
}
objKey, err := keyFunc(order)
if err != nil {
runtime.HandleError(err)
continue
}
c.queue.Add(objKey)
}
}
}
func (c *Controller) Run(workers int, stopCh <-chan struct{}) error {
glog.V(4).Infof("Starting %s control loop", ControllerName)
// wait for all the informer caches we depend on are synced
if !cache.WaitForCacheSync(stopCh, c.watchedInformers...) {
// c.challengeInformerSynced) {
return fmt.Errorf("error waiting for informer caches to sync")
}
var wg sync.WaitGroup
for i := 0; i < workers; i++ {
wg.Add(1)
// TODO (@munnerz): make time.Second duration configurable
go wait.Until(func() {
defer wg.Done()
c.worker(stopCh)
},
time.Second, stopCh)
}
<-stopCh
glog.V(4).Infof("Shutting down queue as workqueue signaled shutdown")
c.queue.ShutDown()
glog.V(4).Infof("Waiting for workers to exit...")
wg.Wait()
glog.V(4).Infof("Workers exited.")
return nil
}
func (c *Controller) worker(stopCh <-chan struct{}) {
glog.V(4).Infof("Starting %q worker", ControllerName)
for {
obj, shutdown := c.queue.Get()
if shutdown {
break
}
var key string
err := func(obj interface{}) error {
defer c.queue.Done(obj)
var ok bool
if key, ok = obj.(string); !ok {
return nil
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
ctx = util.ContextWithStopCh(ctx, stopCh)
glog.Infof("%s controller: syncing item '%s'", ControllerName, key)
if err := c.syncHandler(ctx, key); err != nil {
return err
}
c.queue.Forget(obj)
return nil
}(obj)
if err != nil {
glog.Errorf("%s controller: Re-queuing item %q due to error processing: %s", ControllerName, key, err.Error())
c.queue.AddRateLimited(obj)
continue
}
glog.Infof("%s controller: Finished processing work item %q", ControllerName, key)
}
glog.V(4).Infof("Exiting %q worker loop", ControllerName)
}
func (c *Controller) processNextWorkItem(ctx context.Context, key string) error {
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
runtime.HandleError(fmt.Errorf("invalid resource key: %s", key))
return nil
}
order, err := c.orderLister.Orders(namespace).Get(name)
if err != nil {
if k8sErrors.IsNotFound(err) {
runtime.HandleError(fmt.Errorf("order '%s' in work queue no longer exists", key))
return nil
}
return err
}
return c.Sync(ctx, order)
}
var keyFunc = controllerpkg.KeyFunc
const (
ControllerName = "orders"
)
func init() {
controllerpkg.Register(ControllerName, func(ctx *controllerpkg.Context) controllerpkg.Interface {
return New(ctx).Run
})
}