| 1 | #! /bin/bash |
| 2 | ### |
| 3 | ### Build script for Debian packages |
| 4 | ### |
| 5 | ### (c) 2008 Mark Wooding |
| 6 | ### |
| 7 | |
| 8 | ###----- Licensing notice --------------------------------------------------- |
| 9 | ### |
| 10 | ### This program is free software; you can redistribute it and/or modify |
| 11 | ### it under the terms of the GNU General Public License as published by |
| 12 | ### the Free Software Foundation; either version 2 of the License, or |
| 13 | ### (at your option) any later version. |
| 14 | ### |
| 15 | ### This program is distributed in the hope that it will be useful, |
| 16 | ### but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | ### GNU General Public License for more details. |
| 19 | ### |
| 20 | ### You should have received a copy of the GNU General Public License |
| 21 | ### along with this program; if not, write to the Free Software Foundation, |
| 22 | ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 23 | |
| 24 | ###-------------------------------------------------------------------------- |
| 25 | ### Conventions for build systems. |
| 26 | ### |
| 27 | ### This script is designed to work with a variety of `make'-based build |
| 28 | ### systems, but there are a number of conventions which must be followed if |
| 29 | ### this is going to work properly. |
| 30 | ### |
| 31 | ### * There must be a `configure.ac', `configure.in', or `.links' file, or |
| 32 | ### a `.git' directory in the project top-level, so that we can find it. |
| 33 | ### |
| 34 | ### * The following `make' variables must be assigned in the top-level |
| 35 | ### Makefile, after `mdw-build' has constructed it. |
| 36 | ### |
| 37 | ### distdir The name of the top-level project directory in the |
| 38 | ### source distribution, and the base name for |
| 39 | ### distribution archives; should be of the form |
| 40 | ### `PROJECT-VERSION'. |
| 41 | ### |
| 42 | ### The following `make' targets must be available in the top-level |
| 43 | ### Makefile. |
| 44 | ### |
| 45 | ### dist Write to $(distdir).tar.gz a source distribution of |
| 46 | ### the package. |
| 47 | ### |
| 48 | ### distcheck As for `dist', but also build and test the project. |
| 49 | ### |
| 50 | ### * The source distribution constructed by `make dist' must contain a file |
| 51 | ### $(distdir)/RELEASE containing the release name. This isn't currently |
| 52 | ### tested, but it might be later. |
| 53 | |
| 54 | set -e |
| 55 | |
| 56 | ###-------------------------------------------------------------------------- |
| 57 | ### Parse options. |
| 58 | |
| 59 | usage () { |
| 60 | cat <<EOF |
| 61 | Usage: $0 [-vr] BUILDOPT |
| 62 | |
| 63 | Build options: |
| 64 | |
| 65 | [no]checkout[=REV] |
| 66 | [no]release |
| 67 | [no]setup |
| 68 | [no]distcheck |
| 69 | [no]debian |
| 70 | [no]upload |
| 71 | [no]clean |
| 72 | [no]vpath |
| 73 | EOF |
| 74 | } |
| 75 | |
| 76 | ## Parse simple options. |
| 77 | verbose=no |
| 78 | while getopts "hvr" opt; do |
| 79 | case "$opt" in |
| 80 | h) usage; exit 0 ;; |
| 81 | v) verbose=yes ;; |
| 82 | *) exit 1 ;; |
| 83 | esac |
| 84 | done |
| 85 | shift $((OPTIND - 1)) |
| 86 | |
| 87 | ## Parse the build options. |
| 88 | checkout=yes |
| 89 | checkoutrev=HEAD |
| 90 | build=test |
| 91 | setup=yes |
| 92 | distcheck=yes |
| 93 | debian=yes |
| 94 | upload=yes |
| 95 | clean=yes |
| 96 | vpath=yes |
| 97 | for opt; do |
| 98 | case "$opt" in |
| 99 | checkout) checkout=yes checkoutrev=HEAD ;; |
| 100 | checkout=*) checkout=yes checkoutrev=${opt#*=} ;; |
| 101 | nocheckout) checkout=no ;; |
| 102 | release) build=release ;; |
| 103 | norelease) build=test ;; |
| 104 | |
| 105 | setup | distcheck | debian | upload | clean | vpath) |
| 106 | eval "$opt=yes" |
| 107 | ;; |
| 108 | nosetup | nodistcheck | nodebian | noupload | noclean | novpath) |
| 109 | eval "${opt#no}=no" |
| 110 | ;; |
| 111 | *) |
| 112 | usage >&2 |
| 113 | exit 1 |
| 114 | ;; |
| 115 | esac |
| 116 | done |
| 117 | |
| 118 | ## Parse DEB_BUILD_OPTIONS. |
| 119 | jobs=1 |
| 120 | set -- $DEB_BUILD_OPTIONS |
| 121 | for opt; do |
| 122 | case "$opt" in |
| 123 | parallel=*) jobs=${opt#*=} ;; |
| 124 | esac |
| 125 | done |
| 126 | |
| 127 | makeopts="" |
| 128 | case $jobs in 1) ;; *) makeopts="$makeopts -j$jobs" ;; esac |
| 129 | |
| 130 | ###-------------------------------------------------------------------------- |
| 131 | ### Utility functions. |
| 132 | |
| 133 | exec 3>&2 4>/dev/null 5>&2 |
| 134 | |
| 135 | notify () { |
| 136 | colour=$1 message=$2 |
| 137 | echo $message >&4 |
| 138 | echo "$(tput bold; tput setaf $colour)$message$(tput sgr0; tput op)" >&5 |
| 139 | } |
| 140 | |
| 141 | fail () { |
| 142 | notify 1 "!!! $*" |
| 143 | exit 1 |
| 144 | } |
| 145 | |
| 146 | warn () { |
| 147 | case $build in |
| 148 | release) fail "$*" ;; |
| 149 | *) notify 5 "??? $*" ;; |
| 150 | esac |
| 151 | } |
| 152 | |
| 153 | info () { |
| 154 | notify 6 "--- $*" |
| 155 | } |
| 156 | |
| 157 | assign () { |
| 158 | info "$1 = $2" |
| 159 | eval "$1=$2" |
| 160 | } |
| 161 | |
| 162 | runx () { |
| 163 | notify 2 "+++ $*" |
| 164 | "$@" 2>&3 || fail "$1: exit $?" |
| 165 | } |
| 166 | |
| 167 | run () { runx "$@" >&3; } |
| 168 | |
| 169 | yesno () { |
| 170 | echo -n "(test $*)" >&4 |
| 171 | if "$@" >&4 2>&4; then |
| 172 | echo "(yes)" >&4 |
| 173 | echo yes |
| 174 | else |
| 175 | echo "(no)" >&4 |
| 176 | echo no |
| 177 | fi |
| 178 | } |
| 179 | |
| 180 | ###-------------------------------------------------------------------------- |
| 181 | ### Do the building. |
| 182 | |
| 183 | ## Find the top-level package directory. |
| 184 | while [ ! -f configure.ac -a ! -f configure.in -a \ |
| 185 | ! -f .links -a ! -d .git ]; do |
| 186 | case "$(pwd)" in |
| 187 | /) |
| 188 | fail "couldn't find top-level directory" |
| 189 | ;; |
| 190 | esac |
| 191 | cd .. |
| 192 | done |
| 193 | assign srcpath $(pwd) |
| 194 | |
| 195 | ## Construct the output directory. |
| 196 | assign releasepath $srcpath/dist-$build |
| 197 | chmod -R +w $releasepath 2>/dev/null || : |
| 198 | rm -rf $releasepath 2>/dev/null || : |
| 199 | mkdir $releasepath |
| 200 | case $verbose in |
| 201 | no) |
| 202 | exec 4>$releasepath/mdw-build.log 3>&4 || |
| 203 | fail "Failed to create log." |
| 204 | ;; |
| 205 | esac |
| 206 | |
| 207 | ## Do we have a Git repository? |
| 208 | case "$checkout,$setup,$(yesno [ -d $srcpath/.git ])" in |
| 209 | yes,no,*) |
| 210 | fail "Inconsistent options: can't check out without setup." |
| 211 | ;; |
| 212 | yes,yes,no) |
| 213 | info "No Git repository found." |
| 214 | checkout=no gitver=none |
| 215 | ;; |
| 216 | yes,yes,yes) |
| 217 | cd $srcpath |
| 218 | [ "$(git ls-files -m)" = "" ] || |
| 219 | warn "working tree has uncommitted changes" |
| 220 | gitver=$(git describe) |
| 221 | esac |
| 222 | |
| 223 | ## Is there Debian build equipment? |
| 224 | case "$debian,$(yesno [ -d $srcpath/debian ])" in |
| 225 | yes,no) |
| 226 | info "No debian directory found." |
| 227 | debian=no debver=none |
| 228 | ;; |
| 229 | yes,yes) |
| 230 | debver=$(dpkg-parsechangelog | sed -n 's/^Version: //p') |
| 231 | ;; |
| 232 | esac |
| 233 | |
| 234 | ## Check the version number. |
| 235 | case "$gitver,$debver" in |
| 236 | none,* | *,none) |
| 237 | ;; |
| 238 | *) |
| 239 | [ "$gitver" = "$debver" ] || |
| 240 | warn "Git version $gitver doesn't match Debian version $debver" |
| 241 | ;; |
| 242 | esac |
| 243 | |
| 244 | ## Maybe check out a copy of the source. |
| 245 | case "$checkout" in |
| 246 | yes) |
| 247 | cd $releasepath |
| 248 | run git clone -sn $srcpath/.git _source |
| 249 | assign srcpath $releasepath/_source |
| 250 | cd $srcpath |
| 251 | run git checkout -b mdw-build $checkoutrev |
| 252 | ;; |
| 253 | esac |
| 254 | |
| 255 | ## Maybe refresh the build machinery. |
| 256 | case "$setup" in |
| 257 | yes) |
| 258 | run mdw-setup |
| 259 | ;; |
| 260 | esac |
| 261 | |
| 262 | ## Initialize the build directory. |
| 263 | case "$vpath,$(yesno [ -e $srcpath/configure ])" in |
| 264 | yes,yes) |
| 265 | assign buildpath $releasepath/_build |
| 266 | mkdir $buildpath |
| 267 | cd $buildpath |
| 268 | run $srcpath/configure |
| 269 | ;; |
| 270 | no,yes) |
| 271 | info "VPATH build disabled" |
| 272 | assign buildpath $srcpath |
| 273 | distcheck=no |
| 274 | cd $srcpath |
| 275 | run ./configure |
| 276 | ;; |
| 277 | *,no) |
| 278 | info "no configure script" |
| 279 | assign buildpath $srcpath |
| 280 | cd $srcpath |
| 281 | ;; |
| 282 | esac |
| 283 | |
| 284 | ## Discover the release name. |
| 285 | cat >find-distdir.mk <<'EOF' |
| 286 | include Makefile |
| 287 | print-distdir: |
| 288 | @echo >&3 $(distdir) |
| 289 | EOF |
| 290 | assign distdir \ |
| 291 | $({ make -f find-distdir.mk print-distdir >/dev/null 2>&1; } 3>&1) |
| 292 | |
| 293 | ## Get a tarball distribution. |
| 294 | case "$distcheck" in |
| 295 | yes) |
| 296 | run make $makeopts distcheck |
| 297 | ;; |
| 298 | no) |
| 299 | run make $makeopts dist |
| 300 | ;; |
| 301 | esac |
| 302 | |
| 303 | cd $releasepath |
| 304 | |
| 305 | if ! tar tf $buildpath/$distdir.tar.gz 2>/dev/null | grep -q RELEASE; then |
| 306 | fail "missing RELEASE file in distribution" |
| 307 | fi |
| 308 | |
| 309 | run mv $buildpath/$distdir.tar.gz . |
| 310 | |
| 311 | ## Maybe build the Debian packages. |
| 312 | case "$debian" in |
| 313 | yes) |
| 314 | run tar xvfz $distdir.tar.gz |
| 315 | cd $distdir |
| 316 | run dpkg-buildpackage -k$(mdw-conf releasekey) |
| 317 | ;; |
| 318 | esac |
| 319 | |
| 320 | ## Maybe upload Debian packages. |
| 321 | cd $releasepath |
| 322 | case "$upload,$build" in |
| 323 | yes,test) |
| 324 | info "Test build: not uploading." |
| 325 | ;; |
| 326 | yes,release) |
| 327 | run rsync $distdir.tar.gz \ |
| 328 | $(mdw-conf upload-target ftp.distorted.org.uk:~ftp/pub/mdw/) |
| 329 | case "$debian" in |
| 330 | yes) |
| 331 | run dput -f $(mdw-conf dput-target distorted) *.changes |
| 332 | ;; |
| 333 | esac |
| 334 | esac |
| 335 | |
| 336 | ## Tidy up. |
| 337 | case "$clean" in |
| 338 | yes) |
| 339 | rm -rf $releasepath/$distdir |
| 340 | rm -rf $releasepath/_source |
| 341 | rm -rf $releasepath/_build |
| 342 | ;; |
| 343 | esac |
| 344 | |
| 345 | ## Done. |
| 346 | info "All OK." |
| 347 | |
| 348 | ###----- That's all, folks -------------------------------------------------- |