Merge lp:~patrickas/ensoft-sextant/command-line-ssh-user into lp:ensoft-sextant

[Patrick Stevens]

Add a command line option, --ssh-user, to allow the SSH remote user to be specified.

Add a command line option, --ssh-user, to allow the SSH remote user to be specified.

[Martin Morrison (isoschiz)]

Voting does not meet specified criteria. Required: Approve >= 1, Disapprove == 0. Got: 1 Pending.

[ChrisD (gingerchris)]

review: Approve

=== modified file 'doc/wiki/Reference'
--- doc/wiki/Reference	2014-08-29 10:47:37 +0000
+++ doc/wiki/Reference	2014-09-01 16:06:22 +0000
@@ -53,4 +53,6 @@
 == SSH ==
 Sextant allows you to create an SSH tunnel between your client and the Neo4J server. Sextant picks a random high-numbered port which is not in use, sets up an SSH tunnel between {{{ localhost:{that port} }}} and the specified {{{ remote_neo4j }}} in the configuration file (or as the {{{ --remote-neo4j }}} command-line option), and then uses {{{ localhost:{port} }}} for communications.  This happens by default; if you do not wish for this to happen, set the config option {{{ use_ssh_tunnel }}} to {{{ False }}} in the configuration file.
 
+By default, Sextant uses your current logged-in username as the remote SSH username. You can change this behaviour in the config file by supplying {{{ ssh_user }}}, or by using the command line argument {{{ --ssh-user }}}.
+
 Warning: if you have {{{ remote_neo4j }}} set to some variant of {{{ localhost }}}, then SSH may fail (because a machine can't easily SSH to itself as currently implemented). We have some error-catching here - if we detect that we are attempting to SSH to ourself, then we skip using SSH at all - but it can probably be broken by a determined user. If you do encounter an error for this reason, the workaround at present is to set {{{ use_ssh_tunnel }}} to {{{ False }}} in the configuration file.

=== modified file 'src/sextant/__main__.py'
--- src/sextant/__main__.py	2014-09-01 15:05:09 +0000
+++ src/sextant/__main__.py	2014-09-01 16:06:22 +0000
@@ -228,6 +228,9 @@
                                   help="whether to SSH into the remote server,"
                                        "True/False",
                                   default=str(config.use_ssh_tunnel))
+        parsers[key].add_argument('--ssh-user', metavar="NAME", type=str,
+                                  help="username to use as remote SSH name",
+                                  default=str(config.ssh_user))
 
     parsers['audit'].set_defaults(func=_audit)
     parsers['web'].set_defaults(func=_start_web)
@@ -406,10 +409,13 @@
         else:  # we need to SSH
             try:
                 _start_tunnel(localport, remotehost, remoteport,
-                              ssh_user=config.ssh_user)
+                              ssh_user=args.ssh_user)
             except OSError as e:
                 logging.error(str(e))
                 return
+            except KeyboardInterrupt:
+                logging.info('Halting because of user interrupt.')
+                return
 
             try:
                 args.display_neo4j = args.remote_neo4j