Fix: configuration variable that overrides a template variable in env… #955
Conversation
…0_environment shows drift
| IsReadOnly *bool `json:"isReadonly,omitempty"` | ||
| IsRequired *bool `json:"isRequired,omitempty"` | ||
| Regex string `json:"regex,omitempty"` | ||
| Overwrites *ConfigurationVariableOverwrites `json:"overwrites,omitempty"` // Is removed when marhseling to a JSON. |
There was a problem hiding this comment.
This struct is also sent in a POST requests.
Overwrites field should not be sent in a request. (We are only intrested of this value in a response).
To solve this issue without making too many code changes, I have decided to write a custom marshal.
| v.Overwrites = nil | ||
|
|
||
| // This is done to prevent an infinite loop. | ||
| type ConfigurationVariableDummy ConfigurationVariable |
There was a problem hiding this comment.
without doing the following an infinite loop will happen, because inside marshal we are calling marshal again on the same object.
| @@ -77,6 +86,17 @@ type ConfigurationVariableUpdateParams struct { | |||
| Id string | |||
| } | |||
|
|
|||
| func (v ConfigurationVariable) MarshalJSON() ([]byte, error) { | |||
| v.Overwrites = nil | |||
There was a problem hiding this comment.
avoid sending Overwrites when marshaling a json to bytes.
|
|
||
| dummy := ConfigurationVariableDummy(v) | ||
|
|
||
| return json.Marshal(&dummy) |
There was a problem hiding this comment.
this would have caused loops...
| @@ -291,3 +295,37 @@ var _ = Describe("Configuration Variable", func() { | |||
| }) | |||
| }) | |||
| }) | |||
|
|
|||
| func TestConfigurationVariableMarshelling(t *testing.T) { | |||
There was a problem hiding this comment.
this test was added to verify that the marshal and unmarshal are working as expected.
| @@ -0,0 +1,143 @@ | |||
| package env0 | |||
There was a problem hiding this comment.
moved these functions to here from env0/resource_environment.go
(These are mostly commom functions).
There was a problem hiding this comment.
no changes for now...
|
/review |
| BeforeEach(func() { | ||
| httpCall = mockHttpClient.EXPECT().Delete("configuration/"+mockConfigurationVariable.Id, nil) | ||
| apiClient.ConfigurationVariableDelete(mockConfigurationVariable.Id) | ||
| _ = apiClient.ConfigurationVariableDelete(mockConfigurationVariable.Id) |
There was a problem hiding this comment.
using a new linter - fixes a linting issue.
It tells the linter, I know that this can return an error - but I want to ignore it.
github-actions
bot
added
ready to merge
…0_environment shows drift
Part of #894
Solution
Since the change is large and complex, this PR is the first part of fixing the issue.
For now I've just added the Overwrites field to the struct.