mguymon-buildr 1.4.5-java

data/spec/java/commands_spec.rb

@@ -0,0 +1,93 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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 File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+
+describe Java::Commands do
+
+  it "should not be verbose by default" do
+    write "build.xml", <<-BUILD
+    <project name="MyProject" default="dist" basedir=".">
+        <description>
+            simple example build file
+        </description>
+        <target name="dist"/>
+    </project>
+BUILD
+    lambda { Java::Commands.java("org.apache.tools.ant.Main", :classpath => Buildr::Ant.dependencies) }.should_not show_info(/java/)
+    lambda { Java::Commands.java("org.apache.tools.ant.Main", :classpath => Buildr::Ant.dependencies, :verbose => true) }.should show_info(/java/)
+  end
+  
+  describe "Java::Commands.javac" do
+    
+    it "should compile java" do
+      write "Foo.java", "public class Foo {}"
+      lambda { Java::Commands.javac("Foo.java") }.should change {File.exist?("Foo.class")}.to(true)
+    end
+      
+    it 'should let the user specify an output directory' do
+      write "Foo.java", "public class Foo {}"
+      lambda { Java::Commands.javac("Foo.java", :output => "classes") }.should change {File.exist?("classes/Foo.class")}.to(true)
+    end
+    
+    it "should let the user specify a different name" do
+      write "Foo.java", "public class Foo {}"
+      lambda { Java::Commands.javac("Foo.java", :name => "bar") }.should show_info("Compiling 1 source files in bar")
+    end
+    
+    it "should let the user specify a source path" do
+      write "ext/org/Bar.java", "package org; public class Bar {}"
+      write "Foo.java", "import org.Bar;\n public class Foo {}"
+      lambda { Java::Commands.javac("Foo.java", :sourcepath => File.expand_path("ext")) }.should change {File.exist?("Foo.class")}.to(true)
+    end
+    
+    it "should let the user specify a classpath" do
+      write "ext/org/Bar.java", "package org; public class Bar {}"
+      Java::Commands.javac("ext/org/Bar.java", :output => "lib")
+      write "Foo.java", "import org.Bar;\n public class Foo {}"
+      lambda { Java::Commands.javac("Foo.java", :classpath => File.expand_path("lib")) }.should change {File.exist?("Foo.class")}.to(true)
+    end
+  end
+  
+  describe "Java::Commands.javadoc" do
+    
+    it "should fail if no output is defined" do
+      lambda { Java::Commands.javadoc("Foo.java") }.should raise_error(/No output defined for javadoc/)
+    end
+    
+    it "should create javadoc" do
+      write "Foo.java", "public class Foo {}"
+      lambda { Java::Commands.javadoc("Foo.java", :output => "doc") }.should change {File.exist?("doc/Foo.html")}.to(true)
+    end
+    
+    it "should accept file tasks as arguments" do
+      foo = file("Foo.java") do |file|
+        file.enhance do
+          write file.to_s, "public class Foo {}"
+        end
+      end
+      lambda { Java::Commands.javadoc(foo, :output => "doc") }.should change {File.exist?("doc/Foo.html")}.to(true)
+    end
+      
+    it "should accept projects as arguments" do
+      write "src/main/java/Foo.java", "public class Foo {}"
+      write "src/main/java/bar/Foobar.java", "package bar; public class Foobar {}"
+      define "foo" do
+      end
+      lambda { Java::Commands.javadoc(project("foo"), :output => "doc") }.should change {File.exist?("doc/Foo.html") && File.exist?("doc/bar/Foobar.html")}.to(true)
+    end
+  end
+end

data/spec/java/compiler_spec.rb

@@ -0,0 +1,252 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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 File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+
+describe 'javac compiler' do
+  it 'should identify itself from source directories' do
+    write 'src/main/java/com/example/Test.java', 'package com.example; class Test {}'
+    define('foo').compile.compiler.should eql(:javac)
+  end
+
+  it 'should identify from source directories using custom layout' do
+    write 'src/com/example/Code.java', 'package com.example; class Code {}'
+    write 'testing/com/example/Test.java', 'package com.example; class Test {}'
+    custom = Layout.new
+    custom[:source, :main, :java] = 'src'
+    custom[:source, :test, :java] = 'testing'
+    define 'foo', :layout=>custom do
+      compile.compiler.should eql(:javac)
+      test.compile.compiler.should eql(:javac)
+    end
+  end
+
+  it 'should identify from compile source directories' do
+    write 'src/com/example/Code.java', 'package com.example; class Code {}'
+    write 'testing/com/example/Test.java', 'package com.example; class Test {}'
+    define 'foo' do
+      lambda { compile.from 'src' }.should change { compile.compiler }.to(:javac)
+      lambda { test.compile.from 'testing' }.should change { test.compile.compiler }.to(:javac)
+    end
+  end
+
+  it 'should report the language as :java' do
+    define('foo').compile.using(:javac).language.should eql(:java)
+  end
+
+  it 'should set the target directory to target/classes' do
+    define 'foo' do
+      lambda { compile.using(:javac) }.should change { compile.target.to_s }.to(File.expand_path('target/classes'))
+    end
+  end
+
+  it 'should not override existing target directory' do
+    define 'foo' do
+      compile.into('classes')
+      lambda { compile.using(:javac) }.should_not change { compile.target }
+    end
+  end
+
+  it 'should not change existing list of sources' do
+    define 'foo' do
+      compile.from('sources')
+      lambda { compile.using(:javac) }.should_not change { compile.sources }
+    end
+  end
+
+  it 'should include classpath dependencies' do
+    write 'src/dependency/Dependency.java', 'class Dependency {}'
+    define 'dependency', :version=>'1.0' do
+      compile.from('src/dependency').into('target/dependency')
+      package(:jar)
+    end
+    write 'src/test/DependencyTest.java', 'class DependencyTest { Dependency _var; }'
+    define('foo').compile.from('src/test').with(project('dependency')).invoke
+    file('target/classes/DependencyTest.class').should exist
+  end
+
+  it 'should include tools.jar dependency' do
+    write 'src/main/java/UseApt.java', <<-JAVA
+      import com.sun.mirror.apt.AnnotationProcessor;
+      public class UseApt { }
+    JAVA
+    define('foo').compile.invoke
+    file('target/classes/UseApt.class').should exist
+  end
+end
+
+
+describe 'javac compiler options' do
+  def compile_task
+    @compile_task ||= define('foo').compile.using(:javac)
+  end
+
+  def javac_args
+    compile_task.instance_eval { @compiler }.send(:javac_args)
+  end
+
+  it 'should set warnings option to false by default' do
+    compile_task.options.warnings.should be_false
+  end
+
+  it 'should set warnings option to true when running with --verbose option' do
+    verbose true
+    compile_task.options.warnings.should be_false
+  end
+
+  it 'should use -nowarn argument when warnings is false' do
+    compile_task.using(:warnings=>false)
+    javac_args.should include('-nowarn')
+  end
+
+  it 'should not use -nowarn argument when warnings is true' do
+    compile_task.using(:warnings=>true)
+    javac_args.should_not include('-nowarn')
+  end
+
+  it 'should not use -verbose argument by default' do
+    javac_args.should_not include('-verbose')
+  end
+
+  it 'should use -verbose argument when running with --trace=javac option' do
+    Buildr.application.options.trace_categories = [:javac]
+    javac_args.should include('-verbose')
+  end
+
+  it 'should set debug option to true by default' do
+    compile_task.options.debug.should be_true
+  end
+
+  it 'should set debug option to false based on Buildr.options' do
+    Buildr.options.debug = false
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should set debug option to false based on debug environment variable' do
+    ENV['debug'] = 'no'
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should set debug option to false based on DEBUG environment variable' do
+    ENV['DEBUG'] = 'no'
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should use -g argument when debug option is true' do
+    compile_task.using(:debug=>true)
+    javac_args.should include('-g')
+  end
+
+  it 'should not use -g argument when debug option is false' do
+    compile_task.using(:debug=>false)
+    javac_args.should_not include('-g')
+  end
+
+  it 'should set deprecation option to false by default' do
+    compile_task.options.deprecation.should be_false
+  end
+
+  it 'should use -deprecation argument when deprecation is true' do
+    compile_task.using(:deprecation=>true)
+    javac_args.should include('-deprecation')
+  end
+
+  it 'should not use -deprecation argument when deprecation is false' do
+    compile_task.using(:deprecation=>false)
+    javac_args.should_not include('-deprecation')
+  end
+
+  it 'should not set source option by default' do
+    compile_task.options.source.should be_nil
+    javac_args.should_not include('-source')
+  end
+
+  it 'should not set target option by default' do
+    compile_task.options.target.should be_nil
+    javac_args.should_not include('-target')
+  end
+
+  it 'should use -source nn argument if source option set' do
+    compile_task.using(:source=>'1.5')
+    javac_args.should include('-source', '1.5')
+  end
+
+  it 'should use -target nn argument if target option set' do
+    compile_task.using(:target=>'1.5')
+    javac_args.should include('-target', '1.5')
+  end
+
+  it 'should set lint option to false by default' do
+    compile_task.options.lint.should be_false
+  end
+
+  it 'should use -lint argument if lint option is true' do
+    compile_task.using(:lint=>true)
+    javac_args.should include('-Xlint')
+  end
+
+  it 'should use -lint argument with value of option' do
+    compile_task.using(:lint=>'all')
+    javac_args.should include('-Xlint:all')
+  end
+
+  it 'should use -lint argument with value of option as array' do
+    compile_task.using(:lint=>['path', 'serial'])
+    javac_args.should include('-Xlint:path,serial')
+  end
+
+  it 'should not set other option by default' do
+    compile_task.options.other.should be_nil
+  end
+
+  it 'should pass other argument if other option is string' do
+    compile_task.using(:other=>'-Xprint')
+    javac_args.should include('-Xprint')
+  end
+
+  it 'should pass other argument if other option is array' do
+    compile_task.using(:other=>['-Xstdout', 'msgs'])
+    javac_args.should include('-Xstdout', 'msgs')
+  end
+
+  it 'should complain about options it doesn\'t know' do
+    write 'source/Test.java', 'class Test {}'
+    compile_task.using(:unknown=>'option')
+    lambda { compile_task.from('source').invoke }.should raise_error(ArgumentError, /no such option/i)
+  end
+
+  it 'should inherit options from parent' do
+    define 'foo' do
+      compile.using(:warnings=>true, :debug=>true, :deprecation=>true, :source=>'1.5', :target=>'1.4')
+      define 'bar' do
+        compile.using(:javac)
+        compile.options.warnings.should be_true
+        compile.options.debug.should be_true
+        compile.options.deprecation.should be_true
+        compile.options.source.should eql('1.5')
+        compile.options.target.should eql('1.4')
+      end
+    end
+  end
+
+  after do
+    Buildr.options.debug = nil
+    ENV.delete "debug"
+    ENV.delete "DEBUG"
+  end
+end
+

data/spec/java/doc_spec.rb

@@ -0,0 +1,56 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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 File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+describe 'Javadoc' do
+  def sources
+    @sources ||= (1..3).map { |i| "Test#{i}" }.
+      each { |name| write "src/main/java/foo/#{name}.java", "package foo; public class #{name}{}" }.
+      map { |name| "src/main/java/foo/#{name}.java" }
+  end
+
+  it 'should pick -windowtitle from project name by default' do
+    define 'foo' do
+      compile.using(:javac)
+
+      define 'bar' do
+        compile.using(:javac)
+      end
+    end
+
+    project('foo').doc.options[:windowtitle].should eql('foo')
+    project('foo:bar').doc.options[:windowtitle].should eql('foo:bar')
+  end
+
+  it 'should pick -windowtitle from project description by default, if available' do
+    desc 'My App'
+    define 'foo' do
+      compile.using(:javac)
+    end
+    project('foo').doc.options[:windowtitle].should eql('My App')
+  end
+
+  it 'should not override explicit :windowtitle' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.using :windowtitle => 'explicit'
+    end
+    project('foo').doc.options[:windowtitle].should eql('explicit')
+  end
+
+end
+

data/spec/java/ecj_spec.rb

@@ -0,0 +1,115 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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 File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+
+
+describe Buildr::Compiler::Ecj do
+
+  before(:all) do
+    #Make ecj appear as a compiler that applies:
+    class Buildr::Compiler::Ecj
+      class << self
+
+        def applies_to?(project, task)
+          paths = task.sources + [sources].flatten.map { |src| Array(project.path_to(:source, task.usage, src.to_sym)) }
+          paths.flatten!
+          ext_glob = Array(source_ext).join(',')
+
+          paths.each { |path| 
+            Find.find(path) {|found|
+              if (!File.directory?(found)) && found.match(/.*\.#{Array(source_ext).join('|')}/)
+                return true
+              end
+              } if File.exist? path
+            }
+            false
+          end
+        end
+      end
+    end
+
+    it "should be the default Java compiler once loaded" do
+      write 'src/main/java/Foo.java', 'public class Foo {}'
+    foo = define('foo')
+    foo.compile.compiler.should == :ecj
+  end
+
+  describe "should compile a Java project just in the same way javac does" do  
+    javac_spec = File.read(File.join(File.dirname(__FILE__), "compiler_spec.rb"))
+    javac_spec = javac_spec.match(Regexp.escape("require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))\n")).post_match
+    javac_spec.gsub!("javac", "ecj")
+    javac_spec.gsub!("nowarn", "warn:none")
+    eval(javac_spec)
+  end
+
+  # Redirect the java error ouput, yielding so you can do something while it is
+  # and returning the content of the error buffer.
+  #
+  def redirect_java_err
+    pending "RJB doesn't support well instantiating a class that has several constructors" unless RUBY_PLATFORM =~ /java/
+    err = Java.java.io.ByteArrayOutputStream.new
+    original_err = Java.java.lang.System.err
+    begin
+      printStream = Java.java.io.PrintStream
+      print = printStream.new(err)
+      Java.java.lang.System.setErr(print)
+      yield
+    ensure
+      Java.java.lang.System.setErr(original_err)
+    end
+    err.toString
+  end
+
+  it "should not issue warnings for type casting when warnings are set to warn:none, by default" do
+    write "src/main/java/Main.java", "import java.util.List; public class Main {public List get() {return null;}}"
+    foo = define("foo") {
+      compile.options.source = "1.5"
+      compile.options.target = "1.5"
+    }
+    redirect_java_err { foo.compile.invoke }.should_not match(/WARNING/)
+  end
+
+  it "should issue warnings for type casting when warnings are set" do
+    write "src/main/java/Main.java", "import java.util.List; public class Main {public List get() {return null;}}"
+    foo = define("foo") {
+      compile.options.source = "1.5"
+      compile.options.target = "1.5"
+      compile.options.warnings = true
+    }
+    redirect_java_err { foo.compile.invoke }.should match(/WARNING/)
+  end
+
+  after(:all) do
+    #Make ecj appear as a compiler that doesn't apply:
+    module Buildr
+      module Compiler
+
+        class Ecj
+
+          class << self
+
+            def applies_to?(project, task)
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+