OpenStack Shared File Systems Service (Manila)

docs job breaks with ddt==1.2.0

Bug #1783124 reported by Tom Barron
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Critical
Goutham Pacha Ravi
OpenStack Shared File Systems Service (Manila) rocky-3 "R-3"

Bug Description

The docs job is failing with errors like these:

Warning, treated as error:
/home/tbarron/Workspaces/manila/manila/tests/test_quota.py:docstring of manila.tests.test_quota.DbQuotaDriverTestCase.test_reserve_1:3:Unexpected indentation.
ERROR: InvocationError: '/home/tbarron/Workspaces/manila/.tox/docs/bin/sphinx-build -W -b html doc/source doc/build/html'

This is a ddt generated test case. Perhaps ddt generates a doc string that generates a warning?

If I back ddt off to the next earliest version, 1.1.3 and run the docs build it succeeds.

Tom Barron (tpb)
Changed in manila:
milestone: none → rocky-3
importance: Undecided → Critical
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to manila (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/584886

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (master)

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

Changed in manila:
assignee: nobody → Goutham Pacha Ravi (gouthamr)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on manila (master)

Change abandoned by Tom Barron (<email address hidden>) on branch: master
Review: https://review.openstack.org/584886
Reason: in favor of https://review.openstack.org/#/c/584947/

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.openstack.org/584947
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=2b389ce1e19402e34dfad135719b5d26e11ff8b8
Submitter: Zuul
Branch: master

commit 2b389ce1e19402e34dfad135719b5d26e11ff8b8
Author: Goutham Pacha Ravi <email address hidden>
Date: Mon Jul 23 08:42:29 2018 -0700

    [Docs] Don't include unittest documentation

    The `test_quota` and `test_policy` modules
    don't need to be documented, since they present
    no meaningful information to contributors.

    Removing these also avoids the docstring
    formatting issues that ddt may introduce
    to the sphinx build. [1]

    [1] https://github.com/datadriventests/ddt/pull/51

    Change-Id: I8136e8a000e04bcc213a746c7d793bf9373b1b38
    Closes-Bug: #1783124

Changed in manila:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 7.0.0.0b3

This issue was fixed in the openstack/manila 7.0.0.0b3 development milestone.

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

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.