openstackdocstheme: field.tags not recognized

[Brian Rosmaita]

This is a test from the api-ref generated on patch 547714. The URL is below, you can see that it has a field.tags specification, but that field does not appear to be populated when a bug is filed.

https://bugs.launchpad.net/glance/+filebug?field.title=Image%20Service%20API%20v2%20(CURRENT)%20in%20glance&field.comment=%0A%0A%0AThis%20bug%20tracker%20is%20for%20errors%20with%20the%20documentation,%20use%20the%20following%20as%20a%20template%20and%20remove%20or%20add%20fields%20as%20you%20see%20fit.%20Convert%20[%20]%20into%20[x]%20to%20check%20boxes:%0A%0A-%20[%20]%20This%20doc%20is%20inaccurate%20in%20this%20way:%20______%0A-%20[%20]%20This%20is%20a%20doc%20addition%20request.%0A-%20[%20]%20I%20have%20a%20fix%20to%20the%20document%20that%20I%20can%20paste%20below%20including%20example:%20input%20and%20output.%20%0A%0AIf%20you%20have%20a%20troubleshooting%20or%20support%20issue,%20use%20the%20following%20%20resources:%0A%0A%20-%20Ask%20OpenStack:%20http://ask.openstack.org%0A%20-%20The%20mailing%20list:%20http://lists.openstack.org%0A%20-%20IRC:%20%27openstack%27%20channel%20on%20Freenode%0A%0A-----------------------------------%0ARelease:%20%20on%202018-04-23%2012:43%0ASHA:%205e2df55f04af52af5d7f49f8d04e2b939ed9a57f%0ASource:%20https://git.openstack.org/cgit/openstack/glance/tree/api-ref/source/v2/index.rst%0AURL:%20http://logs.openstack.org/14/547714/4/check/build-openstack-api-ref/b963253/html/v2/index.html#images&field.tags=api-ref

[Brian Rosmaita (brian-rosmaita)]

I think the problem is that there is something in the field.comment that is confusing Launchpad. When I hacked the URL to put the field.bug immediately after the field.title, the tags are populated correctly:

https://bugs.launchpad.net/glance/+filebug?field.title=THIS%20IS%20NOT%20A%20REAL%20BUG&field.tags=api-ref&field.comment=%0A%0A%0AThis%20bug%20tracker%20is%20for%20errors%20with%20the%20documentation,%20use%20the%20following%20as%20a%20template%20and%20remove%20or%20add%20fields%20as%20you%20see%20fit.%20Convert%20[%20]%20into%20[x]%20to%20check%20boxes:%0A%0A-%20[%20]%20This%20doc%20is%20inaccurate%20in%20this%20way:%20______%0A-%20[%20]%20This%20is%20a%20doc%20addition%20request.%0A-%20[%20]%20I%20have%20a%20fix%20to%20the%20document%20that%20I%20can%20paste%20below%20including%20example:%20input%20and%20output.%20%0A%0AIf%20you%20have%20a%20troubleshooting%20or%20support%20issue,%20use%20the%20following%20%20resources:%0A%0A%20-%20Ask%20OpenStack:%20http://ask.openstack.org%0A%20-%20The%20mailing%20list:%20http://lists.openstack.org%0A%20-%20IRC:%20%27openstack%27%20channel%20on%20Freenode%0A%0A-----------------------------------%0ARelease:%20%20on%202018-04-23%2012:43%0ASHA:%205e2df55f04af52af5d7f49f8d04e2b939ed9a57f%0ASource:%20https://git.openstack.org/cgit/openstack/glance/tree/api-ref/source/v2/index.rst%0AURL:%20http://logs.openstack.org/14/547714/4/check/build-openstack-api-ref/b963253/html/v2/index.html#images

The solution is most likely to make sure that openstackdocstheme generates the output with the field.comment last, because whatever's breaking the field.tags detection will break any other fields following the field.comment.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/564059

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/564059
Committed: https://git.openstack.org/cgit/openstack/openstackdocstheme/commit/?id=26553fa96a7b35d44f133087cfb0dc2bef146662
Submitter: Zuul
Branch: master

commit 26553fa96a7b35d44f133087cfb0dc2bef146662
Author: Brian Rosmaita <email address hidden>
Date: Tue Apr 24 16:38:41 2018 -0400

    Relocate bug_tag in logABug generated URL

    The content of field.comment may contain characters that confuse
    Launchpad and block it from recognizing field.tags, so move the
    location of the tags specification to earlier in the URL.

    Change-Id: I62ce0a93ca963fe412f17e56aab743ac9c3deb98
    Closes-bug: #1766705

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstackdocstheme 1.21.0 release.