Fix the kubernetes manifest diff #5154
Merged
Conversation
This file contains hidden or 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: Shinnosuke Sawada <[email protected]>
Signed-off-by: Shinnosuke Sawada <[email protected]>
Signed-off-by: Shinnosuke Sawada <[email protected]>
Signed-off-by: Shinnosuke Sawada <[email protected]>
normalize both of old and new manifests Signed-off-by: Shinnosuke Sawada <[email protected]>
Warashi
requested review from
ffjlabo,
kentakozuka,
khanhtc1202,
nghialv and
t-kikuc
as code owners
Signed-off-by: Shinnosuke Sawada <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #5154 +/- ##
==========================================
+ Coverage 22.79% 22.82% +0.02%
==========================================
Files 412 412
Lines 43827 43833 +6
==========================================
+ Hits 9992 10003 +11
+ Misses 33047 33040 -7
- Partials 788 790 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ffjlabo
reviewed
Aug 22, 2024
Member
ffjlabo
left a comment
ffjlabo
left a comment
There was a problem hiding this comment.
Thank you! This is the nice improvement!
I left nit comments.
Comment on lines
+555
to
+569
| for _, change := range result.Changes { | ||
| t.Log(change.Old.Key, change.New.Key) | ||
| for _, node := range change.Diff.Nodes() { | ||
| t.Log(node.PathString) | ||
| t.Log(node.ValueX) | ||
| t.Log(node.ValueY) | ||
| t.Log("---") | ||
| } | ||
| } | ||
| for _, add := range result.Adds { | ||
| t.Log(add.Key) | ||
| } | ||
| for _, delete := range result.Deletes { | ||
| t.Log(delete.Key) | ||
| } |
Member
There was a problem hiding this comment.
[ask] This codes are for checking the diff when result.NoChange() is false?
Member
Author
There was a problem hiding this comment.
Yes, and these are logs for debugging, not assertions.
|
|
||
| normalizedOld, err := remarshal(old.u) | ||
| if err != nil { | ||
| logger.Info("compare manifests directly since it was unable to remarshal Kubernetes manifest to normalize special fields", zap.Error(err)) |
Member
There was a problem hiding this comment.
[nit] It would be nice to show old or new when investigating with this log.
It is the same for the remarshal new one.
Suggested change
| logger.Info("compare manifests directly since it was unable to remarshal Kubernetes manifest to normalize special fields", zap.Error(err)) | |
| logger.Info("compare manifests directly since it was unable to remarshal old Kubernetes manifest to normalize special fields", zap.Error(err)) |
Signed-off-by: Shinnosuke Sawada <[email protected]>
Merged
github-actions bot
pushed a commit
that referenced
this pull request
Aug 26, 2024
* Add TestLoadAndDiff Signed-off-by: Shinnosuke Sawada <[email protected]> * Make testcase smaller Signed-off-by: Shinnosuke Sawada <[email protected]> * Separate test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * Add test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * FIx the k8s diff normalize both of old and new manifests Signed-off-by: Shinnosuke Sawada <[email protected]> * Rename the testcase Signed-off-by: Shinnosuke Sawada <[email protected]> --------- Signed-off-by: Shinnosuke Sawada <[email protected]> Signed-off-by: pipecd-bot <[email protected]>
Closed
github-actions bot
pushed a commit
that referenced
this pull request
Aug 26, 2024
* Add TestLoadAndDiff Signed-off-by: Shinnosuke Sawada <[email protected]> * Make testcase smaller Signed-off-by: Shinnosuke Sawada <[email protected]> * Separate test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * Add test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * FIx the k8s diff normalize both of old and new manifests Signed-off-by: Shinnosuke Sawada <[email protected]> * Rename the testcase Signed-off-by: Shinnosuke Sawada <[email protected]> --------- Signed-off-by: Shinnosuke Sawada <[email protected]> Signed-off-by: pipecd-bot <[email protected]>
Warashi
added a commit
that referenced
this pull request
Aug 26, 2024
* Add note to RELEASE file (#5149) Signed-off-by: khanhtc1202 <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Fix the kubernetes manifest diff (#5154) * Add TestLoadAndDiff Signed-off-by: Shinnosuke Sawada <[email protected]> * Make testcase smaller Signed-off-by: Shinnosuke Sawada <[email protected]> * Separate test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * Add test cases Signed-off-by: Shinnosuke Sawada <[email protected]> * FIx the k8s diff normalize both of old and new manifests Signed-off-by: Shinnosuke Sawada <[email protected]> * Rename the testcase Signed-off-by: Shinnosuke Sawada <[email protected]> --------- Signed-off-by: Shinnosuke Sawada <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Release v0.48.7 (#5157) Signed-off-by: Shinnosuke Sawada <[email protected]> Signed-off-by: pipecd-bot <[email protected]> --------- Signed-off-by: khanhtc1202 <[email protected]> Signed-off-by: pipecd-bot <[email protected]> Signed-off-by: Shinnosuke Sawada <[email protected]> Co-authored-by: Khanh Tran <[email protected]> Co-authored-by: Shinnosuke Sawada-Dazai <[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.
What this PR does / why we need it:
Normalize both old and new manifests when calculating diff.
Without this PR, the unexpected difference is calculated when resource/limit numbers have floating-point values such as
cpu: "1.5"The diff signs 1.5 and 1500m are different.
This occurs because the new manifests are normalized, but the old ones are not.
Which issue(s) this PR fixes:
N/A
Does this PR introduce a user-facing change?: Yes
How are users affected by this change:
Users can get the correct plan-preview diffs.
Some deployments triggered by incorrect diffs become not triggered.
Is this breaking change:
How to migrate (if breaking change):