New DeploymentStrategy type for JaegerSpec.Strategy #704
+178
−91
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| package v1 | ||
|
|
||
| import ( | ||
| "errors" | ||
| "strings" | ||
| ) | ||
|
|
||
| // DeploymentStrategy represents the possible values for deployment strategies | ||
| // +k8s:openapi-gen=true | ||
| type DeploymentStrategy string | ||
|
|
||
| const ( | ||
| // DeploymentStrategyDeprecatedAllInOne represents the (deprecated) 'all-in-one' deployment strategy | ||
| // +k8s:openapi-gen=true | ||
| DeploymentStrategyDeprecatedAllInOne DeploymentStrategy = "all-in-one" | ||
|
|
||
| // DeploymentStrategyAllInOne represents the 'allInOne' deployment strategy (default) | ||
| // +k8s:openapi-gen=true | ||
| DeploymentStrategyAllInOne DeploymentStrategy = "allinone" | ||
|
|
||
| // DeploymentStrategyStreaming represents the 'streaming' deployment strategy | ||
| // +k8s:openapi-gen=true | ||
| DeploymentStrategyStreaming DeploymentStrategy = "streaming" | ||
|
|
||
| // DeploymentStrategyProduction represents the 'production' deployment strategy | ||
| // +k8s:openapi-gen=true | ||
| DeploymentStrategyProduction DeploymentStrategy = "production" | ||
| ) | ||
|
|
||
| // UnmarshalText implements encoding.TextUnmarshaler to ensure that JSON values in the | ||
| // strategy field of JSON jaeger specs are interpreted in a case-insensitive manner | ||
| func (ds *DeploymentStrategy) UnmarshalText(text []byte) error { | ||
| if ds == nil { | ||
| return errors.New("DeploymentStrategy: UnmarshalText on nil pointer") | ||
| } | ||
|
|
||
| switch strings.ToLower(string(text)) { | ||
| default: | ||
| *ds = DeploymentStrategyAllInOne | ||
| case string(DeploymentStrategyDeprecatedAllInOne): | ||
| *ds = DeploymentStrategyDeprecatedAllInOne | ||
| case string(DeploymentStrategyStreaming): | ||
| *ds = DeploymentStrategyStreaming | ||
| case string(DeploymentStrategyProduction): | ||
| *ds = DeploymentStrategyProduction | ||
| } | ||
|
|
||
| return 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,55 @@ | ||
| package v1 | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestUnmarshalJSON(t *testing.T) { | ||
| tcs := map[string]struct { | ||
| json string | ||
| expected DeploymentStrategy | ||
| }{ | ||
| "allInOne": {json: `"allInOne"`, expected: DeploymentStrategyAllInOne}, | ||
| "streaming": {json: `"streaming"`, expected: DeploymentStrategyStreaming}, | ||
| "production": {json: `"production"`, expected: DeploymentStrategyProduction}, | ||
| "all-in-one": {json: `"all-in-one"`, expected: DeploymentStrategyDeprecatedAllInOne}, | ||
| "ALLinONE": {json: `"ALLinONE"`, expected: DeploymentStrategyAllInOne}, | ||
| "StReAmInG": {json: `"StReAmInG"`, expected: DeploymentStrategyStreaming}, | ||
| "Production": {json: `"Production"`, expected: DeploymentStrategyProduction}, | ||
| "All-IN-One": {json: `"All-IN-One"`, expected: DeploymentStrategyDeprecatedAllInOne}, | ||
| "random value": {json: `"random value"`, expected: DeploymentStrategyAllInOne}, | ||
| "empty string": {json: `""`, expected: DeploymentStrategyAllInOne}, | ||
| } | ||
|
|
||
| for name, tc := range tcs { | ||
| t.Run(name, func(t *testing.T) { | ||
| ds := DeploymentStrategy("") | ||
| err := json.Unmarshal([]byte(tc.json), &ds) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.expected, ds) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestMarshalJSON(t *testing.T) { | ||
| tcs := map[string]struct { | ||
| strategy DeploymentStrategy | ||
| expected string | ||
| }{ | ||
| "allinone": {strategy: DeploymentStrategyAllInOne, expected: `"allinone"`}, | ||
| "streaming": {strategy: DeploymentStrategyStreaming, expected: `"streaming"`}, | ||
| "production": {strategy: DeploymentStrategyProduction, expected: `"production"`}, | ||
| "all-in-one": {strategy: DeploymentStrategyDeprecatedAllInOne, expected: `"all-in-one"`}, | ||
| } | ||
|
|
||
| for name, tc := range tcs { | ||
| t.Run(name, func(t *testing.T) { | ||
| data, err := json.Marshal(tc.strategy) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.expected, string(data)) | ||
| }) | ||
| } | ||
| } |
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
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
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.
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.
This is interesting. I'm probably missing something obvious, but how would this be triggered? Wouldn't a nil object fail with a nil reference before reaching this code? Can you come up with a test case for this?
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.
It's not obvious. It is possible for the function to be called on a nil receiver when interfaces are involved (as is the case here).
I was digging into the docs and I had a look at how json.RawMessage.UnmarshalJSON is implemented. The check for nil felt strange, so I did a bit of research and came up with this https://tour.golang.org/methods/12
Wonderful Go! :)
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.
BTW, I guess this kind of check should be implemented in other types implementing interfaces for additional safety.
Optionscome to my mind, implementing bothjson.Marshalerandjson.Unmarshalerinterfaces, but I'm sure there are several others.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.
TIL! I'm merging this one. Would you mind creating an issue to do the same nil check in the other relevant types?
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.
Will do!