Skip to content

Commit d16b477

Browse files
pwittrockpwittrock
committed
Add simple operator package
1 parent d5af5c5 commit d16b477

File tree

5 files changed

+496
-0
lines changed

5 files changed

+496
-0
lines changed

‎pkg/patterns/application/application.go

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
/*
2+
Copyright 2018 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package application
18+
19+
import (
20+
"fmt"
21+
"strings"
22+
23+
"k8s.io/apimachinery/pkg/runtime"
24+
"k8s.io/client-go/rest"
25+
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
26+
"sigs.k8s.io/controller-runtime/pkg/client/config"
27+
"sigs.k8s.io/controller-runtime/pkg/controller"
28+
"sigs.k8s.io/controller-runtime/pkg/handler"
29+
internalcontroller "sigs.k8s.io/controller-runtime/pkg/internal/controller"
30+
"sigs.k8s.io/controller-runtime/pkg/manager"
31+
"sigs.k8s.io/controller-runtime/pkg/predicate"
32+
"sigs.k8s.io/controller-runtime/pkg/reconcile"
33+
"sigs.k8s.io/controller-runtime/pkg/source"
34+
)
35+
36+
// application is a very simple Controller that embeds a Manager.
37+
type application struct {
38+
mrg manager.Manager
39+
stopFn func() <-chan struct{}
40+
ctrl *internalcontroller.Controller
41+
}
42+
43+
var noop = reconcile.Func(func(reconcile.Request) (reconcile.Result, error) {
44+
return reconcile.Result{}, nil
45+
})
46+
47+
var getConfig = config.GetConfig
48+
var newController = controller.New
49+
var newManager = manager.New
50+
var getGvk = apiutil.GVKForObject
51+
52+
// Builder builds an Application Controller and returns the manager.Manager to start the Controller.
53+
type Builder struct {
54+
apiType runtime.Object
55+
mrg manager.Manager
56+
pred []predicate.Predicate
57+
manages []runtime.Object
58+
config *rest.Config
59+
r reconcile.Reconciler
60+
}
61+
62+
// BuilderFor returns a new Builder for and BuilderFor
63+
func BuilderFor(apiType runtime.Object) *Builder {
64+
return &Builder{apiType: apiType}
65+
}
66+
67+
// Owns configures the Application Controller to respond to create / delete / update events for objects it manages
68+
// - e.g. creates. apiType is an empty instance of an object matching the managed object type.
69+
func (b *Builder) Owns(apiType runtime.Object) *Builder {
70+
b.manages = append(b.manages, apiType)
71+
return b
72+
}
73+
74+
// WithConfig sets the Config to use for configuring clients. Defaults to the in-cluster config or to ~/.kube/config.
75+
func (b *Builder) WithConfig(config *rest.Config) *Builder {
76+
b.config = config
77+
return b
78+
}
79+
80+
// WithManager sets the Manager to use for registering the Controller. Defaults to a new manager.Manager.
81+
func (b *Builder) WithManager(m manager.Manager) *Builder {
82+
b.mrg = m
83+
return b
84+
}
85+
86+
// WithEventFilter sets the event filters. Defaults to the empty list.
87+
func (b *Builder) WithEventFilter(p predicate.Predicate) *Builder {
88+
b.pred = append(b.pred, p)
89+
return b
90+
}
91+
92+
// WithHandler sets th Reconcile called in response to create / update / delete events for the
93+
// BuilderFor type or Created object types.
94+
func (b *Builder) WithHandler(r reconcile.Reconciler) *Builder {
95+
b.r = r
96+
return b
97+
}
98+
99+
// Build builds the Application Controller and returns the Manager used to start it.
100+
func (b *Builder) Build() (manager.Manager, error) {
101+
a := &application{}
102+
103+
if b.r == nil {
104+
return nil, fmt.Errorf("must call Builder.WithHandler to set Reconcile")
105+
}
106+
107+
var err error
108+
if b.config == nil {
109+
b.config, err = getConfig()
110+
if err != nil {
111+
return nil, err
112+
}
113+
}
114+
115+
if b.mrg == nil {
116+
b.mrg, err = newManager(b.config, manager.Options{})
117+
if err != nil {
118+
return nil, err
119+
}
120+
}
121+
122+
a.mrg = b.mrg
123+
124+
gvk, err := getGvk(b.apiType, a.mrg.GetScheme())
125+
if err != nil {
126+
return nil, err
127+
}
128+
129+
// Create the controller
130+
name := fmt.Sprintf("%s-application", strings.ToLower(gvk.Kind))
131+
ctrl, err := newController(name, a.mrg, controller.Options{Reconciler: b.r})
132+
if err != nil {
133+
return nil, err
134+
}
135+
a.ctrl = ctrl.(*internalcontroller.Controller)
136+
137+
// Reconcile type
138+
err = a.ctrl.Watch(&source.Kind{Type: b.apiType}, &handler.EnqueueRequestForObject{}, b.pred...)
139+
if err != nil {
140+
return nil, err
141+
}
142+
143+
// Watch the managed types
144+
for _, t := range b.manages {
145+
err = a.ctrl.Watch(&source.Kind{Type: t}, &handler.EnqueueRequestForOwner{
146+
OwnerType: b.apiType, IsController: true}, b.pred...)
147+
if err != nil {
148+
return nil, err
149+
}
150+
}
151+
152+
return a.mrg, nil
153+
}

‎pkg/patterns/application/application_suite_test.go

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package application
2+
3+
import (
4+
"testing"
5+
6+
. "github.com/onsi/ginkgo"
7+
. "github.com/onsi/gomega"
8+
"k8s.io/client-go/rest"
9+
"sigs.k8s.io/controller-runtime/pkg/envtest"
10+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
11+
)
12+
13+
func TestSource(t *testing.T) {
14+
RegisterFailHandler(Fail)
15+
RunSpecsWithDefaultAndCustomReporters(t, "application Suite", []Reporter{envtest.NewlineReporter{}})
16+
}
17+
18+
var testenv *envtest.Environment
19+
var cfg *rest.Config
20+
21+
var _ = BeforeSuite(func(done Done) {
22+
logf.SetLogger(logf.ZapLogger(false))
23+
24+
testenv = &envtest.Environment{}
25+
26+
var err error
27+
cfg, err = testenv.Start()
28+
Expect(err).NotTo(HaveOccurred())
29+
30+
close(done)
31+
}, 60)
32+
33+
var _ = AfterSuite(func() {
34+
testenv.Stop()
35+
})

‎pkg/patterns/application/application_test.go

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
package application
2+
3+
import (
4+
. "github.com/onsi/ginkgo"
5+
"k8s.io/apimachinery/pkg/runtime"
6+
"k8s.io/apimachinery/pkg/runtime/schema"
7+
)
8+
9+
var _ = Describe("application", func() {
10+
//var stop chan struct{}
11+
//
12+
//BeforeEach(func() {
13+
// stop = make(chan struct{})
14+
// getConfig = func() (*rest.Config, error) { return cfg, nil }
15+
// newController = controller.New
16+
// newManager = manager.New
17+
// getGvk = apiutil.GVKForObject
18+
//})
19+
//
20+
//AfterEach(func() {
21+
// close(stop)
22+
//})
23+
//
24+
//Describe("noop", func() {
25+
// It("should return run", func() {
26+
// _, err := noop.Reconcile(reconcile.Request{})
27+
// Expect(err).NotTo(HaveOccurred())
28+
// })
29+
//})
30+
//
31+
//Describe("New", func() {
32+
// It("should return success if given valid objects", func() {
33+
// instance, err := New(&appsv1.ReplicaSet{}, &appsv1.ReplicaSet{})
34+
// Expect(err).NotTo(HaveOccurred())
35+
// Expect(instance).NotTo(BeNil())
36+
// })
37+
//
38+
// It("should return an error if the Config is invalid", func() {
39+
// getConfig = func() (*rest.Config, error) { return cfg, fmt.Errorf("expected error") }
40+
// instance, err := New(&appsv1.ReplicaSet{}, &appsv1.ReplicaSet{})
41+
// Expect(err).To(HaveOccurred())
42+
// Expect(instance).To(BeNil())
43+
// })
44+
//
45+
// It("should return an error if there is no GVK for an object", func() {
46+
// instance, err := New(fakeType(""), &appsv1.ReplicaSet{})
47+
// Expect(err).To(HaveOccurred())
48+
// Expect(instance).To(BeNil())
49+
//
50+
// instance, err = New(&appsv1.ReplicaSet{}, fakeType(""))
51+
// Expect(err).To(HaveOccurred())
52+
// Expect(instance).To(BeNil())
53+
// })
54+
//
55+
// It("should return an error if it cannot create the manager", func() {
56+
// newManager = func(config *rest.Config, options manager.Options) (manager.Manager, error) {
57+
// return nil, fmt.Errorf("expected error")
58+
// }
59+
// instance, err := New(&appsv1.ReplicaSet{}, &appsv1.ReplicaSet{})
60+
// Expect(err).To(HaveOccurred())
61+
// Expect(instance).To(BeNil())
62+
// })
63+
//
64+
// It("should return an error if it cannot create the controller", func() {
65+
// newController = func(name string, mrg manager.Manager, options controller.Options) (
66+
// controller.Controller, error) {
67+
//
68+
// return nil, fmt.Errorf("expected error")
69+
// }
70+
// instance, err := New(&appsv1.ReplicaSet{}, &appsv1.ReplicaSet{})
71+
// Expect(err).To(HaveOccurred())
72+
// Expect(instance).To(BeNil())
73+
// })
74+
//
75+
// It("should return an error if it cannot call handle", func() {
76+
// // Prevent getGVK from failing so watch fails
77+
// getGvk = func(obj runtime.Object, scheme *runtime.Scheme) (schema.GroupVersionKind, error) {
78+
// return schema.GroupVersionKind{Kind: "foo"}, nil
79+
// }
80+
// instance, err := New(fakeType(""), &appsv1.ReplicaSet{})
81+
// Expect(err).To(HaveOccurred())
82+
// Expect(instance).To(BeNil())
83+
// })
84+
//})
85+
//
86+
//Describe("Start", func() {
87+
// It("should Reconcile objects", func(done Done) {
88+
// By("Creating the application")
89+
// instance, err := New(&appsv1.Deployment{}, &appsv1.ReplicaSet{})
90+
// Expect(err).NotTo(HaveOccurred())
91+
//
92+
// // set the stopFn so we shutdown at the end of the test instead of waiting for a signal
93+
// instance.stopFn = func() <-chan struct{} { return stop }
94+
//
95+
// By("Handling Deployments")
96+
// ch := make(chan reconcile.Request)
97+
// fn := reconcile.Func(func(r reconcile.Request) (reconcile.Result, error) {
98+
// defer GinkgoRecover()
99+
// fmt.Printf("Reconcile\n\n")
100+
// ch <- r
101+
// return reconcile.Result{}, nil
102+
// })
103+
// Expect(err).NotTo(HaveOccurred())
104+
//
105+
// By("Starting the application")
106+
// go func() {
107+
// defer GinkgoRecover()
108+
// Expect(instance.Start(fn)).NotTo(HaveOccurred())
109+
// By("Stopping the application")
110+
// }()
111+
//
112+
// By("Creating a Deployment")
113+
// // Expect a Reconcile when the Deployment is manages.
114+
// dep := &appsv1.Deployment{
115+
// ObjectMeta: metav1.ObjectMeta{
116+
// Namespace: "default",
117+
// Name: "deploy-name",
118+
// },
119+
// Spec: appsv1.DeploymentSpec{
120+
// Selector: &metav1.LabelSelector{
121+
// MatchLabels: map[string]string{"foo": "bar"},
122+
// },
123+
// Template: corev1.PodTemplateSpec{
124+
// ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"foo": "bar"}},
125+
// Spec: corev1.PodSpec{
126+
// Containers: []corev1.Container{
127+
// {
128+
// Name: "nginx",
129+
// Image: "nginx",
130+
// },
131+
// },
132+
// },
133+
// },
134+
// },
135+
// }
136+
// err = instance.GetClient().Create(context.TODO(), dep)
137+
// Expect(err).NotTo(HaveOccurred())
138+
//
139+
// By("Waiting for the Deployment Reconcile")
140+
// Expect(<-ch).To(Equal(reconcile.Request{
141+
// NamespacedName: types.NamespacedName{Namespace: "default", Name: "deploy-name"}}))
142+
//
143+
// By("Creating a ReplicaSet")
144+
// // Expect a Reconcile when an Owned object is manages.
145+
// t := true
146+
// rs := &appsv1.ReplicaSet{
147+
// ObjectMeta: metav1.ObjectMeta{
148+
// Namespace: "default",
149+
// Name: "rs-name",
150+
// Labels: dep.Spec.Selector.MatchLabels,
151+
// OwnerReferences: []metav1.OwnerReference{
152+
// {
153+
// Name: "deploy-name",
154+
// Kind: "Deployment",
155+
// APIVersion: "apps/v1",
156+
// Controller: &t,
157+
// UID: dep.UID,
158+
// },
159+
// },
160+
// },
161+
// Spec: appsv1.ReplicaSetSpec{
162+
// Selector: dep.Spec.Selector,
163+
// Template: dep.Spec.Template,
164+
// },
165+
// }
166+
// err = instance.GetClient().Create(context.TODO(), rs)
167+
// Expect(err).NotTo(HaveOccurred())
168+
//
169+
// By("Waiting for the ReplicaSet Reconcile")
170+
// Expect(<-ch).To(Equal(reconcile.Request{
171+
// NamespacedName: types.NamespacedName{Namespace: "default", Name: "deploy-name"}}))
172+
//
173+
// close(done)
174+
// }, 10)
175+
//})
176+
})
177+
178+
var _ runtime.Object = fakeType("")
179+
180+
type fakeType string
181+
182+
func (fakeType) GetObjectKind() schema.ObjectKind { return nil }
183+
func (fakeType) DeepCopyObject() runtime.Object { return nil }

0 commit comments

Comments
 (0)