Add some tests for bin/swift-recon

Fix also minor bug in zone filtering when zone set to 0.

Moved bin/swift-recon to swift/cli/recon.py, which makes
it possible to import it without using some scary hacks.
bin/swift-recon is now created by setup.py install.

Closes-Bug: #1261692
Change-Id: Id0729991c8ece73604467480dbf93fec7d8eb196

setup.cfg

@@ -52,7 +52,6 @@ scripts =
     bin/swift-oldies
     bin/swift-orphans
     bin/swift-proxy-server
-    bin/swift-recon
     bin/swift-recon-cron
     bin/swift-ring-builder
     bin/swift-temp-url
@@ -89,6 +88,9 @@ paste.filter_factory =
     gatekeeper = swift.common.middleware.gatekeeper:filter_factory
     container_sync = swift.common.middleware.container_sync:filter_factory
 
+console_scripts =
+    swift-recon = swift.cli.recon:main
+
 [build_sphinx]
 all_files = 1
 build-dir = doc/build

swift/cli/recon.py

@@ -168,7 +168,7 @@ class SwiftRecon(object):
         :returns: a set of tuples containing the ip and port of hosts
         """
         ring_data = Ring(swift_dir, ring_name=ring_name)
-        if zone_filter:
+        if zone_filter is not None:
             ips = set((n['ip'], n['port']) for n in ring_data.devs
                       if n and n['zone'] == zone_filter)
         else:
@@ -805,7 +805,7 @@ class SwiftRecon(object):
         self.suppress_errors = options.suppress
         self.timeout = options.timeout
 
-        if options.zone:
+        if options.zone is not None:
             hosts = self.get_devices(options.zone, swift_dir, self.server_type)
         else:
             hosts = self.get_devices(None, swift_dir, self.server_type)
@@ -873,9 +873,13 @@ class SwiftRecon(object):
                 self.socket_usage(hosts)
 
 
-if __name__ == '__main__':
+def main():
     try:
         reconnoiter = SwiftRecon()
         reconnoiter.main()
     except KeyboardInterrupt:
         print '\n'
+
+
+if __name__ == '__main__':
+    main()

test/unit/cli/test_recon.py

@@ -0,0 +1,148 @@
+# Copyright (c) 2013 Christian Schwede <christian.schwede@enovance.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+import mock
+import os
+import random
+import string
+import tempfile
+import time
+import unittest
+
+from eventlet.green import urllib2
+
+from swift.cli import recon
+from swift.common import utils
+from swift.common.ring import builder
+
+
+class TestHelpers(unittest.TestCase):
+    def test_seconds2timeunit(self):
+        self.assertEqual(recon.seconds2timeunit(10), (10, 'seconds'))
+        self.assertEqual(recon.seconds2timeunit(600), (10, 'minutes'))
+        self.assertEqual(recon.seconds2timeunit(36000), (10, 'hours'))
+        self.assertEqual(recon.seconds2timeunit(60 * 60 * 24 * 10),
+                         (10, 'days'))
+
+    def test_size_suffix(self):
+        self.assertEqual(recon.size_suffix(5 * 10 ** 2), '500 bytes')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 3), '5 kB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 6), '5 MB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 9), '5 GB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 12), '5 TB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 15), '5 PB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 18), '5 EB')
+        self.assertEqual(recon.size_suffix(5 * 10 ** 21), '5 ZB')
+
+
+class TestScout(unittest.TestCase):
+    def setUp(self, *_args, **_kwargs):
+        self.scout_instance = recon.Scout("type", suppress_errors=True)
+        self.url = 'http://127.0.0.1:8080/recon/type'
+
+    @mock.patch('eventlet.green.urllib2.urlopen')
+    def test_scout_ok(self, mock_urlopen):
+        mock_urlopen.return_value.read = lambda: json.dumps([])
+        url, content, status = self.scout_instance.scout(
+            ("127.0.0.1", "8080"))
+        self.assertEqual(url, self.url)
+        self.assertEqual(content, [])
+        self.assertEqual(status, 200)
+
+    @mock.patch('eventlet.green.urllib2.urlopen')
+    def test_scout_url_error(self, mock_urlopen):
+        mock_urlopen.side_effect = urllib2.URLError("")
+        url, content, status = self.scout_instance.scout(
+            ("127.0.0.1", "8080"))
+        self.assertTrue(isinstance(content, urllib2.URLError))
+        self.assertEqual(url, self.url)
+        self.assertEqual(status, -1)
+
+    @mock.patch('eventlet.green.urllib2.urlopen')
+    def test_scout_http_error(self, mock_urlopen):
+        mock_urlopen.side_effect = urllib2.HTTPError(
+            self.url, 404, "Internal error", None, None)
+        url, content, status = self.scout_instance.scout(
+            ("127.0.0.1", "8080"))
+        self.assertEqual(url, self.url)
+        self.assertTrue(isinstance(content, urllib2.HTTPError))
+        self.assertEqual(status, 404)
+
+
+class TestRecon(unittest.TestCase):
+    def setUp(self, *_args, **_kwargs):
+        self.recon_instance = recon.SwiftRecon()
+        self.swift_dir = tempfile.gettempdir()
+        self.ring_name = "test_object_%s" % (
+            ''.join(random.choice(string.digits) for x in range(6)))
+        self.tmpfile_name = "%s/%s.ring.gz" % (self.swift_dir, self.ring_name)
+
+        utils.HASH_PATH_SUFFIX = 'endcap'
+        utils.HASH_PATH_PREFIX = 'startcap'
+
+    def tearDown(self, *_args, **_kwargs):
+        try:
+            os.remove(self.tmpfile_name)
+        except:
+            pass
+
+    def test_gen_stats(self):
+        stats = self.recon_instance._gen_stats((1, 4, 10, None), 'Sample')
+        self.assertEqual(stats.get('name'), 'Sample')
+        self.assertEqual(stats.get('average'), 5.0)
+        self.assertEqual(stats.get('high'), 10)
+        self.assertEqual(stats.get('reported'), 3)
+        self.assertEqual(stats.get('low'), 1)
+        self.assertEqual(stats.get('total'), 15)
+        self.assertEqual(stats.get('number_none'), 1)
+        self.assertEqual(stats.get('perc_none'), 25.0)
+
+    def test_ptime(self):
+        with mock.patch('time.localtime') as mock_localtime:
+            mock_localtime.return_value = time.struct_time(
+                (2013, 12, 17, 10, 0, 0, 1, 351, 0))
+
+            timestamp = self.recon_instance._ptime(1387274400)
+            self.assertEqual(timestamp, "2013-12-17 10:00:00")
+            mock_localtime.assertCalledWith(1387274400)
+
+            timestamp2 = self.recon_instance._ptime()
+            self.assertEqual(timestamp2, "2013-12-17 10:00:00")
+            mock_localtime.assertCalledWith()
+
+    def test_get_devices(self):
+        ringbuilder = builder.RingBuilder(2, 3, 1)
+        ringbuilder.add_dev({'id': 0, 'zone': 0, 'weight': 1,
+                             'ip': '127.0.0.1', 'port': 10000,
+                             'device': 'sda1', 'region': 0})
+        ringbuilder.add_dev({'id': 1, 'zone': 1, 'weight': 1,
+                             'ip': '127.0.0.1', 'port': 10001,
+                             'device': 'sda1', 'region': 0})
+        ringbuilder.rebalance()
+        ringbuilder.get_ring().save(self.tmpfile_name)
+
+        ips = self.recon_instance.get_devices(
+            None, self.swift_dir, self.ring_name)
+        self.assertEqual(
+            set([('127.0.0.1', 10000), ('127.0.0.1', 10001)]), ips)
+
+        ips = self.recon_instance.get_devices(
+            0, self.swift_dir, self.ring_name)
+        self.assertEqual(set([('127.0.0.1', 10000)]), ips)
+
+        ips = self.recon_instance.get_devices(
+            1, self.swift_dir, self.ring_name)
+        self.assertEqual(set([('127.0.0.1', 10001)]), ips)