Store MAC as lowercase #279
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| package grpcserver | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/tinkerbell/tink/protos/hardware" | ||
| ) | ||
|
|
||
| func Test_server_normalizeHardwareData(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| given *hardware.Hardware | ||
| expected *hardware.Hardware | ||
| }{ | ||
| { | ||
| name: "Expect MAC to be normalized to lowercase", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0E:D9:C7:53", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0e:d9:c7:53", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Expect MAC to be normalized to lowercase, multiple interfaces", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0E:D9:C7:53", | ||
| }, | ||
| }, | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:4F:0E:D9:C7:5E", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0e:d9:c7:53", | ||
| }, | ||
| }, | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:4f:0e:d9:c7:5e", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Expect MAC to be normalized to lowercase, nultiple interfaces, mixed casing", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0e:d9:c7:53", | ||
| }, | ||
| }, | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:4F:0E:D9:C7:5E", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:42:0e:d9:c7:53", | ||
| }, | ||
| }, | ||
| { | ||
| Dhcp: &hardware.Hardware_DHCP{ | ||
| Mac: "02:4f:0e:d9:c7:5e", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Handle nil DHCP", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: nil, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| { | ||
| Dhcp: nil, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Handle nil Interface", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| nil, | ||
| }, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: []*hardware.Hardware_Network_Interface{ | ||
| nil, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Handle nil Interfaces", | ||
| given: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: nil, | ||
| }, | ||
| }, | ||
| expected: &hardware.Hardware{ | ||
| Network: &hardware.Hardware_Network{ | ||
| Interfaces: nil, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Handle nil Network", | ||
| given: &hardware.Hardware{Network: nil}, | ||
| expected: &hardware.Hardware{Network: nil}, | ||
| }, | ||
| { | ||
| name: "Handle nil Hardware", | ||
| given: nil, | ||
| expected: nil, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| assert.NotPanics(t, func() { normalizeHardwareData(tt.given) }) | ||
| assert.Equal(t, tt.expected, tt.given) | ||
| }) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if it would make sense to add a test for the empty string here prior to calling
s.db.GetByMAC().Would we expect that to be an error condition or would we allow a hardware definition without a mac address?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was questioning similar, whether we should transform the input at all, or just let validate/push throw an error if the hardware mac was not "valid" (lowercase, non-empty).
That said, I don't know if hardware addresses can be treated as optional.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I worry that transforming the data means that any stateful tools (terraform, k8s controllers, salt, etc) that read back the lowercase value will need to be aware of the transform and copy that logic themselves.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The alternative I thought of was to make the comparisons case-insensitive, but with it being stored embedded inside of a stored json blob that seemed a bit more error prone.