lib/buildr/scala/tests.rb

# 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::Scala#:nodoc:

  # Mockito is available when running ScalaTest
  module Mockito
    VERSION = '1.8.5'

    class << self
      def version
        Buildr.settings.build['scalatest-mockito'] || Buildr.settings.build['mockito'] || VERSION
      end

      def dependencies
        @dependencies ||= ["org.mockito:mockito-all:jar:#{version}"]
      end
    end
  end

  # Scala::Check is available when using Scala::Test or Scala::Specs
  module Check
    VERSION = case
      when Buildr::Scala.version?("2.7")
        '1.6'
      when Buildr::Scala.version?("2.8.0")
        '1.7'
      when Buildr::Scala.version?("2.8.1")
        '1.8'
      when Buildr::Scala.version < "2.11"
        '1.10.0'
      else
        '1.12.5'
    end

    class << self
      def version
        Buildr.settings.build['scala.check'] || VERSION
      end

      def classifier
        Buildr.settings.build['scala.check.classifier']
      end

      def artifact
        custom = Buildr.settings.build['scala.check.artifact']
        return custom if !!custom
        case
        when Buildr::Scala.version < "2.11"
          "scalacheck_#{Buildr::Scala.version_without_build}"
        else
          "scalacheck_#{Buildr::Scala.version_major_minor}"
        end
      end

      def dependencies
        return [version] if (version =~ /:/)
        group = case
          when version =~ /^1.[67]/
            "org.scala-tools.testing"
          else
            "org.scalacheck"
        end
        if classifier
          ["#{group}:#{artifact}:jar:#{classifier}:#{version}"]
        else
          ["#{group}:#{artifact}:jar:#{version}"]
        end
      end
    end
  end


  # ScalaTest framework, the default test framework for Scala tests.
  #
  # Support the following options:
  # * :properties  -- Hash of system properties available to the test case.
  # * :environment -- Hash of environment variables available to the test case.
  # * :java_args   -- Arguments passed as is to the JVM.
  class ScalaTest < Buildr::TestFramework::Java

    VERSION = case
      when Buildr::Scala.version?(2.7)
        '1.3'
      when Buildr::Scala.version < "2.11"
        '1.8'
      else
        '2.2.6'
    end

    class << self
      def version
        custom = Buildr.settings.build['scala.test']
        (custom =~ /:/) ? Buildr.artifact(custom).version : VERSION
      end

      def specs
        custom = Buildr.settings.build['scala.test']
        return custom if (custom =~ /:/)
        if Buildr::Scala.version?(2.7, 2.8)
          "org.scalatest:scalatest:jar:#{version}"
        elsif Buildr::Scala.version < "2.11"
          "org.scalatest:scalatest_#{Buildr::Scala.version_without_build}:jar:#{version}"
        else
          "org.scalatest:scalatest_#{Buildr::Scala.version_major_minor}:jar:#{version}"
        end
      end

      def dependencies
        [specs] + Check.dependencies + JMock.dependencies + JUnit.dependencies + Mockito.dependencies + ["org.scala-lang.modules:scala-xml_2.11:jar:1.0.5"]
      end

      def applies_to?(project) #:nodoc:
        !Dir[project.path_to(:source, :test, :scala, '**/*.scala')].empty?
      end
    end

    # annotation-based group inclusion
    attr_accessor :group_includes

    # annotation-based group exclusion
    attr_accessor :group_excludes

    def initialize(test_task, options)
      super
      @group_includes = []
      @group_excludes = []
    end

    def tests(dependencies) #:nodoc:
      filter_classes(dependencies, :interfaces => %w{org.scalatest.Suite})
    end

    def run(scalatest, dependencies) #:nodoc:
      mkpath task.report_to.to_s
      success = []

      reporter_options = if (ScalaTest.version =~ /^0\./)
        'TFGBSAR' # testSucceeded, testFailed, testIgnored, suiteAborted, runStopped, runAborted, runCompleted
      else
        ''
      end

      scalatest.each do |suite|
        info "ScalaTest #{suite.inspect}"
        # Use Ant to execute the ScalaTest task, gives us performance and reporting.
        reportDir = task.report_to.to_s
        reportFile = File.join(reportDir, "TEST-#{suite}.txt")
        taskdef = Buildr.artifacts(self.class.dependencies).each(&:invoke).map(&:to_s)
        Buildr.ant('scalatest') do |ant|
          # ScalaTestTask was deprecated in 1.2, in favor of ScalaTestAntTask
          classname = (ScalaTest.version =~ /^1\.[01]/) ? \
            'org.scalatest.tools.ScalaTestTask' : 'org.scalatest.tools.ScalaTestAntTask'
          ant.taskdef :name=>'scalatest', :classname=>classname,
            :classpath=>taskdef.join(File::PATH_SEPARATOR)
          ant.scalatest :runpath=>dependencies.join(File::PATH_SEPARATOR) do
            ant.suite    :classname=>suite
            ant.reporter :type=>'stdout', :config=>reporter_options
            ant.reporter :type=>'file', :filename=> reportFile, :config=>reporter_options
            ant.reporter :type=>(ScalaTest.version == "1.0") ? "xml" : "junitxml",
                         :directory=> reportDir, :config=>reporter_options
            # TODO: This should be name=>value pairs!
            #ant.includes group_includes.join(" ") if group_includes
            #ant.excludes group_excludes.join(" ") if group_excludes
            (options[:properties] || []).each { |name, value| ant.config :name=>name, :value=>value }
          end
        end

        # Parse for failures, errors, etc.
        # This is a bit of a pain right now because ScalaTest doesn't flush its
        # output synchronously before the Ant test finishes so we have to loop
        # and wait for an indication that the test run was completed.
        failed = false
        completed = false
        wait = 0
        while (!completed) do
          File.open(reportFile, "r") do |input|
            while (line = input.gets) do
              failed = (line =~ /(TESTS? FAILED)|(RUN STOPPED)|(RUN ABORTED)/) unless failed
              completed |= (line =~ /Run completed/)
              break if (failed)
            end
          end
          wait += 1
          break if (failed || wait > 10)
          unless completed
            sleep(1)
          end
        end
        success << suite if (completed && !failed)
      end

      success
    end # run

  end # ScalaTest

end

Buildr::TestFramework << Buildr::Scala::ScalaTest