tests: Convert soexpand build tool from Perl to Python.

Perl is unfashionable and Python is more widely available and understood,
so this commit converts one of the OVS uses of Perl into Python.

Signed-off-by: Ben Pfaff <[email protected]>
Acked-by: Aaron Conole <[email protected]>

Makefile.am

@@ -88,7 +88,7 @@ EXTRA_DIST = \
 	build-aux/dist-docs \
 	build-aux/dpdkstrip.py \
 	build-aux/sodepends.pl \
-	build-aux/soexpand.pl \
+	build-aux/soexpand.py \
 	build-aux/xml2nroff \
 	$(MAN_FRAGMENTS) \
 	$(MAN_ROOTS) \
@@ -144,7 +144,7 @@ ro_shell = printf '\043 Generated automatically -- do not modify!    -*- buffer-
 
 SUFFIXES += .in
 .in:
-	$(AM_V_GEN)$(PERL) $(srcdir)/build-aux/soexpand.pl -I$(srcdir) < $< | \
+	$(AM_V_GEN)PYTHONPATH=$$PYTHONPATH:$(srcdir)/python $(PYTHON) $(srcdir)/build-aux/soexpand.py -I$(srcdir) < $< | \
 	  $(PYTHON) $(srcdir)/build-aux/dpdkstrip.py $(DPDKSTRIP_FLAGS) | \
 	  sed \
 	    -e 's,[@]PKIDIR[@],$(PKIDIR),g' \

build-aux/automake.mk

@@ -1,4 +1,5 @@
 # This file is purely used for checking the style of the python build tools.
 FLAKE8_PYFILES += \
     $(srcdir)/build-aux/xml2nroff \
-    build-aux/dpdkstrip.py
+    build-aux/dpdkstrip.py \
+    build-aux/soexpand.py

build-aux/soexpand.py

@@ -0,0 +1,59 @@
+#! /usr/bin/env python
+
+# Copyright (c) 2008, 2017 Nicira, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from build import soutil
+import sys
+
+
+def soexpand(include_dirs, src, dst):
+    ok = True
+    while True:
+        line = src.readline()
+        if not line:
+            break
+
+        name = soutil.extract_include_directive(line)
+        if name:
+            fn = soutil.find_file(include_dirs, name)
+            if fn:
+                try:
+                    f = open(fn)
+                    while True:
+                        inner = f.readline()
+                        if not inner:
+                            break
+                        dst.write(inner)
+                except IOError as e:
+                    sys.stderr.write("%s: open: %s\n" % (fn, e.strerror))
+                    ok = False
+                continue
+            else:
+                ok = False
+
+        dst.write(line)
+    return ok
+
+
+if __name__ == '__main__':
+    include_dirs, args = soutil.parse_include_dirs()
+    if args:
+        error = False
+        for arg in args:
+            if not soexpand(include_dirs, open(arg), sys.stdout):
+                error = True
+    else:
+        error = not soexpand(include_dirs, sys.stdin, sys.stdout)
+    sys.exit(1 if error else 0)

python/automake.mk

@@ -41,7 +41,8 @@ ovs_pyfiles = \
 # so they are not installed.
 EXTRA_DIST += \
 	python/build/__init__.py \
-	python/build/nroff.py
+	python/build/nroff.py \
+	python/build/soutil.py
 
 # PyPI support.
 EXTRA_DIST += \

python/build/soutil.py

@@ -0,0 +1,56 @@
+#! /usr/bin/env python
+
+# Copyright (c) 2008, 2017 Nicira, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import getopt
+import os
+import re
+import sys
+
+
+def parse_include_dirs():
+    include_dirs = []
+    options, args = getopt.gnu_getopt(sys.argv[1:], 'I:', ['include='])
+    for key, value in options:
+        if key in ['-I', '--include']:
+            include_dirs.append(value)
+        else:
+            assert False
+
+    include_dirs.append('.')
+    return include_dirs, args
+
+
+def find_file(include_dirs, name):
+    for dir in include_dirs:
+        file = "%s/%s" % (dir, name)
+        try:
+            os.stat(file)
+            return file
+        except OSError:
+            pass
+    sys.stderr.write("%s not found in: %s\n" % (name, ' '.join(include_dirs)))
+    return None
+
+
+so_re = re.compile(r'^\.so (\S+)$')
+
+
+def extract_include_directive(line):
+    m = so_re.match(line)
+    if m:
+        return m.group(1)
+    else:
+        return None