scripts: consolidate code to find bitbake path

Several of these scripts were using duplicated code (and slightly
different methods) to find the path to bitbake and add its lib
subdirectory to the Python import path. Add some common code to do this
and change the scripts to use it.

Fixes [YOCTO #5076].

(From OE-Core rev: 0b5e94e168819134dcda0433c8ae893df4ab13ce)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

scripts/bitbake-whatchanged

@@ -27,18 +27,18 @@ import warnings
 import subprocess
 from optparse import OptionParser
 
+scripts_path = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])))
+lib_path = scripts_path + '/lib'
+sys.path = sys.path + [lib_path]
+
+import scriptpath
+
 # Figure out where is the bitbake/lib/bb since we need bb.siggen and bb.process
-p = subprocess.Popen("bash -c 'echo $(dirname $(which bitbake-diffsigs | grep -v \'^alias\'))/../lib'",
+bitbakepath = scriptpath.add_bitbake_lib_path()
-        shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+if not bitbakepath:
-
+    sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
-err = p.stderr.read()
-if err:
-    print("ERROR: Failed to locate bitbake-diffsigs:", file=sys.stderr)
-    print(err, file=sys.stderr)
     sys.exit(1)
 
-sys.path.insert(0, p.stdout.read().rstrip('\n'))
-
 import bb.siggen
 import bb.process
 

scripts/buildhistory-diff

@@ -50,24 +50,20 @@ def main():
         parser.print_help()
         sys.exit(1)
 
-    # Set path to OE lib dir so we can import the buildhistory_analysis module
+    scripts_path = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])))
-    basepath = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])) + '/..')
+    lib_path = scripts_path + '/lib'
-    newpath = basepath + '/meta/lib'
+    sys.path = sys.path + [lib_path]
-    # Set path to bitbake lib dir so the buildhistory_analysis module can load bb.utils
+
-    if os.path.exists(basepath + '/bitbake/lib/bb'):
+    import scriptpath
-        bitbakepath = basepath + '/bitbake'
+
-    else:
+    # Set path to OE lib dir so we can import the buildhistory_analysis module
-        # look for bitbake/bin dir in PATH
+    scriptpath.add_oe_lib_path()
-        bitbakepath = None
+    # Set path to bitbake lib dir so the buildhistory_analysis module can load bb.utils
-        for pth in os.environ['PATH'].split(':'):
+    bitbakepath = scriptpath.add_bitbake_lib_path()
-            if os.path.exists(os.path.join(pth, '../lib/bb')):
+    if not bitbakepath:
-                bitbakepath = os.path.abspath(os.path.join(pth, '..'))
+        sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
-                break
+        sys.exit(1)
-        if not bitbakepath:
-            sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
-            sys.exit(1)
 
-    sys.path[0:0] = [newpath, bitbakepath + '/lib']
     import oe.buildhistory_analysis
 
     fromrev = 'build-minus-1'

scripts/contrib/list-packageconfig-flags.py

@@ -23,26 +23,19 @@ import sys
 import getopt
 import os
 
-def search_bitbakepath():
-    bitbakepath = ""
 
-    # Search path to bitbake lib dir in order to load bb modules
+scripts_path = os.path.abspath(os.path.dirname(os.path.abspath(sys.argv[0])))
-    if os.path.exists(os.path.join(os.path.dirname(sys.argv[0]), '../../bitbake/lib/bb')):
+lib_path = os.path.abspath(scripts_path + '/../lib')
-        bitbakepath = os.path.join(os.path.dirname(sys.argv[0]), '../../bitbake/lib')
+sys.path = sys.path + [lib_path]
-        bitbakepath = os.path.abspath(bitbakepath)
+
-    else:
+import scriptpath
-        # Look for bitbake/bin dir in PATH
-        for pth in os.environ['PATH'].split(':'):
-            if os.path.exists(os.path.join(pth, '../lib/bb')):
-                bitbakepath = os.path.abspath(os.path.join(pth, '../lib'))
-                break
-        if not bitbakepath:
-            sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
-            sys.exit(1)
-    return bitbakepath
 
 # For importing the following modules
-sys.path.insert(0, search_bitbakepath())
+bitbakepath = scriptpath.add_bitbake_lib_path()
+if not bitbakepath:
+    sys.stderr.write("Unable to find bitbake by searching parent directory of this script or PATH\n")
+    sys.exit(1)
+
 import bb.cache
 import bb.cooker
 import bb.providers

scripts/lib/scriptpath.py

@@ -0,0 +1,42 @@
+# Path utility functions for OE python scripts
+#
+# Copyright (C) 2012-2014 Intel Corporation
+# Copyright (C) 2011 Mentor Graphics Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 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 warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+import sys
+import os
+import os.path
+
+def add_oe_lib_path():
+    basepath = os.path.abspath(os.path.dirname(__file__) + '/../..')
+    newpath = basepath + '/meta/lib'
+    sys.path.insert(0, newpath)
+
+def add_bitbake_lib_path():
+    basepath = os.path.abspath(os.path.dirname(__file__) + '/../..')
+    bitbakepath = None
+    if os.path.exists(basepath + '/bitbake/lib/bb'):
+        bitbakepath = basepath + '/bitbake'
+    else:
+        # look for bitbake/bin dir in PATH
+        for pth in os.environ['PATH'].split(':'):
+            if os.path.exists(os.path.join(pth, '../lib/bb')):
+                bitbakepath = os.path.abspath(os.path.join(pth, '..'))
+                break
+
+    if bitbakepath:
+        sys.path.insert(0, bitbakepath + '/lib')
+    return bitbakepath