fix(): Fixed tunnel status reporting in the slicegw CR #406
Conversation
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
Signed-off-by: Bharath Horatti <[email protected]>
bharath-avesha
requested review from
narmidm,
richiesebastian,
Rahul-D78,
gourishkb and
mridulgain
as code owners
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| if isClient(slicegateway) { | ||
| // get the remote port number this gw pod is connected to on the remote cluster | ||
| _, remotePortInUse := getClientGwRemotePortInUse(ctx, r.Client, slicegateway, GetDepNameFromPodName(slicegateway.Status.Config.SliceGatewayID, gwPod.PodName)) | ||
| gwPod.RemotePort = int32(remotePortInUse) |
Check failure
Code scanning / CodeQL
Incorrect conversion between integer types High
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix AI 3 months ago
To fix the problem, we need to ensure that the integer value parsed from the string does not exceed the bounds of the int32 type before performing the conversion. This can be achieved by using strconv.ParseInt with a specified bit size of 32, which directly returns an int64 that can be safely cast to int32 if within bounds.
- Replace the use of
strconv.Atoiwithstrconv.ParseIntspecifying a bit size of 32. - Ensure that the parsed value is within the bounds of
int32before performing the conversion.
Suggested changeset
2
controllers/slicegateway/slicegateway.go
| @@ -678,3 +678,8 @@ | ||
| _, remotePortInUse := getClientGwRemotePortInUse(ctx, r.Client, slicegateway, GetDepNameFromPodName(slicegateway.Status.Config.SliceGatewayID, gwPod.PodName)) | ||
| gwPod.RemotePort = int32(remotePortInUse) | ||
| if remotePortInUse >= math.MinInt32 && remotePortInUse <= math.MaxInt32 { | ||
| gwPod.RemotePort = int32(remotePortInUse) | ||
| } else { | ||
| log.Error(fmt.Errorf("remotePortInUse out of int32 bounds"), "Invalid remote port", "remotePortInUse", remotePortInUse) | ||
| gwPod.RemotePort = 0 // or some default value | ||
| } | ||
| } |
controllers/slicegateway/utils.go
Outside changed files
| @@ -336,5 +336,5 @@ | ||
| if envVar.Name == "NODE_PORT" { | ||
| nodePort, err := strconv.Atoi(envVar.Value) | ||
| if err == nil { | ||
| return true, nodePort | ||
| nodePort64, err := strconv.ParseInt(envVar.Value, 10, 32) | ||
| if err == nil && nodePort64 >= math.MinInt32 && nodePort64 <= math.MaxInt32 { | ||
| return true, int(nodePort64) | ||
| } |
Copilot is powered by AI and may make mistakes. Always verify output.
Unable to commit as this autofix suggestion is now outdated
mridulgain
approved these changes
Nov 4, 2024
gourishkb
pushed a commit
that referenced
this pull request
Nov 18, 2024
Signed-off-by: Bharath Horatti <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The gw tunnel status is recorded in the slicegateway CR status field. There are a number of fields like the interface name, rx and tx rates, latency and pkt loss in the status field but not all of them are getting filled. This is occurring because of an incorrect type conversion between gwpod.TunnelStatus and gwsidecar.TunnelStatus. The former struct is what is written to the status field of the CR and the latter is the struct that is filled by the grpc messaging between the operator and the gw sidecar.
The code changes in this PR address the above issue. It also adds additional info in the status field of the CR like the remote port number an instance of gw client is connecting to, and the tunnel state in string format for ease of debugging. The code also contains a couple of fixes for issues reported by the Go static analysis tool: removed unnecessary input params from a couple of functions and updated error messages to start with lowercase.