build-tool 0.0.3 → 0.1.0

data/tasks/genfiles.rake

@@ -0,0 +1,28 @@
+PARSER = Dir["lib/build-tool/*.y", "lib/build-tool/cfg/*.y"].map { |f| f.chomp(".y") }
+
+rule '.rb' => [ '.y' ] do |t|
+    puts "generating #{t.source}"
+    sh "racc -o#{t.name} #{t.source}"
+end
+
+PARSER.each do |parser|  # need closure
+    # file "#{parser}.rb" => [ "#{parser}.y" ]
+    task :genfiles  => [ "#{parser}.rb" ]
+end
+
+
+LEXER = Dir["lib/build-tool/*.rex", "lib/build-tool/cfg/*.rex"].map { |f| f.chomp(".rex") }
+rule '.rb' => [ '.rex' ] do |t|
+    puts "generating #{t.source}"
+    sh "rex -o#{t.name} #{t.source}"
+end
+
+LEXER.each do |lexer|  # need closure
+    # file "#{lexer}.rb" => [ "#{lexer}.rex" ]
+    task :genfiles  => [ "#{lexer}.rb" ]
+end
+
+task :test      => :genfiles
+
+desc 'Regenerate all rex and racc files if necessary.'
+task :genfiles

data/tasks/rdoc.rake

@@ -0,0 +1,34 @@
+begin
+  require 'yard'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'yard'
+end
+begin
+  require 'yard/rake/yardoc_task'
+rescue LoadError
+  puts <<-EOS
+To use yard you must install the gem:
+    gem install yard
+EOS
+  exit(0)
+end
+
+namespace :yard do
+
+    desc "Create yardoc documentation"
+    YARD::Rake::YardocTask.new :generate do |t|
+      t.files   = ['lib/**/*.rb']
+      t.options = ['--output-dir', "meta/documentation" ]
+    end
+
+    YARD::Rake::YardocTask.new :dot_yardoc do |t|
+      t.files   = ['lib/**/*.rb']
+      t.options = ['--no-output', '--readme', 'README.mkdn']
+    end
+
+    task :open do
+      system 'open ' + 'meta' / 'documentation' / 'index.html' if PLATFORM['darwin']
+    end
+
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/test.rb

@@ -0,0 +1,28 @@
+module Wrrr
+    def self.included( base )
+        base.module_eval do
+            alias_method :old_doit, :doit
+            remove_method :doit
+        end
+
+        def doit
+            "Yes"
+        end
+        def doit2
+            "Yes"
+        end
+    end
+end
+
+class Test
+    def doit
+        "Hallo"
+    end
+    include Wrrr
+end
+
+t = Test.new
+puts t.old_doit
+puts t.doit
+puts t.doit2
+

data/test/commands/test_build.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+require Pathname.new( File.dirname(__FILE__)).join( '../test_helper' ).cleanpath
+
+require 'build-tool/configuration'
+require 'build-tool/commands'
+require 'build-tool/commands/build'
+
+class TestBuildCommand < ::Test::Unit::TestCase
+
+  def test_default_values
+    cmd = BuildTool::Commands::Build.new( BuildTool::Configuration.new(nil) )
+    assert_equal cmd.name, "build"
+    assert_equal cmd.description, "Build a module."
+    # clean is off by default
+    assert_equal false, cmd.instance_variable_get( "@clean" )
+    # configure is off by default
+    assert_equal false, cmd.instance_variable_get( "@configure" )
+    # from-scratch is off by default
+    assert_equal false, cmd.instance_variable_get( "@from_scratch" )
+    # install is off by default
+    assert_equal true, cmd.instance_variable_get( "@install" )
+    # reconfigure is off by default
+    assert_equal false, cmd.instance_variable_get( "@reconfigure" )
+    # update is off by default
+    assert_equal false, cmd.instance_variable_get( "@update" )
+  end
+
+end
+

data/test/test_build_system.rb

@@ -0,0 +1,98 @@
+require 'pathname'
+require Pathname.new( File.dirname(__FILE__)).join( 'test_helper' ).cleanpath
+
+require 'build-tool/build-system/base'
+require 'build-tool/module'
+require 'build-tool/cfg/parser'
+
+class TestBuildSystem < Test::Unit::TestCase
+
+    def test_creation
+        base = BuildTool::BuildSystem::Base.new
+
+        # Out of source build is default
+        assert base.out_of_source
+
+        # No module is set
+        assert_nil base.module
+
+        # No options set
+        assert_equal 0, base.options.size
+    end
+
+    def test_virtual_methods
+        base = BuildTool::BuildSystem::Base.new
+
+        assert_raise NotImplementedError do
+            base.configure
+        end
+
+        assert_raise NotImplementedError do
+            base.configured?
+        end
+
+        assert_raise NotImplementedError do
+            base.make
+        end
+
+        assert_raise NotImplementedError do
+            base.name
+        end
+
+        assert_raise NotImplementedError do
+            base.reconfigure
+        end
+    end
+
+    def test_module_required
+        base = BuildTool::BuildSystem::Base.new
+
+        assert_raise BuildTool::ConfigurationError do
+            base.source_directory
+        end
+
+        assert_raise BuildTool::ConfigurationError do
+            base.install_prefix
+        end
+
+        mod = BuildTool::Module::new( "kdelibs" )
+        base.module = mod
+
+        assert_raise BuildTool::ConfigurationError do
+            base.source_directory
+        end
+
+        assert_raise BuildTool::ConfigurationError do
+            base.install_prefix
+        end
+
+        mod.install_prefix= "/opt/kde"
+        assert_equal "/opt/kde", base.install_prefix.to_s
+
+        mod.build_prefix= "/home/user/kde"
+        assert_equal "/home/user/kde/src/kdelibs", base.source_directory
+    end
+
+    def test_dup
+        base = BuildTool::BuildSystem::CMake.new
+        base['CMAKE_BUILD_TYPE'] = 'Debug'
+        assert_equal 'Debug', base['CMAKE_BUILD_TYPE']
+        copy = base.dup
+        base['CMAKE_BUILD_TYPE'] = 'Release'
+        assert_equal 'Debug', copy['CMAKE_BUILD_TYPE']
+        assert_equal 'Release', base['CMAKE_BUILD_TYPE']
+    end
+
+    def test_parsing
+        text = <<EOS
+build-system "cmake"
+    inplace
+end
+EOS
+        parser = BuildTool::Cfg::Parser.new
+        configuration = parser.parse_string(text)
+        test = configuration.build_system( "cmake" )
+        assert !test.out_of_source
+    end
+
+end

data/test/test_cli.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+require Pathname.new( File.dirname(__FILE__)).join( 'test_helper' ).cleanpath
+
+require 'build-tool/configuration'
+require 'build-tool/commands'
+require 'build-tool/commands/build'
+require 'build-tool/commands/help'
+require 'build-tool/commands/recipes'
+require 'build-tool/commands/recipes/list'
+require 'build-tool/commands/recipes/install'
+
+class TestCli < Test::Unit::TestCase
+
+  def setup
+      cfg = BuildTool::Configuration.new(nil)
+      @cmd = BuildTool::Commands::Shell.new( cfg )
+      @cmd.add_command( BuildTool::Commands::Build.new( cfg ) )
+      @cmd.add_command( BuildTool::Commands::Help.new( cfg ) )
+      @cmd.add_command( BuildTool::Commands::Recipes::CLI.new( cfg ) )
+      @cmd.get_command( "recipes" ).add_command( BuildTool::Commands::Recipes::List.new( cfg ) )
+      @cmd.get_command( "recipes" ).add_command( BuildTool::Commands::Recipes::Install.new( cfg ) )
+  end
+
+  def teardown
+      @cmd = nil
+  end
+
+  def test_command_completion
+      assert_equal ["build"], @cmd.complete_command("bui")
+      assert_equal ["build", "help", "recipes"], @cmd.complete_command("")
+
+      assert_equal ["build"], @cmd.complete("bui")
+      assert_equal ["build", "help", "recipes"], @cmd.complete("")
+
+
+  end
+
+  def test_subcommand_completion
+      if !Readline.respond_to? 'line_buffer'
+          assert_equal ["recipes list", "recipes install"], @cmd.complete( "recipes")
+          assert_equal ["recipes list", "recipes install"], @cmd.complete( "recipes ")
+      else
+          assert_equal ["list", "install"], @cmd.complete( "recipes")
+          assert_equal ["list", "install"], @cmd.complete( "recipes ")
+      end
+  end
+
+  def test_argument_completion
+      require 'readline'
+      cmd = @cmd.get_command( "build" )
+      if !Readline.respond_to? 'line_buffer'
+          assert_equal ["build --clean", "build --configure"], cmd.complete( "build --c" )
+          assert_equal ["build --from-scratch --clean", "build --from-scratch --configure"], cmd.complete( "build --from-scratch --c")
+          assert_equal ["build --from-scratch --install"], cmd.complete( "build --from-scratch --inst")
+      else
+          assert_equal ["--clean", "--configure"], cmd.complete( "build --c" )
+          assert_equal ["--clean", "--configure"], cmd.complete( "build --from-scratch --c" )
+      end
+  end
+
+end

data/test/test_command.rb

@@ -0,0 +1,175 @@
+require 'pathname'
+require Pathname.new( File.dirname(__FILE__)).join( 'test_helper' ).cleanpath
+
+require 'build-tool/configuration'
+require 'build-tool/commands'
+
+class TestCommand < BuildTool::Commands::Standard
+
+    name        "simple_test"
+    description "For Testing purposes"
+
+    attr_reader :do_clean, :do_configure, :do_from_scratch, :do_install, :do_reconfigure, :do_update
+
+    def initialize_options
+        @do_clean        = false
+        @do_configure    = false
+        @do_from_scratch = false
+        @do_install      = true
+        @do_reconfigure  = false
+        @do_update       = false
+
+        reset_done_markers
+
+        options.on( "--[no-]clean", "Make clean before building." ) { |t|
+            @do_clean = t
+            }
+
+        options.on( "--[no-]install", "Do not install" ) { |t|
+            @do_install = t
+            }
+
+        options.on( "--[no-]update", "Do not update from the repository" ) { |t|
+            @do_update = t
+            }
+
+        options.on( "-c", "--configure", "Run the configuration step again" ) { |t|
+            @do_configure = true
+            }
+
+        options.on( "--reconfigure", "Remove old configuration then run configuration again" ) { |t|
+            @do_reconfigure = true
+            }
+
+        options.on( nil, "--from-scratch", "Rebuild from scratch" ) { |t|
+            @do_from_scratch = true
+            }
+
+        super
+
+    end
+
+    # Reset the done markers
+    def reset_done_markers
+        @done_help = false
+        @done_command = false
+    end
+
+    # Overload the show_help method to check if it was executed
+    def show_help( args = [] )
+        @done_help = true
+        super
+    end
+    attr_reader :done_help
+
+    # # Overload the do_execute method to check if it was executed
+    def do_execute( args )
+        @done_command = true
+    end
+    attr_reader :done_command
+
+end # class Build
+
+
+class TestBuildtoolCommands < ::Test::Unit::TestCase
+
+  def test_default_values
+    cmd = TestCommand.new( BuildTool::Configuration.new(nil) )
+
+    assert_equal cmd.name, "simple_test"
+    assert_equal cmd.description, "For Testing purposes"
+
+    # clean is off by default
+    assert !cmd.do_clean, "do not clean"
+    # configure is off by default
+    assert !cmd.do_configure, "do not configure"
+    # from-scratch is off by default
+    assert !cmd.do_from_scratch, "do not build from scratch"
+    # install is off by default
+    assert cmd.do_install, "do install"
+    # reconfigure is off by default
+    assert !cmd.do_reconfigure, "do not reconfigure"
+    # update is off by default
+    assert !cmd.do_update, "do not update"
+
+  end
+
+  def test_help
+      # With --help call show_help and then return without executing the
+      # command
+      cmd = TestCommand.new( BuildTool::Configuration.new(nil) )
+      assert !cmd.done_help.nil? and !cmd.done_help
+      assert !cmd.done_command.nil? and !cmd.done_command
+
+      expected_output = <<EOS
+Usage: simple_test [options]
+        --[no-]clean                 Make clean before building.
+        --[no-]install               Do not install
+        --[no-]update                Do not update from the repository
+    -c, --configure                  Run the configuration step again
+        --reconfigure                Remove old configuration then run configuration again
+        --from-scratch               Rebuild from scratch
+Common options
+    -v, --verbose                    Enable verbose output
+        --dry-run                    Enable dry run.
+    -h, --help                       Show this help text
+EOS
+      # *TODO* make that work again
+      # assert_output( expected_output ) { cmd.execute(["--help"]) }
+      cmd.execute(["--help"])
+      assert cmd.done_help, "help was shown"
+      assert !cmd.done_command, "command was not executed"
+  end
+
+  def test_verbose
+
+      Logging.logger.root.appenders = Logging.appenders.stdout(
+          :layout => Logging::Layouts::Pattern.new( :pattern => '%m\n' ),
+          :level  => :info)
+
+      # --verbose should increase the verbosity by one
+      cmd = TestCommand.new( BuildTool::Configuration.new(nil) )
+
+      Logging.appenders['stdout'].level = :info
+      current = Logging.appenders['stdout'].level
+      cmd.execute(["--verbose"])
+      assert_equal current - 1, Logging.appenders['stdout'].level
+
+      Logging.appenders['stdout'].level = current
+      cmd.execute(["--verbose", "--verbose"])
+      assert_equal current - 2, Logging.appenders['stdout'].level
+
+      # There are no more levels.
+      Logging.appenders['stdout'].level = current
+      cmd.execute(["--verbose", "--verbose", "--verbose", "--verbose", "--verbose", "--verbose", "--verbose"])
+      assert_equal 0, Logging.appenders['stdout'].level
+
+      Logging.logger.root.clear_appenders()
+  end
+
+  def test_execute_twice
+      # When executing the command more than once make sure the options are
+      # reset
+      cmd = TestCommand.new( BuildTool::Configuration.new(nil) )
+      assert !cmd.done_help.nil? and !cmd.done_help
+      assert !cmd.done_command.nil? and !cmd.done_command
+      cmd.execute(["--install", "--clean"])
+      assert cmd.do_install, "do make install"
+      assert cmd.do_clean,   "do make clean"
+
+      cmd.execute(["--update", "--configure"])
+      assert cmd.do_install, "do not make install"
+      assert !cmd.do_clean,   "do not make clean"
+      assert cmd.do_update, "do update"
+      assert cmd.do_configure,   "do configure"
+  end
+
+  def test_completion
+      cmd = TestCommand.new( BuildTool::Configuration.new(nil) )
+      assert_equal [ "--from-scratch" ], cmd.complete_arguments( ["--from"] )
+      assert_equal ["--no-clean", "--no-install", "--no-update"], cmd.complete_arguments( ["--no"] )
+      assert_equal ["--clean", "--configure"], cmd.complete_arguments( ["--c"] )
+  end
+
+end
+