Typo in cloud-guest-utils: "reserveration-id"

Bug #1810857 reported by Daniel Serodio on 2019-01-07
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-utils (Ubuntu)
Low
Unassigned
Disco
Low
Rafael David Tinoco

Bug Description

[Impact]

  * DEP8 race condition for ppc64el (LP: #1836593): intermittent migration regressions.

  * growpart: fix bug when file image ends in a digit (LP: #1835124): image files can't end in ".ext4", for example, orelse growpart doesn't work.

  * fix spelling error in ec2metadata (LP: #1810857): no impact.

[Test Case]

$ ec2metadata --reservation-id
Error: option --reservation-id not recognized
...

$ ec2metadata | grep reserv
reserveration-id: unavailable

After applying this trivial (attached) patch, it works as expected:

$ ec2metadata --reservation-id
r-REDACTED

$ ec2metadata | grep reserv
reservation-id: r-REDACTED

[Regression Potential]

 * Whoever has scripted ec2metadata already considering the misspelled command might find the wrapper stops working after the update.

[Other Info]

ORIGINAL DESCRIPTION:

This may be related to Bug 510773.

This typo actually breaks functionality (see below), it's not just "cosmetic"

$ ec2metadata --reservation-id
Error: option --reservation-id not recognized
...

$ ec2metadata | grep reserv
reserveration-id: unavailable

After applying this trivial (attached) patch, it works as expected:

$ ec2metadata --reservation-id
r-REDACTED

$ ec2metadata | grep reserv
reservation-id: r-REDACTED

Related branches

Daniel Serodio (dserodio) wrote :
Paul White (paulw2u) on 2019-01-07
affects: ubuntu → cloud-utils (Ubuntu)

The attachment "ec2metadata.diff" seems to be a patch. If it isn't, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are a member of the ~ubuntu-reviewers, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issues please contact him.]

tags: added: patch
Scott Moser (smoser) wrote :

Daniel,
Thanks for the bug report.
I've committed the fix to trunk.

Changed in cloud-utils (Ubuntu):
importance: Undecided → Low
status: New → Fix Committed
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package cloud-utils - 0.31-3-gfadd07fe-0ubuntu1

---------------
cloud-utils (0.31-3-gfadd07fe-0ubuntu1) eoan; urgency=medium

  * New upstream snapshot.
    - growpart: Fix bug when file image ends in a digit. (LP: #1835124)
    - Fix spelling error in ec2metadata (--reserveration-id).
      (LP: #1810857)
    - tools: rename export-tarball to make-tarball.

 -- Scott Moser <email address hidden> Wed, 10 Jul 2019 14:09:37 -0400

Changed in cloud-utils (Ubuntu):
status: Fix Committed → Fix Released
Changed in cloud-utils (Ubuntu Disco):
status: New → In Progress
importance: Undecided → Low
assignee: nobody → Rafael David Tinoco (rafaeldtinoco)
Robie Basak (racb) wrote :

For the Disco SRU, what if some user is already relying on the typo'd option --reserveration-id. Won't this change break that user's automation? Do we need to support both in the SRU?

Robie Basak (racb) wrote :

While you're answering that, please complete the required SRU information in this bug!

Changed in cloud-utils (Ubuntu Disco):
status: In Progress → Incomplete
Changed in cloud-utils (Ubuntu Disco):
status: Incomplete → In Progress
description: updated

@rbasak,

On your question, the option is passed as an argument to EC2Metadata object and it calls:

    def _get(self, uri, decode=True):
        url = "%s/%s" % (self.burl, uri)
        try:
            resp = urllib_request.urlopen(urllib_request.Request(url))
            value = resp.read()

where uri == fixed spelling option.

Meaning that the http request would be broken no matter what and the spelling fix is not just cosmetic.

I also fixed the SRU template (I had done it only for the main bug of the 3, all 3 now have the template).

@Brian, I think this covers what you flagged as incomplete, pls let me know if not.

Hello Daniel, or anyone else affected,

Accepted cloud-utils into disco-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/cloud-utils/0.31-0ubuntu1.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-disco to verification-done-disco. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-disco. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Changed in cloud-utils (Ubuntu Disco):
status: In Progress → Fix Committed
tags: added: verification-needed verification-needed-disco

All autopkgtests for the newly accepted cloud-utils (0.31-0ubuntu1.1) for disco have finished running.
The following regressions have been reported in tests triggered by the package:

cloud-utils/0.31-0ubuntu1.1 (amd64, i386, ppc64el, arm64, s390x)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/disco/update_excuses.html#cloud-utils

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

I confirm version 0.31-0ubuntu1.1 indeed fixes the issue.

tags: added: verification-done verification-done-disco
removed: verification-needed verification-needed-disco

Hello Daniel, or anyone else affected,

Accepted cloud-utils into disco-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/cloud-utils/0.31-0ubuntu1.2 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-disco to verification-done-disco. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-disco. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

tags: added: verification-needed verification-needed-disco
removed: verification-done verification-done-disco

Verified:

(k)rafaeldtinoco@cloudutils:~$ dpkg -l | grep cloud-utils
ii cloud-utils 0.31-0ubuntu1.2 all metapackage for installation of upstream cloud-utils source

$ ec2metadata --reservation-id
r-REDACTED

worked good.

tags: added: verification-done verification-done-disco
removed: verification-needed verification-needed-disco
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package cloud-utils - 0.31-0ubuntu1.2

---------------
cloud-utils (0.31-0ubuntu1.2) disco; urgency=medium

  * test-growpart: fix logic error resulting in test failure.
    [Scott Moser] (LP: #1842682)

cloud-utils (0.31-0ubuntu1.1) disco; urgency=medium

  * fix race condition in test-growpart teardown seen on ppc64el (LP: #1836593)
  * growpart: fix bug when file image ends in a digit (LP: #1835124)
  * fix spelling error in ec2metadata (LP: #1810857)

 -- Rafael David Tinoco <email address hidden> Fri, 06 Sep 2019 10:47:23 -0300

Changed in cloud-utils (Ubuntu Disco):
status: Fix Committed → Fix Released

The verification of the Stable Release Update for cloud-utils has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers