Merge lp:~mterry/pkgme/autoconf-helpers into lp:pkgme

[Michael Terry]

We've talked about allowing a series of helper functions or programs for dealing with autotools projects (and maybe similar helper utilities for other build systems too).

I've taken the liberty of refactoring the vala backend autoconf code into several autoconf helper programs.

This should ease the burden of creating future autoconf-based backends.

[lp:~mterry/pkgme/autoconf-helpers]

51. By Michael Terry on 2011-02-14

whoops, remove some debugging code

[James Westby (james-w)]

Hi,

That's a nice simple change, thanks.

I wonder if we want a set of helpers, or we want these to be part of an autoconf
backend?

We could make it possible for the vala backend to query the autoconf backend for
these values.

Thanks,

James

review: Needs Information

[Michael Terry (mterry)]

I'm not sure if an autoconf backend would be useful on its own? Plus, helper scripts have the possibility of doing more than just the set of backend functions (e.g. the pkgme_autoconf_initfield helper script).

I could maybe imagine a need for non-build-system-related helper scripts in future...? In which case, where to put them?

If you were thinking it might eventually be useful for inheritance, I would disagree, as a backend like vala may eventually want to support other build systems (e.g. cmake) too and that would be difficult with inheritance.

[James Westby (james-w)]

Hi,

Sorry for the delay. You make good points, so I refactored some of the code
to reduce some duplication (that was already there), and merged.

Thanks,

James

review: Approve

=== modified file 'pkgme/backend.py'
--- pkgme/backend.py	2011-02-05 21:06:45 +0000
+++ pkgme/backend.py	2011-02-14 20:14:26 +0000
@@ -118,11 +118,14 @@
         script_path = os.path.join(
             os.path.abspath(self.basepath), self.WANT_SCRIPT_NAME)
         if os.path.exists(script_path):
+            helperpath = os.path.join(os.path.dirname(os.path.dirname(self.basepath)), 'helpers')
+            env = os.environ.copy()
+            env['PATH'] = env['PATH'] + ':' + helperpath if 'PATH' in env else helperpath
             try:
                 proc = subprocess.Popen(
                     [script_path], stdout=subprocess.PIPE,
                     stderr=subprocess.STDOUT, stdin=subprocess.PIPE,
-                    cwd=path)
+                    cwd=path, env=env)
             except OSError as e:
                 if e.errno == errno.ENOENT:
                     raise ExternalHelperFailed(

=== modified file 'pkgme/backends/vala/homepage'
--- pkgme/backends/vala/homepage	2010-11-12 17:57:49 +0000
+++ pkgme/backends/vala/homepage	2011-02-14 20:14:26 +0000
@@ -1,7 +1,7 @@
 #!/bin/sh
 # -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
 #
-# © 2010 Canonical Ltd
+# © 2010,2011 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,33 +18,4 @@
 # Authors: Michael Terry <[e-mail]>
 # =====================================================================
 
-# The homepage may be in AC_INIT, in the 5th field
-# AC_INIT([Example Project],[1.0],[http://bugs.example.com/],[example-project],[http://example.com/])
-
-CONFIG_NAME=configure.ac
-if [ ! -e "$CONFIG_NAME" ]; then
-  CONFIG_NAME=configure.in
-  if [ ! -e "$CONFIG_NAME" ]; then
-    # not an autotools project
-    exit 0
-  fi
-fi
-
-acinit=$(grep --max-count=1 AC_INIT "$CONFIG_NAME" 2>/dev/null)
-
-initfield() {
-  rv=$(echo $1 | sed 's/AC_INIT//')
-  rv=$(echo $rv | cut -d, -f"$2")
-  # Find end (either , or ending ')')
-  rv=$(echo $rv | sed 's/[[( ]*\([^,)]*\).*/\1/')
-  # chop off ending odd characters
-  rv=$(echo $rv | sed 's/[] ]*$//')
-  echo $rv
-}
-
-tarname=$(initfield "$acinit" 5)
-if [ -n "$tarname" ]; then
-  echo "$tarname"
-fi
-
-exit 0
+pkgme_autoconf_homepage

=== modified file 'pkgme/backends/vala/package_name'
--- pkgme/backends/vala/package_name	2010-11-12 17:57:49 +0000
+++ pkgme/backends/vala/package_name	2011-02-14 20:14:26 +0000
@@ -1,7 +1,7 @@
 #!/bin/sh
 # -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
 #
-# © 2010 Canonical Ltd
+# © 2010,2011 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,45 +18,4 @@
 # Authors: Michael Terry <[e-mail]>
 # =====================================================================
 
-CONFIG_NAME=configure.ac
-if [ ! -e "$CONFIG_NAME" ]; then
-  CONFIG_NAME=configure.in
-  if [ ! -e "$CONFIG_NAME"]; then
-    # not an autotools project.  Don't know how to grab name
-    exit 0
-  fi
-fi
-
-# So this could be set up multiple ways.
-# AC_INIT([Example Project],[1.0],[http://bugs.example.com/],[example-project],[http://example.com/])
-# AC_INIT([Example Project],[1.0])
-# First is easy, we just grab the 4th field.  Second is harder, and requires us
-# to simplify the string as autoconf would.
-
-acinit=$(grep --max-count=1 AC_INIT "$CONFIG_NAME" 2>/dev/null)
-
-initfield() {
-  rv=$(echo $1 | sed 's/AC_INIT//')
-  rv=$(echo $rv | cut -d, -f"$2")
-  # Find end (either , or ending ')')
-  rv=$(echo $rv | sed 's/[[( ]*\([^,)]*\).*/\1/')
-  # chop off ending odd characters
-  rv=$(echo $rv | sed 's/[] ]*$//')
-  echo $rv
-}
-
-tarname=$(initfield "$acinit" 4)
-if [ -n "$tarname" ]; then
-  echo "$tarname"
-  exit 0
-fi
-
-# Now we mangle the project name into a tarball name. From the autoconf manual:
-# "... with `GNU ' stripped, lower-cased, and all characters
-#  other than alphanumerics and underscores are changed to `-'."
-
-pkgname=$(initfield "$acinit" 1)
-pkgname=$(echo $pkgname | sed 's/^GNU //')
-pkgname=$(echo $pkgname | tr [:upper:] [:lower:])
-pkgname=$(echo -n $pkgname | tr -c [:alnum:]_ -)
-echo $pkgname
+pkgme_autoconf_package_name

=== modified file 'pkgme/backends/vala/want'
--- pkgme/backends/vala/want	2010-11-12 17:57:49 +0000
+++ pkgme/backends/vala/want	2011-02-14 20:14:26 +0000
@@ -1,7 +1,7 @@
 #!/bin/sh
 # -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
 #
-# © 2010 Canonical Ltd
+# © 2010,2011 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -27,13 +27,10 @@
   exit 0
 }
 
-CONFIG_NAME=configure.ac
-if [ ! -e "$CONFIG_NAME" ]; then
-  CONFIG_NAME=configure.in
-  if [ ! -e "$CONFIG_NAME" ]; then
-    # not an autotools project
-    end 0
-  fi
+# Require autoconf for now
+CONFIG_NAME=$(pkgme_autoconf_config)
+if [ -z "$CONFIG_NAME" ]; then
+  end 0
 fi
 
 # Scan toplevel and immediate subdirectories for Vala files

=== added directory 'pkgme/helpers'
=== added file 'pkgme/helpers/pkgme_autoconf_config'
--- pkgme/helpers/pkgme_autoconf_config	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_config	2011-02-14 20:14:26 +0000
@@ -0,0 +1,31 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+CONFIG_NAME=configure.ac
+if [ ! -e "$CONFIG_NAME" ]; then
+  CONFIG_NAME=configure.in
+  if [ ! -e "$CONFIG_NAME" ]; then
+    # not an autotools project
+    exit 0
+  fi
+fi
+
+echo "$CONFIG_NAME"
+exit 0

=== added file 'pkgme/helpers/pkgme_autoconf_description'
--- pkgme/helpers/pkgme_autoconf_description	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_description	2011-02-14 20:14:26 +0000
@@ -0,0 +1,29 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+# There isn't a well-defined location for a description in autoconf packages.
+# So just look in several common places.
+
+if [ -e "README" ]; then
+  cat README
+elif [ -e "README.txt" ]; then
+  cat README.txt
+fi
+exit 0

=== added file 'pkgme/helpers/pkgme_autoconf_homepage'
--- pkgme/helpers/pkgme_autoconf_homepage	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_homepage	2011-02-14 20:14:26 +0000
@@ -0,0 +1,23 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+# The homepage is the 5th field of AC_INIT
+pkgme_autoconf_initfield 5
+exit 0

=== added file 'pkgme/helpers/pkgme_autoconf_initfield'
--- pkgme/helpers/pkgme_autoconf_initfield	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_initfield	2011-02-14 20:14:26 +0000
@@ -0,0 +1,39 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+# Usage: pkgme_autoconf_initfield FIELD
+
+# Example AC_INIT line:
+# AC_INIT([Example Project],[1.0],[http://bugs.example.com/],[example-project],[http://example.com/])
+
+CONFIG_NAME=$(pkgme_autoconf_config)
+if [ -z "$CONFIG_NAME" ]; then
+  exit 0
+fi
+
+acinit=$(grep --max-count=1 AC_INIT "$CONFIG_NAME" 2>/dev/null)
+rv=$(echo $acinit | sed 's/AC_INIT//')
+rv=$(echo $rv | cut -d, -f"$1")
+# Find end (either , or ending ')')
+rv=$(echo $rv | sed 's/[[( ]*\([^,)]*\).*/\1/')
+# chop off ending odd characters
+rv=$(echo $rv | sed 's/[] ]*$//')
+echo $rv
+exit 0

=== added file 'pkgme/helpers/pkgme_autoconf_maintainer'
--- pkgme/helpers/pkgme_autoconf_maintainer	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_maintainer	2011-02-14 20:14:26 +0000
@@ -0,0 +1,29 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+# There isn't a well-defined location for maintainer info in autoconf packages.
+# So just look in several common places.
+
+if [ -e "MAINTAINERS" ]; then
+  cat MAINTAINERS
+elif [ -e "AUTHORS" ]; then
+  cat AUTHORS
+fi
+exit 0

=== added file 'pkgme/helpers/pkgme_autoconf_package_name'
--- pkgme/helpers/pkgme_autoconf_package_name	1970-01-01 00:00:00 +0000
+++ pkgme/helpers/pkgme_autoconf_package_name	2011-02-14 20:14:26 +0000
@@ -0,0 +1,42 @@
+#!/bin/sh
+# -*- Mode: sh; indent-tabs-mode: nil; tab-width: 2 -*-
+#
+# © 2010,2011 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+# Authors: Michael Terry <[e-mail]>
+# =====================================================================
+
+# The package name could be set up multiple ways.
+# AC_INIT([Example Project],[1.0],[http://bugs.example.com/],[example-project],[http://example.com/])
+# AC_INIT([Example Project],[1.0])
+# First is easy; we just grab the 4th field.  Second is harder and requires us
+# to simplify the string as autoconf would.
+
+tarname=$(pkgme_autoconf_initfield 4)
+if [ -n "$tarname" ]; then
+  echo "$tarname"
+  exit 0
+fi
+
+# Now we mangle the project name into a tarball name. From the autoconf manual:
+# "... with `GNU ' stripped, lower-cased, and all characters
+#  other than alphanumerics and underscores are changed to `-'."
+
+pkgname=$(pkgme_autoconf_initfield 1)
+pkgname=$(echo "$pkgname" | sed 's/^GNU //')
+pkgname=$(echo "$pkgname" | tr [:upper:] [:lower:])
+pkgname=$(echo -n "$pkgname" | tr -c [:alnum:]_ -)
+echo "$pkgname"
+exit 0

=== modified file 'pkgme/project_info.py'
--- pkgme/project_info.py	2011-02-05 21:06:45 +0000
+++ pkgme/project_info.py	2011-02-14 20:14:26 +0000
@@ -41,11 +41,14 @@
     def get_all(self, keys):
         script_path = os.path.join(self.basepath, self.INFO_SCRIPT_NAME)
         if os.path.exists(script_path):
+            helperpath = os.path.join(os.path.dirname(os.path.dirname(self.basepath)), 'helpers')
+            env = os.environ.copy()
+            env['PATH'] = env['PATH'] + ':' + helperpath if 'PATH' in env else helperpath
             try:
                 proc = subprocess.Popen(
                     [script_path], stdout=subprocess.PIPE,
                     stderr=subprocess.STDOUT, stdin=subprocess.PIPE,
-                    cwd=self.cwd)
+                    cwd=self.cwd, env=env)
             except OSError as e:
                 if e.errno == errno.ENOENT:
                     raise ExternalHelperFailed(
@@ -65,11 +68,14 @@
     def _get(self, key):
         script_path = os.path.join(self.basepath, key)
         if os.path.exists(script_path):
+            helperpath = os.path.join(os.path.dirname(os.path.dirname(self.basepath)), 'helpers')
+            env = os.environ.copy()
+            env['PATH'] = env['PATH'] + ':' + helperpath if 'PATH' in env else helperpath
             try:
                 proc = subprocess.Popen(
                     [script_path], stdout=subprocess.PIPE,
                     stderr=subprocess.STDOUT, stdin=subprocess.PIPE,
-                    cwd=self.cwd)
+                    cwd=self.cwd, env=env)
             except OSError as e:
                 if e.errno == errno.ENOENT:
                     raise ExternalHelperFailed(