Ironic

API FunctionalTest class lacks doc strings

Bug #1193666 reported by aeva black
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Ceilometer
Fix Released
Low
gordon chung
Ironic
Fix Released
Low
Ruby Loo
Ironic 2014.1 "icehouse"

Bug Description

ironic/tests/api/base.py and the file it originates from, ceilometer/tests/api.py, lack doc strings, and some of the methods' functionality may not be obvious to everyone. We should add doc strings.

Also, this file should be oslo'ified at some point.

aeva black (tenbrae)
Changed in ironic:
status: New → Triaged
importance: Undecided → Low
Julien Danjou (jdanjou)
Changed in ceilometer:
status: New → Triaged
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ceilometer (master)

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

Changed in ceilometer:
assignee: nobody → gordon chung (chungg)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ceilometer (master)

Reviewed: https://review.openstack.org/43897
Committed: http://github.com/openstack/ceilometer/commit/dd34d83accc525534352ddca77b3ab3c09cd1ced
Submitter: Jenkins
Branch: master

commit dd34d83accc525534352ddca77b3ab3c09cd1ced
Author: Gordon Chung <email address hidden>
Date: Tue Aug 27 10:48:28 2013 -0400

    API FunctionalTest class lacks doc strings

    add docstrings to api call functions.
    Partial-Bug: #1193666

    Change-Id: I34a586fba343c88ef8807908eb1667392c016225

gordon chung (chungg)
Changed in ceilometer:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ceilometer:
status: Fix Committed → Fix Released
Ruby Loo (rloo)
Changed in ironic:
assignee: nobody → Ruby Loo (rloo)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

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

Changed in ironic:
status: Triaged → In Progress
Revision history for this message
Ruby Loo (rloo) wrote :

I think if we want these files oslo-ified, it might warrant its own bug.

Revision history for this message
Ruby Loo (rloo) wrote :

Looks like we still want it oslo-ified; it will be tracked via https://bugs.launchpad.net/ironic/+bug/1255115.

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

Reviewed: https://review.openstack.org/57344
Committed: http://github.com/openstack/ironic/commit/096481c0a0730ceeb5c292a2ee0e38497dc730d5
Submitter: Jenkins
Branch: master

commit 096481c0a0730ceeb5c292a2ee0e38497dc730d5
Author: Ruby Loo <email address hidden>
Date: Tue Nov 19 22:37:27 2013 +0000

    Adds doc strings to API FunctionalTest class

    The API FunctionalTest class in ironic/tests/api/base.py lacks doc
    strings, and some of the methods' functionality may not be obvious
    to everyone. This adds doc strings that, for the most part, are
    copied from ceilometer/tests/api/__init__.py. (base.py was ported
    from that ceilometer file.)

    The code from post_json() was moved to _request_json(), to make
    post_json() more consistent with the corresponding patch/put methods.

    This also undoes https://review.openstack.org/#/c/38909/ because
    it was decided that the original version was more readable.

    Change-Id: I92dad5bb77f4834604e61c28303ee8b0acc60ea1
    Closes-Bug: #1193666

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → icehouse-1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: icehouse-1 → 2014.1
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.