[SRU] SwiftSignalHandle fails due to python2-3 decode error

[Rodrigo Barbieri]

Storyboard link: https://storyboard.openstack.org/#!/story/2010485

============
SRU TEMPLATE
============

[Impact]

The issue impact stack creation workflows where swift signals are used. There is no workaround for the issue other than not using swift signals. The fix is a conditional one-liner that performs a type-check before running the code change.

[TestCase]

1. Setting up env
1a. Deploy an environment with ceph-rgw and heat
1b. Make sure rgw-swift-versioning-enabled=true

2. Reproducing the bug

2a. Create a stack using the following template:

---
heat_template_version: 2021-04-16

resources:
  signal:
    type: OS::Heat::SwiftSignal
    properties:
      handle: {get_resource: signal_handle}
      timeout: 300

  signal_handle:
    type: OS::Heat::SwiftSignalHandle

  instance_port:
    type: OS::Neutron::Port
    properties:
      network: private
      fixed_ips:
        - subnet_id: private_subnet

  the_server:
    type: OS::Nova::Server
    properties:
      name: test
      image: cirros2
      flavor: m1.cirros
      networks:
        - port: { get_resource: instance_port }
      user_data_format: RAW
      user_data:
        str_replace:
          template: |
            #!/bin/sh

            # Simple success signal
            wc_notify --data-binary '{"status": "SUCCESS"}'
          params:
            wc_notify: { get_attr: [signal_handle, curl_cli] }

2b. Use command "openstack stack create test -t template.yaml

2c. Wait for stack creation to fail using command "openstack stack list"

2d. Once failed, display the details using command "openstack stack show test"

2e. Confirm error with the message:

| stack_status_reason | Resource CREATE failed: Error: resources.signal: Failed to parse JSON data: b'in progress'

3. Cleanup not really needed

4. Install package that contains the fixed code

5. Confirming fix: Repeat steps 2a-2e and confirm stack creation is either successful or fails with a different message for another reason

[Regression Potential]

Since there is a type-check included in the fix, the regression potential is minimal, as if the condition is not fulfilled, then the original code is run.

[Corey Bryant (corey.bryant)]

Thanks Rodrigo. Uploaded to kinetic and jammy unapproved queues.

[Steve Langasek (vorlon)]

Hello Rodrigo, or anyone else affected,

Accepted heat into kinetic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/heat/1:19.0.0-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, what testing has been performed on the package and change the tag from verification-needed-kinetic to verification-done-kinetic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-kinetic. 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.

[Steve Langasek (vorlon)]

Hello Rodrigo, or anyone else affected,

Accepted heat into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/heat/1:18.0.0-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, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. 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.

[Corey Bryant (corey.bryant)]

Hello Rodrigo, or anyone else affected,

Accepted heat into zed-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:zed-proposed
  sudo apt-get update

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-zed-needed to verification-zed-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-zed-failed. In either case, details of your testing will help us make a better decision.

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

[Corey Bryant (corey.bryant)]

Hello Rodrigo, or anyone else affected,

Accepted heat into yoga-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:yoga-proposed
  sudo apt-get update

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-yoga-needed to verification-yoga-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-yoga-failed. In either case, details of your testing will help us make a better decision.

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

[Rodrigo Barbieri (rodrigo-barbieri2010)]

validation completed

[Andreas Hasenack (ahasenack)]

I verified the test results and am satisfied that they show the executed planned test case, and that the results are correct.

Note for future reviewers, in this case, the jammy-yoga verification is valid for plain jammy (no cloud archive involved), and kinetic-zed is valid for plain kinetic, for the same reason.

The package built correctly in all architectures and Ubuntu releases it was meant for.

There are no DEP8 regressions.

There is no SRU freeze ongoing at the moment.

There is no halted phasing on the previous update.

[Launchpad Janitor (janitor)]

This bug was fixed in the package heat - 1:19.0.0-0ubuntu1.2

---------------
heat (1:19.0.0-0ubuntu1.2) kinetic; urgency=medium

  * d/p/lp2012073.patch: Decode UTF-8 body data in SwiftSignal (LP: #2012073).

 -- Rodrigo Barbieri <email address hidden> Fri, 17 Mar 2023 12:37:11 -0300

[Andreas Hasenack (ahasenack)]

The verification of the Stable Release Update for heat 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.

[Launchpad Janitor (janitor)]

This bug was fixed in the package heat - 1:18.0.0-0ubuntu1.2

---------------
heat (1:18.0.0-0ubuntu1.2) jammy; urgency=medium

  * d/p/lp2012073.patch: Decode UTF-8 body data in SwiftSignal (LP: #2012073).

 -- Rodrigo Barbieri <email address hidden> Fri, 17 Mar 2023 12:46:43 -0300

[Corey Bryant (corey.bryant)]

The verification of the Stable Release Update for heat has completed successfully and the package has now been released to -updates. 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.

[Corey Bryant (corey.bryant)]

This bug was fixed in the package heat - 1:19.0.0-0ubuntu1.2~cloud0
---------------

 heat (1:19.0.0-0ubuntu1.2~cloud0) jammy-zed; urgency=medium
 .
   * New update for the Ubuntu Cloud Archive.
 .
 heat (1:19.0.0-0ubuntu1.2) kinetic; urgency=medium
 .
   * d/p/lp2012073.patch: Decode UTF-8 body data in SwiftSignal (LP: #2012073).

[Corey Bryant (corey.bryant)]

The verification of the Stable Release Update for heat has completed successfully and the package has now been released to -updates. 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.

[Corey Bryant (corey.bryant)]

This bug was fixed in the package heat - 1:18.0.0-0ubuntu1.2~cloud0
---------------

 heat (1:18.0.0-0ubuntu1.2~cloud0) focal-yoga; urgency=medium
 .
   * New update for the Ubuntu Cloud Archive.
 .
 heat (1:18.0.0-0ubuntu1.2) jammy; urgency=medium
 .
   * d/p/lp2012073.patch: Decode UTF-8 body data in SwiftSignal (LP: #2012073).