Port: add propagationUplinkStatus field #641
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -87,3 +87,4 @@ spec: | |
| macAddress: fa:16:3e:23:fd:d7 | ||
| hostID: | ||
| id: devstack | ||
| propagateUplinkStatus: false | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ package osclients | |
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "iter" | ||
|
|
||
|
|
@@ -58,6 +59,30 @@ type PortExt struct { | |
| portsecurity.PortSecurityExt | ||
| portsbinding.PortsBindingExt | ||
| portstrustedvif.PortTrustedVIFExt | ||
|
|
||
| PropagateUplinkStatusPtr *bool `json:"propagate_uplink_status,omitempty"` | ||
| } | ||
|
|
||
| func (p *PortExt) UnmarshalJSON(b []byte) error { | ||
|
Collaborator
There was a problem hiding this comment. This custom unmarshaller omits
Contributor
Author
There was a problem hiding this comment. It is something that I was in doubt about... I'm not sure, and if you can correct me if I'm wrong, I'll appreciate it, but it looks like Gophercloud uses reflection to populate the result rather than simply using a json.Unmarshal, am I wrong? https://github.com/gophercloud/gophercloud/blob/main/results.go#L70 You're right that they will always have the zero value, but maybe in the above phase, the fields are populated using reflection. I need to better understand this. Any initial thought?
Collaborator
There was a problem hiding this comment. A well crafted test should give us the answer.
Contributor
Author
There was a problem hiding this comment. Sorry for the late response. The idea of this test is to show that using
Contributor
Author
There was a problem hiding this comment. After understanding more about how the parse actually works, I've decided to add This helps us especially when listing ports because we are not using the default Gophercloud's |
||
| if err := json.Unmarshal(b, &p.Port); err != nil { | ||
| return err | ||
| } | ||
| if err := json.Unmarshal(b, &p.PortSecurityExt); err != nil { | ||
| return err | ||
| } | ||
| if err := json.Unmarshal(b, &p.PortsBindingExt); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var tmp struct { | ||
| PropagateUplinkStatusPtr *bool `json:"propagate_uplink_status"` | ||
| } | ||
| if err := json.Unmarshal(b, &tmp); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| p.PropagateUplinkStatusPtr = tmp.PropagateUplinkStatusPtr | ||
| return nil | ||
| } | ||
|
|
||
| type NetworkClient interface { | ||
|
|
@@ -182,13 +207,30 @@ func (c networkClient) UpdateFloatingIP(ctx context.Context, id string, opts flo | |
|
|
||
| func (c networkClient) ListPort(ctx context.Context, opts ports.ListOptsBuilder) iter.Seq2[*PortExt, error] { | ||
|
Collaborator
There was a problem hiding this comment. We shouldn't have to update ListPort I believe.
Contributor
Author
There was a problem hiding this comment. IIRC, there was a failing test, and the solution was to change the ListPort function, but I'll double-check this to confirm what exactly the error was.
Contributor
Author
There was a problem hiding this comment. After discussion, we found a potential bug in Gophercloud, and a PR has been created. More information is there. |
||
| extractPortExt := func(p pagination.Page) ([]PortExt, error) { | ||
| bodyMap, ok := p.(ports.PortPage).Body.(map[string]interface{}) | ||
| if !ok { | ||
| return nil, fmt.Errorf("unexpected body type: %T", p.(ports.PortPage).Body) | ||
| } | ||
|
|
||
| portsData, ok := bodyMap["ports"] | ||
| if !ok { | ||
| return nil, fmt.Errorf("ports key not found in response") | ||
| } | ||
|
|
||
| // Marshal and unmarshal to trigger UnmarshalJSON | ||
| jsonData, err := json.Marshal(portsData) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var resources []PortExt | ||
| if err := json.Unmarshal(jsonData, &resources); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return resources, nil | ||
| } | ||
|
|
||
| pager := ports.List(c.serviceClient, opts) | ||
| return func(yield func(*PortExt, error) bool) { | ||
| _ = pager.EachPage(ctx, yieldPage(extractPortExt, yield)) | ||
|
|
||
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.
We've discussed this privately already, after you brought the issue to my attention: gophercloud implements the
PropagateUplinkStatusin the responsePortstructure as aboolwhile it should really be a*boolwithomitempty, and because of this we can't reliably know the status forPropagateUplinkStatus. I suggest that until the issue if fixed in gophercloud, we make that field immutable.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 been a while and I don't remember all of the discussion. From reading the PR comments again, I believe we're past the gophercloud limitation (thanks to custom unmarshalling) but we still need to make the field immutable because dalmatien doesn't support updating the field. If that's effectively the case, we should add that as a comment so we know when we can change that behavior.
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.
Yes, you're absolutely right. I'll add this comment.
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.
Done.