Do not encode empty hardwareRAIDVolumes

[levsha]

hardwareRAIDVolumes is nil in some cases (probably when the platform of a host supports hardware raid but does not have any volumes configured). This translates to "null" in json representation and causes validation error because 'nil' and '[]' is not the same in Go:

Reconciler error,reconciler group:metal3.io,reconciler kind:BareMetalHost,name:sch05,namespace:cluster-sch,error:failed to save host status after "preparing": BareMetalHost.metal3.io "sch05" is invalid: status.provisioning.raid.hardwareRAIDVolumes: Invalid value: "null": status.provisioning.raid.hardwareRAIDVolumes in body must be of type array: "null",errorVerbose:BareMetalHost.metal3.io "sch05" is invalid: status.provisioning.raid.hardwareRAIDVolumes: Invalid value: "null": status.provisioning.raid.hardwareRAIDVolumes in body must be of type array: "null"
 failed to save host status after "preparing"
 github.com/metal3-io/baremetal-operator/controllers/metal3%2eio.(*BareMetalHostReconciler).Reconcile
 	/workspace/controllers/metal3.io/baremetalhost_controller.go:259
 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).reconcileHandler
 	/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.9.0/pkg/internal/controller/controller.go:298
 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).processNextWorkItem
 	/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.9.0/pkg/internal/controller/controller.go:253
 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2.2
 	/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.9.0/pkg/internal/controller/controller.go:214
 runtime.goexit
 	/usr/local/go/src/runtime/asm_amd64.s:1371,stacktrace:sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).processNextWorkItem
 	/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.9.0/pkg/internal/controller/controller.go:253
 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2.2
 	/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.9.0/pkg/internal/controller/controller.go:214

Omitting empty values fixes this error.
The field had "omitempty" previously, but it was removed in https://github.com/metal3-io/baremetal-operator/pull/908/files#diff-0f3e356f6156566888fdbc0e7c0fa713ee054933106059fc29f702f8d1a554f2L289

[metal3-io-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign hardys after the PR has been reviewed.
You can assign the PR to them by writing /assign @hardys in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[metal3-io-bot]

Hi @levsha. Thanks for your PR.

I'm waiting for a metal3-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[s3rj1k]

/ok-to-test

@levsha Seems that PR could be rebased to include single commit

[s3rj1k]

/test-integration

[levsha]

/ok-to-test

@levsha Seems that PR could be rebased to include single commit

Done. Thanks for pointing out!

[zaneb]

It was removed for a reason though. @Hellcatlk is there any code that is relying on distinguishing between null/missing and []? If so we may have to change this to a pointer-to-slice (i.e. *[]HardwareRAIDVolume)

Also there's no reason to think that the SoftwareRAIDVolume wouldn't have the same issue.

/hold

[jplimack]

@zaneb yes, it does also effect the softwareRAIDvolume. setting that to an empty array in the bmh spec gets around it. its also effecting the status field

Invalid value: \"null\": status.provisioning.raid.softwareRAIDVolumes in body must be of type array: \"null\"\nfailed to save host status after \"deprovisioning\"

[Hellcatlk]

@Hellcatlk is there any code that is relying on distinguishing between null/missing and []?

BuildRAIDCleanSteps and saveHostProvisioningSettings rely on distinguishing between empty/missing and [].

[zaneb]

Thanks, that's what I thought. This won't work then. I think the only solution is to add a comment like:

// +nullable

to each field. This will cause a change to the CRD.

[levsha]

I can confirm that marking both fields as 'nullable' helps (and that 'omitempty' does not help - the original error disappears but then BMH just switches between 'ready' <-> 'preparing' forever, never goes to 'provisioning').

[levsha]

#966

[zaneb]

/close
in favour of #966

[metal3-io-bot]

@zaneb: Closed this PR.

In response to this:

/close
in favour of #966

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[metal3-io-bot]

@levsha: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.