From: Joey Hess Date: Sun, 28 Jun 2009 20:27:53 +0000 (-0400) Subject: Merge branch 'master' into buildsystems X-Git-Tag: 7.3.0~24 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=13e1de542d940506fdad6f14620131310bd8ec11;hp=63a9ae5d8a3af3d8c707187fb7cb55d55533a7df;p=debhelper.git Merge branch 'master' into buildsystems Conflicts: dh_auto_install --- diff --git a/Debian/Debhelper/Buildsystem.pm b/Debian/Debhelper/Buildsystem.pm new file mode 100644 index 0000000..3ee37a5 --- /dev/null +++ b/Debian/Debhelper/Buildsystem.pm @@ -0,0 +1,377 @@ +# Defines debhelper build system class interface and implementation +# of common functionality. +# +# Copyright: © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem; + +use strict; +use warnings; +use Cwd (); +use File::Spec; +use Debian::Debhelper::Dh_Lib; + +# Cache DEB_BUILD_GNU_TYPE value. Performance hit of multiple +# invocations is noticable when listing build systems. +our $DEB_BUILD_GNU_TYPE = dpkg_architecture_value("DEB_BUILD_GNU_TYPE"); + +# Build system name. Defaults to the last component of the class +# name. Do not override this method unless you know what you are +# doing. +sub NAME { + my $this=shift; + my $class = ref($this) || $this; + if ($class =~ m/^.+::([^:]+)$/) { + return $1; + } + else { + error("ınvalid build system class name: $class"); + } +} + +# Description of the build system to be shown to the users. +sub DESCRIPTION { + error("class lacking a DESCRIPTION"); +} + +# Default build directory. Can be overriden in the derived +# class if really needed. +sub DEFAULT_BUILD_DIRECTORY { + "obj-" . $DEB_BUILD_GNU_TYPE; +} + +# Constructs a new build system object. Named parameters: +# - sourcedir- specifies source directory (relative to the current (top) +# directory) where the sources to be built live. If not +# specified or empty, defaults to the current directory. +# - builddir - specifies build directory to use. Path is relative to the +# current (top) directory. If undef or empty, +# DEFAULT_BUILD_DIRECTORY directory will be used. +# Derived class can override the constructor to initialize common object +# parameters. Do NOT use constructor to execute commands or otherwise +# configure/setup build environment. There is absolutely no guarantee the +# constructed object will be used to build something. Use pre_building_step(), +# $build_step() or post_building_step() methods for this. +sub new { + my ($class, %opts)=@_; + + my $this = bless({ sourcedir => '.', + builddir => undef, }, $class); + + if (exists $opts{sourcedir}) { + # Get relative sourcedir abs_path (without symlinks) + my $curdir = Cwd::getcwd(); + my $abspath = Cwd::abs_path($opts{sourcedir}); + if (! -d $abspath || $abspath !~ /^\Q$curdir\E/) { + error("invalid or non-existing path to the source directory: ".$opts{sourcedir}); + } + $this->{sourcedir} = File::Spec->abs2rel($abspath, $curdir); + } + if (exists $opts{builddir}) { + $this->_set_builddir($opts{builddir}); + } + return $this; +} + +# Private method to set a build directory. If undef, use default. +# Do $this->{builddir} = undef or pass $this->get_sourcedir() to +# unset the build directory. +sub _set_builddir { + my $this=shift; + my $builddir=shift; + $this->{builddir} = ($builddir) ? $builddir : $this->DEFAULT_BUILD_DIRECTORY; + + # Canonicalize. If build directory ends up the same as source directory, drop it + if (defined $this->{builddir}) { + $this->{builddir} = $this->_canonpath($this->{builddir}); + if ($this->{builddir} eq $this->get_sourcedir()) { + $this->{builddir} = undef; + } + } +} + +# This instance method is called to check if the build system is capable +# to auto build a source package. Additional argument $step describes +# which operation the caller is going to perform (either configure, +# build, test, install or clean). You must override this method for the +# build system module to be ever picked up automatically. This method is +# used in conjuction with @Dh_Buildsystems::BUILDSYSTEMS. +# +# This method is supposed to be called with source root directory being +# working directory. Use $this->get_buildpath($path) method to get full +# path to the files in the build directory. +sub check_auto_buildable { + my $this=shift; + my ($step) = @_; + return 0; +} + +# Derived class can call this method in its constructor +# to enforce in source building even if the user requested otherwise. +sub enforce_in_source_building { + my $this=shift; + if ($this->get_builddir()) { + $this->{warn_insource} = 1; + $this->{builddir} = undef; + } +} + +# Derived class can call this method in its constructor to enforce +# out of source building even if the user didn't request it. However, +# if 'builddir' named parameter is passed, accept its value as the +# build directory even if it matches the source directory (meaning out +# of source is only prefered to in source, not enforced). +sub enforce_out_of_source_building { + my $this=shift; + my %args=@_; + if (!defined $this->get_builddir()) { + $this->_set_builddir($args{builddir}); + if (!defined $this->get_builddir() && !$args{builddir}) { + # If we are here, DEFAULT_BUILD_DIRECTORY matches + # the source directory, building might fail. + error("default build directory is the same as the source directory." . + " Please specify a custom build directory"); + } + } +} + +# Enhanced version of File::Spec::canonpath. It collapses .. +# too so it may return invalid path if symlinks are involved. +# On the other hand, it does not need for the path to exist. +sub _canonpath { + my ($this, $path)=@_; + my @canon; + my $back=0; + for my $comp (split(m%/+%, $path)) { + if ($comp eq '.') { + next; + } + elsif ($comp eq '..') { + if (@canon > 0) { pop @canon; } else { $back++; } + } + else { + push @canon, $comp; + } + } + return (@canon + $back > 0) ? join('/', ('..')x$back, @canon) : '.'; +} + +# Given both $path and $base are relative to the same directory, +# converts and returns path of $path being relative the $base. +sub _rel2rel { + my ($this, $path, $base, $root)=@_; + $root = "/tmp" if !defined $root; + + return File::Spec->abs2rel( + File::Spec->rel2abs($path, $root), + File::Spec->rel2abs($base, $root) + ); +} + +# Get path to the source directory +# (relative to the current (top) directory) +sub get_sourcedir { + my $this=shift; + return $this->{sourcedir}; +} + +# Convert path relative to the source directory to the path relative +# to the current (top) directory. +sub get_sourcepath { + my ($this, $path)=@_; + return File::Spec->catfile($this->get_sourcedir(), $path); +} + +# Get path to the build directory if it was specified +# (relative to the current (top) directory). undef if the same +# as the source directory. +sub get_builddir { + my $this=shift; + return $this->{builddir}; +} + +# Convert path that is relative to the build directory to the path +# that is relative to the current (top) directory. +# If $path is not specified, always returns build directory path +# relative to the current (top) directory regardless if builddir was +# specified or not. +sub get_buildpath { + my ($this, $path)=@_; + my $builddir = $this->get_builddir() || $this->get_sourcedir(); + if (defined $path) { + return File::Spec->catfile($builddir, $path); + } + return $builddir; +} + +# When given a relative path to the source directory, converts it +# to the path that is relative to the build directory. If $path is +# not given, returns a path to the source directory that is relative +# to the build directory. +sub get_source_rel2builddir { + my $this=shift; + my $path=shift; + + my $dir = '.'; + if ($this->get_builddir()) { + $dir = $this->_rel2rel($this->get_sourcedir(), $this->get_builddir()); + } + if (defined $path) { + return File::Spec->catfile($dir, $path); + } + return $dir; +} + +# When given a relative path to the build directory, converts it +# to the path that is relative to the source directory. If $path is +# not given, returns a path to the build directory that is relative +# to the source directory. +sub get_build_rel2sourcedir { + my $this=shift; + my $path=shift; + + my $dir = '.'; + if ($this->get_builddir()) { + $dir = $this->_rel2rel($this->get_builddir(), $this->get_sourcedir()); + } + if (defined $path) { + return File::Spec->catfile($dir, $path); + } + return $dir; +} + +# Creates a build directory. +sub mkdir_builddir { + my $this=shift; + if ($this->get_builddir()) { + doit("mkdir", "-p", $this->get_builddir()); + } +} + +sub _cd { + my ($this, $dir)=@_; + if (! $dh{NO_ACT}) { + verbose_print("cd $dir"); + chdir $dir or error("error: unable to chdir to $dir"); + } +} + +# Changes working directory to the source directory (if needed) +# calls doit(@_) and changes working directory back to the top +# directory. +sub doit_in_sourcedir { + my $this=shift; + if ($this->get_sourcedir() ne '.') { + my $sourcedir = $this->get_sourcedir(); + my $curdir = Cwd::getcwd(); + $this->_cd($sourcedir); + doit(@_); + $this->_cd($this->_rel2rel($curdir, $sourcedir, $curdir)); + } + else { + doit(@_); + } + return 1; +} + +# Changes working directory to the build directory (if needed), +# calls doit(@_) and changes working directory back to the top +# directory. +sub doit_in_builddir { + my $this=shift; + if ($this->get_buildpath() ne '.') { + my $buildpath = $this->get_buildpath(); + my $curdir = Cwd::getcwd(); + $this->_cd($buildpath); + doit(@_); + $this->_cd($this->_rel2rel($curdir, $buildpath, $curdir)); + } + else { + doit(@_); + } + return 1; +} + +# In case of out of source tree building, whole build directory +# gets wiped (if it exists) and 1 is returned. If build directory +# had 2 or more levels, empty parent directories are also deleted. +# If build directory does not exist, nothing is done and 0 is returned. +sub rmdir_builddir { + my $this=shift; + my $only_empty=shift; + if ($this->get_builddir()) { + my $buildpath = $this->get_buildpath(); + if (-d $buildpath && ! $dh{NO_ACT}) { + my @spdir = File::Spec->splitdir($this->get_build_rel2sourcedir()); + my $peek; + if (!$only_empty) { + doit("rm", "-rf", $buildpath); + pop @spdir; + } + # If build directory had 2 or more levels, delete empty + # parent directories until the source directory level. + while (($peek=pop(@spdir)) && $peek ne '.' && $peek ne '..') { + last if ! rmdir($this->get_sourcepath(File::Spec->catdir(@spdir, $peek))); + } + } + return 1; + } + return 0; +} + +# Instance method that is called before performing any step (see below). +# Action name is passed as an argument. Derived classes overriding this +# method should also call SUPER implementation of it. +sub pre_building_step { + my $this=shift; + my ($step)=@_; + + # Warn if in source building was enforced but build directory was + # specified. See enforce_in_source_building(). + if ($this->{warn_insource}) { + warning("warning: " . $this->NAME() . + " does not support building out of source tree. In source building enforced."); + delete $this->{warn_insource}; + } +} + +# Instance method that is called after performing any step (see below). +# Action name is passed as an argument. Derived classes overriding this +# method should also call SUPER implementation of it. +sub post_building_step { + my $this=shift; + my ($step)=@_; +} + +# The instance methods below provide support for configuring, +# building, testing, install and cleaning source packages. +# In case of failure, the method may just error() out. +# +# These methods should be overriden by derived classes to +# implement build system specific steps needed to build the +# source. Arbitary number of custom step arguments might be +# passed. Default implementations do nothing. +sub configure { + my $this=shift; +} + +sub build { + my $this=shift; +} + +sub test { + my $this=shift; +} + +# destdir parameter specifies where to install files. +sub install { + my $this=shift; + my $destdir=shift; +} + +sub clean { + my $this=shift; +} + +1; diff --git a/Debian/Debhelper/Buildsystem/autoconf.pm b/Debian/Debhelper/Buildsystem/autoconf.pm new file mode 100644 index 0000000..60fa9e8 --- /dev/null +++ b/Debian/Debhelper/Buildsystem/autoconf.pm @@ -0,0 +1,55 @@ +# A debhelper build system class for handling Autoconf based projects +# +# Copyright: © 2008 Joey Hess +# © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::autoconf; + +use strict; +use Debian::Debhelper::Dh_Lib qw(dpkg_architecture_value sourcepackage); +use base 'Debian::Debhelper::Buildsystem::makefile'; + +sub DESCRIPTION { + "GNU Autoconf (configure)" +} + +sub check_auto_buildable { + my $this=shift; + my ($step)=@_; + + # Handle configure; the rest - next class + if ($step eq "configure") { + return -x $this->get_sourcepath("configure"); + } + return 0; +} + +sub configure { + my $this=shift; + + # Standard set of options for configure. + my @opts; + push @opts, "--build=" . dpkg_architecture_value("DEB_BUILD_GNU_TYPE"); + push @opts, "--prefix=/usr"; + push @opts, "--includedir=\${prefix}/include"; + push @opts, "--mandir=\${prefix}/share/man"; + push @opts, "--infodir=\${prefix}/share/info"; + push @opts, "--sysconfdir=/etc"; + push @opts, "--localstatedir=/var"; + push @opts, "--libexecdir=\${prefix}/lib/" . sourcepackage(); + push @opts, "--disable-maintainer-mode"; + push @opts, "--disable-dependency-tracking"; + # Provide --host only if different from --build, as recommended in + # autotools-dev README.Debian: When provided (even if equal) + # autoconf 2.52+ switches to cross-compiling mode. + if (dpkg_architecture_value("DEB_BUILD_GNU_TYPE") + ne dpkg_architecture_value("DEB_HOST_GNU_TYPE")) { + push @opts, "--host=" . dpkg_architecture_value("DEB_HOST_GNU_TYPE"); + } + + $this->mkdir_builddir(); + $this->doit_in_builddir($this->get_source_rel2builddir("configure"), @opts, @_); +} + +1; diff --git a/Debian/Debhelper/Buildsystem/cmake.pm b/Debian/Debhelper/Buildsystem/cmake.pm new file mode 100644 index 0000000..5662874 --- /dev/null +++ b/Debian/Debhelper/Buildsystem/cmake.pm @@ -0,0 +1,45 @@ +# A debhelper build system class for handling CMake based projects. +# It prefers out of source tree building. +# +# Copyright: © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::cmake; + +use strict; +use base 'Debian::Debhelper::Buildsystem::makefile'; + +sub DESCRIPTION { + "CMake (CMakeLists.txt)" +} + +sub check_auto_buildable { + my $this=shift; + my ($step)=@_; + my $ret = -e $this->get_sourcepath("CMakeLists.txt"); + $ret &&= $this->SUPER::check_auto_buildable(@_) if $step ne "configure"; + return $ret; +} + +sub new { + my $class=shift; + my $this=$class->SUPER::new(@_); + # Prefer out of source tree building. + $this->enforce_out_of_source_building(@_); + return $this; +} + +sub configure { + my $this=shift; + my @flags; + + # Standard set of cmake flags + push @flags, "-DCMAKE_INSTALL_PREFIX=/usr"; + push @flags, "-DCMAKE_SKIP_RPATH=ON"; + push @flags, "-DCMAKE_VERBOSE_MAKEFILE=ON"; + + $this->mkdir_builddir(); + $this->doit_in_builddir("cmake", $this->get_source_rel2builddir(), @flags); +} + +1; diff --git a/Debian/Debhelper/Buildsystem/makefile.pm b/Debian/Debhelper/Buildsystem/makefile.pm new file mode 100644 index 0000000..d84d334 --- /dev/null +++ b/Debian/Debhelper/Buildsystem/makefile.pm @@ -0,0 +1,95 @@ +# A debhelper build system class for handling simple Makefile based projects. +# +# Copyright: © 2008 Joey Hess +# © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::makefile; + +use strict; +use Debian::Debhelper::Dh_Lib qw(escape_shell); +use base 'Debian::Debhelper::Buildsystem'; + +sub get_makecmd_C { + my $this=shift; + my $buildpath = $this->get_buildpath(); + if ($buildpath ne '.') { + return $this->{makecmd} . " -C " . escape_shell($buildpath); + } + return $this->{makecmd}; +} + +sub exists_make_target { + my ($this, $target) = @_; + my $makecmd=$this->get_makecmd_C(); + + # Use make -n to check to see if the target would do + # anything. There's no good way to test if a target exists. + my $ret=`$makecmd -s -n --no-print-directory $target 2>/dev/null`; + chomp $ret; + return length($ret); +} + +sub make_first_existing_target { + my $this=shift; + my $targets=shift; + + foreach my $target (@$targets) { + if ($this->exists_make_target($target)) { + $this->doit_in_builddir($this->{makecmd}, $target, @_); + return $target; + } + } + return undef; +} + +sub DESCRIPTION { + "simple Makefile" +} + +sub new { + my $class=shift; + my $this=$class->SUPER::new(@_); + $this->{makecmd} = (exists $ENV{MAKE}) ? $ENV{MAKE} : "make"; + return $this; +} + +sub check_auto_buildable { + my $this=shift; + my ($step) = @_; + + # Handles build, test, install, clean; configure - next class + if (grep /^\Q$step\E$/, qw{build test install clean}) { + # This is always called in the source directory, but generally + # Makefiles are created (or live) in the the build directory. + return -e $this->get_buildpath("Makefile") || + -e $this->get_buildpath("makefile") || + -e $this->get_buildpath("GNUmakefile"); + } + return 0; +} + +sub build { + my $this=shift; + $this->doit_in_builddir($this->{makecmd}, @_); +} + +sub test { + my $this=shift; + $this->make_first_existing_target(['test', 'check'], @_); +} + +sub install { + my $this=shift; + my $destdir=shift; + $this->make_first_existing_target(['install'], "DESTDIR=$destdir", @_); +} + +sub clean { + my $this=shift; + if (!$this->rmdir_builddir()) { + $this->make_first_existing_target(['distclean', 'realclean', 'clean'], @_); + } +} + +1; diff --git a/Debian/Debhelper/Buildsystem/perl_build.pm b/Debian/Debhelper/Buildsystem/perl_build.pm new file mode 100644 index 0000000..3567cb1 --- /dev/null +++ b/Debian/Debhelper/Buildsystem/perl_build.pm @@ -0,0 +1,67 @@ +# A build system class for handling Perl Build based projects. +# +# Copyright: © 2008-2009 Joey Hess +# © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::perl_build; + +use strict; +use base 'Debian::Debhelper::Buildsystem'; + +sub DESCRIPTION { + "Perl Module::Build (Build.PL)" +} + +sub check_auto_buildable { + my ($this, $step) = @_; + + # Handles everything + my $ret = -e $this->get_sourcepath("Build.PL"); + if ($step ne "configure") { + $ret &&= -e $this->get_sourcepath("Build"); + } + return $ret; +} + +sub do_perl { + my $this=shift; + $ENV{MODULEBUILDRC} = "/dev/null"; + $this->doit_in_sourcedir("perl", @_); +} + +sub new { + my $class=shift; + my $this= $class->SUPER::new(@_); + $this->enforce_in_source_building(); + return $this; +} + +sub configure { + my $this=shift; + $ENV{PERL_MM_USE_DEFAULT}=1; + $this->do_perl("Build.PL", "installdirs=vendor", @_); +} + +sub build { + my $this=shift; + $this->do_perl("Build", @_); +} + +sub test { + my $this=shift; + $this->do_perl("Build", "test", @_); +} + +sub install { + my $this=shift; + my $destdir=shift; + $this->do_perl("Build", "install", "destdir=$destdir", "create_packlist=0", @_); +} + +sub clean { + my $this=shift; + $this->do_perl("Build", "--allow_mb_mismatch", 1, "distclean", @_); +} + +1; diff --git a/Debian/Debhelper/Buildsystem/perl_makemaker.pm b/Debian/Debhelper/Buildsystem/perl_makemaker.pm new file mode 100644 index 0000000..07a827a --- /dev/null +++ b/Debian/Debhelper/Buildsystem/perl_makemaker.pm @@ -0,0 +1,64 @@ +# A debhelper build system class for handling Perl MakeMaker based projects. +# +# Copyright: © 2008-2009 Joey Hess +# © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::perl_makemaker; + +use strict; +use base 'Debian::Debhelper::Buildsystem::makefile'; + +sub DESCRIPTION { + "Perl ExtUtils::MakeMaker (Makefile.PL)" +} + +sub check_auto_buildable { + my $this=shift; + my ($step)=@_; + + # Handles everything if Makefile.PL exists. Otherwise - next class. + if (-e $this->get_sourcepath("Makefile.PL")) { + if ($step eq "install" || $step eq "configure") { + return 1; + } + else { + # This is backwards compatible (with << 7.3) until build, test and + # clean steps are not reimplemented in the backwards compatibility + # breaking way. However, this is absolutely necessary for + # enforce_in_source_building() to work in corner cases in build, + # test and clean steps as the next class (makefile) does not + # enforce it. + return $this->SUPER::check_auto_buildable(@_); + } + } + return 0; +} + +sub new { + my $class=shift; + my $this=$class->SUPER::new(@_); + $this->enforce_in_source_building(); + return $this; +} + +sub configure { + my $this=shift; + # If set to a true value then MakeMaker's prompt function will + # # always return the default without waiting for user input. + $ENV{PERL_MM_USE_DEFAULT}=1; + # This prevents Module::Install from interactive behavior. + $ENV{PERL_AUTOINSTALL}="--skipdeps"; + + $this->doit_in_sourcedir("perl", "Makefile.PL", "INSTALLDIRS=vendor", + "create_packlist=0", + @_); +} + +sub install { + my $this=shift; + my $destdir=shift; + $this->SUPER::install($destdir, "PREFIX=/usr", @_); +} + +1; diff --git a/Debian/Debhelper/Buildsystem/python_distutils.pm b/Debian/Debhelper/Buildsystem/python_distutils.pm new file mode 100644 index 0000000..39a4466 --- /dev/null +++ b/Debian/Debhelper/Buildsystem/python_distutils.pm @@ -0,0 +1,114 @@ +# A debhelper build system class for building Python Distutils based +# projects. It prefers out of source tree building. +# +# Copyright: © 2008 Joey Hess +# © 2008-2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Buildsystem::python_distutils; + +use strict; +use Cwd (); +use Debian::Debhelper::Dh_Lib qw(error); +use base 'Debian::Debhelper::Buildsystem'; + +sub DESCRIPTION { + "Python Distutils (setup.py)" +} + +sub DEFAULT_BUILD_DIRECTORY { + my $this=shift; + return $this->_canonpath($this->get_sourcepath("build")); +} + +sub new { + my $class=shift; + my $this=$class->SUPER::new(@_); + # Out of source tree building is prefered. + $this->enforce_out_of_source_building(@_); + return $this; +} + +sub check_auto_buildable { + my $this=shift; + return -e $this->get_sourcepath("setup.py"); +} + +sub not_our_cfg { + my $this=shift; + my $ret; + if (open(my $cfg, $this->get_buildpath(".pydistutils.cfg"))) { + $ret = not "# Created by dh_auto\n" eq <$cfg>; + close $cfg; + } + return $ret; +} + +sub create_cfg { + my $this=shift; + if (open(my $cfg, ">", $this->get_buildpath(".pydistutils.cfg"))) { + print $cfg "# Created by dh_auto", "\n"; + print $cfg "[build]\nbuild-base=", $this->get_build_rel2sourcedir(), "\n"; + close $cfg; + return 1; + } + return 0; +} + +sub pre_building_step { + my $this=shift; + my $step=shift; + + return unless grep /$step/, qw(build install clean); + + # --build-base can only be passed to the build command. However, + # it is always read from the config file (really weird design). + # Therefore create such a cfg config file. + if ($this->get_buildpath() ne $this->DEFAULT_BUILD_DIRECTORY()) { + not $this->not_our_cfg() or + error("cannot set custom build directory: .pydistutils.cfg is in use"); + $this->mkdir_builddir(); + $this->create_cfg() or + error("cannot set custom build directory: unwritable .pydistutils.cfg"); + # Distutils reads $HOME/.pydistutils.cfg + $ENV{HOME} = Cwd::abs_path($this->get_buildpath()); + } +} + +sub setup_py { + my $this=shift; + my $act=shift; + $this->doit_in_sourcedir("python", "setup.py", $act, @_); +} + +sub build { + my $this=shift; + $this->setup_py("build", @_); +} + +sub install { + my $this=shift; + my $destdir=shift; + $this->setup_py("install", + "--root=$destdir", + "--no-compile", + "-O0", + "--install-layout=deb", + @_); +} + +sub clean { + my $this=shift; + $this->setup_py("clean", "-a", @_); + + # Config file will remain if it was created by us + if (!$this->not_our_cfg()) { + unlink($this->get_buildpath(".pydistutils.cfg")); + $this->rmdir_builddir(1); # only if empty + } + # The setup.py might import files, leading to python creating pyc + # files. + $this->doit_in_sourcedir('find', '.', '-name', '*.pyc', '-exec', 'rm', '{}', ';'); +} + +1; diff --git a/Debian/Debhelper/Dh_Buildsystems.pm b/Debian/Debhelper/Dh_Buildsystems.pm new file mode 100644 index 0000000..d37c593 --- /dev/null +++ b/Debian/Debhelper/Dh_Buildsystems.pm @@ -0,0 +1,180 @@ +# A module for loading and managing debhelper build system classes. +# This module is intended to be used by all dh_auto_* programs. +# +# Copyright: © 2009 Modestas Vainius +# License: GPL-2+ + +package Debian::Debhelper::Dh_Buildsystems; + +use strict; +use warnings; +use Debian::Debhelper::Dh_Lib; +use File::Spec; + +use base 'Exporter'; +our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem &load_all_buildsystems); + +# Historical order must be kept for backwards compatibility. New +# build systems MUST be added to the END of the list. +our @BUILDSYSTEMS = ( + "autoconf", + "perl_makemaker", + "makefile", + "python_distutils", + "perl_build", + "cmake", +); + +my $opt_buildsys; +my $opt_sourcedir; +my $opt_builddir; +my $opt_list; + +sub create_buildsystem_instance { + my $system=shift; + my %bsopts=@_; + my $module = "Debian::Debhelper::Buildsystem::$system"; + + eval "use $module"; + if ($@) { + error("unable to load build system class '$system': $@"); + } + + if (!exists $bsopts{builddir} && defined $opt_builddir) { + $bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir; + } + if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) { + $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir; + } + return $module->new(%bsopts); +} + +# Similar to create_build system_instance(), but it attempts to autoselect +# a build system if none was specified. In case autoselection fails, undef +# is returned. +sub load_buildsystem { + my $system=shift; + my $step=shift; + if (defined $system) { + my $inst = create_buildsystem_instance($system, @_); + return $inst; + } + else { + # Try to determine build system automatically + for $system (@BUILDSYSTEMS) { + my $inst = create_buildsystem_instance($system, @_); + if ($inst->check_auto_buildable($step)) { + return $inst; + } + } + } + return; +} + +sub load_all_buildsystems { + my $incs=shift || \@INC; + my (%buildsystems, @buildsystems); + + for my $inc (@$incs) { + my $path = File::Spec->catdir($inc, "Debian/Debhelper/Buildsystem"); + if (-d $path) { + for my $module_path (glob "$path/*.pm") { + my $name = basename($module_path); + $name =~ s/\.pm$//; + next if exists $buildsystems{$name}; + $buildsystems{$name} = create_buildsystem_instance($name, @_); + } + } + } + + # Push standard debhelper build systems first + for my $name (@BUILDSYSTEMS) { + error("standard debhelper build system '$name' could not be found/loaded") + if not exists $buildsystems{$name}; + push @buildsystems, $buildsystems{$name}; + delete $buildsystems{$name}; + } + + # The rest are 3rd party build systems + for my $name (keys %buildsystems) { + my $inst = $buildsystems{$name}; + $inst->{thirdparty} = 1; + push @buildsystems, $inst; + } + + return @buildsystems; +} + +sub buildsystems_init { + my %args=@_; + + # Available command line options + my %options = ( + "D=s" => \$opt_sourcedir, + "sourcedirectory=s" => \$opt_sourcedir, + + "B:s" => \$opt_builddir, + "builddirectory:s" => \$opt_builddir, + + "S=s" => \$opt_buildsys, + "buildsystem=s" => \$opt_buildsys, + + "l" => \$opt_list, + "list" => \$opt_list, + ); + $args{options}{$_} = $options{$_} foreach keys(%options); + Debian::Debhelper::Dh_Lib::init(%args); +} + +sub buildsystems_list { + my $step=shift; + + # List build systems (including auto and specified status) + my ($auto, $specified); + my @buildsystems = load_all_buildsystems(); + for my $inst (@buildsystems) { + my $is_specified = defined $opt_buildsys && $opt_buildsys eq $inst->NAME(); + if (! defined $specified && defined $opt_buildsys && $opt_buildsys eq $inst->NAME()) { + $specified = $inst->NAME(); + } + elsif (! defined $auto && ! $inst->{thirdparty} && $inst->check_auto_buildable($step)) { + $auto = $inst->NAME(); + } + printf("%s - %s", $inst->NAME(), $inst->DESCRIPTION()); + print " [3rd party]" if $inst->{thirdparty}; + print "\n"; + } + print "\n"; + print "Auto-selected: $auto\n" if defined $auto; + print "Specified: $specified\n" if defined $specified; + print "No system auto-selected or specified\n" + if ! defined $auto && ! defined $specified; +} + +sub buildsystems_do { + my $step=shift; + + if (!defined $step) { + $step = basename($0); + $step =~ s/^dh_auto_//; + } + + if (grep(/^\Q$step\E$/, qw{configure build test install clean}) == 0) { + error("unrecognized build step: " . $step); + } + + if ($opt_list) { + buildsystems_list($step); + exit 0; + } + + my $buildsystem = load_buildsystem($opt_buildsys, $step); + if (defined $buildsystem) { + $buildsystem->pre_building_step($step); + $buildsystem->$step(@_, @{$dh{U_PARAMS}}); + $buildsystem->post_building_step($step); + } + return 0; +} + +1; diff --git a/Debian/Debhelper/Dh_Getopt.pm b/Debian/Debhelper/Dh_Getopt.pm index 864b168..9ca9d16 100644 --- a/Debian/Debhelper/Dh_Getopt.pm +++ b/Debian/Debhelper/Dh_Getopt.pm @@ -143,6 +143,12 @@ sub getoptions { ) } +sub split_options_string { + my $str=shift; + $str=~s/^\s+//; + return split(/\s+/,$str); +} + # Parse options and set %dh values. sub parseopts { my $options=shift; @@ -152,10 +158,7 @@ sub parseopts { # DH_INTERNAL_OPTIONS is used to pass additional options from # dh through an override target to a command. if (defined $ENV{DH_INTERNAL_OPTIONS}) { - $ENV{DH_INTERNAL_OPTIONS}=~s/^\s+//; - $ENV{DH_INTERNAL_OPTIONS}=~s/\s+$//; - @ARGV_extra=split(/\s+/,$ENV{DH_INTERNAL_OPTIONS}); - + @ARGV_extra=split_options_string($ENV{DH_INTERNAL_OPTIONS}); # Unknown options will be silently ignored. my $oldwarn=$SIG{__WARN__}; $SIG{__WARN__}=sub {}; @@ -184,9 +187,7 @@ sub parseopts { # to be parsed like @ARGV, but with unknown options # skipped. if (defined $ENV{DH_OPTIONS}) { - $ENV{DH_OPTIONS}=~s/^\s+//; - $ENV{DH_OPTIONS}=~s/\s+$//; - @ARGV_extra=split(/\s+/,$ENV{DH_OPTIONS}); + @ARGV_extra=split_options_string($ENV{DH_OPTIONS}); my $ret=getoptions(\@ARGV_extra, $options); if (!$ret) { warning("warning: ignored unknown options in DH_OPTIONS"); diff --git a/Debian/Debhelper/Dh_Lib.pm b/Debian/Debhelper/Dh_Lib.pm index f09c808..28a90f7 100644 --- a/Debian/Debhelper/Dh_Lib.pm +++ b/Debian/Debhelper/Dh_Lib.pm @@ -15,7 +15,8 @@ use vars qw(@ISA @EXPORT %dh); &filedoublearray &getpackages &basename &dirname &xargs %dh &compat &addsubstvar &delsubstvar &excludefile &package_arch &is_udeb &udeb_filename &debhelper_script_subst &escape_shell - &inhibit_log &load_log &write_log); + &inhibit_log &load_log &write_log &dpkg_architecture_value + &sourcepackage); my $max_compat=7; @@ -605,15 +606,21 @@ sub excludefile { return 0; } +sub dpkg_architecture_value { + my $var = shift; + my $value=`dpkg-architecture -q$var 2>/dev/null` || error("dpkg-architecture failed"); + chomp $value; + return $value; +} + # Returns the build architecture. (Memoized) { my $arch; sub buildarch { - return $arch if defined $arch; - - $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed"); - chomp $arch; + if (!defined $arch) { + $arch=dpkg_architecture_value('DEB_HOST_ARCH'); + } return $arch; } } @@ -643,6 +650,23 @@ sub samearch { return 0; } +# Returns source package name +sub sourcepackage { + open (CONTROL, 'debian/control') || + error("cannot read debian/control: $!\n"); + while () { + chomp; + s/\s+$//; + if (/^Source:\s*(.*)/) { + close CONTROL; + return $1; + } + } + + close CONTROL; + error("could not find Source: line in control file."); +} + # Returns a list of packages in the control file. # Must pass "arch" or "indep" or "same" to specify arch-dependant or # -independant or same arch packages. If nothing is specified, returns all diff --git a/Makefile b/Makefile index cde1139..f13b3fc 100644 --- a/Makefile +++ b/Makefile @@ -63,13 +63,15 @@ clean: install: install -d $(DESTDIR)/usr/bin \ $(DESTDIR)/usr/share/debhelper/autoscripts \ - $(DESTDIR)$(PERLLIBDIR)/Sequence + $(DESTDIR)$(PERLLIBDIR)/Sequence \ + $(DESTDIR)$(PERLLIBDIR)/Buildsystem install $(shell find -maxdepth 1 -mindepth 1 -name dh\* |grep -v \.1\$$) $(DESTDIR)/usr/bin install -m 0644 autoscripts/* $(DESTDIR)/usr/share/debhelper/autoscripts install -m 0644 Debian/Debhelper/*.pm $(DESTDIR)$(PERLLIBDIR) install -m 0644 Debian/Debhelper/Sequence/*.pm $(DESTDIR)$(PERLLIBDIR)/Sequence + install -m 0644 Debian/Debhelper/Buildsystem/*.pm $(DESTDIR)$(PERLLIBDIR)/Buildsystem test: version - ./run perl -MTest::Harness -e 'runtests grep { ! /CVS/ && ! /\.svn/ } @ARGV' t/* + ./run perl -MTest::Harness -e 'runtests grep { ! /CVS/ && ! /\.svn/ && -f && -x } @ARGV' t/* t/buildsystems/* # clean up log etc ./run dh_clean diff --git a/debhelper.pod b/debhelper.pod index 388453c..cea5283 100644 --- a/debhelper.pod +++ b/debhelper.pod @@ -174,6 +174,50 @@ in ALL packages acted on, not just the first. =back +=head1 BUILD SYSTEM OPTIONS + +The following command line options are supported by all of the dh_auto_* +debhelper programs. These programs support a variety of build systems, +and normally heuristically determine which to use, and how to use them. +You can use these command line options to override the default behavior. + +=over 4 + +=item B<-S>I, B<--buildsystem=>I + +Force use of the specified I, instead of trying to auto-select +one which might be applicable for the package. + +=item B<-D>I, B<--sourcedirectory=>I + +Assume that the original package source tree is at the specified +I rather than the top level directory of the Debian +source package tree. + +=item B<-B>[I], B<--builddirectory>=[I] + +Enable out of source building and use the specified I as the build +directory. If I parameter is omitted, a default build directory +will chosen. + +If this option is not specified, building will be done in source by default +unless the build system requires or prefers out of source tree building. +In such a case, the default build directory will be used even if +L<--builddirectory> is not specified. + +If the build system prefers out of source tree building but still +allows in source building, the latter can be re-enabled by passing a build +directory path that is the same as the source directory path. + +=item B<--list>, B<-l> + +List all build systems supported by debhelper on this system. The list +includes both default and third party build systems (marked as such). Also +shows which build system would be automatically selected, or which one +is manually specified with the I<--buildsystem> option. + +=back + =head1 NOTES =head2 Multiple binary package support diff --git a/debian/changelog b/debian/changelog index deae621..9120e2f 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,26 @@ +debhelper (7.3.0) UNRELEASED; urgency=low + + * Modular object oriented dh_auto_* buildsystem support, + contributed by Modestas Vainius + - dh_auto_* --sourcedirectory can now be used to specify a source + directory if sources and/or the whole buildsystem lives in other + but the top level directory. Closes: #530597 + - dh_auto_* --builddirectory can now be used to specify a build + directory to use for out of source building, for build systems + that support it. Closes: #480577 + - dh_auto_* --buildsystem can now be used to override the autodetected + build system, or force use of a third-party class. + - dh_auto_* --list can be used to list available and selected build + systems. + - Adds support for cmake. + - For the perl_build build system, Build is used consistently + instead of falling back to using the generated Makefile. + Closes: #534332 + - Historical dh_auto_* behavior should be preserved despite these + large changes.. + + -- Joey Hess Mon, 20 Apr 2009 16:26:08 -0400 + debhelper (7.2.18) UNRELEASED; urgency=low * dh_shlibdeps: Ensure DEBIAN directory exists, as dpkg-shlibdeps diff --git a/debian/copyright b/debian/copyright index 46e4492..ffb117c 100644 --- a/debian/copyright +++ b/debian/copyright @@ -54,3 +54,7 @@ License: GPL-2+ Files: dh_bugfiles Copyright: Modestas Vainius License: GPL-2+ + +Files: Debian/Debhelper/Buildsystem*, Debian/Debhelper/Dh_Buildsystems.pm +Copyright: © 2008-2009 Modestas Vainius +License: GPL-2+ diff --git a/dh_auto_build b/dh_auto_build index 75ce51c..250c7d9 100755 --- a/dh_auto_build +++ b/dh_auto_build @@ -7,18 +7,19 @@ dh_auto_build - automatically builds a package =cut use strict; -use Debian::Debhelper::Dh_Lib; +use Debian::Debhelper::Dh_Buildsystems; =head1 SYNOPSIS -B [S>] [S I>] +B [S>] [S>] [S I>] =head1 DESCRIPTION -dh_auto_build is a debhelper program that tries to automatically -build a package. If a Makefile is found, this is done by running make (or -MAKE, if the environment variable is set). -If there's a setup.py, or Build.PL, it is run to build the package. +dh_auto_build is a debhelper program that tries to automatically build a +package. It does so by running the appropriate command for the build system +it detects the package uses. For example, if a Makefile is found, this is +done by running make (or MAKE, if the environment variable is set). If +there's a setup.py, or Build.PL, it is run to build the package. This is intended to work for about 90% of packages. If it doesn't work, you're encouraged to skip using dh_auto_build at all, and just run the @@ -26,6 +27,9 @@ build process manually. =head1 OPTIONS +See L for a list of common build +system selection and control options. + =over 4 =item B<--> I @@ -37,18 +41,8 @@ or override any standard parameters that dh_auto_build passes. =cut -init(); - -if (-e "Makefile" || -e "makefile" || -e "GNUmakefile") { - doit(exists $ENV{MAKE} ? $ENV{MAKE} : "make", @{$dh{U_PARAMS}}); -} -elsif (-e "setup.py") { - doit("python", "setup.py", "build", @{$dh{U_PARAMS}}); -} -elsif (-e "Build.PL" && -e "Build") { - $ENV{MODULEBUILDRC} = "/dev/null"; - doit("perl", "Build", @{$dh{U_PARAMS}}); -} +buildsystems_init(); +buildsystems_do(); =head1 SEE ALSO diff --git a/dh_auto_clean b/dh_auto_clean index 610155a..8603b11 100755 --- a/dh_auto_clean +++ b/dh_auto_clean @@ -7,19 +7,20 @@ dh_auto_clean - automatically cleans up after a build =cut use strict; -use Debian::Debhelper::Dh_Lib; +use Debian::Debhelper::Dh_Buildsystems; =head1 SYNOPSIS -B [S>] [S I>] +B [S>] [S>] [S I>] =head1 DESCRIPTION dh_auto_clean is a debhelper program that tries to automatically clean up -after a package build. If there's a Makefile and it contains a "distclean", -"realclean", or "clean" target, then this is done by running make (or MAKE, -if the environment variable is set). If there is a setup.py or Build.PL, it -is run to clean the package. +after a package build. It does so by running the appropriate command for +the build system it detects the package uses. For example, if there's a +Makefile and it contains a "distclean", "realclean", or "clean" target, +then this is done by running make (or MAKE, if the environment variable is +set). If there is a setup.py or Build.PL, it is run to clean the package. This is intended to work for about 90% of packages. If it doesn't work, or tries to use the wrong clean target, you're encouraged to skip using @@ -27,6 +28,9 @@ dh_auto_clean at all, and just run make clean manually. =head1 OPTIONS +See L for a list of common build +system selection and control options. + =over 4 =item B<--> I @@ -38,31 +42,8 @@ or override the any standard parameters that dh_auto_clean passes. =cut -init(); - -if (-e "Makefile" || -e "makefile" || -e "GNUmakefile") { - $ENV{MAKE}="make" unless exists $ENV{MAKE}; - foreach my $target (qw{distclean realclean clean}) { - # Use make -n to check to see if the target would do - # anything. There's no good way to test if a target exists. - my $ret=`$ENV{MAKE} -s -n $target 2>/dev/null`; - chomp $ret; - if (length $ret) { - doit($ENV{MAKE}, $target, @{$dh{U_PARAMS}}); - last; - } - } -} -elsif (-e "setup.py") { - doit("python", "setup.py", "clean", "-a", @{$dh{U_PARAMS}}); - # The setup.py might import files, leading to python creating pyc - # files. - doit('find', '.', '-name', '*.pyc', '-exec', 'rm', '{}', ';'); -} -elsif (-e "Build.PL" && -e "Build") { - $ENV{MODULEBUILDRC} = "/dev/null"; - doit("perl", "Build", "--allow_mb_mismatch", 1, "distclean", @{$dh{U_PARAMS}}); -} +buildsystems_init(); +buildsystems_do(); =head1 SEE ALSO diff --git a/dh_auto_configure b/dh_auto_configure index 5f48056..4a8c28c 100755 --- a/dh_auto_configure +++ b/dh_auto_configure @@ -7,19 +7,22 @@ dh_auto_configure - automatically configure a package prior to building =cut use strict; -use Debian::Debhelper::Dh_Lib; +use Debian::Debhelper::Dh_Buildsystems; =head1 SYNOPSIS -B [S>] [S I>] +B [S>] [S>] [S I>] =head1 DESCRIPTION dh_auto_configure is a debhelper program that tries to automatically -configure a package prior to building. It looks for and runs a ./configure -script, Makefile.PL, or Build.PL. A standard set of parameters is -determined and passed to the program that is run. If no program to run is -found, dh_auto_configure will exit without doing anything. +configure a package prior to building. It does so by running the +appropriate command for the build system it detects the package uses. +For example, it looks for and runs a ./configure script, Makefile.PL, +Build.PL, or cmake. A standard set of parameters is determined and passed +to the program that is run. Some build systems, such as make, do not +need a configure step; for these dh_auto_configure will exit without +doing anything. This is intended to work for about 90% of packages. If it doesn't work, you're encouraged to skip using dh_auto_configure at all, and just run @@ -29,6 +32,9 @@ you're encouraged to skip using dh_auto_configure at all, and just run =over 4 +See L for a list of common build +system selection and control options. + =item B<--> I Pass "params" to the program that is run, after the standard @@ -41,67 +47,8 @@ or override those parameters. For example: =cut -init(); - -sub dpkg_architecture_value { - my $var=shift; - my $value=`dpkg-architecture -q$var 2>/dev/null` || error("dpkg-architecture failed"); - chomp $value; - return $value; -} - -sub sourcepackage { - open (CONTROL, 'debian/control') || - error("cannot read debian/control: $!\n"); - while () { - chomp; - s/\s+$//; - if (/^Source:\s*(.*)/) { - close CONTROL; - return $1; - } - } - - close CONTROL; - error("could not find Source: line in control file."); -} - -if (-x "configure") { - # Standard set of options for configure. - my @opts; - push @opts, "--build=".dpkg_architecture_value("DEB_BUILD_GNU_TYPE"); - push @opts, "--prefix=/usr"; - push @opts, "--includedir=\${prefix}/include"; - push @opts, "--mandir=\${prefix}/share/man"; - push @opts, "--infodir=\${prefix}/share/info"; - push @opts, "--sysconfdir=/etc"; - push @opts, "--localstatedir=/var"; - push @opts, "--libexecdir=\${prefix}/lib/".sourcepackage(); - push @opts, "--disable-maintainer-mode"; - push @opts, "--disable-dependency-tracking"; - # Provide --host only if different from --build, as recommended in - # autotools-dev README.Debian: When provided (even if equal) autotools - # 2.52+ switches to cross-compiling mode. - if (dpkg_architecture_value("DEB_BUILD_GNU_TYPE") ne dpkg_architecture_value("DEB_HOST_GNU_TYPE")) { - push @opts, "--host=".dpkg_architecture_value("DEB_HOST_GNU_TYPE"); - } - doit("./configure", @opts, @{$dh{U_PARAMS}}); -} -elsif (-e "Makefile.PL") { - # If set to a true value then MakeMaker's prompt function will - # always return the default without waiting for user input. - $ENV{PERL_MM_USE_DEFAULT}=1; - # This prevents Module::Install from interactive behavior. - $ENV{PERL_AUTOINSTALL}="--skipdeps"; - - doit("perl", "Makefile.PL", "INSTALLDIRS=vendor", - "create_packlist=0", @{$dh{U_PARAMS}}); -} -elsif (-e "Build.PL") { - $ENV{PERL_MM_USE_DEFAULT}=1; # Module::Build can also use this. - $ENV{MODULEBUILDRC} = "/dev/null"; - doit("perl", "Build.PL", "installdirs=vendor", @{$dh{U_PARAMS}}); -} +buildsystems_init(); +buildsystems_do(); =head1 SEE ALSO diff --git a/dh_auto_install b/dh_auto_install index 61ed904..4464702 100755 --- a/dh_auto_install +++ b/dh_auto_install @@ -8,18 +8,21 @@ dh_auto_install - automatically runs make install or similar use strict; use Debian::Debhelper::Dh_Lib; +use Debian::Debhelper::Dh_Buildsystems; use Cwd; =head1 SYNOPSIS -B [S>] [S I>] +B [S>] [S>] [S I>] =head1 DESCRIPTION dh_auto_install is a debhelper program that tries to automatically install -built files. If there's a Makefile and it contains a "install" target, -then this is done by running make (or MAKE, if the environment variable is -set). If there is a setup.py or Build.PL, it is used. +built files. It does so by running the appropriate command for the build +system it detects the package uses. For example, if there's a Makefile and +it contains a "install" target, then this is done by running make (or MAKE, +if the environment variable is set). If there is a setup.py or Build.PL, +it is used. The files are installed into debian// if there is only one binary package. In the multiple binary package case, the files are instead @@ -39,6 +42,9 @@ dh_auto_install at all, and just run make install manually. =over 4 +See L for a list of common build +system selection and control options. + =item B<--> I Pass "params" to the program that is run. These can be used to supplement @@ -48,7 +54,7 @@ or override the any standard parameters that dh_auto_install passes. =cut -init(); +buildsystems_init(); my $destdir; my @allpackages=getpackages(); @@ -60,41 +66,7 @@ else { } $destdir=cwd()."/".$destdir; -if (-e "Makefile" || -e "makefile" || -e "GNUmakefile") { - $ENV{MAKE}="make" unless exists $ENV{MAKE}; - my @params="DESTDIR=$destdir"; - - # Special case for MakeMaker generated Makefiles. - if (-e "Makefile" && - system('grep -q "generated automatically by MakeMaker" Makefile') == 0) { - push @params, "PREFIX=/usr"; - } - - foreach my $target (qw{install}) { - # Use make -n to check to see if the target would do - # anything. There's no good way to test if a target exists. - my $ret=`$ENV{MAKE} -s -n $target 2>/dev/null`; - chomp $ret; - if (length $ret) { - doit($ENV{MAKE}, $target, - @params, - @{$dh{U_PARAMS}}); - last; - } - } -} -elsif (-e "setup.py") { - doit("python", "setup.py", "install", - "--root=$destdir", - "--no-compile", "-O0", - "--install-layout=deb", - @{$dh{U_PARAMS}}); -} -elsif (-e "Build.PL" && -e "Build") { - $ENV{MODULEBUILDRC} = "/dev/null"; - doit("perl", "Build", "install", "destdir=$destdir", - "create_packlist=0", @{$dh{U_PARAMS}}); -} +buildsystems_do("install", $destdir); =head1 SEE ALSO diff --git a/dh_auto_test b/dh_auto_test index ea2d7fd..6caf393 100755 --- a/dh_auto_test +++ b/dh_auto_test @@ -7,20 +7,21 @@ dh_auto_test - automatically runs a package's test suites =cut use strict; -use Debian::Debhelper::Dh_Lib; +use Debian::Debhelper::Dh_Buildsystems; =head1 SYNOPSIS -B [S>] [S I>] +B [S>] [S>] [S I>] =head1 DESCRIPTION dh_auto_test is a debhelper program that tries to automatically run a -package's test suite. If there's a Makefile and it contains a "test" -or "check" target, then this is done by running make (or MAKE, if the -environment variable is set). If the test suite fails, the command will -exit nonzero. If there's no test suite, it will exit zero without doing -anything. +package's test suite. It does so by running the appropriate command for the +build system it detects the package uses. For example, if there's a +Makefile and it contains a "test" or "check" target, then this is done by +running make (or MAKE, if the environment variable is set). If the test +suite fails, the command will exit nonzero. If there's no test suite, it +will exit zero without doing anything. This is intended to work for about 90% of packages with a test suite. If it doesn't work, you're encouraged to skip using dh_auto_test at all, and @@ -28,6 +29,9 @@ just run the test suite manually. =head1 OPTIONS +See L for a list of common build +system selection and control options. + =over 4 =item B<--> I @@ -44,29 +48,12 @@ tests will be performed. =cut -init(); - if (defined $ENV{DEB_BUILD_OPTIONS} && $ENV{DEB_BUILD_OPTIONS} =~ /nocheck/) { exit 0; } -if (-e "Makefile" || -e "makefile" || -e "GNUmakefile") { - $ENV{MAKE}="make" unless exists $ENV{MAKE}; - foreach my $target (qw{test check}) { - # Use make -n to check to see if the target would do - # anything. There's no good way to test if a target exists. - my $ret=`$ENV{MAKE} -s -n $target 2>/dev/null`; - chomp $ret; - if (length $ret) { - doit($ENV{MAKE}, $target, @{$dh{U_PARAMS}}); - last; - } - } -} -elsif (-e "Build.PL" && -e "Build") { - $ENV{MODULEBUILDRC} = "/dev/null"; - doit(qw/perl Build test/, @{$dh{U_PARAMS}}); -} +buildsystems_init(); +buildsystems_do(); =head1 SEE ALSO diff --git a/dh_clean b/dh_clean index 47019fc..1213f6c 100755 --- a/dh_clean +++ b/dh_clean @@ -25,7 +25,7 @@ debian diff: The debian/clean file can list other files to be removed. It does not run "make clean" to clean up after the build process. Use -L to do that. +L to do things like that. dh_clean (or "dh clean") should be the last debhelper command run in the clean target in debian/rules. diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING index 9963181..bd79628 100644 --- a/doc/PROGRAMMING +++ b/doc/PROGRAMMING @@ -250,13 +250,13 @@ write_log($cmd, $package ...) Writes the log files for the specified package(s), adding the cmd to the end. -Sequence Addons +Sequence Addons: --------------- The dh(1) command has a --with parameter that ca be used to load -a sequence addon named Debian::Debhelper::Sequence::. -These addons can add/remove commands to the dh command sequences, by calling -some functions from Dh_Lib: +a sequence addon module named Debian::Debhelper::Sequence::. +These modules can add/remove commands to the dh command sequences, by +calling some functions from Dh_Lib: insert_before($existing_command, $new_command) Insert $new_command in sequences before $existing_command @@ -267,4 +267,19 @@ insert_after($existing_command, $new_command) remove_command($existing_command) Remove $existing_command from the list of commands to run. +Buildsystem Classes: +------------------- + +The dh_auto_* commands are frontends that use debhelper buildsystem +classes. These classes have names like Debian::Debhelper::Buildsystem::foo, +and are derived from Debian::Debhelper::Buildsystem, or other, related +classes. + +A buildsystem class needs to inherit or define these methods: DESCRIPTION, +check_auto_buildable, build, test, install, clean. See the comments +inside Debian::Debhelper::Buildsystem for details. + +Note that third-party buildsystems will not automatically be used by default, +but can be forced to be used via the --buildsystem parameter. + -- Joey Hess diff --git a/t/buildsystems/autoconf/configure b/t/buildsystems/autoconf/configure new file mode 100755 index 0000000..adea14e --- /dev/null +++ b/t/buildsystems/autoconf/configure @@ -0,0 +1,74 @@ +#!/usr/bin/perl + +# Emulate autoconf behaviour and do some checks + +use strict; +use warnings; + +my @OPTIONS=qw( + ^--build=.*$ + ^--prefix=/usr$ + ^--includedir=\$\{prefix\}/include$ + ^--mandir=\$\{prefix\}/share/man$ + ^--infodir=\$\{prefix\}/share/info$ + ^--sysconfdir=/etc$ + ^--localstatedir=/var$ + ^--libexecdir=\$\{prefix\}/lib/.*$ + ^--disable-maintainer-mode$ + ^--disable-dependency-tracking$ +); + +# Verify if all command line arguments were passed +my @options = map { { regex => qr/$_/, + str => $_, + found => 0 } } @OPTIONS; +my @extra_args; +ARGV_LOOP: foreach my $arg (@ARGV) { + foreach my $opt (@options) { + if ($arg =~ $opt->{regex}) { + $opt->{found} = 1; + next ARGV_LOOP; + } + } + # Extra / unrecognized argument + push @extra_args, $arg; +} + +my @notfound = grep { ! $_->{found} and $_ } @options; +if (@notfound) { + print STDERR "Error: the following default options were NOT passed\n"; + print STDERR " ", $_->{str}, "\n" foreach (@notfound); + exit 1; +} + +# Create a simple Makefile +open(MAKEFILE, ">", "Makefile"); +print MAKEFILE < stamp_build + +# Tests if dh_auto_test executes 'check' target if 'test' does not exist +check: \$(CONFIGURE) stamp_build + \@echo Tested > stamp_test + +install: stamp_build + \@echo DESTDIR=\$(DESTDIR) > stamp_install + +# Tests whether dh_auto_clean executes distclean but does not touch +# this target +clean: + echo "This should not have been executed" >&2 && exit 1 + +distclean: + \@rm -f stamp_* Makefile + +.PHONY: all check install clean distclean +EOF +close MAKEFILE; + +open(STAMP, ">", "stamp_configure"); +print STAMP $_, "\n" foreach (@extra_args); +close STAMP; + +exit 0; diff --git a/t/buildsystems/buildsystem_tests b/t/buildsystems/buildsystem_tests new file mode 100755 index 0000000..82d8c10 --- /dev/null +++ b/t/buildsystems/buildsystem_tests @@ -0,0 +1,434 @@ +#!/usr/bin/perl + +use Test::More tests => 227; + +use strict; +use warnings; +use IPC::Open2; +use Cwd (); +use File::Temp qw(tempfile tempdir); +use File::Basename (); + +# Let the tests to be run from anywhere but currect directory +# is expected to be the one where this test lives in. +chdir File::Basename::dirname($0) or die "Unable to chdir to ".File::Basename::dirname($0); + +use_ok( 'Debian::Debhelper::Dh_Lib' ); +use_ok( 'Debian::Debhelper::Buildsystem' ); +use_ok( 'Debian::Debhelper::Dh_Buildsystems' ); + +my $TOPDIR = "../.."; +my @STEPS = qw(configure build test install clean); +my @BUILDSYSTEMS = qw(autoconf perl_makemaker makefile python_distutils perl_build cmake); +my $BS_CLASS = 'Debian::Debhelper::Buildsystem'; + +my ($bs, @bs, %bs); +my ($tmp, @tmp, %tmp); +my ($tmpdir, $builddir, $default_builddir); + +### Common subs #### +sub touch { + my $file=shift; + my $chmod=shift; + open FILE, ">", $file and close FILE or die "Unable to touch $file"; + chmod $chmod, $file if defined $chmod; +} + +sub cleandir { + my $dir=shift; + system ("find", $dir, "-type", "f", "-delete"); +} +sub readlines { + my $h=shift; + my @lines = <$h>; + close $h; + chop @lines; + return \@lines; +} + +sub process_stdout { + my ($cmdline, $stdin) = @_; + my ($reader, $writer); + + open2($reader, $writer, $cmdline) or die "Unable to exec $cmdline"; + print $writer $stdin if $stdin; + close $writer; + return readlines($reader); +} + +### Test Buildsystem class API methods +is( $BS_CLASS->_canonpath("path/to/the/./nowhere/../../somewhere"), + "path/to/somewhere", "_canonpath no1" ); +is( $BS_CLASS->_canonpath("path/to/../forward/../../somewhere"), + "somewhere","_canonpath no2" ); +is( $BS_CLASS->_canonpath("path/to/../../../somewhere"), + "../somewhere","_canonpath no3" ); +is( $BS_CLASS->_canonpath("./"), ".", "_canonpath no4" ); +is( $BS_CLASS->_rel2rel("path/my/file", "path/my"), + "file", "_rel2rel no1" ); +is( $BS_CLASS->_rel2rel("path/dir/file", "path/my"), + "../dir/file", "_rel2rel no2" ); +is( $BS_CLASS->_rel2rel("file", "/root/path/my", "/root"), + "../../file", "_rel2rel no3" ); +is( $BS_CLASS->_rel2rel(".", "."), ".", "_rel2rel no4" ); +is( $BS_CLASS->_rel2rel("path", "path/"), ".", "_rel2rel no5" ); + +### Test Buildsystem class path API methods under different configurations +sub test_buildsystem_paths_api { + my ($bs, $config, $expected)=@_; + + my $api_is = sub { + my ($got, $name)=@_; + is( $got, $expected->{$name}, "paths API ($config): $name") + }; + + &$api_is( $bs->get_sourcedir(), 'get_sourcedir()' ); + &$api_is( $bs->get_sourcepath("a/b"), 'get_sourcepath(a/b)' ); + &$api_is( $bs->get_builddir(), 'get_builddir()' ); + &$api_is( $bs->get_buildpath(), 'get_buildpath()' ); + &$api_is( $bs->get_buildpath("a/b"), 'get_buildpath(a/b)' ); + &$api_is( $bs->get_source_rel2builddir(), 'get_source_rel2builddir()' ); + &$api_is( $bs->get_source_rel2builddir("a/b"), 'get_source_rel2builddir(a/b)' ); + &$api_is( $bs->get_build_rel2sourcedir(), 'get_build_rel2sourcedir()' ); + &$api_is( $bs->get_build_rel2sourcedir("a/b"), 'get_build_rel2sourcedir(a/b)' ); +} + +# Defaults +$bs = $BS_CLASS->new(); +$default_builddir = $bs->DEFAULT_BUILD_DIRECTORY(); +%tmp = ( + "get_sourcedir()" => ".", + "get_sourcepath(a/b)" => "./a/b", + "get_builddir()" => undef, + "get_buildpath()" => ".", + "get_buildpath(a/b)" => "./a/b", + "get_source_rel2builddir()" => ".", + "get_source_rel2builddir(a/b)" => "./a/b", + "get_build_rel2sourcedir()" => ".", + "get_build_rel2sourcedir(a/b)" => "./a/b", +); +test_buildsystem_paths_api($bs, "no builddir, no sourcedir", \%tmp); + +# builddir=bld/dir +$bs = $BS_CLASS->new(builddir => "bld/dir"); +%tmp = ( + "get_sourcedir()" => ".", + "get_sourcepath(a/b)" => "./a/b", + "get_builddir()" => "bld/dir", + "get_buildpath()" => "bld/dir", + "get_buildpath(a/b)" => "bld/dir/a/b", + "get_source_rel2builddir()" => "../..", + "get_source_rel2builddir(a/b)" => "../../a/b", + "get_build_rel2sourcedir()" => "bld/dir", + "get_build_rel2sourcedir(a/b)" => "bld/dir/a/b", +); +test_buildsystem_paths_api($bs, "builddir=bld/dir, no sourcedir", \%tmp); + +# Default builddir, sourcedir=autoconf +$bs = $BS_CLASS->new(builddir => undef, sourcedir => "autoconf"); +%tmp = ( + "get_sourcedir()" => "autoconf", + "get_sourcepath(a/b)" => "autoconf/a/b", + "get_builddir()" => "$default_builddir", + "get_buildpath()" => "$default_builddir", + "get_buildpath(a/b)" => "$default_builddir/a/b", + "get_source_rel2builddir()" => "../autoconf", + "get_source_rel2builddir(a/b)" => "../autoconf/a/b", + "get_build_rel2sourcedir()" => "../$default_builddir", + "get_build_rel2sourcedir(a/b)" => "../$default_builddir/a/b", +); +test_buildsystem_paths_api($bs, "default builddir, sourcedir=autoconf", \%tmp); + +# Enforce out of source tree building +# sourcedir=builddir=autoconf hence default builddir is implied +$bs = $BS_CLASS->new(builddir => "autoconf", sourcedir => "autoconf/"); +$bs->enforce_out_of_source_building(); +test_buildsystem_paths_api($bs, "hard out of source enforced, sourcedir=builddir", \%tmp); + +# sourcedir=autoconf (builddir should be dropped) +$bs = $BS_CLASS->new(builddir => "autoconf", sourcedir => "autoconf"); +%tmp = ( + "get_sourcedir()" => "autoconf", + "get_sourcepath(a/b)" => "autoconf/a/b", + "get_builddir()" => undef, + "get_buildpath()" => "autoconf", + "get_buildpath(a/b)" => "autoconf/a/b", + "get_source_rel2builddir()" => ".", + "get_source_rel2builddir(a/b)" => "./a/b", + "get_build_rel2sourcedir()" => ".", + "get_build_rel2sourcedir(a/b)" => "./a/b", +); +test_buildsystem_paths_api($bs, "no builddir, sourcedir=autoconf", \%tmp); + +# Prefer out of source tree building when +# sourcedir=builddir=autoconf hence builddir should be dropped. +$bs->enforce_out_of_source_building(builddir => "autoconf"); +test_buildsystem_paths_api($bs, "out of source prefered, sourcedir=builddir", \%tmp); + +# builddir=bld/dir, sourcedir=autoconf. Should be the same as sourcedir=autoconf. +$bs = $BS_CLASS->new(builddir => "bld/dir", sourcedir => "autoconf"); +$bs->enforce_in_source_building(); +test_buildsystem_paths_api($bs, "in source enforced, sourcedir=autoconf", \%tmp); + +# builddir=../bld/dir (relative to the curdir) +$bs = $BS_CLASS->new(builddir => "bld/dir/", sourcedir => "autoconf"); +%tmp = ( + "get_sourcedir()" => "autoconf", + "get_sourcepath(a/b)" => "autoconf/a/b", + "get_builddir()" => "bld/dir", + "get_buildpath()" => "bld/dir", + "get_buildpath(a/b)" => "bld/dir/a/b", + "get_source_rel2builddir()" => "../../autoconf", + "get_source_rel2builddir(a/b)" => "../../autoconf/a/b", + "get_build_rel2sourcedir()" => "../bld/dir", + "get_build_rel2sourcedir(a/b)" => "../bld/dir/a/b", +); +test_buildsystem_paths_api($bs, "builddir=../bld/dir, sourcedir=autoconf", \%tmp); + +### Test if all buildsystems can be loaded +@bs = load_all_buildsystems([ $INC[0] ]); +@tmp = map { $_->NAME() } @bs; +is_deeply( \@tmp, \@BUILDSYSTEMS, "load_all_buildsystems() loads all built-in buildsystems" ); + +### Test check_auto_buildable() of each buildsystem +sub test_check_auto_buildable { + my $bs=shift; + my $config=shift; + my $expected=shift; + my @steps=@_ || @STEPS; + + if (! ref $expected) { + my %all_steps; + $all_steps{$_} = $expected foreach (@steps); + $expected = \%all_steps; + } + for my $step (@steps) { + my $e = 0; + if (exists $expected->{$step}) { + $e = $expected->{$step}; + } elsif (exists $expected->{default}) { + $e = $expected->{default}; + } + if ($e) { + ok( $bs->check_auto_buildable($step), + $bs->NAME() . "($config): check_auto_buildable($step)" ); + } + else { + ok( ! $bs->check_auto_buildable($step), + $bs->NAME() . "($config): ! check_auto_buildable($step)" ); + } + } +} + +$tmpdir = tempdir("tmp.XXXXXX"); +$builddir = "$tmpdir/builddir"; +mkdir $builddir; +%tmp = ( + builddir => "$tmpdir/builddir", + sourcedir => $tmpdir +); + +$bs{autoconf} = load_buildsystem("autoconf", undef, %tmp); +$bs{cmake} = load_buildsystem("cmake", undef, %tmp); +$bs{perl_mm} = load_buildsystem("perl_makemaker", undef, %tmp); +$bs = load_buildsystem("makefile", undef, %tmp); + +test_check_auto_buildable($bs{autoconf}, "no configure", 0); +test_check_auto_buildable($bs{cmake}, "no CMakeLists.txt", 0); +test_check_auto_buildable($bs{perl_mm}, "no Makefile.PL", 0); +test_check_auto_buildable($bs, "no Makefile", 0); + +touch "$tmpdir/configure", 0755; +test_check_auto_buildable($bs{autoconf}, "configure", { configure => 1 }); + +touch "$tmpdir/CMakeLists.txt"; +test_check_auto_buildable($bs{cmake}, "CMakeLists.txt", { configure => 1 }); + +touch "$tmpdir/Makefile.PL"; +test_check_auto_buildable($bs{perl_mm}, "Makefile.PL", + { configure => 1, install => 1 }); + +# With Makefile +touch "$builddir/Makefile"; +test_check_auto_buildable($bs, "Makefile", { configure => 0, default => 1 }); +test_check_auto_buildable($bs{autoconf}, "configure+Makefile", { configure => 1 }); +test_check_auto_buildable($bs{cmake}, "CMakeLists.txt+Makefile", 1); + +# Makefile.PL forces in-source +#(see note in check_auto_buildable() why always 1 here) +unlink "$builddir/Makefile"; +touch "$tmpdir/Makefile"; +test_check_auto_buildable($bs{perl_mm}, "Makefile.PL+Makefile", 1); + +# Perl Build.PL - handles always +$bs = load_buildsystem("perl_build", undef, %tmp); +test_check_auto_buildable($bs, "no Build.PL", 0); +touch "$tmpdir/Build.PL"; +test_check_auto_buildable($bs, "Build.PL", { configure => 1 }); +touch "$tmpdir/Build"; # forced in source +test_check_auto_buildable($bs, "Build.PL+Build", 1); + +# Python Distutils +$bs = load_buildsystem("python_distutils", undef, %tmp); +test_check_auto_buildable($bs, "no setup.py", 0); +touch "$tmpdir/setup.py"; +test_check_auto_buildable($bs, "setup.py", 1); + +cleandir($tmpdir); + +### Now test if it can autoselect a proper buildsystem for a typical package +sub test_autoselection { + my $system=shift; + my $expected=shift; + for my $step (@STEPS) { + my $bs = load_buildsystem(undef, $step, @_); + my $e = $expected; + $e = $expected->{$step} if ref $expected; + if (defined $bs) { + is( $bs->NAME(), $e, "autoselection($system): $step=".((defined $e)?$e:'undef') ); + } + else { + is ( undef, $e, "autoselection($system): $step=".((defined $e)?$e:'undef') ); + } + } +} + +# Autoconf +touch "$tmpdir/configure", 0755; +touch "$builddir/Makefile"; +test_autoselection("autoconf", + { configure => "autoconf", build => "makefile", + test => "makefile", install => "makefile", clean => "makefile" }, %tmp); +cleandir $tmpdir; + +# Perl Makemaker (build, test, clean fail with builddir set [not supported]) +touch "$tmpdir/Makefile.PL"; +touch "$tmpdir/Makefile"; +test_autoselection("perl_makemaker", "perl_makemaker", %tmp); +cleandir $tmpdir; + +# Makefile +touch "$builddir/Makefile"; +test_autoselection("makefile", { build => "makefile", test => "makefile", + install => "makefile", clean => "makefile" }, %tmp); +cleandir $tmpdir; + +# Python Distutils +touch "$tmpdir/setup.py"; +test_autoselection("python_distutils", "python_distutils", %tmp); +cleandir $tmpdir; + +# Perl Build +touch "$tmpdir/Build.PL"; +touch "$tmpdir/Build"; +test_autoselection("perl_build", "perl_build", %tmp); +cleandir $tmpdir; + +# CMake +touch "$tmpdir/CMakeLists.txt"; +touch "$builddir/Makefile"; +test_autoselection("cmake", + { configure => "cmake", build => "makefile", + test => "makefile", install => "makefile", clean => "makefile" }, %tmp); +cleandir $tmpdir; + +### Test buildsystems_init() and commandline/env argument handling +sub get_load_bs_source { + my ($system, $step)=@_; + $step = (defined $step) ? "'$step'" : 'undef'; + $system = (defined $system) ? "'$system'" : 'undef'; + +return < [ "--extra-autoconf-configure-arg" ]); +ok ( ! -e 'autoconf/bld', "autoconf/bld got deleted too" ); + +END { + system("rm", "-rf", $tmpdir); + system("$TOPDIR/dh_clean"); +} diff --git a/t/buildsystems/debian/changelog b/t/buildsystems/debian/changelog new file mode 100644 index 0000000..f902d89 --- /dev/null +++ b/t/buildsystems/debian/changelog @@ -0,0 +1,5 @@ +testpackage (1.0-1) unstable; urgency=low + + * Initial release. (Closes: #XXXXXX) + + -- Test Tue, 09 Jun 2009 15:35:32 +0300 diff --git a/t/buildsystems/debian/compat b/t/buildsystems/debian/compat new file mode 100644 index 0000000..7f8f011 --- /dev/null +++ b/t/buildsystems/debian/compat @@ -0,0 +1 @@ +7 diff --git a/t/buildsystems/debian/control b/t/buildsystems/debian/control new file mode 100644 index 0000000..7edd806 --- /dev/null +++ b/t/buildsystems/debian/control @@ -0,0 +1,10 @@ +Source: testsrcpackage +Section: devel +Priority: optional +Maintainer: Test +Standards-Version: 3.8.1 + +Package: testpackage +Architecture: all +Description: short description + Long description diff --git a/t/syntax b/t/syntax index f80fa97..9245545 100755 --- a/t/syntax +++ b/t/syntax @@ -2,7 +2,7 @@ use Test; my @progs=grep { -x $_ } glob("dh_*"), "dh"; -my @libs=glob("Debian/Debhelper/*.pm"); +my @libs=(glob("Debian/Debhelper/*.pm"), glob("Debian/Debhelper/*/*.pm")); plan(tests => (@progs + @libs));