MSYS2: Add python script to generate a list of dependencies / check for missing dependencies of the installed distribution

1 files changed, 150 insertions, 0 deletions

diff --git a/msys2checkdeps.py b/msys2checkdeps.py
new file mode 100644
index 000000000..6578b4cad
--- /dev/null
+++ b/msys2checkdeps.py
@@ -0,0 +1,150 @@
+#!/usr/bin/env python
+# ------------------------------------------------------------------------------------------------------------------
+# list or check dependencies for binary distributions based on MSYS2 (requires the package mingw-w64-ntldd)
+#
+# Usage:
+#   python msys2checkdeps.py MODE PATH
+#
+#   MODE
+#     list         - list dependencies in human-readable form with full path and list of dependents
+#     list-compact - list dependencies in compact form (as a plain list of filenames)
+#     check        - check if all dependecies are present in PATH (or the parent directory of PATH if it is a file)
+#                    exits with error code 2 if missing dependecies are found and prints the list to stderr
+#
+#  PATH
+#     full or relative path to a single file or a directory to work on (directories will be checked recursively)
+# ------------------------------------------------------------------------------------------------------------------
+
+from __future__ import print_function
+
+
+import os
+import subprocess
+import sys
+
+
+class Dependency:
+    def __init__(self):
+        self.location = None
+        self.dependents = set()
+
+
+def warning(msg):
+    print("Warning: " + msg, file=sys.stderr)
+
+
+def error(msg):
+    print("Error: " + msg, file=sys.stderr)
+    exit(1)
+
+
+def call_ntldd(filename):
+    try:
+        output = subprocess.check_output(['ntldd', '-R', filename], stderr=subprocess.STDOUT)
+    except subprocess.CalledProcessError as e:
+        error("'ntldd' failed with '" + str(e) + "'")
+    except WindowsError as e:
+        error("Calling 'ntldd' failed with '" + str(e) + "' (have you installed 'mingw-w64-ntldd-git'?)")
+    except Exception as e:
+        error("Calling 'ntldd' failed with '" + str(e) + "'")
+    return output.decode('utf-8')
+
+
+def get_dependencies(filename, deps):
+    raw_list = call_ntldd(filename)
+
+    skip_indent = float('Inf')
+    parents = {}
+    parents[0] = os.path.basename(filename)
+    for line in raw_list.splitlines():
+        line = line[1:]
+        indent = len(line) - len(line.lstrip())
+        if indent > skip_indent:
+            continue
+        else:
+            skip_indent = float('Inf')
+
+        # if the dependency is not found in the working directory ntldd tries to find it on the search path
+        # which is indicated by the string '=>' followed by the determined location or 'not found'
+        if ('=>' in line):
+            (lib, location) = line.lstrip().split(' => ')
+            if location == 'not found':
+                location = None
+            else:
+                location = location.rsplit('(', 1)[0].strip()
+        else:
+            lib = line.rsplit('(', 1)[0].strip()
+            location = os.getcwd()
+
+        parents[indent+1] = lib
+
+        # we don't care about Microsoft libraries and their dependencies
+        if location and ':\\WINDOWS\\' in location:
+            skip_indent = indent
+            continue
+
+        if lib not in deps:
+            deps[lib] = Dependency()
+            deps[lib].location = location
+        deps[lib].dependents.add(parents[indent])
+    return deps
+
+
+def collect_dependencies(path):
+    # collect dependencies
+    #   - each key in 'deps' will be the filename of a dependency
+    #   - the corresponding value is an instance of class Dependency (containing full path and dependents)
+    deps = {}
+    if os.path.isfile(path):
+        os.chdir(os.path.dirname(path))
+        deps = get_dependencies(path, deps)
+    elif os.path.isdir(path):
+        os.chdir(path)
+        extensions = ['.exe', '.pyd', '.dll']
+        exclusions = ['python2.7/distutils/command/wininst']
+        for base, dirs, files in os.walk(path):
+            for f in files:
+                filepath = os.path.join(base, f)
+                (_, ext) = os.path.splitext(f)
+                if (ext.lower() not in extensions) or any(exclusion in filepath for exclusion in exclusions):
+                    continue
+                deps = get_dependencies(filepath, deps)
+    return deps
+
+
+if __name__ == '__main__':
+
+    # get mode from command line
+    mode = sys.argv[1]
+    modes = ['list', 'list-compact', 'check']
+    if mode not in modes:
+        error("First argument needs to be a valid mode (" + (', ').join(modes) + ").")
+
+    # get path from command line
+    path = sys.argv[2]
+    path = os.path.abspath(path)
+    if not os.path.exists(path):
+        error("Can't find file/folder '" + path + "'")
+
+    # get dependencies for path recursively
+    deps = collect_dependencies(path)
+
+    # print output / prepare exit code
+    exit_code = 0
+    for dep in sorted(deps):
+        location = deps[dep].location
+        dependents = deps[dep].dependents
+
+        if mode == 'list':
+            if (location is None):
+                location = '---MISSING---'
+            print(dep + " - " + location + " (" + ", ".join(dependents) + ")")
+        elif mode == 'list-compact':
+            print(dep)
+        elif mode == 'check':
+            root = path if os.path.isdir(path) else os.path.dirname(path)
+            if ((location is None) or (root not in os.path.abspath(location))):
+                warning("Missing dependency " + dep + " (" + ", ".join(dependents) + ")")
+                exit_code = 2
+
+    exit(exit_code)