[tor-commits] [arm/master] Revised script for starting arm
atagar at torproject.org
atagar at torproject.org
Thu Jan 9 17:31:04 UTC 2014
commit fb1d2d2d1b2ff1cefa4eba210d190addd9d1d911
Author: Damian Johnson <atagar at torproject.org>
Date: Thu Jan 9 09:09:23 2014 -0800
Revised script for starting arm
Swapping run_arm from sh to python and having it do our prereq checks. This
removes our fancy auto-install functionality which, while convenient, was
insecure. People should install stem from their repositories.
This also bumps our dependency from python 2.5 to 2.6, so we match stem's
dependencies.
---
arm/prereq.py | 141 ---------------------------------------------------------
run_arm | 54 +++++++++++++++++-----
run_tests.py | 1 +
runner.py | 3 --
4 files changed, 43 insertions(+), 156 deletions(-)
diff --git a/arm/prereq.py b/arm/prereq.py
deleted file mode 100644
index 1813662..0000000
--- a/arm/prereq.py
+++ /dev/null
@@ -1,141 +0,0 @@
-"""
-Provides a warning and error code if python version isn't compatible.
-"""
-
-import os
-import sys
-import shutil
-import urllib
-import hashlib
-import tarfile
-import tempfile
-
-# Library dependencies can be fetched on request. By default this is via
-# the following mirrors with their sha256 signatures checked.
-#STEM_ARCHIVE = "http://www.atagar.com/arm/resources/deps/11-06-16/torctl.tar.gz"
-#STEM_SIG = "5460adb1394c368ba492cc33d6681618b3d3062b3f5f70b2a87520fc291701c3"
-
-# optionally we can do an unverified fetch from the library's sources
-STEM_REPO = "git://git.torproject.org/stem.git"
-
-def isStemAvailable():
- """
- True if stem is already available on the platform, false otherwise.
- """
-
- try:
- import stem
- return True
- except ImportError:
- return False
-
-def promptStemInstall():
- """
- Asks the user to install stem. This returns True if it was installed and
- False otherwise (if it was either declined or failed to be fetched).
- """
-
- userInput = raw_input("Arm requires stem to run, but it's unavailable. Would you like to install it? (y/n): ")
-
- # if user says no then terminate
- if not userInput.lower() in ("y", "yes"): return False
-
- # attempt to install stem, printing the issue if unsuccessful
- try:
- #fetchLibrary(STEM_ARCHIVE, STEM_SIG)
- installStem()
-
- if not isStemAvailable():
- raise IOError("Unable to install stem, sorry")
-
- print "Stem successfully installed"
- return True
- except IOError, exc:
- print exc
- return False
-
-def fetchLibrary(url, sig):
- """
- Downloads the given archive, verifies its signature, then installs the
- library. This raises an IOError if any of these steps fail.
-
- Arguments:
- url - url from which to fetch the gzipped tarball
- sig - sha256 signature for the archive
- """
-
- tmpDir = tempfile.mkdtemp()
- destination = tmpDir + "/" + url.split("/")[-1]
- urllib.urlretrieve(url, destination)
-
- # checks the signature, reading the archive in 256-byte chunks
- m = hashlib.sha256()
- fd = open(destination, "rb")
-
- while True:
- data = fd.read(256)
- if not data: break
- m.update(data)
-
- fd.close()
- actualSig = m.hexdigest()
-
- if sig != actualSig:
- raise IOError("Signature of the library is incorrect (got '%s' rather than '%s')" % (actualSig, sig))
-
- # extracts the tarball
- tarFd = tarfile.open(destination, 'r:gz')
- tarFd.extractall("src/")
- tarFd.close()
-
- # clean up the temporary contents (fails quietly if unsuccessful)
- shutil.rmtree(destination, ignore_errors=True)
-
-def installStem():
- """
- Checks out the current git head release for stem and bundles it with arm.
- This raises an IOError if unsuccessful.
- """
-
- if isStemAvailable(): return
-
- # temporary destination for stem's git clone, guarenteed to be unoccupied
- # (to avoid conflicting with files that are already there)
- tmpFilename = tempfile.mktemp("/stem")
-
- # fetches stem
- exitStatus = os.system("git clone --quiet %s %s > /dev/null" % (STEM_REPO, tmpFilename))
- if exitStatus: raise IOError("Unable to get stem from %s. Is git installed?" % STEM_REPO)
-
- # the destination for stem will be our directory
- ourDir = os.path.dirname(os.path.realpath(__file__))
-
- # exports stem to our location
- exitStatus = os.system("(cd %s && git archive --format=tar master stem) | (cd %s && tar xf - 2> /dev/null)" % (tmpFilename, ourDir))
- if exitStatus: raise IOError("Unable to install stem to %s" % ourDir)
-
- # Clean up the temporary contents. This isn't vital so quietly fails in case
- # of errors.
- shutil.rmtree(tmpFilename, ignore_errors=True)
-
-if __name__ == '__main__':
- majorVersion = sys.version_info[0]
- minorVersion = sys.version_info[1]
-
- if majorVersion > 2:
- print("arm isn't compatible beyond the python 2.x series\n")
- sys.exit(1)
- elif majorVersion < 2 or minorVersion < 5:
- print("arm requires python version 2.5 or greater\n")
- sys.exit(1)
-
- if not isStemAvailable():
- isInstalled = promptStemInstall()
- if not isInstalled: sys.exit(1)
-
- try:
- import curses
- except ImportError:
- print("arm requires curses - try installing the python-curses package\n")
- sys.exit(1)
-
diff --git a/run_arm b/run_arm
index cbe74d6..0e823d4 100755
--- a/run_arm
+++ b/run_arm
@@ -1,17 +1,47 @@
-#!/bin/sh
+#!/usr/bin/env python
+# Copyright 2014, Damian Johnson and The Tor Project
+# See LICENSE for licensing information
-# Also looking in /bin/arm because of the UsrMove feature on Fedora...
-# https://trac.torproject.org/5973
+import sys
-if [ "$0" = /usr/bin/arm ] || [ "$0" = /bin/arm ]; then
- arm_base=/usr/share/arm/
-else
- arm_base=$( dirname "$0" )/arm/
-fi
+import arm.starter
-python "${arm_base}prereq.py" $*
+def main():
+ try:
+ _check_prereq()
+ except ImportError as exc:
+ print exc
+ sys.exit(1)
-if [ $? = 0 ]; then
- exec python "runner.py" $*
-fi
+ arm.starter.main()
+
+def _check_prereq():
+ """
+ Checks for arm's prerequisistes...
+
+ * python 2.6 or later
+ * stem
+ * curses
+
+ :raises: **ImportError** if any of our prerequisites aren't met
+ """
+
+ major_version, minor_version = sys.version_info[0:2]
+
+ if major_version < 2 or (major_version == 2 and minor_version < 6):
+ raise ImportError("arm requires python version 2.6 or greater")
+
+ try:
+ import stem
+ except ImportError:
+ raise ImportError("arm requires stem, try running 'sudo apt-get install python-stem'")
+
+ try:
+ import curses
+ except ImportError:
+ raise ImportError("arm requires curses, try running 'sudo apt-get install python-curses'")
+
+
+if __name__ == '__main__':
+ main()
diff --git a/run_tests.py b/run_tests.py
index 1553da8..dd7ff98 100755
--- a/run_tests.py
+++ b/run_tests.py
@@ -28,6 +28,7 @@ SRC_PATHS = [os.path.join(ARM_BASE, path) for path in (
'arm',
'test',
'run_tests.py',
+ 'run_arm',
)]
diff --git a/runner.py b/runner.py
deleted file mode 100644
index 78ba482..0000000
--- a/runner.py
+++ /dev/null
@@ -1,3 +0,0 @@
-import arm.starter
-
-arm.starter.main()
More information about the tor-commits
mailing list