[libvirt] [PATCH 06/11] docs: rewrite augest test generator in Python

[Daniel P. Berrangé]

As part of an goal to eliminate Perl from libvirt build tools,
rewrite the augeas-gentest.pl tool in Python.

This was a straight conversion, manually going line-by-line to
change the syntax from Perl to Python. Thus the overall structure
of the file and approach is the same.

Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
---
 Makefile.am                 |  2 +-
 build-aux/augeas-gentest.pl | 60 -------------------------------
 build-aux/augeas-gentest.py | 72 +++++++++++++++++++++++++++++++++++++
 src/Makefile.am             |  2 +-
 4 files changed, 74 insertions(+), 62 deletions(-)
 delete mode 100755 build-aux/augeas-gentest.pl
 create mode 100755 build-aux/augeas-gentest.py

diff --git a/Makefile.am b/Makefile.am
index cf9ff94f4f..e909d29d10 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -41,7 +41,7 @@ EXTRA_DIST = \
   run.in \
   README.md \
   AUTHORS.in \
-  build-aux/augeas-gentest.pl \
+  build-aux/augeas-gentest.py \
   build-aux/check-spacing.pl \
   build-aux/gitlog-to-changelog \
   build-aux/header-ifdef.pl \
diff --git a/build-aux/augeas-gentest.pl b/build-aux/augeas-gentest.pl
deleted file mode 100755
index 65834b533b..0000000000
--- a/build-aux/augeas-gentest.pl
+++ /dev/null
@@ -1,60 +0,0 @@
-#!/usr/bin/env perl
-#
-# augeas-gentest.pl: Generate an augeas test file, from an
-#                    example config file + test file template
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library 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
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library.  If not, see
-# <http://www.gnu.org/licenses/>.
-
-use strict;
-use warnings;
-
-die "syntax: $0 CONFIG TEMPLATE\n" unless @ARGV == 2;
-
-my $config = shift @ARGV;
-my $template = shift @ARGV;
-
-open CONFIG, "<", $config or die "cannot read $config: $!";
-open TEMPLATE, "<", $template or die "cannot read $template: $!";
-
-my $group = 0;
-while (<TEMPLATE>) {
-    if (/\@CONFIG\@/) {
-        my $group = 0;
-        print "  let conf = \"";
-        while (<CONFIG>) {
-            if (/^#\w/) {
-                s/^#//;
-                s/\"/\\\"/g;
-                print $_;
-                $group = /\[\s$/;
-            } elsif ($group) {
-                s/\"/\\\"/g;
-                if (/#\s*\]/) {
-                    $group = 0;
-                }
-                if (/^#/) {
-                    s/^#//;
-                    print $_;
-                }
-            }
-        }
-        print "\"\n";
-    } else {
-        print $_;
-    }
-}
-
-close TEMPLATE;
-close CONFIG;
diff --git a/build-aux/augeas-gentest.py b/build-aux/augeas-gentest.py
new file mode 100755
index 0000000000..b7f343ef42
--- /dev/null
+++ b/build-aux/augeas-gentest.py
@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2012-2019 Red Hat, Inc.
+#
+# augeas-gentest.py: Generate an augeas test file, from an
+#                    example config file + test file template
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library.  If not, see
+# <http://www.gnu.org/licenses/>.
+
+from __future__ import print_function
+
+import re
+import sys
+
+if len(sys.argv) != 3:
+    print("syntax: %s CONFIG TEMPLATE" % sys.argv[0], file=sys.stderr)
+    sys.exit(1)
+
+config = sys.argv[1]
+template = sys.argv[2]
+
+def expand_config(config):
+    with open(config) as fh:
+        optprog = re.compile(r'''^#\w.*''')
+        groupstartprog = re.compile(r'''.*\[\s$''')
+        groupendprog = re.compile(r'''#\s*\].*$''')
+
+        group = False
+        for line in fh:
+            if optprog.match(line) is not None:
+                line = line[1:]
+                line = line.replace('"', '\\"')
+                print(line, end='')
+                if groupstartprog.match(line):
+                    group = True
+            elif group:
+                line = line.replace('"', '\\"')
+
+                if groupendprog.match(line):
+                    group = False
+
+                if line[0] == '#':
+                    line = line[1:]
+                    print(line, end='')
+
+
+def expand_template(template, config):
+    with open(template) as fh:
+        group = 0
+
+        markerprog = re.compile(r'''\s*@CONFIG@\s*''')
+        for line in fh:
+            if markerprog.match(line) is not None:
+                print('   let conf = "', end='')
+                expand_config(config)
+                print('"')
+            else:
+                print(line, end='')
+
+expand_template(template, config)
diff --git a/src/Makefile.am b/src/Makefile.am
index 1724b3b809..716c2000e2 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -422,7 +422,7 @@ check-augeas: $(augeas_DATA) $(augeastest_DATA)
 	fi
 .PHONY: check-augeas
 
-AUG_GENTEST = $(PERL) $(top_srcdir)/build-aux/augeas-gentest.pl
+AUG_GENTEST = $(PYTHON) $(top_srcdir)/build-aux/augeas-gentest.py
 
 
 #
-- 
2.21.0