Clients return one value

Registered by David Kranz on 2014-10-03

Currently tempest clients return a response code and body. Since we moved response checking to clients, almost all callers of the clients ignore the response code. It would be much cleaner if clients returned a single response object that was the body, with a property to get the response code if needed.

Etherpad for tracking progress by service: https://etherpad.openstack.org/p/bp-clients-return-one-value

The swift API is different than the others in that it tends to return data in headers rather than a json dict, so most apis have a null body. The cleanup strategy in this blueprint does not apply so cleanly to swift so the swift client was not touched as part of this work.

Blueprint information

Status:
Complete
Approver:
David Kranz
Priority:
High
Drafter:
David Kranz
Direction:
Approved
Assignee:
David Kranz
Definition:
Approved
Series goal:
Accepted for kilo
Implementation:
Implemented
Milestone target:
None
Started by
David Kranz on 2014-12-04
Completed by
David Kranz on 2015-02-24

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/clients-return-one-value,n,z

Addressed by: https://review.openstack.org/126004
    Add spec for clients returning one value

Gerrit topic: https://review.openstack.org/#q,topic:bp/this,n,z

Addressed by: https://review.openstack.org/130645
    Add code to enable returning single-value response for http clients

Addressed by: https://review.openstack.org/138402
    Make policy client methods return one value, and fix tests

Addressed by: https://review.openstack.org/141152
    Change neutron client methods to return one value and update tests

Addressed by: https://review.openstack.org/142809
    Change volume client methods to return one value

Addressed by: https://review.openstack.org/144326
    Change v3 identity client methods to return one value

Addressed by: https://review.openstack.org/144473
    Change v2 identity client methods to return one value

Addressed by: https://review.openstack.org/145295
    Change image client methods to return one value

Addressed by: https://review.openstack.org/145360
    printout testr tests that fail

Addressed by: https://review.openstack.org/147685
    Change compute image client methods to return one value

Addressed by: https://review.openstack.org/147868
    Add return one value to volume delete methods

Addressed by: https://review.openstack.org/148008
    Change orchestration client to return one value and update tests

Addressed by: https://review.openstack.org/147892
    Change some compute admin image client methods to return one value

Addressed by: https://review.openstack.org/148787
    update test_volume_boot_pattern to assign one value

Addressed by: https://review.openstack.org/152441
    Update live migration test for return one value

Addressed by: https://review.openstack.org/153652
    Change keypair client to return one value and update tests

Addressed by: https://review.openstack.org/153685
    Change security-group clients to return one value and update tests

Addressed by: https://review.openstack.org/154047
    Update test_live_migration for return-one-value

Addressed by: https://review.openstack.org/154114
    Change flavors client to return one value and update tests

Addressed by: https://review.openstack.org/154137
    Change limits/quota clients to return one value and update tests

Addressed by: https://review.openstack.org/154202
    Change data_processing client to return one value and update tests

Addressed by: https://review.openstack.org/154218
    Change telemetry client to return one value and update tests

Addressed by: https://review.openstack.org/154537
    Change fixed/floating ip clients to return one value and update tests

Addressed by: https://review.openstack.org/154573
    Change compute volume client to return one value and update tests

Addressed by: https://review.openstack.org/154613
    Change some small compute clients to return one value and update tests

Addressed by: https://review.openstack.org/155053
    Change basic server client methods to return one value and update tests

Addressed by: https://review.openstack.org/156378
    Change servers client to return one value and update tests

Addressed by: https://review.openstack.org/157101
    Change network/interfaces clients to return one value and update tests

Addressed by: https://review.openstack.org/157104
    Change database clients to return one value and update tests

Addressed by: https://review.openstack.org/157106
    Change messaging clients to return one value and update tests

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.