buildscript.rb

# @BEGIN_LICENSE
#
# Halyard - Multimedia authoring and playback system
# Copyright 1993-2009 Trustees of Dartmouth College
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 2.1 of the
# License, or (at your option) any later version.
# 
# This 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
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
# USA.
#
# @END_LICENSE

require 'buildscript/build'
require 'buildscript/remote_host'
require 'pathname'

# Calculate this now, while we have a fighting chance of resolving relative
# paths correctly.
$_buildscript_source_dir = Pathname.new(File.dirname(__FILE__)).realpath

# Include this module to write build scripts in a domain-specific language.
#
#   require 'buildscript/buildscript'
#   include Buildscript
#
#   start_build :build_dir => 'c:/build/myproject'
#
#   heading 'Check out source code.'
#   run 'cvs', 'co', 'MyProject'
#   cd 'MyProject'
#
#   heading 'Build the project.'
#   run 'make'
#   release 'MyProject Installer.exe'
#
#   finish_build_and_upload_files
module Buildscript
  include BuildUtils
  
  # Start a new build running. See Build#new for options.
  def start_build options
    if ARGV.include? "--dirty"
      ARGV.delete "--dirty"
      options[:dirty_build] = true
    end
    if ARGV.include? "--release"
      ARGV.delete "--release"
      options[:release_build] = true
    end
    if ARGV.include? "--sign"
      ARGV.delete "--sign"
      options[:sign] = true
    end
    sections = ARGV.map {|arg| arg.to_sym}
    options[:enabled_headings] = sections unless sections == []
    $build = Build.new options
    cd $build.build_dir
  end

  # Finish the build, and upload all our files to the server.  No
  # files will be uploaded for a dirty build.
  def finish_build_and_upload_files
    $build.finish
  end

  # See Build#heading.
  def heading(str, options={}, &block) $build.heading(str, options, &block) end
  # See Report#run.
  def run(command, *args) $build.run(command, *args) end
  # See Build#sign?
  def sign?() $build.sign? end
  # See Build#dirty?
  def dirty_build?() $build.dirty? end
  # See Build#release?
  def release_build?() $build.release? end
  # See Build#sign_file
  def sign_file path, description=nil, description_url=nil
    $build.sign_file path, description, description_url
  end
  # See Build#sign_file_with_gpg
  def sign_file_with_gpg path
    $build.sign_file_with_gpg path
  end
  # See Build#release.
  def release(path, options={}) $build.release(path, options) end
  # See RemoteHost#initialize
  def remote_host(host, options={}) 
    RemoteHost.new(host, options.merge( {:runner => $build} )) 
  end

  def buildscript_source_dir() $_buildscript_source_dir end
  
  def release_id() $build.release_id end

  module_function :start_build, :finish_build_and_upload_files
  module_function :heading, :run, :sign?, :dirty_build?, :release_build?
  module_function :sign_file, :sign_file_with_gpg, :release, :release_id
end