Merge lp:~soren/nova/run-from-checkout into lp:~hudson-openstack/nova/trunk

[Soren Hansen]

It's annoying and confusing to have to set PYTHONPATH to point to your
development tree before you run any of the scripts.

If you're lucky, it just fails (because you don't have nova in the default
search path (i.e. don't have them installed in /usr/lib/blah)) so that you can
fix it up.

If you're less lucky, you spend at least a couple of minutes wondering
why the cool changes you made to one of the nova modules don't take effect
until you realise it's because it's using the nova stuff in /usr/lib.

So, to save myself (and probably others) a bit of time, this patch adds
a snippet to each of the scripts in bin/ to detect this and set up the PYTHONPATH.

[termie (termie)]

lgtm

review: Approve

[Vish Ishaya (vishvananda)]

But the bin files were down to only about one line of actual code!!! :) But seriously, I have been burned by this plenty of times myself. This seems like a reasonable way to deal with the annoyance.

review: Approve

=== modified file 'bin/nova-api'
--- bin/nova-api	2010-08-19 01:25:16 +0000
+++ bin/nova-api	2010-09-08 09:29:39 +0000
@@ -22,9 +22,19 @@
 """
 
 import logging
+import os
+import sys
 from tornado import httpserver
 from tornado import ioloop
 
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import flags
 from nova import server
 from nova import utils

=== modified file 'bin/nova-api-new'
--- bin/nova-api-new	2010-08-19 18:53:44 +0000
+++ bin/nova-api-new	2010-09-08 09:29:39 +0000
@@ -21,6 +21,17 @@
 Nova API daemon.
 """
 
+import os
+import sys
+
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import api
 from nova import flags
 from nova import utils

=== modified file 'bin/nova-compute'
--- bin/nova-compute	2010-08-19 00:39:12 +0000
+++ bin/nova-compute	2010-09-08 09:29:39 +0000
@@ -21,6 +21,17 @@
   Twistd daemon for the nova compute nodes.
 """
 
+import os
+import sys
+
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import twistd
 from nova.compute import service
 

=== modified file 'bin/nova-dhcpbridge'
--- bin/nova-dhcpbridge	2010-08-19 00:39:12 +0000
+++ bin/nova-dhcpbridge	2010-09-08 09:29:39 +0000
@@ -25,10 +25,13 @@
 import os
 import sys
 
-#TODO(joshua): there is concern that the user dnsmasq runs under will not
-#              have nova in the path. This should be verified and if it is
-#              not true the ugly line below can be removed
-sys.path.append(os.path.abspath(os.path.join(__file__, "../../")))
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
 
 from nova import flags
 from nova import rpc

=== modified file 'bin/nova-import-canonical-imagestore'
--- bin/nova-import-canonical-imagestore	2010-08-20 01:24:59 +0000
+++ bin/nova-import-canonical-imagestore	2010-09-08 09:29:39 +0000
@@ -29,6 +29,14 @@
 import sys
 import urllib2
 
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import flags
 from nova import utils
 from nova.objectstore import image

=== modified file 'bin/nova-instancemonitor'
--- bin/nova-instancemonitor	2010-08-19 00:39:12 +0000
+++ bin/nova-instancemonitor	2010-09-08 09:29:39 +0000
@@ -21,9 +21,19 @@
   Daemon for Nova RRD based instance resource monitoring.
 """
 
+import os
 import logging
+import sys
 from twisted.application import service
 
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import twistd
 from nova.compute import monitor
 

=== modified file 'bin/nova-manage'
--- bin/nova-manage	2010-08-20 01:24:59 +0000
+++ bin/nova-manage	2010-09-08 09:29:39 +0000
@@ -22,9 +22,18 @@
   Connects to the running ADMIN api in the api daemon.
 """
 
+import os
 import sys
 import time
 
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import flags
 from nova import utils
 from nova.auth import manager

=== modified file 'bin/nova-network'
--- bin/nova-network	2010-08-19 00:39:12 +0000
+++ bin/nova-network	2010-09-08 09:29:39 +0000
@@ -21,6 +21,17 @@
   Twistd daemon for the nova network nodes.
 """
 
+import os
+import sys
+
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import flags
 from nova import twistd
 

=== modified file 'bin/nova-objectstore'
--- bin/nova-objectstore	2010-08-19 00:39:12 +0000
+++ bin/nova-objectstore	2010-09-08 09:29:39 +0000
@@ -21,6 +21,17 @@
   Twisted daemon for nova objectstore. Supports S3 API.
 """
 
+import os
+import sys
+
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import flags
 from nova import utils
 from nova import twistd

=== modified file 'bin/nova-volume'
--- bin/nova-volume	2010-08-19 00:39:12 +0000
+++ bin/nova-volume	2010-09-08 09:29:39 +0000
@@ -21,6 +21,17 @@
   Twistd daemon for the nova volume nodes.
 """
 
+import os
+import sys
+
+# If ../nova/__init__.py exists, add ../ to Python search path, so that
+# it will override what happens to be installed in /usr/(local/)lib/python...
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir,
+                                   os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
 from nova import twistd
 from nova.volume import service