Merge lp:~robru/phablet-tools/phablet-shell into lp:phablet-tools

[Robert Bruce Park]

Add phablet-shell tool for a nicer shell experience on device.

[lp:~robru/phablet-tools/phablet-shell]

270. By Robert Bruce Park on 2014-05-12

Install script.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:270
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/324/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/5
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/5
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/5

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/324/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

Can we package split this into a ci binary package?

[Sergio Schvezov (sergiusens)]

https://code.launchpad.net/~sergiusens/phablet-tools/common_scripts/+merge/219520

[Robert Bruce Park (robru)]

Lol, did you review the right branch Sergio? This one has nothing to do with CI, it's just a script that whips up some ssh magic to give a (much) nicer shell experience on the phone than you'd get with your typical 'adb shell' command. Seems to fit right in with all the other phablet-* tools to me.

I have no problem taking my *other* branch and splitting it off into it's own -citrain package.

[Sergio Schvezov (sergiusens)]

On Wed, May 14, 2014 at 3:58 PM, Robert Bruce Park <
<email address hidden>> wrote:

> Lol, did you review the right branch Sergio? This one has nothing to do
> with CI, it's just a script that whips up some ssh magic to give a (much)
> nicer shell experience on the phone than you'd get with your typical 'adb
> shell' command. Seems to fit right in with all the other phablet-* tools to
> me.
>

> I have no problem taking my *other* branch and splitting it off into it's
> own -citrain package.
>

yeah, sorry about this, I meant it to send that to the other branch.
Anyways, it's just one script, no need for it so disregard the packaging
split comment

[Sergio Schvezov (sergiusens)]

It takes to long to login if we do the ssh key dance all the time. Do you mind stripping that? It will be useless soon anyways since ssh would need to be manually enabled soon (or through a flash option) due to security reasons.

We also need to think that forwarding to the same port isn't feasible in a multi connected device scenario

review: Needs Fixing

[Robert Bruce Park (robru)]

Hmmm I'm using this all the time and the performance isn't bad...

[Robert Bruce Park (robru)]

Also, the script is already manually starting ssh each time.

You're right about the multi-device setup though, I'm just using this with a single device.

[Robert Bruce Park (robru)]

it's not hard to imagine a way to programmatically select an available port instead of hard-coding 2222 each time, but one thing I'm not sure about is how to avoid copying down the ssh key and bash config each time... I'm not sure how to check for those in order to avoid doing them redundantly. open to suggestions though.

[lp:~robru/phablet-tools/phablet-shell]

271. By Robert Bruce Park on 2014-05-21

Merge trunk.

272. By Robert Bruce Park on 2014-05-21

Pick a fresh port for each device.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:272
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/333/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/14
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/14
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/14

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/333/rebuild

review: Approve (continuous-integration)

[lp:~robru/phablet-tools/phablet-shell]

273. By Robert Bruce Park on 2014-05-21

Use rsync and reduce code duplication.

274. By Robert Bruce Park on 2014-05-21

Quiet rsync.

275. By Robert Bruce Park on 2014-05-21

Add usage help.

276. By Robert Bruce Park on 2014-05-21

Use check_devices.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:275
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/334/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/15

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/334/rebuild

review: Approve (continuous-integration)

[Robert Bruce Park (robru)]

Please take another look at this, I think it's starting to shape up.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:276
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/335/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/16
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/16
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/16

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/335/rebuild

review: Approve (continuous-integration)

[lp:~robru/phablet-tools/phablet-shell]

277. By Robert Bruce Park on 2014-05-26

Use adb push instead of ssh-copy-id so password is never needed.

[Robert Bruce Park (robru)]

Hi Sergio,

I dropped ssh-copy-id in favor of adb push, which means now this tool never does a password login, so it should be safe when password logins get shut off soon.

Please re-review!

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:277
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/336/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/336/rebuild

review: Approve (continuous-integration)

[lp:~robru/phablet-tools/phablet-shell]

278. By Robert Bruce Park on 2014-05-27

Do argument parsing.

279. By Robert Bruce Park on 2014-05-27

Some fixes.

280. By Robert Bruce Park on 2014-05-27

Misc fixes.

[Sergio Schvezov (sergiusens)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:280
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/337/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-amd64-ci/18
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-armhf-ci/18
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-utopic-i386-ci/18

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/337/rebuild

review: Approve (continuous-integration)

=== added file 'phablet-shell'
--- phablet-shell	1970-01-01 00:00:00 +0000
+++ phablet-shell	2014-05-27 15:16:30 +0000
@@ -0,0 +1,95 @@
+#!/bin/sh -e
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the the GNU General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the applicable version of the GNU General Public
+# License for more details.
+#.
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright (C) 2014 Canonical, Ltd.
+
+usage () {
+cat <<EOF
+Usage: $0 [-s SERIAL]
+
+This tool will start ssh on your connected Ubuntu Touch device, forward a local
+port to the device, copy your ssh id down to the device (so you only have to log
+in once), rsync down your bash config so you get any nice prompt & aliases you
+might be used to from your host bash config, and then finally sshs into the
+device through the locally forwarded port.
+
+This results in a very nice shell, which for example can display the output of
+'top' at the correct terminal size, rather than being stuck at 80x25 like 'adb
+shell'
+
+Like ssh-copy-id, this script will push down the newest ssh key it can find in
+~/.ssh/*.pub, so if you find the wrong key being pushed down, simply use 'touch'
+to make your desired key the newest one, and then this script will find it.
+EOF
+exit 1
+}
+
+if [ -f "$(dirname $0)/shell-adb-common.sh" ]; then
+    . "$(dirname $0)/shell-adb-common.sh"
+else
+    . "/usr/share/phabletutils/shell-adb-common.sh"
+fi
+
+ARGS=$(getopt -o hs: -n "$0" -- "$@")
+if [ $? -ne 0 ] ; then
+    usage
+fi
+eval set -- "$ARGS"
+
+while true; do
+    case "$1" in
+        -h)
+            usage
+            ;;
+        -s)
+            export ANDROID_SERIAL="$2"
+            shift 2
+            break
+            ;;
+        *)
+            break
+            ;;
+    esac
+done
+
+check_devices
+
+# Start ssh on the device and use port forwarding to connect to it.
+# This means that we'll connect to the device through the USB cable
+# and won't depend on if the device has it's wifi configured or not.
+adb shell start ssh
+for PORT in `seq 2222 2299`; do
+    adb forward tcp:$PORT tcp:22 && break
+done
+
+SSH_OPTS="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p $PORT"
+
+# Purge the device host key so that SSH doesn't print a scary warning about it
+# (it changes every time the device is reflashed and this is expected)
+ssh-keygen -f ~/.ssh/known_hosts -R [localhost]:$PORT
+
+# Copy your ssh id down to the device so you never need a password.
+NEWEST_KEY=$(ls -t ~/.ssh/*.pub | grep -v -- -cert.pub | head -1)
+adb push $NEWEST_KEY /home/phablet/.ssh/authorized_keys
+adb shell chown phablet:phablet -R /home/phablet/.ssh/
+adb shell chmod 700 /home/phablet/.ssh
+adb shell chmod 600 /home/phablet/.ssh/authorized_keys
+
+# Copy your bash config down to the device so you get the benefit of your
+# colourful $PS1 prompt and any bash aliases that you may be used to from your
+# host device.
+rsync -qae "ssh $SSH_OPTS" ~/.bash* ~/.profile* phablet@localhost:/home/phablet
+
+# Now connect to the device and provide the user with a shell.
+ssh $SSH_OPTS phablet@localhost

=== modified file 'setup.py'
--- setup.py	2014-05-15 19:59:37 +0000
+++ setup.py	2014-05-27 15:16:30 +0000
@@ -21,6 +21,7 @@
     'phablet-test-run',
     'click-buddy',
     'phablet-bootchart',
+    'phablet-shell',
     ]
 
 DATA_FILES = [