-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
520 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
package v1alpha1 | ||
|
||
// +kubebuilder:object:generate=false | ||
// | ||
//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 . PromiseFetcher | ||
type PromiseFetcher interface { | ||
FromURL(string) (*Promise, error) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
/* | ||
Copyright 2021 Syntasso. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1alpha1 | ||
|
||
import ( | ||
"fmt" | ||
|
||
"k8s.io/apimachinery/pkg/runtime" | ||
ctrl "sigs.k8s.io/controller-runtime" | ||
logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
"sigs.k8s.io/controller-runtime/pkg/webhook" | ||
"sigs.k8s.io/controller-runtime/pkg/webhook/admission" | ||
) | ||
|
||
const ( | ||
KratixPrefix = "kratix.io/" | ||
PromiseVersionLabel = KratixPrefix + "promise-version" | ||
) | ||
|
||
var ( | ||
promiseFetcher PromiseFetcher | ||
promisereleaselog = logf.Log.WithName("promiserelease-resource") | ||
) | ||
|
||
func (r *PromiseRelease) SetupWebhookWithManager(mgr ctrl.Manager, pf PromiseFetcher) error { | ||
promiseFetcher = pf | ||
return ctrl.NewWebhookManagedBy(mgr). | ||
For(r). | ||
Complete() | ||
} | ||
|
||
// +kubebuilder:webhook:path=/validate-platform-kratix-io-v1alpha1-promiserelease,mutating=false,failurePolicy=fail,sideEffects=None,groups=platform.kratix.io,resources=promisereleases,verbs=create;update,versions=v1alpha1,name=vpromiserelease.kb.io,admissionReviewVersions=v1 | ||
var _ webhook.Validator = &PromiseRelease{} | ||
|
||
func (r *PromiseRelease) ValidateCreate() (admission.Warnings, error) { | ||
promisereleaselog.Info("validate create", "name", r.Name) | ||
if err := r.validate(); err != nil { | ||
return nil, err | ||
} | ||
|
||
promise, err := promiseFetcher.FromURL(r.Spec.SourceRef.URL) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to fetch promise: %w", err) | ||
} | ||
|
||
promiseVersion, found := promise.GetLabels()[PromiseVersionLabel] | ||
if !found { | ||
msg := fmt.Sprintf("Warning: version label (%s) not found on promise, installation will fail", PromiseVersionLabel) | ||
return []string{msg}, nil | ||
} | ||
|
||
if promiseVersion != r.Spec.Version { | ||
msg := fmt.Sprintf("Warning: version labels do not match, found: %s, expected: %s, installation will fail", promiseVersion, r.Spec.Version) | ||
return []string{msg}, nil | ||
} | ||
|
||
return nil, nil | ||
} | ||
|
||
func (r *PromiseRelease) ValidateUpdate(old runtime.Object) (admission.Warnings, error) { | ||
promisereleaselog.Info("validate update", "name", r.Name) | ||
// oldPromiseRelease, _ := old.(*PromiseRelease) | ||
if err := r.validate(); err != nil { | ||
return nil, err | ||
} | ||
|
||
return nil, nil | ||
} | ||
|
||
func (r *PromiseRelease) validate() error { | ||
if r.Spec.SourceRef.Type != TypeHTTP { | ||
return fmt.Errorf("unknown sourceRef type %q", r.Spec.SourceRef.Type) | ||
} | ||
|
||
if r.Spec.SourceRef.URL == "" { | ||
return fmt.Errorf("sourceRef.url must be set") | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (r *PromiseRelease) ValidateDelete() (admission.Warnings, error) { | ||
// promisereleaselog.Info("validate delete", "name", r.Name) | ||
return nil, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
package v1alpha1_test | ||
|
||
import ( | ||
"fmt" | ||
|
||
. "github.com/onsi/ginkgo/v2" | ||
. "github.com/onsi/gomega" | ||
"github.com/syntasso/kratix/api/v1alpha1" | ||
"github.com/syntasso/kratix/api/v1alpha1/v1alpha1fakes" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
) | ||
|
||
var _ = Describe("PromiseReleaseWebhook", func() { | ||
var ( | ||
p *v1alpha1.Promise | ||
pr *v1alpha1.PromiseRelease | ||
promiseFetcher v1alpha1fakes.FakePromiseFetcher | ||
) | ||
BeforeEach(func() { | ||
promiseFetcher = v1alpha1fakes.FakePromiseFetcher{} | ||
v1alpha1.SetPromiseFetcher(&promiseFetcher) | ||
|
||
pr = &v1alpha1.PromiseRelease{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "mycrds.group.example", | ||
Namespace: "default", | ||
}, | ||
Spec: v1alpha1.PromiseReleaseSpec{ | ||
Version: "v0.1.0", | ||
SourceRef: v1alpha1.SourceRef{ | ||
Type: "http", | ||
URL: "example.com", | ||
}, | ||
}, | ||
} | ||
|
||
p = &v1alpha1.Promise{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "foo", | ||
Labels: map[string]string{ | ||
"kratix.io/promise-version": "v0.1.0", | ||
}, | ||
}, | ||
} | ||
}) | ||
|
||
When("source ref is unknown", func() { | ||
It("errors on create and update", func() { | ||
pr.Spec.SourceRef.Type = "ssh" | ||
warnings, err := pr.ValidateCreate() | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).To(MatchError("unknown sourceRef type \"ssh\"")) | ||
|
||
warnings, err = pr.ValidateUpdate(pr) | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).To(MatchError("unknown sourceRef type \"ssh\"")) | ||
}) | ||
}) | ||
|
||
When("URL is empty", func() { | ||
It("errors on create and update", func() { | ||
pr.Spec.SourceRef.URL = "" | ||
warnings, err := pr.ValidateCreate() | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).To(MatchError("sourceRef.url must be set")) | ||
|
||
warnings, err = pr.ValidateUpdate(pr) | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).To(MatchError("sourceRef.url must be set")) | ||
}) | ||
}) | ||
|
||
When("fetching the URL fails", func() { | ||
It("errors on create", func() { | ||
promiseFetcher.FromURLReturns(p, fmt.Errorf("foo")) | ||
warnings, err := pr.ValidateCreate() | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).To(MatchError("failed to fetch promise: foo")) | ||
|
||
warnings, err = pr.ValidateUpdate(pr) | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).NotTo(HaveOccurred()) | ||
}) | ||
|
||
It("does not error on update", func() { | ||
//We only want to fetch it on create, its expensive to do this call | ||
//frequently. | ||
promiseFetcher.FromURLReturns(p, fmt.Errorf("foo")) | ||
warnings, err := pr.ValidateUpdate(pr) | ||
Expect(warnings).To(BeEmpty()) | ||
Expect(err).NotTo(HaveOccurred()) | ||
}) | ||
}) | ||
|
||
When("the promise is missing the label", func() { | ||
It("emits a warning", func() { | ||
p.Labels = map[string]string{} | ||
promiseFetcher.FromURLReturns(p, nil) | ||
warnings, err := pr.ValidateCreate() | ||
Expect(err).NotTo(HaveOccurred()) | ||
Expect(warnings).To(ConsistOf("Warning: version label (kratix.io/promise-version) not found on promise, installation will fail")) | ||
}) | ||
}) | ||
|
||
When("the promise is at a different version", func() { | ||
It("emits a warning", func() { | ||
p.Labels = map[string]string{ | ||
"kratix.io/promise-version": "v0.2.0", | ||
} | ||
promiseFetcher.FromURLReturns(p, nil) | ||
warnings, err := pr.ValidateCreate() | ||
Expect(err).NotTo(HaveOccurred()) | ||
Expect(warnings).To(ConsistOf("Warning: version labels do not match, found: v0.2.0, expected: v0.1.0, installation will fail")) | ||
}) | ||
}) | ||
}) |
5 changes: 2 additions & 3 deletions
5
.../controllersfakes/fake_promise_fetcher.go → ...ha1/v1alpha1fakes/fake_promise_fetcher.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.