Fixing argument parser bug and adding unittests to catch any future regressions.

Signed-off-by: Rob Dobson <[email protected]>

Author: rdobson

hwinfo/tools/inspector.py

@@ -223,6 +223,34 @@ def print_unit(title, content):
     print content
     print ""
 
+
+def validate_args(args):
+    if args.machine != 'localhost':
+        if not args.username or not args.password:
+            print "Error: you must specify a username and password to query a remote machine."
+            sys.exit(1)
+
+def print_system_info(host, options):
+
+    if 'bios' in options:
+        print_unit("Bios Info:", rec_to_table(host.get_info()))
+
+    if 'cpu' in options:
+        print_unit("CPU Info:", tabulate_cpu_recs(host.get_cpu_info()))
+
+    if 'nic' in options:
+        devices = pci_filter_for_nics(host.get_pci_devices())
+        print_unit("Ethernet Controller Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
+
+    if 'storage' in options:
+        devices = pci_filter_for_storage(host.get_pci_devices())
+        print_unit("Storage Controller Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
+
+    if 'gpu' in options:
+        devices = pci_filter_for_gpu(host.get_pci_devices())
+        if devices:
+            print_unit("GPU Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
+
 def main():
     """Entry Point"""
 
@@ -236,14 +264,11 @@ def main():
     parser.add_argument("-l", "--logs", help="Path to the directory with the logfiles.")
 
     args = parser.parse_args()
+    validate_args(args)
 
     if args.logs:
         host = HostFromLogs(args.logs)
     else:
-        if args.machine and not args.username or not args.password:
-            print "Error: you must specify a username and password to query a remote machine."
-            sys.exit(1)
-
         host = Host(args.machine, args.username, args.password)
 
     options = []
@@ -255,21 +280,4 @@ def main():
     else:
         options = filter_choices
 
-    if 'bios' in options:
-        print_unit("Bios Info:", rec_to_table(host.get_info()))
-
-    if 'cpu' in options:
-        print_unit("CPU Info:", tabulate_cpu_recs(host.get_cpu_info()))
-
-    if 'nic' in options:
-        devices = pci_filter_for_nics(host.get_pci_devices())
-        print_unit("Ethernet Controller Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
-
-    if 'storage' in options:
-        devices = pci_filter_for_storage(host.get_pci_devices())
-        print_unit("Storage Controller Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
-
-    if 'gpu' in options:
-        devices = pci_filter_for_gpu(host.get_pci_devices())
-        if devices:
-            print_unit("GPU Info:", tabulate_pci_recs([dev.get_rec() for dev in devices]))
+    print_system_info(host, options)

hwinfo/tools/tests/test_inspector.py

@@ -1,5 +1,6 @@
 import unittest
 import mock
+import sys
 from mock import patch
 from StringIO import StringIO
 
@@ -267,3 +268,93 @@ def test_colliding_values(self):
             combined_recs = inspector.combine_recs(recs, 'name')
         self.assertEqual(context.exception.message, "Mis-match for key 'valuea'")
 
+
+class CLITests(unittest.TestCase):
+
+    OPTIONS = ['bios', 'nic', 'storage', 'gpu', 'cpu']
+
+    @patch('hwinfo.tools.inspector.print_system_info')
+    @patch('hwinfo.tools.inspector.Host')
+    @patch('sys.argv')
+    def test_local_machine(self, argv, host_cls, print_system_info):
+        argv = ['hwinfo']
+        mhost = host_cls.return_value = mock.MagicMock()
+        inspector.main()
+        host_cls.assert_called_with('localhost',None, None)
+        print_system_info.assert_called_with(mhost, self.OPTIONS)
+
+    @patch('hwinfo.tools.inspector.print_system_info')
+    @patch('hwinfo.tools.inspector.Host')
+    def test_remote_machine(self, host_cls, print_system_info):
+        sys.argv = ['hwinfo', '-m', 'test', '-u', 'root', '-p', 'pass']
+        mhost = host_cls.return_value = mock.MagicMock()
+        inspector.main()
+        host_cls.assert_called_with('test', 'root' , 'pass')
+        print_system_info.assert_called_with(mhost, self.OPTIONS)
+
+    @patch('hwinfo.tools.inspector.print_system_info')
+    @patch('hwinfo.tools.inspector.HostFromLogs')
+    def test_host_from_logs(self, host_cls, print_system_info):
+        sys.argv = ['hwinfo', '-l', '/tmp/thisisatestpath']
+        mhost = host_cls.return_value = mock.MagicMock()
+        inspector.main()
+        host_cls.assert_called_with('/tmp/thisisatestpath')
+        print_system_info.assert_called_with(mhost, self.OPTIONS)
+
+    @patch('hwinfo.tools.inspector.print_system_info')
+    @patch('hwinfo.tools.inspector.Host')
+    def test_local_machine_filter_for_nic(self, host_cls, print_system_info):
+        sys.argv = ['hwinfo', '-f', 'nic']
+        mhost = host_cls.return_value = mock.MagicMock()
+        inspector.main()
+        print_system_info.assert_called_with(mhost, ['nic'])
+
+    @patch('hwinfo.tools.inspector.print_system_info')
+    @patch('hwinfo.tools.inspector.Host')
+    def test_local_machine_filter_for_gpu(self, host_cls, print_system_info):
+        sys.argv = ['hwinfo', '-f', 'gpu']
+        mhost = host_cls.return_value = mock.MagicMock()
+        inspector.main()
+        print_system_info.assert_called_with(mhost, ['gpu'])
+
+    @patch('sys.exit')
+    def test_validate_args_no_username(self, exit):
+        args = mock.MagicMock()
+        args.machine = 'test'
+        args.username = None
+        args.password = 'test'
+        inspector.validate_args(args)
+        exit.assert_called_with(1)
+
+    @patch('sys.exit')
+    def test_validate_args_no_password(self, exit):
+        args = mock.MagicMock()
+        args.machine = 'test'
+        args.username = 'user'
+        args.password = None
+        inspector.validate_args(args)
+        exit.assert_called_with(1)
+
+    def test_validate_local_machine(self):
+        args = mock.MagicMock()
+        args.machine = 'localhost'
+        args.username = None
+        args.password = None
+        inspector.validate_args(args)
+
+class PrintSystemInfoTests(unittest.TestCase):
+
+    @patch('hwinfo.tools.inspector.print_unit')
+    def test_print_all(self, mprint_unit):
+        mhost = mock.MagicMock()
+        options = ['bios', 'nic', 'storage', 'gpu', 'cpu']
+        inspector.print_system_info(mhost, options)
+        # GPU is optionally shown only if devices exist
+        self.assertEqual(len(mprint_unit.mock_calls), 4)
+
+    @patch('hwinfo.tools.inspector.print_unit')
+    def test_print_bios(self, mprint_unit):
+        mhost = mock.MagicMock()
+        options = ['bios']
+        inspector.print_system_info(mhost, options)
+        self.assertEqual(len(mprint_unit.mock_calls), 1)