neutron port-list -f csv outputs poorly formatted JSON strings.

[Tim Spriggs]

I have two IPs attached to a port. One IPv4 address and one IPv6 address:

$ neutron port-list -f table | grep '..relevant lines..'
| f59ec695-d52d-40b0-9d7c-1d8ebe315305 | | fa:16:3e:7d:99:3a | {"subnet_id": "1bb2eda5-5860-4864-84a3-4e31e3a0f130", "ip_address": "192.168.2.102"} |
| | | | {"subnet_id": "81aa0d62-4b8d-4494-98c8-50b434b067d8", "ip_address": "2607:f088:0:2::1338"} |

$ neutron port-list -f csv | grep '..relevant lines..'
"f59ec695-d52d-40b0-9d7c-1d8ebe315305","","fa:16:3e:7d:99:3a","{""subnet_id"": ""1bb2eda5-5860-4864-84a3-4e31e3a0f130"", ""ip_address"": ""192.168.2.102""}
{""subnet_id"": ""81aa0d62-4b8d-4494-98c8-50b434b067d8"", ""ip_address"": ""2607:f088:0:2::1338""}"

Running this through a CSV filter:

$VAR1 = '10fd0850-7799-4ac7-ae54-09ecb3ac8b8f';
$VAR2 = '';
$VAR3 = 'fa:16:3e:37:ac:cc';
$VAR4 = '{"subnet_id": "1bb2eda5-5860-4864-84a3-4e31e3a0f130", "ip_address": "192.168.2.104"}
{"subnet_id": "81aa0d62-4b8d-4494-98c8-50b434b067d8", "ip_address": "2607:f088:0:2::133a"}';

Finally, attempting to parse the JSON string ($VAR4) in perl:

garbage after JSON object, at character offset 85 (before "{"subnet_id": "81aa0...") at ./neutron_ports line 48, <$NEUTRON_PORTS> line 15.

Indeed, this isn't perl's fault. Putting the string through http://jsonlint.com/ comes up with a similar error.

The two strings need to be contained in a larger structure: [{...},{...}]
instead of just concatenated together: {...}{...}

Or the output specification needs to be changed.

Package/version information:
# dpkg -l | awk '/neutron/ {print $3 " " $2}'
1:2013.2-0ubuntu1 neutron-common
1:2013.2-0ubuntu1 neutron-dhcp-agent
1:2013.2-0ubuntu1 neutron-metadata-agent
1:2013.2-0ubuntu1 neutron-plugin-linuxbridge
1:2013.2-0ubuntu1 neutron-plugin-linuxbridge-agent
1:2013.2-0ubuntu1 neutron-plugin-openvswitch
1:2013.2-0ubuntu1 neutron-server
1:2013.2-0ubuntu1 python-neutron
1:2.3.0-0ubuntu1 python-neutronclient

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/99929
Committed: https://git.openstack.org/cgit/openstack/python-neutronclient/commit/?id=5d2bafa56fae2d273579c5d73f4686ee9d404a26
Submitter: Jenkins
Branch: master

commit 5d2bafa56fae2d273579c5d73f4686ee9d404a26
Author: Jyotsna <email address hidden>
Date: Fri Jun 13 18:11:17 2014 +0530

    neutron port-list -f csv outputs poorly formatted
    JSON strings

    After the change, the attached subnets are displayed
    as a list of dictionaries in one line only for csv
    option.
    It does not modify the output for tabular format.

    Closes-Bug: #1263551

    Change-Id: Ia34062562f0471bc926f9fc0bbed2d5dc4352dc0

[Ilya Shakhat (shakhat)]

The committed fix does not change the behavior:
 * https://review.openstack.org/#/c/99929/8/neutronclient/neutron/v2_0/__init__.py -- lines 666-673 are added after return statement making the code unreachable
 * https://review.openstack.org/#/c/99929/8/neutronclient/neutron/v2_0/port.py -- line 36 refers to function utils.dumps which does not exist.
Thus re-opening the bug.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/146863
Committed: https://git.openstack.org/cgit/openstack/python-neutronclient/commit/?id=57adb7f340577c0d27b377be449cb65edeb8508a
Submitter: Jenkins
Branch: master

commit 57adb7f340577c0d27b377be449cb65edeb8508a
Author: Ilya Shakhat <email address hidden>
Date: Tue Jan 13 16:44:01 2015 +0300

    Fix CSV formatting of fixed_ips field in port-list command

    With this patch fixed_ips field is printed in JSON format.
    The patch corrects https://review.openstack.org/#/c/99929/

    Closes bug 1263551

    Change-Id: I10842b96a443396abf0b268a699cce85b98c5a72

[OpenStack Infra (hudson-openstack)]

Change abandoned by Cedric Brandily (<email address hidden>) on branch: master
Review: https://review.openstack.org/154822
Reason: corrected by https://review.openstack.org/146863