Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug 1904663: Fix comparison in pointer ignition customization asset #4455

Merged
merged 1 commit into from
Dec 9, 2020

Conversation

hardys
Copy link
Contributor

@hardys hardys commented Dec 4, 2020

An issue was spotted after #4413 landed, the config comparison
always evaluates to true, so we're generating empty machineconfig
objects even when no customization has happened.

Update to compare a json representation of the configs, and add
a test to confirm all works as expected.

@hardys
Copy link
Contributor Author

hardys commented Dec 4, 2020

This fixes the issue mentioned in the comments of #4413 by @cgwalters

/cc @stbenjam @staebler

@hardys
Copy link
Contributor Author

hardys commented Dec 4, 2020

/cc @kirankt

if savedPointerIgnition != defaultPointerIgnition {
savedPointerIgnitionJson, err := ignition.Marshal(savedPointerIgnition)
defaultPointerIgnitionJson, err := ignition.Marshal(defaultPointerIgnition)
if string(savedPointerIgnitionJson) != string(defaultPointerIgnitionJson) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe reflect.DeepEqual instead? Not sure if there's much distinction, but DeepEqual is used elsewhere in the installer for e.g. comparing on disk and in-memory assets.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I used the reflect.DeepEqual, it returned false consistently in testing. This method from @hardys looks to be more fool-proof, IMHO,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I did consider DeepEqual but decided to just use the exact same format the underlying asset does, e.g the ignition configs get serialized via ignition.Marshal, and the thing we ultimately care about after loading them is did that json data change, so a string comparison seemed like the simpler and more consistent option.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, upon reflection, they're equal approaches.

@stbenjam
Copy link
Member

stbenjam commented Dec 4, 2020

/retest

Copy link
Contributor

@staebler staebler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: staebler

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 4, 2020
@hardys
Copy link
Contributor Author

hardys commented Dec 5, 2020

/retitle Bug 1904663: Fix comparison in pointer ignition customization asset

@openshift-ci-robot openshift-ci-robot changed the title Fix comparison in pointer ignition customization asset Bug 1904663: Fix comparison in pointer ignition customization asset Dec 5, 2020
@openshift-ci-robot openshift-ci-robot added the bugzilla/severity-high Referenced Bugzilla bug's severity is high for the branch this PR is targeting. label Dec 5, 2020
@openshift-ci-robot
Copy link
Contributor

@hardys: This pull request references Bugzilla bug 1904663, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1904663: Fix comparison in pointer ignition customization asset

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot openshift-ci-robot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Dec 5, 2020
@hardys hardys force-pushed the pointer_mc_fix branch 2 times, most recently from 2b36b5a to fa8f4e5 Compare December 7, 2020 09:25
An issue was spotted after openshift#4413 landed, the config comparison
always evaluates to true, so we're generating empty machineconfig
objects even when no customization has happened.

Update to compare a json representation of the configs, and add
a test to confirm all works as expected.
@kirankt
Copy link
Contributor

kirankt commented Dec 9, 2020

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 9, 2020
@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-merge-robot
Copy link
Contributor

openshift-merge-robot commented Dec 9, 2020

@hardys: The following tests failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
ci/prow/e2e-metal-ipi-ovn-ipv6 2da500a link /test e2e-metal-ipi-ovn-ipv6
ci/prow/e2e-ovirt 2da500a link /test e2e-ovirt
ci/prow/e2e-crc 2da500a link /test e2e-crc

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-merge-robot openshift-merge-robot merged commit 83d52fb into openshift:master Dec 9, 2020
@openshift-ci-robot
Copy link
Contributor

@hardys: All pull requests linked via external trackers have merged:

Bugzilla bug 1904663 has been moved to the MODIFIED state.

In response to this:

Bug 1904663: Fix comparison in pointer ignition customization asset

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-high Referenced Bugzilla bug's severity is high for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants