Skip to content
This repository was archived by the owner on Aug 12, 2024. It is now read-only.

Commit 4f952d4

Browse files
Mikalai Radchukstevekuznetsov
Mikalai Radchuk
authored and
stevekuznetsov
committed
Remove pointer to BundleTemplate from spec
`Template` field in `BundleDeploymentSpec` seems to have unnecessary pointer as we expect to always populate this field. Signed-off-by: Mikalai Radchuk <[email protected]>
1 parent ee9a975 commit 4f952d4

File tree

8 files changed

+33
-37
lines changed

8 files changed

+33
-37
lines changed

‎api/v1alpha1/bundledeployment_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ type BundleDeploymentSpec struct {
5353
// ProvisionerClassName sets the name of the provisioner that should reconcile this BundleDeployment.
5454
ProvisionerClassName string `json:"provisionerClassName"`
5555
// Template describes the generated Bundle that this deployment will manage.
56-
Template *BundleTemplate `json:"template"`
56+
Template BundleTemplate `json:"template"`
5757
// Config is provisioner specific configurations
5858
// +kubebuilder:pruning:PreserveUnknownFields
5959
Config runtime.RawExtension `json:"config,omitempty"`

‎api/v1alpha1/zz_generated.deepcopy.go

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/util/util.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ func GetBundlesForBundleDeploymentSelector(ctx context.Context, c client.Client,
270270
// CheckExistingBundlesMatchesTemplate evaluates whether the existing list of Bundle objects
271271
// match the desired Bundle template that's specified in a BundleDeployment object. If a match
272272
// is found, that Bundle object is returned, so callers are responsible for nil checking the result.
273-
func CheckExistingBundlesMatchesTemplate(existingBundles *rukpakv1alpha1.BundleList, desiredBundleTemplate *rukpakv1alpha1.BundleTemplate) *rukpakv1alpha1.Bundle {
273+
func CheckExistingBundlesMatchesTemplate(existingBundles *rukpakv1alpha1.BundleList, desiredBundleTemplate rukpakv1alpha1.BundleTemplate) *rukpakv1alpha1.Bundle {
274274
for i := range existingBundles.Items {
275275
if !CheckDesiredBundleTemplate(&existingBundles.Items[i], desiredBundleTemplate) {
276276
continue
@@ -282,7 +282,7 @@ func CheckExistingBundlesMatchesTemplate(existingBundles *rukpakv1alpha1.BundleL
282282

283283
// CheckDesiredBundleTemplate is responsible for determining whether the existingBundle
284284
// hash is equal to the desiredBundle Bundle template hash.
285-
func CheckDesiredBundleTemplate(existingBundle *rukpakv1alpha1.Bundle, desiredBundle *rukpakv1alpha1.BundleTemplate) bool {
285+
func CheckDesiredBundleTemplate(existingBundle *rukpakv1alpha1.Bundle, desiredBundle rukpakv1alpha1.BundleTemplate) bool {
286286
if len(existingBundle.Labels) == 0 {
287287
// Existing Bundle has no labels set, which should never be the case.
288288
// Return false so that the Bundle is forced to be recreated with the expected labels.
@@ -301,7 +301,7 @@ func CheckDesiredBundleTemplate(existingBundle *rukpakv1alpha1.Bundle, desiredBu
301301
return existingHash == desiredHash
302302
}
303303

304-
func GenerateTemplateHash(template *rukpakv1alpha1.BundleTemplate) string {
304+
func GenerateTemplateHash(template rukpakv1alpha1.BundleTemplate) string {
305305
hasher := fnv.New32a()
306306
DeepHashObject(hasher, template)
307307
return rand.SafeEncodeString(fmt.Sprintf("%x", hasher.Sum32())[:6])

‎internal/util/util_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var sampleSpec = rukpakv1alpha1.BundleSpec{
2121
func TestCheckDesiredBundleTemplate(t *testing.T) {
2222
type args struct {
2323
existingBundle *rukpakv1alpha1.Bundle
24-
desiredBundle *rukpakv1alpha1.BundleTemplate
24+
desiredBundle rukpakv1alpha1.BundleTemplate
2525
}
2626
tests := []struct {
2727
name string
@@ -40,7 +40,7 @@ func TestCheckDesiredBundleTemplate(t *testing.T) {
4040
},
4141
Spec: sampleSpec,
4242
},
43-
desiredBundle: &rukpakv1alpha1.BundleTemplate{
43+
desiredBundle: rukpakv1alpha1.BundleTemplate{
4444
ObjectMeta: metav1.ObjectMeta{
4545
Name: "stub",
4646
Labels: map[string]string{
@@ -66,7 +66,7 @@ func TestCheckDesiredBundleTemplate(t *testing.T) {
6666
ProvisionerClassName: "non-existent-provisioner-class-name",
6767
},
6868
},
69-
desiredBundle: &rukpakv1alpha1.BundleTemplate{
69+
desiredBundle: rukpakv1alpha1.BundleTemplate{
7070
ObjectMeta: metav1.ObjectMeta{
7171
Name: "stub",
7272
Labels: map[string]string{
@@ -90,7 +90,7 @@ func TestCheckDesiredBundleTemplate(t *testing.T) {
9090
},
9191
Spec: sampleSpec,
9292
},
93-
desiredBundle: &rukpakv1alpha1.BundleTemplate{
93+
desiredBundle: rukpakv1alpha1.BundleTemplate{
9494
ObjectMeta: metav1.ObjectMeta{
9595
Name: "stub",
9696
Labels: map[string]string{
@@ -117,7 +117,7 @@ func TestCheckDesiredBundleTemplate(t *testing.T) {
117117
},
118118
Spec: sampleSpec,
119119
},
120-
desiredBundle: &rukpakv1alpha1.BundleTemplate{
120+
desiredBundle: rukpakv1alpha1.BundleTemplate{
121121
ObjectMeta: metav1.ObjectMeta{
122122
Name: "stub",
123123
Labels: map[string]string{
@@ -144,7 +144,7 @@ func TestCheckDesiredBundleTemplate(t *testing.T) {
144144
},
145145
Spec: sampleSpec,
146146
},
147-
desiredBundle: &rukpakv1alpha1.BundleTemplate{
147+
desiredBundle: rukpakv1alpha1.BundleTemplate{
148148
ObjectMeta: metav1.ObjectMeta{
149149
Name: "stub-123",
150150
Labels: map[string]string{
@@ -180,7 +180,7 @@ func injectCoreLabels(bundle *rukpakv1alpha1.Bundle) {
180180
labels[CoreOwnerNameKey] = ""
181181
}
182182

183-
func injectTemplateHashLabel(bundle *rukpakv1alpha1.Bundle, template *rukpakv1alpha1.BundleTemplate, want bool) {
183+
func injectTemplateHashLabel(bundle *rukpakv1alpha1.Bundle, template rukpakv1alpha1.BundleTemplate, want bool) {
184184
labels := bundle.GetLabels()
185185
if want {
186186
labels[CoreBundleTemplateHashKey] = GenerateTemplateHash(template)

‎test/e2e/api_validation_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ var _ = Describe("bundle deployment api validation", func() {
257257
},
258258
Spec: rukpakv1alpha1.BundleDeploymentSpec{
259259
ProvisionerClassName: plain.ProvisionerID,
260-
Template: &rukpakv1alpha1.BundleTemplate{
260+
Template: rukpakv1alpha1.BundleTemplate{
261261
Spec: rukpakv1alpha1.BundleSpec{
262262
ProvisionerClassName: plain.ProvisionerID,
263263
Source: rukpakv1alpha1.BundleSource{
@@ -302,7 +302,7 @@ var _ = Describe("bundle deployment api validation", func() {
302302
},
303303
Spec: rukpakv1alpha1.BundleDeploymentSpec{
304304
ProvisionerClassName: "invalid/class-name",
305-
Template: &rukpakv1alpha1.BundleTemplate{
305+
Template: rukpakv1alpha1.BundleTemplate{
306306
Spec: rukpakv1alpha1.BundleSpec{
307307
ProvisionerClassName: plain.ProvisionerID,
308308
Source: rukpakv1alpha1.BundleSource{
@@ -344,7 +344,7 @@ var _ = Describe("bundle deployment api validation", func() {
344344
},
345345
Spec: rukpakv1alpha1.BundleDeploymentSpec{
346346
ProvisionerClassName: plain.ProvisionerID,
347-
Template: &rukpakv1alpha1.BundleTemplate{
347+
Template: rukpakv1alpha1.BundleTemplate{
348348
Spec: rukpakv1alpha1.BundleSpec{
349349
ProvisionerClassName: "invalid/class-name",
350350
Source: rukpakv1alpha1.BundleSource{

‎test/e2e/helm_provisioner_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
3333
},
3434
Spec: rukpakv1alpha1.BundleDeploymentSpec{
3535
ProvisionerClassName: helm.ProvisionerID,
36-
Template: &rukpakv1alpha1.BundleTemplate{
36+
Template: rukpakv1alpha1.BundleTemplate{
3737
ObjectMeta: metav1.ObjectMeta{
3838
Labels: map[string]string{
3939
"app.kubernetes.io/name": "ahoy",
@@ -147,7 +147,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
147147
},
148148
Spec: rukpakv1alpha1.BundleDeploymentSpec{
149149
ProvisionerClassName: helm.ProvisionerID,
150-
Template: &rukpakv1alpha1.BundleTemplate{
150+
Template: rukpakv1alpha1.BundleTemplate{
151151
ObjectMeta: metav1.ObjectMeta{
152152
Labels: map[string]string{
153153
"app.kubernetes.io/name": "ahoy",
@@ -203,7 +203,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
203203
},
204204
Spec: rukpakv1alpha1.BundleDeploymentSpec{
205205
ProvisionerClassName: helm.ProvisionerID,
206-
Template: &rukpakv1alpha1.BundleTemplate{
206+
Template: rukpakv1alpha1.BundleTemplate{
207207
ObjectMeta: metav1.ObjectMeta{
208208
Labels: map[string]string{
209209
"app.kubernetes.io/name": "ahoy",
@@ -259,7 +259,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
259259
},
260260
Spec: rukpakv1alpha1.BundleDeploymentSpec{
261261
ProvisionerClassName: helm.ProvisionerID,
262-
Template: &rukpakv1alpha1.BundleTemplate{
262+
Template: rukpakv1alpha1.BundleTemplate{
263263
ObjectMeta: metav1.ObjectMeta{
264264
Labels: map[string]string{
265265
"app.kubernetes.io/name": "ahoy",
@@ -315,7 +315,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
315315
},
316316
Spec: rukpakv1alpha1.BundleDeploymentSpec{
317317
ProvisionerClassName: helm.ProvisionerID,
318-
Template: &rukpakv1alpha1.BundleTemplate{
318+
Template: rukpakv1alpha1.BundleTemplate{
319319
ObjectMeta: metav1.ObjectMeta{
320320
Labels: map[string]string{
321321
"app.kubernetes.io/name": "ahoy",
@@ -439,7 +439,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
439439
},
440440
Spec: rukpakv1alpha1.BundleDeploymentSpec{
441441
ProvisionerClassName: helm.ProvisionerID,
442-
Template: &rukpakv1alpha1.BundleTemplate{
442+
Template: rukpakv1alpha1.BundleTemplate{
443443
ObjectMeta: metav1.ObjectMeta{
444444
Labels: map[string]string{
445445
"app.kubernetes.io/name": "ahoy",
@@ -503,7 +503,7 @@ var _ = Describe("helm provisioner bundledeployment", func() {
503503
Spec: rukpakv1alpha1.BundleDeploymentSpec{
504504
ProvisionerClassName: helm.ProvisionerID,
505505
Config: runtime.RawExtension{Raw: []byte(`{"values": "# Default values for hello-world.\n# This is a YAML-formatted file.\n# Declare variables to be passed into your templates.\nreplicaCount: 1\nimage:\n repository: nginx\n pullPolicy: IfNotPresent\n # Overrides the image tag whose default is the chart appVersion.\n tag: \"\"\nnameOverride: \"fromvalues\"\nfullnameOverride: \"\"\nserviceAccount:\n # Specifies whether a service account should be created\n create: true\n # Annotations to add to the service account\n annotations: {}\n # The name of the service account to use.\n # If not set and create is true, a name is generated using the fullname template\n name: \"\"\nservice:\n type: ClusterIP\n port: 80\n"}`)},
506-
Template: &rukpakv1alpha1.BundleTemplate{
506+
Template: rukpakv1alpha1.BundleTemplate{
507507
ObjectMeta: metav1.ObjectMeta{
508508
Labels: map[string]string{
509509
"app.kubernetes.io/name": "ahoy",

‎test/e2e/plain_provisioner_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1394,7 +1394,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
13941394
},
13951395
Spec: rukpakv1alpha1.BundleDeploymentSpec{
13961396
ProvisionerClassName: plain.ProvisionerID,
1397-
Template: &rukpakv1alpha1.BundleTemplate{
1397+
Template: rukpakv1alpha1.BundleTemplate{
13981398
Spec: rukpakv1alpha1.BundleSpec{
13991399
ProvisionerClassName: plain.ProvisionerID,
14001400
Source: rukpakv1alpha1.BundleSource{
@@ -1636,7 +1636,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
16361636
},
16371637
Spec: rukpakv1alpha1.BundleDeploymentSpec{
16381638
ProvisionerClassName: plain.ProvisionerID,
1639-
Template: &rukpakv1alpha1.BundleTemplate{
1639+
Template: rukpakv1alpha1.BundleTemplate{
16401640
ObjectMeta: metav1.ObjectMeta{
16411641
Labels: map[string]string{
16421642
"app.kubernetes.io/name": "olm-crds",
@@ -1695,7 +1695,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
16951695
},
16961696
Spec: rukpakv1alpha1.BundleDeploymentSpec{
16971697
ProvisionerClassName: plain.ProvisionerID,
1698-
Template: &rukpakv1alpha1.BundleTemplate{
1698+
Template: rukpakv1alpha1.BundleTemplate{
16991699
ObjectMeta: metav1.ObjectMeta{
17001700
Labels: map[string]string{
17011701
"app.kubernetes.io/name": "olm-apis",
@@ -1774,7 +1774,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
17741774
},
17751775
Spec: rukpakv1alpha1.BundleDeploymentSpec{
17761776
ProvisionerClassName: plain.ProvisionerID,
1777-
Template: &rukpakv1alpha1.BundleTemplate{
1777+
Template: rukpakv1alpha1.BundleTemplate{
17781778
ObjectMeta: metav1.ObjectMeta{
17791779
Labels: map[string]string{
17801780
"app.kubernetes.io/name": "olm-apis",
@@ -1838,7 +1838,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
18381838
},
18391839
Spec: rukpakv1alpha1.BundleDeploymentSpec{
18401840
ProvisionerClassName: plain.ProvisionerID,
1841-
Template: &rukpakv1alpha1.BundleTemplate{
1841+
Template: rukpakv1alpha1.BundleTemplate{
18421842
ObjectMeta: metav1.ObjectMeta{
18431843
Labels: map[string]string{
18441844
"app.kubernetes.io/name": "e2e-dependent-bundle",
@@ -1895,7 +1895,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
18951895
},
18961896
Spec: rukpakv1alpha1.BundleDeploymentSpec{
18971897
ProvisionerClassName: plain.ProvisionerID,
1898-
Template: &rukpakv1alpha1.BundleTemplate{
1898+
Template: rukpakv1alpha1.BundleTemplate{
18991899
ObjectMeta: metav1.ObjectMeta{
19001900
Labels: map[string]string{
19011901
"app.kubernetes.io/name": "e2e-bundle-providing",
@@ -1956,7 +1956,7 @@ var _ = Describe("plain provisioner bundledeployment", func() {
19561956
},
19571957
Spec: rukpakv1alpha1.BundleDeploymentSpec{
19581958
ProvisionerClassName: plain.ProvisionerID,
1959-
Template: &rukpakv1alpha1.BundleTemplate{
1959+
Template: rukpakv1alpha1.BundleTemplate{
19601960
ObjectMeta: metav1.ObjectMeta{
19611961
Labels: map[string]string{
19621962
"app.kubernetes.io/name": "e2e-bundle-crds-and-crs",
@@ -2090,7 +2090,7 @@ var _ = Describe("plain provisioner garbage collection", func() {
20902090
},
20912091
Spec: rukpakv1alpha1.BundleDeploymentSpec{
20922092
ProvisionerClassName: plain.ProvisionerID,
2093-
Template: &rukpakv1alpha1.BundleTemplate{
2093+
Template: rukpakv1alpha1.BundleTemplate{
20942094
ObjectMeta: metav1.ObjectMeta{
20952095
Labels: labels,
20962096
},
@@ -2182,7 +2182,7 @@ var _ = Describe("plain provisioner garbage collection", func() {
21822182
},
21832183
Spec: rukpakv1alpha1.BundleDeploymentSpec{
21842184
ProvisionerClassName: plain.ProvisionerID,
2185-
Template: &rukpakv1alpha1.BundleTemplate{
2185+
Template: rukpakv1alpha1.BundleTemplate{
21862186
ObjectMeta: metav1.ObjectMeta{
21872187
Labels: map[string]string{
21882188
"app.kubernetes.io/name": "e2e-ownerref-bundle-valid",

‎test/e2e/registry_provisioner_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var _ = Describe("registry provisioner bundle", func() {
3030
},
3131
Spec: rukpakv1alpha1.BundleDeploymentSpec{
3232
ProvisionerClassName: plain.ProvisionerID,
33-
Template: &rukpakv1alpha1.BundleTemplate{
33+
Template: rukpakv1alpha1.BundleTemplate{
3434
ObjectMeta: metav1.ObjectMeta{
3535
Labels: map[string]string{
3636
"app.kubernetes.io/name": "prometheus",
@@ -89,7 +89,7 @@ var _ = Describe("registry provisioner bundle", func() {
8989
},
9090
Spec: rukpakv1alpha1.BundleDeploymentSpec{
9191
ProvisionerClassName: plain.ProvisionerID,
92-
Template: &rukpakv1alpha1.BundleTemplate{
92+
Template: rukpakv1alpha1.BundleTemplate{
9393
ObjectMeta: metav1.ObjectMeta{
9494
Labels: map[string]string{
9595
"app.kubernetes.io/name": "cincinnati",

0 commit comments

Comments
 (0)