realityforge-buildr 1.5.9

data/spec/java/commands_spec.rb

@@ -0,0 +1,79 @@
+# 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
+  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,274 @@
+# 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 accept a task to compile from' do
+    p = define 'foo' do
+      project.version = '1'
+      f = file(_(:target, :generated, 'myjava')) do
+        mkdir_p _(:target, :generated, 'myjava')
+        File.open("#{_(:target, :generated, 'myjava')}/Foo.java", "wb") do |f|
+          f.write "public class Foo {}"
+        end
+      end
+
+      compile.from(f)
+      package(:jar)
+    end.compile.invoke
+    file('target/classes/Foo.class').should exist
+  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/UseJarSigner.java', <<-JAVA
+    import sun.tools.jar.Manifest;
+    public class UseJarSigner { }
+    JAVA
+    define('foo').compile.invoke
+    file('target/classes/UseJarSigner.class').should exist
+  end
+
+  it 'should ignore package-info.java files in up-to-date check' do
+    write 'src/main/java/foo/Test.java', 'package foo; class Test { public void foo() {} }'
+    write 'src/main/java/foo/package-info.java', 'package foo;'
+    lambda{ define('foo').compile.invoke }.should run_task('foo:compile')
+    lambda{ define('bar').compile.invoke }.should_not run_task('bar:compile')
+  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=>%w[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=>%w[-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/custom_pom_spec.rb

@@ -0,0 +1,165 @@
+# 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('../spec_helpers', File.dirname(__FILE__))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'xpath_matchers'))
+
+describe Buildr::CustomPom do
+
+  def xml_document(filename)
+    File.should be_exist(filename)
+    REXML::Document.new(File.read(filename))
+  end
+
+  def project_pom_xml(project)
+    xml_document(project.packages[0].pom.to_s)
+  end
+
+  def verify_license(pom_xml, name, url)
+    pom_xml.should match_xpath("/project/licenses/license/url[../name/text() = '#{name}']", url)
+  end
+
+  def dependency_xpath(artifact_id)
+    "/project/dependencies/dependency[artifactId/text() = '#{artifact_id}']"
+  end
+
+  def verify_dependency_group(pom_xml, artifact_id, group)
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/groupId", group)
+  end
+
+  def verify_dependency_version(pom_xml, artifact_id, version)
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/version", version)
+  end
+
+  def verify_dependency_scope(pom_xml, artifact_id, scope)
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/scope", scope)
+  end
+
+  def verify_dependency_optional(pom_xml, artifact_id, optional)
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/optional", optional)
+  end
+
+  def verify_dependency(pom_xml, artifact_id, group, version, scope, optional)
+    verify_dependency_group(pom_xml, artifact_id, group)
+    verify_dependency_version(pom_xml, artifact_id, version)
+    verify_dependency_scope(pom_xml, artifact_id, scope)
+    verify_dependency_optional(pom_xml, artifact_id, optional)
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/exclusions/exclusion/groupId", '*')
+    pom_xml.should match_xpath("#{dependency_xpath(artifact_id)}/exclusions/exclusion/artifactId", '*')
+  end
+
+  describe 'with explicitly specified pom details' do
+    before do
+      %w(id-provided id-optional id-runtime id-test).each do |artifact_id|
+        artifact("group:#{artifact_id}:jar:1.0") do |t|
+          mkdir_p File.dirname(t.to_s)
+          Zip::OutputStream.open t.to_s do |zip|
+            zip.put_next_entry 'empty.txt'
+          end
+        end
+      end
+      write 'src/main/java/Example.java', 'public class Example {}'
+
+      @foo = define 'foo' do
+        project.group = 'org.myproject'
+        project.version = '1.0'
+
+        pom.licenses['The Apache Software License, Version 2.0'] = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+        pom.licenses['GNU General Public License (GPL) version 3.0'] = 'http://www.gnu.org/licenses/gpl-3.0.html'
+        pom.scm_connection = pom.scm_developer_connection = 'scm:git:git@github.com:jbloggs/myproject'
+        pom.scm_url = 'git@github.com:jbloggs/myproject'
+        pom.url = 'https://github.com/jbloggs/myproject'
+        pom.issues_url = 'https://github.com/jbloggs/myproject/issues'
+        pom.issues_system = 'GitHub Issues'
+        pom.add_developer('jbloggs', 'Joe Bloggs', 'jbloggs@example.com', ['Project Lead'])
+        pom.provided_dependencies = ['group:id-provided:jar:1.0']
+        pom.optional_dependencies = ['group:id-optional:jar:1.0']
+
+        compile.with 'group:id-runtime:jar:1.0', 'group:id-optional:jar:1.0', 'group:id-provided:jar:1.0'
+
+        test.with 'group:id-test:jar:1.0'
+
+        package(:jar)
+      end
+      task('package').invoke
+      @pom_xml = project_pom_xml(@foo)
+      #$stderr.puts @pom_xml.to_s
+    end
+
+    it 'has correct project level metadata' do
+      @pom_xml.should match_xpath('/project/groupId', 'org.myproject')
+      @pom_xml.should match_xpath('/project/artifactId', 'foo')
+      @pom_xml.should match_xpath('/project/version', '1.0')
+      @pom_xml.should match_xpath('/project/packaging', 'jar')
+      @pom_xml.should match_xpath('/project/name', 'foo')
+      @pom_xml.should match_xpath('/project/description', 'foo')
+      @pom_xml.should match_xpath('/project/url', 'https://github.com/jbloggs/myproject')
+    end
+
+    it 'has correct scm details' do
+      @pom_xml.should match_xpath('/project/scm/connection', 'scm:git:git@github.com:jbloggs/myproject')
+      @pom_xml.should match_xpath('/project/scm/developerConnection', 'scm:git:git@github.com:jbloggs/myproject')
+      @pom_xml.should match_xpath('/project/scm/url', 'git@github.com:jbloggs/myproject')
+    end
+
+    it 'has correct issueManagement details' do
+      @pom_xml.should match_xpath('/project/issueManagement/url', 'https://github.com/jbloggs/myproject/issues')
+      @pom_xml.should match_xpath('/project/issueManagement/system', 'GitHub Issues')
+    end
+
+    it 'has correct developers details' do
+      @pom_xml.should match_xpath('/project/developers/developer/id', 'jbloggs')
+      @pom_xml.should match_xpath('/project/developers/developer/name', 'Joe Bloggs')
+      @pom_xml.should match_xpath('/project/developers/developer/email', 'jbloggs@example.com')
+      @pom_xml.should match_xpath('/project/developers/developer/roles/role', 'Project Lead')
+    end
+
+    it 'has correct license details' do
+      verify_license(@pom_xml, 'The Apache Software License, Version 2.0', 'http://www.apache.org/licenses/LICENSE-2.0.txt')
+      verify_license(@pom_xml, 'GNU General Public License (GPL) version 3.0', 'http://www.gnu.org/licenses/gpl-3.0.html')
+    end
+
+    it 'has correct dependency details' do
+      verify_dependency(@pom_xml, 'id-runtime', 'group', '1.0', nil, nil)
+      verify_dependency(@pom_xml, 'id-optional', 'group', '1.0', nil, 'true')
+      verify_dependency(@pom_xml, 'id-provided', 'group', '1.0', 'provided', nil)
+      verify_dependency(@pom_xml, 'id-test', 'group', '1.0', 'test', nil)
+    end
+  end
+
+  describe 'with a multi-module project' do
+    before do
+      write 'foo/src/main/java/Foo.java', 'public class Foo {}'
+      write 'bar/src/main/java/Bar.java', 'public class Bar {}'
+      define('myproject', :group => 'group', :version => '1.0') do
+        define('foo') do
+          package(:jar)
+        end
+        define(:bar) do
+          compile.with project('foo')
+          package(:jar)
+          pom.description = 'BAR Project'
+        end
+      end
+      task('package').invoke
+
+      @pom_xml = project_pom_xml(project('myproject:bar'))
+    end
+
+    it 'should add foo to the dependencies of bar\'s pom.xml' do
+      verify_dependency(@pom_xml, 'myproject-foo', 'group', '1.0', nil, nil)
+    end
+  end
+end