Merge ~chad.smith/cloud-init:simpletable-getstring-fix into cloud-init:master

[Chad Smith]

simpletable: Fix get_string method to return table-formatted string

Output in cloud-init-output.log contained only the string representation
of a SimpleTable object instead of the table formatted content. This bug
also affected ssh_authkey_fingerprints.

LP: #1722566

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:daf5dd118451bef3216c440b10650b26233cc9fd
https://jenkins.ubuntu.com/server/job/cloud-init-ci/398/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    FAILED: MAAS Compatability Testing

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/398/rebuild

review: Needs Fixing (continuous-integration)

[Scott Moser (smoser)]

need to make sure the failure there is just noise... looks like it was,
and doesn't seem like it should be related.

the code looks good and thanks for the tests.

I am running a test here just quick to verify we get
the network output rendered.

I ran a integration test with:
$ tox -e citest -- run --preserve-data --data-dir=/tmp/artifacts --deb=/home/smoser-public/src/cloud-init/build/../cloud-init_17.1-20-gdaf5dd11-1~bddeb_all.deb --verbose --os-name=xenial --test=modules/final_message

and then verify that /tmp/artifacts/lxd/xenial/modules/final_message/cloud-init-output.log had the
messages we wanted. see
 http://paste.ubuntu.com/25714903/

[Scott Moser (smoser)]

wait on the re-build to post results and then lets get this and upload.

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/399/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    SUCCESS: MAAS Compatability Testing
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/399/rebuild

review: Approve (continuous-integration)

[Scott Moser (smoser)]

I approve.
wrt Ryan's comment, i agree that the 80 chars is annoying here, but i think we should just leave as is to get it in.

[Scott Moser (smoser)]

review: Approve

diff --git a/cloudinit/netinfo.py b/cloudinit/netinfo.py
index 8f99d99..993b26c 100644
--- a/cloudinit/netinfo.py
+++ b/cloudinit/netinfo.py
@@ -171,7 +171,7 @@ def netdev_pformat():
     else:
         fields = ['Device', 'Up', 'Address', 'Mask', 'Scope', 'Hw-Address']
         tbl = SimpleTable(fields)
-        for (dev, d) in netdev.items():
+        for (dev, d) in sorted(netdev.items()):
             tbl.add_row([dev, d["up"], d["addr"], d["mask"], ".", d["hwaddr"]])
             if d.get('addr6'):
                 tbl.add_row([dev, d["up"],
diff --git a/cloudinit/simpletable.py b/cloudinit/simpletable.py
index 9060322..ca663cc 100644
--- a/cloudinit/simpletable.py
+++ b/cloudinit/simpletable.py
@@ -59,4 +59,4 @@ class SimpleTable(object):
         return '\n'.join(lines)
 
     def get_string(self):
-        return repr(self)
+        return self.__str__()
diff --git a/cloudinit/tests/test_netinfo.py b/cloudinit/tests/test_netinfo.py
new file mode 100644
index 0000000..7dea2e4
--- /dev/null
+++ b/cloudinit/tests/test_netinfo.py
@@ -0,0 +1,106 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+"""Tests netinfo module functions and classes."""
+
+from cloudinit.netinfo import netdev_pformat, route_pformat
+from cloudinit.tests.helpers import CiTestCase, mock
+
+
+# Example ifconfig and route output
+SAMPLE_IFCONFIG_OUT = """\
+enp0s25   Link encap:Ethernet  HWaddr 50:7b:9d:2c:af:91
+          inet addr:192.168.2.18  Bcast:192.168.2.255  Mask:255.255.255.0
+          inet6 addr: fe80::8107:2b92:867e:f8a6/64 Scope:Link
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          RX packets:8106427 errors:55 dropped:0 overruns:0 frame:37
+          TX packets:9339739 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:4953721719 (4.9 GB)  TX bytes:7731890194 (7.7 GB)
+          Interrupt:20 Memory:e1200000-e1220000
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          inet6 addr: ::1/128 Scope:Host
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:579230851 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:579230851 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1
+"""
+
+SAMPLE_ROUTE_OUT = '\n'.join([
+    '0.0.0.0         192.168.2.1     0.0.0.0         UG        0 0          0'
+    ' enp0s25',
+    '0.0.0.0         192.168.2.1     0.0.0.0         UG        0 0          0'
+    ' wlp3s0',
+    '192.168.2.0     0.0.0.0         255.255.255.0   U         0 0          0'
+    ' enp0s25'])
+
+
+NETDEV_FORMATTED_OUT = '\n'.join([
+    '+++++++++++++++++++++++++++++++++++++++Net device info+++++++++++++++++++'
+    '++++++++++++++++++++',
+    '+---------+------+------------------------------+---------------+-------+'
+    '-------------------+',
+    '|  Device |  Up  |           Address            |      Mask     | Scope |'
+    '     Hw-Address    |',
+    '+---------+------+------------------------------+---------------+-------+'
+    '-------------------+',
+    '| enp0s25 | True |         192.168.2.18         | 255.255.255.0 |   .   |'
+    ' 50:7b:9d:2c:af:91 |',
+    '| enp0s25 | True | fe80::8107:2b92:867e:f8a6/64 |       .       |  link |'
+    ' 50:7b:9d:2c:af:91 |',
+    '|    lo   | True |          127.0.0.1           |   255.0.0.0   |   .   |'
+    '         .         |',
+    '|    lo   | True |           ::1/128            |       .       |  host |'
+    '         .         |',
+    '+---------+------+------------------------------+---------------+-------+'
+    '-------------------+'])
+
+ROUTE_FORMATTED_OUT = '\n'.join([
+    '+++++++++++++++++++++++++++++Route IPv4 info++++++++++++++++++++++++++'
+    '+++',
+    '+-------+-------------+-------------+---------------+-----------+-----'
+    '--+',
+    '| Route | Destination |   Gateway   |    Genmask    | Interface | Flags'
+    ' |',
+    '+-------+-------------+-------------+---------------+-----------+'
+    '-------+',
+    '|   0   |   0.0.0.0   | 192.168.2.1 |    0.0.0.0    |   wlp3s0  |'
+    '   UG  |',
+    '|   1   | 192.168.2.0 |   0.0.0.0   | 255.255.255.0 |  enp0s25  |'
+    '   U   |',
+    '+-------+-------------+-------------+---------------+-----------+'
+    '-------+',
+    '++++++++++++++++++++++++++++++++++++++++Route IPv6 info++++++++++'
+    '++++++++++++++++++++++++++++++',
+    '+-------+-------------+-------------+---------------+---------------+'
+    '-----------------+-------+',
+    '| Route |    Proto    |    Recv-Q   |     Send-Q    | Local Address |'
+    ' Foreign Address | State |',
+    '+-------+-------------+-------------+---------------+---------------+'
+    '-----------------+-------+',
+    '|   0   |   0.0.0.0   | 192.168.2.1 |    0.0.0.0    |       UG      |'
+    '        0        |   0   |',
+    '|   1   | 192.168.2.0 |   0.0.0.0   | 255.255.255.0 |       U       |'
+    '        0        |   0   |',
+    '+-------+-------------+-------------+---------------+---------------+'
+    '-----------------+-------+'])
+
+
+class TestNetInfo(CiTestCase):
+
+    maxDiff = None
+
+    @mock.patch('cloudinit.netinfo.util.subp')
+    def test_netdev_pformat(self, m_subp):
+        """netdev_pformat properly rendering network device information."""
+        m_subp.return_value = (SAMPLE_IFCONFIG_OUT, '')
+        content = netdev_pformat()
+        self.assertEqual(NETDEV_FORMATTED_OUT, content)
+
+    @mock.patch('cloudinit.netinfo.util.subp')
+    def test_route_pformat(self, m_subp):
+        """netdev_pformat properly rendering network device information."""
+        m_subp.return_value = (SAMPLE_ROUTE_OUT, '')
+        content = route_pformat()
+        self.assertEqual(ROUTE_FORMATTED_OUT, content)
diff --git a/cloudinit/tests/test_simpletable.py b/cloudinit/tests/test_simpletable.py
index 96bc24c..a12a62a 100644
--- a/cloudinit/tests/test_simpletable.py
+++ b/cloudinit/tests/test_simpletable.py
@@ -97,4 +97,10 @@ class TestSimpleTable(CiTestCase):
         table = SimpleTable(AUTHORIZED_KEYS_FIELDS)
         for row in AUTHORIZED_KEYS_ROWS:
             table.add_row(row)
-        self.assertEqual(str(table), AUTHORIZED_KEYS_TABLE)
+
+    def test_get_string(self):
+        """get_string() method returns the same content as str()."""
+        table = SimpleTable(AUTHORIZED_KEYS_FIELDS)
+        for row in AUTHORIZED_KEYS_ROWS:
+            table.add_row(row)
+        self.assertEqual(table.get_string(), str(table))