Merge lp:~twom/conn-check/port-not-none into lp:conn-check

[Tom Wardill]

Handle missing port in checks, suppress traceback of config errors

[lp:~twom/conn-check/port-not-none]

139. By Tom Wardill on 2018-06-04

Test the port that we're using

140. By Tom Wardill on 2018-06-04

Merge master

141. By Tom Wardill on 2018-06-04

add default postgres port

142. By Tom Wardill on 2018-06-04

Can't use a default there, it's not postgres specific

[Simon Davy (bloodearnest)]

review: Approve

=== modified file 'conn_check/main.py'
--- conn_check/main.py	2018-01-29 14:08:16 +0000
+++ conn_check/main.py	2018-06-04 16:14:17 +0000
@@ -1,3 +1,4 @@
+
 from __future__ import print_function
 from __future__ import unicode_literals
 from future import standard_library
@@ -73,7 +74,15 @@
                                  check_description))
 
     if 'port' in check_description:
-        check_description['port'] = int(check_description['port'])
+        port = check_description.get('port')
+        try:
+            check_description['port'] = int(port)
+        except TypeError:
+            # swap the TypeError for the more generic AssertionError
+            # that we are using for configuration faults
+            # and is caught further up
+            raise AssertionError('Port is invalid for check: {}'.format(
+                                 check_description))
 
     res = check['fn'](**check_description)
     return res
@@ -347,11 +356,18 @@
     def run(self):
         """Run/validate/dry-run the given command with options."""
 
-        checks = build_checks(self.descriptions,
-                              self.options.connect_timeout,
-                              self.options.include_tags,
-                              self.options.exclude_tags,
-                              self.options.dry_run)
+        try:
+            checks = build_checks(self.descriptions,
+                                self.options.connect_timeout,
+                                self.options.include_tags,
+                                self.options.exclude_tags,
+                                self.options.dry_run)
+        except AssertionError as e:
+            # Configuration fault, suppress traceback
+            # but display message
+            self.output.write(str(e))
+            self.output.flush()
+            return 4
 
         if not self.options.validate:
             if not self.options.dry_run:
 
=== modified file 'tests.py'
--- tests.py	2018-01-25 20:58:24 +0000
+++ tests.py	2018-06-04 16:14:17 +0000
@@ -300,6 +300,16 @@
             str(e),
             "host missing from check: {}".format(description))
 
+    def test_check_from_description_port_not_set(self):
+        description = {'type': 'tcp', 'host': 'localhost', 'port': None}
+        e = self.assertRaises(AssertionError,
+                              check_from_description,
+                              description)
+        self.assertEqual(
+            str(e),
+            "Port is invalid for check: {}".format(description)
+        )
+
     def test_check_from_description_makes_check(self):
         description = {'type': 'tcp', 'host': 'localhost', 'port': '8080'}
         result = check_from_description(description)