realityforge-buildr 1.5.9

data/addon/buildr/jacoco.rb

@@ -0,0 +1,161 @@
+# 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.
+
+module Buildr
+  # Initial support for JaCoCo coverage reports.
+  module JaCoCo
+    class << self
+      def agent_spec
+        %w(org.jacoco:org.jacoco.agent:jar:runtime:0.8.6)
+      end
+
+      def dependencies
+        %w[
+          args4j:args4j:jar:2.0.28
+          org.jacoco:org.jacoco.report:jar:0.8.6
+          org.jacoco:org.jacoco.core:jar:0.8.6
+          org.jacoco:org.jacoco.cli:jar:0.8.6
+          org.ow2.asm:asm:jar:8.0.1
+          org.ow2.asm:asm-commons:jar:8.0.1
+          org.ow2.asm:asm-tree:jar:8.0.1
+          org.ow2.asm:asm-analysis:jar:8.0.1
+          org.ow2.asm:asm-util:jar:8.0.1
+        ]
+      end
+
+      def jacoco_report(execution_files, class_paths, source_paths, options = {})
+
+        xml_output_file = options[:xml_output_file]
+        csv_output_file = options[:csv_output_file]
+        html_output_directory = options[:html_output_directory]
+
+        Buildr.artifacts(self.dependencies).each { |a| a.invoke if a.respond_to?(:invoke) }
+
+        args = []
+        args << 'report'
+        args += execution_files
+        class_paths.each do |class_path|
+          args << '--classfiles' << class_path
+        end
+        args << '--csv' << csv_output_file if csv_output_file
+        args << '--encoding' << 'UTF-8'
+        args << '--html' << html_output_directory if html_output_directory
+        source_paths.each do |source_path|
+          args << '--sourcefiles' << source_path
+        end
+        args << '--xml' << xml_output_file if xml_output_file
+
+        Java::Commands.java 'org.jacoco.cli.internal.Main', *(args + [{ :classpath => Buildr.artifacts(self.dependencies), :properties => options[:properties], :java_args => options[:java_args] }])
+      end
+    end
+
+    class Config
+      attr_writer :enabled
+
+      def enabled?
+        @enabled.nil? ? true : @enabled
+      end
+
+      attr_accessor :destfile
+
+      attr_writer :output
+
+      def output
+        @output ||= 'file'
+      end
+
+      attr_accessor :sessionid
+      attr_accessor :address
+      attr_accessor :port
+      attr_accessor :classdumpdir
+      attr_accessor :dumponexit
+      attr_accessor :append
+      attr_accessor :exclclassloader
+
+      def includes
+        @includes ||= []
+      end
+
+      def excludes
+        @excludes ||= []
+      end
+
+      protected
+
+      def initialize(destfile)
+        @destfile = destfile
+      end
+    end
+
+    module ProjectExtension
+      include Extension
+
+      def jacoco
+        @jacoco ||= Buildr::JaCoCo::Config.new(project._(:reports, :jacoco, 'jacoco.cov'))
+      end
+
+      after_define do |project|
+        unless project.test.compile.target.nil? || !project.jacoco.enabled?
+          project.test.setup do
+            agent_jar = Buildr.artifacts(Buildr::JaCoCo.agent_spec).each(&:invoke).map(&:to_s).join('')
+            options = []
+            %w(destfile append exclclassloader sessionid dumponexit output address port classdumpdir).each do |option|
+              value = project.jacoco.send(option.to_sym)
+              options << "#{option}=#{value}" unless value.nil?
+            end
+            options << "includes=#{project.jacoco.includes.join(':')}" unless project.jacoco.includes.empty?
+            options << "excludes=#{project.jacoco.excludes.join(':')}" unless project.jacoco.excludes.empty?
+
+            agent_config = "-javaagent:#{agent_jar}=#{options.join(',')}"
+            existing = project.test.options[:java_args] || []
+            project.test.options[:java_args] = (existing.is_a?(Array) ? existing : [existing]) + [agent_config]
+          end
+        end
+      end
+      namespace 'jacoco' do
+        desc 'Generate JaCoCo reports.'
+        task 'report' do
+
+          execution_files = []
+          class_paths = []
+          source_paths = []
+          Buildr.projects.select { |p| p.jacoco.enabled? }.each do |project|
+            execution_files << project.jacoco.destfile if File.exist?(project.jacoco.destfile)
+            target = project.compile.target.to_s
+            class_paths << target.to_s if File.exist?(target)
+            project.compile.sources.flatten.map(&:to_s).each do |src|
+              source_paths << src.to_s if File.exist?(src)
+            end
+          end
+
+          project = Buildr.projects[0].root_project
+
+          options = {}
+          options[:xml_output_file] = project._(:reports, :jacoco, 'jacoco.xml')
+          options[:csv_output_file] = project._(:reports, :jacoco, 'jacoco.csv')
+          options[:html_output_directory] = project._(:reports, :jacoco, 'docs')
+
+          unless execution_files.empty?
+            Buildr::JaCoCo.jacoco_report(execution_files, class_paths, source_paths, options)
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::JaCoCo::ProjectExtension
+end

data/addon/buildr/pmd.rb

@@ -0,0 +1,185 @@
+# 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.
+
+module Buildr
+  # Provides the <code>pmd:xml</code> and <code>pmd:html</code> tasks.
+  #
+  # Require explicitly using <code>require 'buildr/pmd'</code>.
+  module Pmd
+
+    class << self
+
+      # The specs for requirements
+      def dependencies
+        %w(
+          net.sourceforge.pmd:pmd-core:jar:6.11.0
+          net.sourceforge.pmd:pmd-java:jar:6.11.0
+          net.sourceforge.pmd:pmd-java8:jar:6.11.0
+          jaxen:jaxen:jar:1.1.6
+          commons-io:commons-io:jar:2.6
+          com.beust:jcommander:jar:1.72
+          org.ow2.asm:asm:jar:7.1
+          com.google.code.gson:gson:jar:2.8.5
+          net.java.dev.javacc:javacc:jar:5.0
+          net.sourceforge.saxon:saxon:jar:9.1.0.8
+          org.apache.commons:commons-lang3:jar:3.8.1
+          org.antlr:antlr4-runtime:jar:4.7
+        )
+      end
+
+      def pmd(rule_set_files, format, output_file_prefix, source_paths, options = {})
+        dependencies = (options[:dependencies] || []) + self.dependencies
+        cp = Buildr.artifacts(dependencies).each(&:invoke).map(&:to_s)
+        (options[:rule_set_paths] || []).each {|p| cp << p}
+
+        rule_sets = rule_set_files.dup
+
+        Buildr.artifacts(options[:rule_set_artifacts] || []).each do |artifact|
+          a = artifact.to_s
+          dirname = File.dirname(a)
+          rule_sets << a[dirname.length + 1, a.length]
+          cp << File.dirname(a)
+          artifact.invoke
+        end
+
+        puts 'PMD: Analyzing source code...'
+        mkdir_p File.dirname(output_file_prefix)
+
+        args = []
+        args << '-no-cache'
+        args << '-shortnames'
+        args << '-rulesets' << rule_sets.join(',')
+        args << '-format' << format
+        args << '-reportfile' << "#{output_file_prefix}.#{format}"
+
+        files = []
+        source_paths.each do |src|
+          files += Dir["#{src}/**/*.java"] if File.directory?(src)
+        end
+        files = files.sort.uniq
+
+        Tempfile.open('pmd') do |tmp|
+          tmp.write files.join(',')
+          args << '-filelist' << tmp.path.to_s
+        end
+
+        begin
+          Java::Commands.java 'net.sourceforge.pmd.PMD', *(args + [{:classpath => cp, :properties => options[:properties], :java_args => options[:java_args]}])
+        rescue Exception => e
+          raise e if options[:fail_on_error]
+        end
+      end
+    end
+
+    class Config
+
+      attr_writer :enabled
+
+      def enabled?
+        !!@enabled
+      end
+
+      attr_writer :rule_set_files
+
+      def rule_set_files
+        @rule_set_files ||= (self.rule_set_artifacts.empty? ? %w(rulesets/java/basic.xml rulesets/java/imports.xml rulesets/java/unusedcode.xml rulesets/java/finalizers.xml rulesets/java/braces.xml) : [])
+      end
+
+      # Support specification of rule sets that are distributed as part of a maven repository
+      def rule_set_artifacts
+        @rule_set_artifacts ||= []
+      end
+
+      attr_writer :rule_set_paths
+
+      def rule_set_paths
+        @rule_set_paths ||= []
+      end
+
+      attr_writer :report_dir
+
+      def report_dir
+        @report_dir || project._(:reports, :pmd)
+      end
+
+      attr_writer :output_file_prefix
+
+      def output_file_prefix
+        @output_file_prefix || "#{self.report_dir}/pmd"
+      end
+
+      def source_paths
+        @source_paths ||= [self.project.compile.sources, self.project.test.compile.sources].flatten.compact
+      end
+
+      # An array of paths that should be excluded no matter how they are added to pmd
+      def exclude_paths
+        @source_paths ||= []
+      end
+
+      # An array of additional projects to scan for main and test sources
+      attr_writer :additional_project_names
+
+      def additional_project_names
+        @additional_project_names ||= []
+      end
+
+      def flat_source_paths
+        paths = source_paths.dup
+
+        self.additional_project_names.each do |project_name|
+          p = self.project.project(project_name)
+          paths << [p.compile.sources, p.test.compile.sources].flatten.compact
+        end
+
+        paths.flatten.select{|p|!self.exclude_paths.include?(p)}.compact
+      end
+
+      protected
+
+      def initialize(project)
+        @project = project
+      end
+
+      attr_reader :project
+    end
+
+    module ProjectExtension
+      include Extension
+
+      def pmd
+        @pmd ||= Buildr::Pmd::Config.new(project)
+      end
+
+      after_define do |project|
+        if project.pmd.enabled?
+          desc 'Generate pmd xml report.'
+          project.task('pmd:xml') do
+            Buildr::Pmd.pmd(project.pmd.rule_set_files, 'xml', project.pmd.output_file_prefix, project.pmd.flat_source_paths, :rule_set_paths => project.pmd.rule_set_paths, :rule_set_artifacts => project.pmd.rule_set_artifacts)
+          end
+
+          desc 'Generate pmd html report.'
+          project.task('pmd:html') do
+            Buildr::Pmd.pmd(project.pmd.rule_set_files, 'html', project.pmd.output_file_prefix, project.pmd.flat_source_paths, :rule_set_paths => project.pmd.rule_set_paths, :rule_set_artifacts => project.pmd.rule_set_artifacts)
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::Pmd::ProjectExtension
+end

data/addon/buildr/single_intermediate_layout.rb

@@ -0,0 +1,71 @@
+# 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.
+
+module Buildr #nodoc
+  class Project #nodoc
+    class << self
+
+      alias :original_define :define
+
+      # Monkey patch the built-in define so that there is a single root directory for
+      # all of the generated artifacts within a project hierarchy.
+      #
+      def define(name, properties = nil, &block) #:yields:project
+
+        properties = properties.nil? ? {} : properties.dup
+
+        parent_name = name.split(':')[0...-1]
+        parent = parent_name.empty? ? nil : Buildr.application.lookup(parent_name.join(':'))
+
+        # Follow the same algorithm as in project code
+        if properties[:base_dir]
+          base_dir = properties[:base_dir]
+        elsif parent
+          base_dir = File.expand_path(name.split(':').last, parent.base_dir)
+        else
+          base_dir = Dir.pwd
+        end
+
+        # The top directory is the base directory of the root project
+        top_dir = base_dir
+        while parent
+          top_dir = parent.base_dir
+          parent = parent.parent
+        end
+
+        target_dir = "#{top_dir}/target/#{name.gsub(':', '_')}"
+        reports_dir = "#{top_dir}/reports/#{name.gsub(':', '_')}"
+        target_dir = ::Buildr::Util.relative_path(target_dir, File.expand_path(base_dir))
+        reports_dir = ::Buildr::Util.relative_path(reports_dir, File.expand_path(base_dir))
+
+        properties[:layout] = Buildr::Layout::Default.new unless properties[:layout]
+        properties[:layout][:target] = target_dir
+        properties[:layout][:reports] = reports_dir
+        properties[:layout][:target, :main] = target_dir
+
+        Project.original_define(name, properties) do
+          project.instance_eval &block
+          if top_dir == base_dir && project.iml?
+            project.iml.excluded_directories << "#{base_dir}/target"
+            project.iml.excluded_directories << "#{base_dir}/reports"
+            clean { rm_rf "#{base_dir}/target" }
+            clean { rm_rf "#{base_dir}/reports" }
+          end
+          project
+        end
+      end
+    end
+  end
+end

data/addon/buildr/spotbugs.rb

@@ -0,0 +1,265 @@
+# 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.
+
+module Buildr
+  # Provides the <code>spotbugs:html</code> and <code>spotbugs:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/spotbugs"</code>.
+  module Spotbugs
+
+    class << self
+
+      # The specs for requirements
+      def dependencies
+        %w(
+          com.github.spotbugs:spotbugs:jar:4.2.1
+          com.github.spotbugs:spotbugs-annotations:jar:4.2.1
+          com.google.code.findbugs:jsr305:jar:3.0.2
+          net.jcip:jcip-annotations:jar:1.0
+          org.apache.bcel:bcel:jar:6.5.0
+          org.apache.commons:commons-lang3:jar:3.11
+          org.apache.commons:commons-text:jar:1.9
+          org.dom4j:dom4j:jar:2.1.3
+          org.json:json:jar:20201115
+          org.ow2.asm:asm:jar:9.0
+          org.ow2.asm:asm-analysis:jar:9.0
+          org.ow2.asm:asm-tree:jar:9.0
+          org.ow2.asm:asm-commons:jar:9.0
+          org.ow2.asm:asm-util:jar:9.0
+          org.slf4j:slf4j-api:jar:1.7.30
+          org.slf4j:slf4j-jdk14:jar:1.7.30
+          jaxen:jaxen:jar:1.2.0
+          net.sf.saxon:Saxon-HE:jar:10.3
+        )
+      end
+
+      def fb_contrib_dependencies
+        %w(com.mebigfatguy.fb-contrib:fb-contrib:jar:7.4.2.sb)
+      end
+
+      def spotbugs(output_file, source_paths, analyze_paths, options = {})
+        plugins = self.fb_contrib_dependencies
+        Buildr.artifacts(self.dependencies).each { |a| a.invoke if a.respond_to?(:invoke) }
+
+        args = []
+        args << '-textui'
+        packages_to_analyze = options[:packages_to_analyze] || []
+        if packages_to_analyze.size > 0
+          args << '-onlyAnalyze' << (packages_to_analyze.collect{|p| "#{p}.-"}.join(',') + ':')
+        end
+        args << '-effort:max'
+        args << '-medium'
+        args << ('html' == options[:output] ? '-html' : '-xml:withMessages')
+        args << '-output' << output_file
+        args << '-sourcepath' << source_paths.map(&:to_s).join(File::PATH_SEPARATOR)
+        args << '-pluginList' << Buildr.artifacts(plugins).map(&:to_s).join(File::PATH_SEPARATOR)
+
+        extra_dependencies = (options[:extra_dependencies] || []) + plugins
+        if 0 != extra_dependencies.size
+          args << '-auxclasspath' << Buildr.artifacts(extra_dependencies).each { |a| a.invoke if a.respond_to?(:invoke) }.map(&:to_s).join(File::PATH_SEPARATOR)
+        end
+        if options[:exclude_filter]
+          args << '-exclude' << options[:exclude_filter]
+        end
+
+        analyze_paths.each do |dep|
+          a = dep.is_a?(String) ? file(dep) : dep
+          a.invoke
+          args << a.to_s
+        end
+
+        mkdir_p File.dirname(output_file)
+
+        begin
+          Java::Commands.java 'edu.umd.cs.findbugs.LaunchAppropriateUI', *(args + [{:classpath => Buildr.artifacts(dependencies), :properties => options[:properties], :java_args => options[:java_args]}])
+        rescue Exception => e
+          puts e
+          raise e if options[:fail_on_error]
+        end
+      end
+    end
+
+    class Config
+
+      attr_accessor :enabled
+
+      def enabled?
+        !!@enabled
+      end
+
+      attr_writer :config_directory
+
+      def config_directory
+        @config_directory || project._(:source, :main, :etc, :spotbugs)
+      end
+
+      attr_writer :report_dir
+
+      def report_dir
+        @report_dir || project._(:reports, :spotbugs)
+      end
+
+      attr_writer :fail_on_error
+
+      def fail_on_error?
+        @fail_on_error.nil? ? false : @fail_on_error
+      end
+
+      attr_writer :xml_output_file
+
+      def xml_output_file
+        @xml_output_file || "#{self.report_dir}/spotbugs.xml"
+      end
+
+      attr_writer :html_output_file
+
+      def html_output_file
+        @html_output_file || "#{self.report_dir}/spotbugs.html"
+      end
+
+      attr_writer :filter_file
+
+      def filter_file
+        @filter_file || "#{self.config_directory}/filter.xml"
+      end
+
+      def properties
+        @properties ||= {}
+      end
+
+      attr_writer :java_args
+
+      def java_args
+        @java_args || '-server -Xss1m -Xmx1.4G -Duser.language=en -Duser.region=EN'
+      end
+
+      def packages_to_analyze
+        @packages_to_analyze ||= [self.project.java_package_name]
+      end
+
+      def source_paths
+        @source_paths ||= [self.project.compile.sources, self.project.test.compile.sources].flatten.compact
+      end
+
+      def analyze_paths
+        @analyze_path ||= [self.project.compile.target]
+      end
+
+      def extra_dependencies
+        @extra_dependencies ||= [self.project.compile.dependencies, self.project.test.compile.dependencies].flatten.compact
+      end
+
+      # An array of additional projects to scan for main and test sources
+      attr_writer :additional_project_names
+
+      def additional_project_names
+        @additional_project_names ||= []
+      end
+
+      def complete_source_paths
+        paths = self.source_paths.dup
+
+        self.additional_project_names.each do |project_name|
+          p = self.project.project(project_name)
+          paths << [p.compile.sources, p.test.compile.sources].flatten.compact
+        end
+
+        paths.flatten.compact
+      end
+
+      def complete_analyze_paths
+        paths = self.analyze_paths.dup
+
+        self.additional_project_names.each do |project_name|
+          paths << self.project.project(project_name).compile.target
+        end
+
+        paths.flatten.compact
+      end
+
+      def complete_extra_dependencies
+        deps = self.extra_dependencies.dup
+
+        self.additional_project_names.each do |project_name|
+          p = self.project.project(project_name)
+          deps << [p.compile.dependencies, p.test.compile.dependencies].flatten.compact
+        end
+
+        deps.flatten.compact
+      end
+
+      protected
+
+      def initialize(project)
+        @project = project
+      end
+
+      attr_reader :project
+    end
+
+    module ProjectExtension
+      include Extension
+
+      def spotbugs
+        @spotbugs ||= Buildr::Spotbugs::Config.new(project)
+      end
+
+      after_define do |project|
+        if project.spotbugs.enabled?
+          desc 'Generate spotbugs xml report.'
+          project.task('spotbugs:xml') do
+            puts 'Spotbugs: Analyzing source code...'
+            options =
+              {
+                :packages_to_analyze => project.spotbugs.packages_to_analyze,
+                :properties => project.spotbugs.properties,
+                :fail_on_error => project.spotbugs.fail_on_error?,
+                :extra_dependencies => project.spotbugs.complete_extra_dependencies
+              }
+            options[:exclude_filter] = project.spotbugs.filter_file if File.exist?(project.spotbugs.filter_file)
+            options[:output] = 'xml:withMessages'
+
+            Buildr::Spotbugs.spotbugs(project.spotbugs.xml_output_file,
+                                      project.spotbugs.complete_source_paths,
+                                      project.spotbugs.complete_analyze_paths,
+                                      options)
+          end
+
+          desc 'Generate spotbugs html report.'
+          project.task('spotbugs:html') do
+            puts 'Spotbugs: Analyzing source code...'
+            options =
+              {
+                :packages_to_analyze => project.spotbugs.packages_to_analyze,
+                :properties => project.spotbugs.properties,
+                :fail_on_error => project.spotbugs.fail_on_error?,
+                :extra_dependencies => project.spotbugs.complete_extra_dependencies
+              }
+            options[:exclude_filter] = project.spotbugs.filter_file if File.exist?(project.spotbugs.filter_file)
+            options[:output] = 'html'
+
+            Buildr::Spotbugs.spotbugs(project.spotbugs.html_output_file,
+                                      project.spotbugs.complete_source_paths,
+                                      project.spotbugs.complete_analyze_paths,
+                                      options)
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::Spotbugs::ProjectExtension
+end