bee 0.3.1 → 0.4.0

data/lib/bee_util.rb

@@ -0,0 +1,230 @@
+# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+#           2006 Avi Bryant
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Bee
+  
+  module Util
+    
+    # Get line length calling IOCTL. Return nil if call failed.
+    # FIXME: doesn't work on MacOSX.
+    def self.term_width
+      begin
+        tiocgwinsz = 0x5413
+        string = [0, 0, 0, 0].pack('SSSS')
+        if $stdin.ioctl(tiocgwinsz, string) >= 0 then
+          rows, cols, xpixels, ypixels = string.unpack('SSSS')
+          return cols
+        end
+      rescue
+        return nil
+      end
+    end
+
+    # Looks recursively up in file system for a file.
+    # - file: file name to look for.
+    # Return: found file or raises an exception if file was not found.
+    def self.find(file)
+      return file if File.exists?(file)
+      raise "File not found" if File.identical?(File.dirname(file), '/')
+      file = File.join('..', file)
+      find(file)
+    end
+
+    # Default package name.
+    DEFAULT_PACKAGE = 'default'
+    
+    # Parse packaged name and return package and name.
+    # - packaged: packaged name (such as 'foo.bar').
+    # Return: package ('foo') and name ('bar').
+    def self.get_package_name(packaged)
+      if packaged =~ /\./
+        package, name = packaged.split('.')
+      else
+        package, name = DEFAULT_PACKAGE, packaged
+      end
+      return package, name
+    end
+      
+    # Class that holds information about a given method.
+    class MethodInfo
+      
+      attr_accessor :source, :comment, :defn, :params
+      
+      def initialize(file, lineno)
+        lines = file_cache(file)
+        @source = match_tabs(lines, lineno, "def")
+        @comment = preceding_comment(lines, lineno)
+        @defn = lines[lineno].strip.gsub(/^def\W+(.*?\W*\((.*?)\))/){$1}
+        @params = $2 ? $2.split(',') : nil
+      end
+      
+      private
+      
+      @@file_cache = {}
+      
+      def file_cache(file)
+        unless lines = @@file_cache[file]
+          @@file_cache[file] = lines = File.new(file).readlines
+        end
+        lines
+      end	
+      
+      def match_tabs(lines, i, keyword)
+        lines[i] =~ /(\W*)((#{keyword}(.*;\W*end)?)|(.*))/
+        return $2 if $4 or $5
+        tabs = $1
+        result = ""
+        lines[i..-1].each do |line|
+          result << line.gsub(/^#{tabs}(.*)/) { $1}
+          return result if $1 =~ /^end/
+        end
+      end
+      
+      def preceding_comment(lines, i)
+        result = []
+        i = i-1
+        i = i-1 while lines[i] =~ /^\W*$/
+        if lines[i] =~ /^=end/
+          i = i-1
+          until lines[i] =~ /^=begin/
+            result.unshift lines[i]
+            i = i-1
+          end
+        else
+          while lines[i] =~ /^\W*#(.*)/
+            result.unshift $1[1..-1]
+            i = i-1
+          end
+        end
+        result.join("\n")
+      end
+      
+    end
+    
+    # This abstract class provides information about its methods.
+    class MethodInfoBase
+      
+      @@minfo = {}
+      
+      def self.method_info(method)
+        @@minfo[method.to_s]
+      end
+      
+      private
+      
+      def self.method_added(method)
+        super if defined? super
+        last = caller[0]
+        file = last[0, last.rindex(':')]
+        lineno = last[last.rindex(':')+1, last.length]
+        @@minfo[method.to_s] = MethodInfo.new(file, lineno.to_i - 1)
+      end
+      
+    end
+
+    # Error raised on a user error. This error should be raised to interrupt
+    # the build with a message on console but with no stack trace (that should
+    # be displayed on an internal error only). Include BuildErrorMixin to get
+    # a convenient way to raise such an error.
+    class BuildError < RuntimeError
+    end
+    
+    # Build error mixin provides error() function to raise a BuildError.
+    # Use this function to interrupt the build on a user error (bad YAML
+    # syntax, error running a task and so on). This will result in an
+    # error message on the console, with no stack trace.
+    module BuildErrorMixin
+      
+      # Convenient method to raise a BuildError.
+      # - message: error message.
+      def error(message)
+        raise BuildError.new(message)
+      end
+      
+    end
+    
+    # Mixin that provides a way to check a hash entries using a description
+    # that associates hash keys with a :mandatory or :optional symbol. Other
+    # keys are not allowed.
+    module HashCheckerMixin
+
+      include BuildErrorMixin
+      
+      # Check that all mandatory keys are in the hash and all keys in the
+      # hash are in description.
+      # - hash: hash to check.
+      # - description: hash keys description.
+      def check_hash(hash, description)
+        # check for mandatory keys
+        for key in description.keys
+          case description[key]
+          when :mandatory
+            error "Missing mandatory key '#{key}'" if not hash[key]
+          when :optional
+          else
+            error "Unknown symbol '#{description[key]}'"
+          end
+        end
+        # look for unknown keys in hash
+        for key in hash.keys
+          error "Unknown key '#{key}'" if not description.keys.member?(key)
+        end
+      end
+      
+    end
+
+    # Module that includes a mixin that provides file selection using include
+    # and exclude globs.
+    module FileSelector
+      
+      include BuildErrorMixin
+      
+      # Select files with globs to include and exclude.
+      # - include: glob (or list of globs) for files to include.
+      # - exclude: glob (or list of globs) for files to exclude.
+      # Return: a list of files as strings.
+      def select_files(includes, excludes)
+        return [] if !includes
+        error "includes can't be nil" if not includes
+        error "includes must be a glob or a list of globs" unless
+        includes.kind_of?(String) or includes.kind_of?(Array)
+        error "excludes must be a glob or a list of globs" unless
+        !excludes or excludes.kind_of?(String) or excludes.kind_of?(Array)
+        included = []
+        for include in includes
+          error "includes must be a glob or a list of globs" unless
+          include.kind_of?(String)
+          included += Dir.glob(include)
+        end
+        if excludes
+          excluded = []
+          for exclude in excludes
+            error "excludes must be a glob or a list of globs" unless
+            exclude.kind_of?(String)
+            excluded += Dir.glob(exclude)
+          end
+          included = included.select do |file|
+            !excluded.member?(file)
+          end
+        end
+        return included
+      end
+      
+    end
+    
+  end
+  
+end

data/test/tc_bee_build.rb

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby
+
+# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+$:.unshift(File.join(File.dirname(__FILE__)))
+require 'tmp_test_case'
+require 'test_build_listener'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bee'
+
+# Test case for console formatter.
+class TestBeeBuild < TmpTestCase
+
+  def test_load
+    # try loading a build file that doesn't exist
+    begin
+      Bee::Build::load('foo')
+      flunk "Build file should not have been found!"
+    rescue Bee::Util::BuildError
+      expected = "Build file 'foo' not found"
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+    # try loading a build file that is a directory
+    begin
+      Bee::Build::load('.')
+      flunk "Build file may not be a directory!"
+    rescue Bee::Util::BuildError
+      expected = "Build file '.' is not a file"
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+    # try running a build that should never fail
+    build_file = File.join(@tmp_dir, 'build.yml')
+    begin
+      source = '- target: test
+  script:
+    - print: "Hello World!"'
+      File.open(build_file, 'w') {|file| file.write(source)}
+      listener = TestBuildListener.new
+      build = Bee::Build::load(build_file)
+      build.run('', listener)
+    ensure
+      File.delete(build_file)
+    end
+    # try loading a build file with YAML syntax error
+    begin
+      source = 
+'- target: test
+   script: \"test\"'
+      File.open(build_file, 'w') {|file| file.write(source)}
+      build = Bee::Build::load(build_file)
+      flunk "Should fail to parse YAML file!"
+    rescue Bee::Util::BuildError
+      expected = "YAML syntax error in build file: syntax error on line 1, " +
+        "col 10: `   script: \\\"test\\\"'"
+      actual = $!.message
+      assert_equal(expected, actual)
+    ensure
+      File.delete(build_file)
+    end
+    # try loading a build file that is a YAML string
+    begin
+      source = 'foo'
+      File.open(build_file, 'w') {|file| file.write(source)}
+      build = Bee::Build::load(build_file)
+      flunk "Build object must be a list!"
+    rescue Bee::Util::BuildError
+      expected = "Build must be a list"
+      actual = $!.message
+      assert_equal(expected, actual)
+    ensure
+      File.delete(build_file)
+    end
+  end
+  
+  def test_initialize
+    # try loading a build object (resulting from loading YAML file) that is not
+    # a list
+    begin
+      Bee::Build.new(Object.new, nil)
+      flunk "Build object must be a list!"
+    rescue Bee::Util::BuildError
+      expected = "Build must be a list"
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+    # try loading a build object with two build info entries
+    object = [{'build' => 'test'}, {'build' => 'test'}]
+    begin
+      Bee::Build.new(object, nil)
+      flunk "Build can't have duplicate info entries!"
+    rescue Bee::Util::BuildError
+      expected = "Duplicate build info"
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+    # try loading a build object defining a context
+    context_file = 'context.rb'
+    context_path = File.join(@tmp_dir, context_file)
+    context_source = 'def test
+set_property(:tested, true)
+end'
+    File.open(context_path, 'w') {|file| file.write(context_source)}
+    object = [{'build' => 'test', 'context' => context_file},
+      {'target' => 'test', 'script' => [{'rb' => 'test'}]}]
+    listener = TestBuildListener.new
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    build.run('', listener)
+    assert(build.context.get_property(:tested))
+    assert(listener.started)
+    assert(listener.finished)
+    assert(!listener.errors)
+    # try loading a buggy context
+    context_file = 'context.rb'
+    context_path = File.join(@tmp_dir, context_file)
+    context_source = 'def test end'
+    File.open(context_path, 'w') {|file| file.write(context_source)}
+    object = [{'build' => 'test', 'context' => context_file},
+      {'target' => 'test', 'script' => [{'rb' => 'test'}]}]
+    listener = TestBuildListener.new
+    begin
+      build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+      flunk "Should have raised a BuildError"
+    rescue Bee::Util::BuildError
+      assert_match(/Error loading context 'context.rb': compile error/,
+        $!.message)
+    end
+    # load a build defining properties
+    object = [{'properties' => [{'foo' => 'bar'}]}]
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    assert_equal(build.context.get_property(:foo), 'bar')
+    # load a build defining duplicate properties
+    object = [{'properties' => [{'foo' => 'bar'}, {'foo' => 'bar'}]}]
+    begin
+      build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    rescue Bee::Util::BuildError
+      assert_equal("Property 'foo' was already defined", $!.message)
+    end
+    # load a build with unknown entry
+    object = [{'foo' => 'bar'}]
+    begin
+      build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    rescue Bee::Util::BuildError
+      assert_match("Unknown entry:", $!.message)
+    end
+    # try running a buggy build with a listener
+    object = [{'target' => 'test', 'script' => [{'foo' => 'bar'}]}]
+    listener = TestBuildListener.new
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    build.run('', listener)
+    assert(listener.started)
+    assert(!listener.finished)
+    assert(listener.errors)
+    # try running a buggy build without a listener
+    object = [{'target' => 'test', 'script' => [{'foo' => 'bar'}]}]
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    begin
+      build.run('', nil)
+    rescue Bee::Util::BuildError
+      assert_equal("Task 'foo' not found in package 'default'", $!.message)
+    end
+    # try running a build with dependencies
+    target1 = {'target' => 'test1', 
+      'script' => [{'rb' => 'set_property(:foo, "bar")'}]}
+    target2 = {'target' => 'test2', 'depends' => 'test1'}
+    object = [target2, target1]
+    listener = TestBuildListener.new
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    build.run('', listener)
+    assert(listener.started)
+    assert(listener.finished)
+    assert(!listener.errors)
+    assert_equal(['test1', 'test2'], 
+                 listener.targets.collect {|target| target.name})
+    # run a task with two keys
+    object = [{'target' => 'test', 
+                'script' => [{'foo' => 'bar', 'spam' => 'eggs'}]}]
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    begin
+      build.run('', nil)
+    rescue Bee::Util::BuildError
+      assert_equal("A task entry must be a Hash with a single key", $!.message)
+    end
+    # run a buggy Ruby script
+    object = [{'target' => 'test', 'script' => [{'rb' => 'bar'}]}]
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    begin
+      build.run('', nil)
+    rescue Bee::Util::BuildError
+      assert_match(/Error running Ruby script/, $!.message)
+    end
+    # run a buggy Ruby script (with bad property reference)
+    object = [{'target' => 'test', 'script' => [{'print' => :bar}]}]
+    build = Bee::Build.new(object, File.join(@tmp_dir, 'build.yml'))
+    begin
+      build.run('', nil)
+    rescue Bee::Util::BuildError
+      assert_match(/Property 'bar' was not set/,
+        $!.message)
+    end
+  end
+
+end

data/test/tc_bee_console.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'stringio'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bee_console'
+$:.unshift(File.dirname(__FILE__))
+require 'tmp_test_case'
+
+# Test context.
+class TestBeeConsole < TmpTestCase
+  
+  def test_parse_command_line
+    ARGV.replace(['-h', '-b', '-k', 'foo', '-t', '-v', '-s', 'bar', '-f', 'spam', 'eggs'])
+    actual = Bee::Console.parse_command_line
+    expected = [true, true, true, 'foo', true, true, 'bar', 'spam', false, ['eggs']]
+    assert_equal(expected, actual)
+  end
+  
+  def test_start_command_line
+    stdout = $stdout
+    stderr = $stderr
+    output = StringIO.new
+    $stdout = $stderr = output
+    begin
+      # nominal case starting a build from command line
+      build_file = 'test.yml'
+      build_path = File.join(@tmp_dir, build_file)
+      source = '- target: test
+  script: "cd ."'
+      File.open(build_path, 'w') {|file| file.write(source)}
+      ARGV.replace(['-f', build_path])
+      Bee::Console.start_command_line
+      # error parsing command line arguments
+      ARGV.replace(['-z'])
+      begin
+        Bee::Console.start_command_line
+        flunk "Command line parsing should have failed"
+      rescue SystemExit => e
+        assert_equal(Bee::Console::EXIT_PARSING_CMDLINE, e.status)
+      end
+      # help command
+      ARGV.replace(['-h'])
+      Bee::Console.start_command_line
+      # build help
+      build_file = 'test.yml'
+      build_path = File.join(@tmp_dir, build_file)
+      source = '- target: test
+  script: "cd ."'
+      File.open(build_path, 'w') {|file| file.write(source)}
+      ARGV.replace(['-f', build_path, '-b'])
+      Bee::Console.start_command_line
+      # task help
+      ARGV.replace(['-k', 'print'])
+      Bee::Console.start_command_line
+      # task help
+      ARGV.replace(['-k', '?'])
+      Bee::Console.start_command_line
+      # error task help
+      ARGV.replace(['-k', 'foo'])
+      begin
+        Bee::Console.start_command_line
+        flunk "Should have failed"
+      rescue Exception
+      end
+      # template generation
+      build_file = 'test.yml'
+      build_path = File.join(@tmp_dir, build_file)
+      File.delete(build_path)
+      build_path = File.join(build_path)
+      ARGV.replace(['-f', build_path, '-t'])
+      Bee::Console.start_command_line
+      # template generation with a build file that already exists
+      begin
+        build_file = 'test.yml'
+        build_path = File.join(@tmp_dir, build_file)
+        build_path = File.join(build_path)
+        ARGV.replace(['-f', build_path, '-t'])
+        Bee::Console.start_command_line
+        flunk "Template generation should have failed"
+      rescue SystemExit => e
+        assert_equal(Bee::Console::EXIT_BUILD_ERROR, e.status)
+      end
+      # test unknown internal error
+      # TODO
+    ensure
+      $stdout = stdout
+      $stderr = stderr
+    end
+  end
+  
+end