-
Notifications
You must be signed in to change notification settings - Fork 413
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: spec.uid for Datasource * test: update example test resources * refactor: Update datasource field descriptions * test: Datasource immutability with envtest dep: upgrade ginkgo to v2
- Loading branch information
1 parent
e1fa46a
commit 3b42b31
Showing
14 changed files
with
242 additions
and
108 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,70 @@ | ||
| package v1beta1 | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "testing" | ||
| ) | ||
| "context" | ||
|
|
||
| func TestGrafanaDatasources_expandVariables(t *testing.T) { | ||
| type testcase struct { | ||
| name string | ||
| variables map[string][]byte | ||
| in GrafanaDatasource | ||
| out []byte | ||
| } | ||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
| v1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| testcases := []testcase{ | ||
| { | ||
| name: "basic replacement", | ||
| variables: map[string][]byte{ | ||
| "PROMETHEUS_USERNAME": []byte("root"), | ||
| }, | ||
| in: GrafanaDatasource{ | ||
| Spec: GrafanaDatasourceSpec{ | ||
| Datasource: &GrafanaDatasourceInternal{ | ||
| Name: "prometheus", | ||
| User: "${PROMETHEUS_USERNAME}", | ||
| }, | ||
| }, | ||
| }, | ||
| out: []byte("{\"name\":\"prometheus\",\"user\":\"root\"}"), | ||
| func newDatasource(name string, uid string) *GrafanaDatasource { | ||
| return &GrafanaDatasource{ | ||
| TypeMeta: v1.TypeMeta{ | ||
| APIVersion: APIVersion, | ||
| Kind: "GrafanaDatasource", | ||
| }, | ||
| { | ||
| name: "replacement without curly braces", | ||
| variables: map[string][]byte{ | ||
| "PROMETHEUS_USERNAME": []byte("root"), | ||
| }, | ||
| in: GrafanaDatasource{ | ||
| Spec: GrafanaDatasourceSpec{ | ||
| Datasource: &GrafanaDatasourceInternal{ | ||
| Name: "prometheus", | ||
| User: "$PROMETHEUS_USERNAME", | ||
| }, | ||
| ObjectMeta: v1.ObjectMeta{ | ||
| Name: name, | ||
| Namespace: "default", | ||
| }, | ||
| Spec: GrafanaDatasourceSpec{ | ||
| CustomUID: uid, | ||
| InstanceSelector: &v1.LabelSelector{ | ||
| MatchLabels: map[string]string{ | ||
| "test": "datasource", | ||
| }, | ||
| }, | ||
| out: []byte("{\"name\":\"prometheus\",\"user\":\"root\"}"), | ||
| Datasource: &GrafanaDatasourceInternal{ | ||
| Name: "testdata", | ||
| Type: "grafana-testdata-datasource", | ||
| Access: "proxy", | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| for _, tc := range testcases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| b, err := tc.in.ExpandVariables(tc.variables) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| var _ = Describe("Datasource type", func() { | ||
| Context("Ensure Datasource spec.uid is immutable", func() { | ||
| ctx := context.Background() | ||
| It("Should block adding uid field when missing", func() { | ||
| ds := newDatasource("missing-uid", "") | ||
| By("Create new Datasource without uid") | ||
| Expect(k8sClient.Create(ctx, ds)).To(Succeed()) | ||
|
|
||
| if !bytes.Equal(b, tc.out) { | ||
| t.Error(fmt.Errorf("expected %v, but got %v", string(tc.out), string(b))) | ||
| } | ||
| By("Adding a uid") | ||
| ds.Spec.CustomUID = "new-uid" | ||
| Expect(k8sClient.Update(ctx, ds)).To(HaveOccurred()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| It("Should block removing uid field when set", func() { | ||
| ds := newDatasource("existing-uid", "existing-uid") | ||
| By("Creating Datasource with existing UID") | ||
| Expect(k8sClient.Create(ctx, ds)).To(Succeed()) | ||
|
|
||
| By("And setting UID to ''") | ||
| ds.Spec.CustomUID = "" | ||
| Expect(k8sClient.Update(ctx, ds)).To(HaveOccurred()) | ||
| }) | ||
|
|
||
| It("Should block changing value of uid", func() { | ||
| ds := newDatasource("removing-uid", "existing-uid") | ||
| By("Create new Datasource with existing UID") | ||
| Expect(k8sClient.Create(ctx, ds)).To(Succeed()) | ||
|
|
||
| By("Changing the existing UID") | ||
| ds.Spec.CustomUID = "new-uid" | ||
| Expect(k8sClient.Update(ctx, ds)).To(HaveOccurred()) | ||
| }) | ||
| }) | ||
| }) |
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,80 @@ | ||
| /* | ||
| Copyright 2022. | ||
| 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 v1beta1 | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
| "k8s.io/client-go/kubernetes/scheme" | ||
| "k8s.io/client-go/rest" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/envtest" | ||
| logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
| "sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
| //+kubebuilder:scaffold:imports | ||
| ) | ||
|
|
||
| // These tests use Ginkgo (BDD-style Go testing framework). Refer to | ||
| // http://onsi.github.io/ginkgo/ to learn more about Ginkgo. | ||
|
|
||
| const ( | ||
| APIVersion = "grafana.integreatly.org/v1beta1" | ||
| ) | ||
|
|
||
| var ( | ||
| cfg *rest.Config | ||
| k8sClient client.Client | ||
| testEnv *envtest.Environment | ||
| ) | ||
|
|
||
| func TestAPIs(t *testing.T) { | ||
| RegisterFailHandler(Fail) | ||
|
|
||
| RunSpecs(t, "CRDs Suite") | ||
| } | ||
|
|
||
| var _ = BeforeSuite(func() { | ||
| logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true))) | ||
|
|
||
| By("bootstrapping test environment") | ||
| testEnv = &envtest.Environment{ | ||
| CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")}, | ||
| ErrorIfCRDPathMissing: true, | ||
| } | ||
|
|
||
| cfg, err := testEnv.Start() | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(cfg).NotTo(BeNil()) | ||
|
|
||
| err = AddToScheme(scheme.Scheme) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| //+kubebuilder:scaffold:scheme | ||
|
|
||
| k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme}) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(k8sClient).NotTo(BeNil()) | ||
| }) | ||
|
|
||
| var _ = AfterSuite(func() { | ||
| By("tearing down the test environment") | ||
| err := testEnv.Stop() | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| }) |
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
Oops, something went wrong.