Handle xmlrpclib.Fault cleanly, and document the exit codes in the man page

wgwoods · wgwoods · commit 63a01f397299 · 2010-04-01T14:55:58.000-04:00
diff --git a/bin/bugzilla b/bin/bugzilla
@@ -18,6 +18,7 @@ import bugzilla.util
 import locale
 import pprint
 import socket
+import xmlrpclib
 
 version = '0.6.0'
 default_bz = 'https://bugzilla.redhat.com/xmlrpc.cgi'
@@ -263,7 +264,12 @@ by Bugzilla.
 bugzilla query --bug_id 62037
 .SH EXIT STATUS
 .BR bugzilla
-returns 1 if login fails or it is interrupted, and 0 otherwise.
+normally returns 0 if the requested command was successful. Otherwise, exit
+status is 1 if
+.BR bugzilla
+is interrupted by the user (or a login attempt fails), 2 if a
+socket error occurs (e.g. TCP connection timeout), and 3 if the server returns
+an XML-RPC fault.
 .SH NOTES
 Not everything that's exposed in the Web UI is exposed by XML-RPC, and not
 everything that's exposed by XML-RPC is used by
@@ -659,3 +665,6 @@ if __name__ == '__main__':
     except socket.error, e:
         print "\nConnection lost/failed: %s" % str(e)
         sys.exit(2)
+    except xmlrpclib.Fault, e:
+        print "\nServer error: %s" % str(e)
+        sys.exit(3)
diff --git a/bugzilla.1 b/bugzilla.1
@@ -1,4 +1,4 @@
-.TH bugzilla 1  "February 25, 2010" "version 0.6.0" "User Commands"
+.TH bugzilla 1  "April 02, 2010" "version 0.6.0" "User Commands"
 .SH NAME
 bugzilla \- command-line interface to Bugzilla over XML-RPC
 .SH SYNOPSIS
@@ -192,7 +192,12 @@ show this help message and exit
 bugzilla query --bug_id 62037
 .SH EXIT STATUS
 .BR bugzilla
-returns 1 if login fails or it is interrupted, and 0 otherwise.
+normally returns 0 if the requested command was successful. Otherwise, exit
+status is 1 if
+.BR bugzilla
+is interrupted by the user (or a login attempt fails), 2 if a
+socket error occurs (e.g. TCP connection timeout), and 3 if the server returns
+an XML-RPC fault.
 .SH NOTES
 Not everything that's exposed in the Web UI is exposed by XML-RPC, and not
 everything that's exposed by XML-RPC is used by
