[SRU] Cannot list shares in dashboard GUI: "Error: Unable to retrieve share list. 'NoneType' object has no attribute 'pop'"

[Przemyslaw Hausman]

[Impact]
It is impossible to list shares in OpenStack dashboard GUI. Share list is empty and the error message in GUI says: "Error: Unable to retrieve share list. 'NoneType' object has no attribute 'pop'".

It is however possible to list shares with CLI `manila list` command.

Versions:
OpenStack Yoga
Ubuntu 20.04 Focal
manila charm: channel yoga/stable, revision 98
manila-dashboard charm: channel yoga/stable, revision 11
openstack-dashboard charm: channel yoga/stable, revision 566

I'm attaching juju overlay bundle with manila-related charms which has been used to deploy the environment (overlay-manila.yaml).

Log files from manila unit for the successful `manila list` call:
- cli-success_manila-access.log
- cli-success_manila-error.log

Output of successful `manila list`:
- manila-list.out

Log files from manila and openstack-dashboard units, for failure scenario, when visiting /project/shares/ URL:
- gui-error_manila-access.log
- gui-error_manila-error.log
- gui-error_openstack-dashboard_access.log
- gui-error_openstack-dashboard_error.log

[Test Case]
Deploy openstack with juju, including manila and manila dashboard. Create a share and attempt to list shares via the manila dashboard. This should be successful.

[Regression Potential]
I don't see any potential regression. The manila dashboard can't list shares so this will fix that regression. The fix is limited to the share_list() function.

[Discussion]
I've confirmed that this is already fixed in the kinetic/zed package.

[Denis Nurislamov (spumm)]

Fix released.
Should close ticket.

https://review.opendev.org/c/openstack/manila-ui/+/837614
https://bugs.launchpad.net/python-manilaclient/+bug/1967312

[Przemyslaw Hausman (phausman)]

I can confirm that the fix in python3-manila-ui works the problem around. Thank you @spumm for providing the patch!

[Vern Hart (vern)]

I can see that python3-manila-ui has this fix in 7.0.0-5 (https://docs.openstack.org/releasenotes/manila-ui/yoga.html) but the focal/yoga cloud-archive still has 7.0.0:

  $ apt-cache policy python3-manila-ui
  python3-manila-ui:
    Installed: 1:7.0.0-0ubuntu1~cloud0
    Candidate: 1:7.0.0-0ubuntu1~cloud0
    Version table:
   *** 1:7.0.0-0ubuntu1~cloud0 500
          500 http://ubuntu-cloud.archive.canonical.com/ubuntu focal-updates/yoga/main amd64 Packages
          100 /var/lib/dpkg/status
       1:3.0.0-0ubuntu0.20.04.1 500
          500 http://archive.ubuntu.com/ubuntu focal-updates/universe amd64 Packages
       1:2.19.2~git2020041511.a2dcb0e-0ubuntu1 500
          500 http://archive.ubuntu.com/ubuntu focal/universe amd64 Packages

What needs to happen next for the stable release update (SRU) process?

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Corey Bryant (corey.bryant)]

manila-ui 1:7.0.0-0ubuntu1.1 has been uploaded the the jammy unapproved queue with this fix. Once the SRU team approves they will accept it into jammy-proposed for testing, at which time we can also accept it into yoga-proposed for testing.

[Timo Aaltonen (tjaalton)]

Hello Przemyslaw, or anyone else affected,

Accepted manila-ui into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/manila-ui/1:7.0.0-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, 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 Przemyslaw, or anyone else affected,

Accepted manila-ui 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!

[Gabriel Samfira (gabriel-samfira)]

Hi Corey and Timo,

I can confirm that this fix indeed works on Jammy with yoga. After enabling the proposed repos and doing an apt-get dist-upgrade followed by a restart of apache, I can now see the shares in the UI and the error is gone.

[Corey Bryant (corey.bryant)]

Thanks for testing Gabriel!

[Launchpad Janitor (janitor)]

This bug was fixed in the package manila-ui - 1:7.0.0-0ubuntu1.1

---------------
manila-ui (1:7.0.0-0ubuntu1.1) jammy; urgency=medium

  * d/gbp.conf: Create stable/yoga branch.
  * d/p/workaround-sdk-bug-in-listing-shares.patch: Cherry-picked
    from upstream stable/yoga branch to fix listing of shares
    in OpenStack dashboard (LP: #2003772).

 -- Corey Bryant <email address hidden> Mon, 25 Apr 2022 09:58:21 -0400

[Andreas Hasenack (ahasenack)]

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

[Corey Bryant (corey.bryant)]

The verification of the Stable Release Update for manila-ui 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 manila-ui - 1:7.0.0-0ubuntu1.1~cloud0
---------------

 manila-ui (1:7.0.0-0ubuntu1.1~cloud0) focal-yoga; urgency=medium
 .
   * New update for the Ubuntu Cloud Archive.
 .
 manila-ui (1:7.0.0-0ubuntu1.1) jammy; urgency=medium
 .
   * d/gbp.conf: Create stable/yoga branch.
   * d/p/workaround-sdk-bug-in-listing-shares.patch: Cherry-picked
     from upstream stable/yoga branch to fix listing of shares
     in OpenStack dashboard (LP: #2003772).