rspec-teamcity 0.0.1

data/lib/rspec/teamcity/formatter_initializer.rb

@@ -0,0 +1,50 @@
+# Copyright 2000-2014 JetBrains s.r.o.
+#
+# 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.
+
+# @author Roman.Chernyatchik
+
+module Spec
+  module Runner
+    module Formatter
+      # Let's determine current RSpec gem version
+      # Formatter is required from some other RSpec code, so let's check some
+      # marker classed in object space
+
+      if defined? ::RSpec::Core::Version::STRING
+        if ::RSpec::Core::Version::STRING.split('.')[0] == '2'
+          # rspec >= 2.x
+          require 'rspec/core/formatters/base_formatter'
+          RSPEC_VERSION_2 = true
+          RSPEC_VERSION_3 = false
+        else
+          # rspec >= 3.x
+          require 'rspec/core/formatters/base_formatter'
+          RSPEC_VERSION_2 = false
+          RSPEC_VERSION_3 = true
+        end
+      elsif defined? ::Spec::VERSION::STRING
+        # rspec 1.x
+        require 'spec/runner/formatter/base_formatter'
+        RSPEC_VERSION_2 = false
+        RSPEC_VERSION_3 = false
+      else
+        # some unsupported version. Let's assume that it is something like rspec 2.x
+        # such require may force gem activation
+        require 'rspec/core/formatters/base_formatter'
+        RSPEC_VERSION_2 = true
+        RSPEC_VERSION_3 = false
+      end
+    end
+  end
+end

data/lib/rspec/teamcity/rake_exceptions.rb

@@ -0,0 +1,25 @@
+# Copyright 2000-2012 JetBrains s.r.o.
+#
+# 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.
+
+# Created by IntelliJ IDEA.
+#
+# @author: Roman.Chernyatchik
+# @date: 21:40:05
+
+module Rake
+  module TeamCity
+    class InnerException < Exception
+    end
+  end
+end

data/lib/rspec/teamcity/rakerunner_consts.rb

@@ -0,0 +1,131 @@
+# Copyright 2000-2012 JetBrains s.r.o.
+#
+# 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.
+
+# Created by IntelliJ IDEA.
+#
+# @author: Roman.Chernyatchik
+# @date: 29.01.2008
+
+#TODO move all to TeamCity module
+
+# Behaviour properties
+# Debug
+TEAMCITY_RAKERUNNER_LOG_RSPEC_XML_MSFS_KEY = 'TEAMCITY_RAKE_RUNNER_DEBUG_LOG_RSPEC_XML_MSGS'
+TEAMCITY_RAKERUNNER_LOG_PATH_KEY = 'TEAMCITY_RAKE_RUNNER_DEBUG_LOG_PATH'
+TEAMCITY_RAKERUNNER_LOG_OUTPUT_HACK_DISABLED_KEY = 'TEAMCITY_RAKE_RUNNER_DEBUG_OUTPUT_HACK_DISABLED'
+TEAMCITY_RAKERUNNER_LOG_OUTPUT_CAPTURER_ENABLED_KEY = 'TEAMCITY_RAKE_RUNNER_DEBUG_OUTPUT_CAPTURER_ENABLED'
+# Log files
+TEAMCITY_RAKERUNNER_LOG_FILENAME_SUFFIX = '/rakeRunner_rake.log'
+TEAMCITY_RAKERUNNER_RPC_LOG_FILENAME_SUFFIX = '/rakeRunner_xmlrpc.log'
+TEAMCITY_RAKERUNNER_SPEC_LOG_FILENAME_SUFFIX = '/rakeRunner_rspec.log'
+TEAMCITY_RAKERUNNER_TESTUNIT_LOG_FILENAME_SUFFIX = '/rakeRunner_testUnit.log'
+TEAMCITY_RAKERUNNER_TESTUNIT_EVENTS_LOG_FILENAME_SUFFIX = '/rakeRunner_testUnit_events.log'
+
+# Teamcity connection properties
+#TODO it seems this section is deprecated!
+IDEA_BUILDSERVER_BUILD_ID_KEY = 'IDEA_BUILD_SERVER_BUILD_ID'
+IDEA_BUILDSERVER_AGENT_PORT_KEY = 'IDEA_BUILD_AGENT_PORT'
+IDEA_BUILDSERVER_HOST_ID_KEY = 'IDEA_BUILD_SERVER_HOST'
+
+# Name of Teamcity RPC logger method
+TEAMCITY_LOGGER_RPC_NAME = "testRunnerLogger.log"
+#TEAMCITY_LOGGER_RPC_NAME = "buildAgent.log"
+
+# Rake runner dispatcher settings
+TEAMCITY_RAKERUNNER_DISPATCHER_MAX_ATTEMPTS = 100
+TEAMCITY_RAKERUNNER_DISPATCHER_RETRY_DELAY = 0.25
+
+# Rakerunner system properties
+ORIGINAL_SDK_AUTORUNNER_PATH_KEY = 'TEAMCIY_RAKE_TU_AUTORUNNER_PATH'
+ORIGINAL_SDK_TESTRUNNERMEDIATOR_PATH_KEY = 'TEAMCITY_RAKE_TU_TESTRUNNERMADIATOR_PATH'
+TEAMCITY_RAKERUNNER_RAKE_TRACE_INVOKE_EXEC_STAGES_ENABLED = 'TEAMCITY_RAKE_TRACE'
+
+module Rake
+  module TeamCity
+    # Mode
+    TEAMCITY_VERSION_KEY ='TEAMCITY_VERSION'
+
+
+    # Test::Unit
+    RUBY19_SDK_MINITEST_RUNNER_PATH_KEY = "TC_RUBY19_SDK_MINITEST_RUNNER_PATH_KEY"
+
+    # TODO: remove TEAMCITY_* prefix
+    TEAMCITY_RAKERUNNER_USED_FRAMEWORKS_KEY ='TEAMCITY_RAKE_RUNNER_USED_FRAMEWORKS'
+    TEAMCITY_RAKERUNNER_DEBUG_OPTIONS_KEY ='TEAMCITY_RAKERUNNER_DEBUG_OPTIONS'
+
+    TEAMCITY_RAKERUNNER_SUPPORTED_FRAMEWORKS =[:rspec, :test_spec, :test_unit, :cucumber, :shoulda]
+
+    TC_EXCLUDED_DEFAULT_TEST_CASES = [
+        "ActionController::IntegrationTest",
+        "ActionController::TestCase",
+        "ActionView::TestCase",
+        "ActionMailer::TestCase",
+        "ActiveRecord::TestCase",
+        "ActiveSupport::TestCase",
+        # Rails 3.0
+        "ActionDispatch::IntegrationTest",
+        "ActionDispatch::PerformanceTest"
+    ]
+
+    def self.is_in_idea_mode
+      !is_in_buildserver_mode
+    end
+
+    def self.is_in_buildserver_mode
+      version = ENV[TEAMCITY_VERSION_KEY]
+      # version must be set and not empty
+      if !version.nil? && !version.empty?
+        return true
+      end
+    end
+
+    # Supported frameworks
+    # :rspec
+    # :test_spec
+    # :test_unit
+    def self.is_framework_used(symbol)
+      value = ENV[TEAMCITY_RAKERUNNER_USED_FRAMEWORKS_KEY]
+      # check that symbol is name of supported framework
+      # and that supported frameworks env variable is set
+      return false if value.nil?
+      if TEAMCITY_RAKERUNNER_SUPPORTED_FRAMEWORKS.index(symbol).nil?
+        raise ArgumentError, "Unsupported framework: #{symbol}", caller
+      end
+
+      return !value.index(":#{symbol.to_s}").nil?
+    end
+
+    def self.is_fake_time_enabled?
+      self.is_enabled_in_debug_options(:fake_time)
+    end
+
+    def self.is_fake_stacktrace_enabled?
+      self.is_enabled_in_debug_options(:fake_stacktrace)
+    end
+
+    def self.is_fake_error_msg_enabled?
+      self.is_enabled_in_debug_options(:fake_error_msg)
+    end
+
+    def self.is_fake_location_url_enabled?
+      self.is_enabled_in_debug_options(:fake_location_url)
+    end
+
+    private
+    def self.is_enabled_in_debug_options(symbol)
+      debug_options = ENV[TEAMCITY_RAKERUNNER_DEBUG_OPTIONS_KEY]
+      !debug_options.nil? && !debug_options[symbol.to_s].nil?
+    end
+  end
+end

data/lib/rspec/teamcity/runner_common.rb

@@ -0,0 +1,62 @@
+# Copyright 2000-2012 JetBrains s.r.o.
+#
+# 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.
+#
+# @author: Roman Chernyatchik
+
+module Rake
+  module TeamCity
+    module RunnerCommon
+      # Let's keep STDOUT, our users likes to capture it and block our events
+      @@original_stdout = STDOUT
+
+      # Current time in ms
+      def get_current_time_in_ms
+        get_time_in_ms(Time.now)
+      end
+
+      def get_time_in_ms(time)
+        ((time.to_f) * 1000 ).to_i
+      end
+
+      # Sends msg to runner
+      def send_msg(msg)
+        @@original_stdout.flush
+        @@original_stdout.puts("\n#{msg}")
+        @@original_stdout.flush
+      end
+
+      # Sets factory for creating messages
+      def set_message_factory(factory)
+        @message_factory = factory
+      end
+
+      def log_test_reporter_attached
+        if ::Rake::TeamCity.is_in_idea_mode
+          # log method is be defined in target class
+          log(@message_factory.create_test_reported_attached)
+        end
+      end
+
+      # Is from base_text_formatter.rb of rspec 1.1.4
+      def self.backtrace_line(line)
+        line.sub(/\A([^:]+:\d+)$/, '\\1:')
+      end
+
+      def self.format_backtrace(backtrace)
+        return "" if backtrace.nil?
+        backtrace.map { |line| backtrace_line(line) }.join("\n")
+      end
+    end
+  end
+end

data/lib/rspec/teamcity/utils/logger_util.rb

@@ -0,0 +1,90 @@
+# Copyright 2000-2012 JetBrains s.r.o.
+#
+# 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.
+
+# Created by IntelliJ IDEA.
+#
+# @author: Roman.Chernyatchik
+# @date: 18:04:35
+
+require_relative '../rakerunner_consts'
+
+module Rake
+  module TeamCity
+    module Utils
+      class FileLogger
+        def initialize(logs_dir, file_suffix)
+          @enabled = ENV[logs_dir]
+
+          @log_file = @enabled ? File.new(ENV[logs_dir] + file_suffix, "a+") : nil
+        end
+
+        def current_proc_thread_info
+          "[pid:#{Process.pid}x#{Thread.current}]"
+        end
+
+        def log_msg(msg, add_proc_thread_info=false)
+          if @enabled
+            @log_file << "[#{Time.now}] : #{(add_proc_thread_info ? current_proc_thread_info : "") + " " + msg}\n"
+            @log_file.flush
+          end
+        end
+
+        def log_block(id, data = nil, add_proc_thread_info=false)
+          log_msg("Start [#{id}]" + (data ? " data=[#{data}]" : ""), add_proc_thread_info);
+          begin
+            yield
+          rescue Exception => e
+            log_msg("Exception [#{id}], type=#{e.class.name}, msg=#{e.message}", add_proc_thread_info)
+            raise
+          end
+          log_msg("End [#{id}]", add_proc_thread_info)
+        end
+
+        def close
+          @log_file.close if @enabled
+        end
+      end
+
+      class RakeFileLogger < FileLogger
+        def initialize
+          super(TEAMCITY_RAKERUNNER_LOG_PATH_KEY, TEAMCITY_RAKERUNNER_LOG_FILENAME_SUFFIX)
+        end
+      end
+
+      class RPCMessagesLogger < FileLogger
+        def initialize
+          super(TEAMCITY_RAKERUNNER_LOG_PATH_KEY, TEAMCITY_RAKERUNNER_RPC_LOG_FILENAME_SUFFIX)
+        end
+      end
+
+      class RSpecFileLogger < FileLogger
+        def initialize
+          super(TEAMCITY_RAKERUNNER_LOG_PATH_KEY, TEAMCITY_RAKERUNNER_SPEC_LOG_FILENAME_SUFFIX)
+        end
+      end
+
+      class TestUnitFileLogger < FileLogger
+        def initialize
+          super(TEAMCITY_RAKERUNNER_LOG_PATH_KEY, TEAMCITY_RAKERUNNER_TESTUNIT_LOG_FILENAME_SUFFIX)
+        end
+      end
+
+      class TestUnitEventsFileLogger < FileLogger
+        def initialize
+          super(TEAMCITY_RAKERUNNER_LOG_PATH_KEY, TEAMCITY_RAKERUNNER_TESTUNIT_EVENTS_LOG_FILENAME_SUFFIX)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/teamcity/utils/runner_utils.rb

@@ -0,0 +1,182 @@
+# Copyright 2000-2012 JetBrains s.r.o.
+#
+# 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.
+
+# Created by IntelliJ IDEA.
+#
+# @author: Roman.Chernyatchik
+# @date: 02.06.2007
+
+require_relative '../rakerunner_consts'
+
+module Rake
+  module TeamCity
+    module RunnerUtils
+
+      ###########################################################################
+      ####  Test::Unit
+      ###########################################################################
+
+      # Converts Ruby Test Names : $TEST_METHOD_NAME($TEST_CASE_QUALIFIED_NAME)
+      # to Qualified name format :  $TEST_CASE_QUALIFIED_NAME.$TEST_METHOD_NAME
+      def convert_ruby_test_name_to_qualified(ruby_name)
+        if ruby_name && (ruby_name.strip =~ /(\S+)\(([\w:]*)\)/)
+          # p [$1, $2]
+          method_name = $1
+          qualified_name = $2
+          return convert_test_unit_to_qualified(qualified_name, method_name)
+        end
+        ruby_name
+      end
+
+      def convert_test_unit_to_qualified(class_qualified_name, method_name)
+        if class_qualified_name.empty?
+          "#{method_name}"
+        else
+          "#{class_qualified_name}.#{method_name}"
+        end
+      end
+
+      def self.use_minitest?
+        defined? ::MiniTest::Unit::TestCase
+      end
+
+      ###########################################################################
+      ####  RSpec
+      ###########################################################################
+
+      #@Nullable
+      #@returns pair of two strings: [source file path, line in source file] or [nil, nil]
+      def extract_source_location_from_example(example)
+        #example.instance_variable_hash['@_implementation'].to_s.gsub(/#<Proc:.+@/, "")
+
+        #TODO - replace with example full name!!!!!
+
+        if example.respond_to?(:location)
+          # rspec 1.2.1 API
+          return extract_rspec_proxy_location(example)
+        elsif (example.respond_to?(:metadata))
+          # rspec 2.0 beta API
+          return parse_rspec_proxy_location(example.metadata[:location])
+        end
+
+        proc = (example.respond_to?(:instance_variable_hash)) ? example.instance_variable_hash['@_implementation'] : nil
+
+        if !proc.nil? && proc.is_a?(Proc)
+          return extract_source_location_from_closure(proc.to_s)
+        end
+
+        return nil, nil
+      end
+
+      #[@Nullable, @Nullable]
+      def get_pair_by(src_file_path_str, src_file_line_str)
+        if src_file_path_str && src_file_line_str
+          return File.expand_path(src_file_path_str), src_file_line_str
+        end
+
+        return nil, nil
+      end
+
+      #@Nullable
+      #@returns pair of two strings: [source file path, line in source file] or [nil, nil]
+      def extract_source_location_from_path_info(spec_path_info)
+        # E.g.: "/Users/romeo/IdeaProjects/dianaplugin/rails/spec/my_example_spec.rb:4"
+        if spec_path_info =~ /(^)([^:]+)(:)(\d+)(\D*)($)/
+          src_file_path_str = $2
+          src_file_line_str = $4
+          if src_file_path_str && src_file_line_str
+            return src_file_path_str, src_file_line_str
+          end
+        elsif spec_path_info =~ /(^)([^:]+)($)/
+          return spec_path_info, "0"
+        end
+
+        return nil, nil
+      end
+
+      @@ignore_root_test_case = true
+
+      # usually we should ignore root test case that is test file
+      # but in run_all_in_folder case we shouldn't ignore it!
+      def self.ignore_root_test_case?
+        @@ignore_root_test_case
+      end
+
+      def self.ignore_root_test_case=(value)
+        @@ignore_root_test_case = value
+      end
+
+
+      def self.excluded_default_testcase_name?(suite_or_test_name)
+        ::Rake::TeamCity::TC_EXCLUDED_DEFAULT_TEST_CASES.index(suite_or_test_name) != nil
+      end
+
+      def self.excluded_default_testcase?(suite_or_test)
+        excluded_default_testcase_name?(suite_or_test.name) && (suite_or_test.size == 1)
+      end
+
+      def self.fake_default_test_for_empty_suite?(suite_or_test)
+        !(defined? suite_or_test.tests) && ("default_test" == suite_or_test.method_name)
+      end
+
+      ############################################################
+      ############################################################
+
+      private
+
+      #[@Nullable, @Nullable]
+      #Exctracting location using new RSpec 1.2.1 API
+      #@returns pair of two stings [source file path, line in source file] or [nil, nil]
+      def extract_rspec_proxy_location(proxy_object)
+        parse_rspec_proxy_location proxy_object.location
+      end
+
+      def parse_rspec_proxy_location(location)
+        #TODO Add test for it!!!!!
+        if location =~ /(.+):(\d+)/
+          return get_pair_by($1, $2)
+        end
+        return nil, nil
+      end
+
+      #@Nullable
+      #@returns pair of two strings: [source file path, line in source file] or [nil, nil]
+      def extract_source_location_from_group(example_group)
+        if example_group
+          if example_group.respond_to?(:location)
+            # rspec 1.2.1 API
+            return extract_rspec_proxy_location(example_group)
+          elsif (example_group.respond_to?(:metadata))
+            # rspec 2.0 beta API
+            return parse_rspec_proxy_location(example_group.metadata[:example_group][:location])
+          elsif (example_group.respond_to?(:spec_path))
+            return extract_source_location_from_path_info(example_group.spec_path)
+          end
+        end
+        return nil, nil
+      end
+
+      #[@Nullable, @Nullable]
+      #@returns pair of two strings: [source file path, line in source file] or [nil, nil]
+      def extract_source_location_from_closure(closure_id)
+        # E.g.: "#<Proc:0xaa3e9a@/Users/romeo/IdeaProjects/dianaplugin/rails/spec/my_example_spec.rb:16>"
+        if closure_id =~ /(#<[^:]+:[^@]+@)([^:]+)(:)(\d+)(>)/
+          return get_pair_by($2, $4)
+        end
+
+        return nil, nil
+      end
+    end
+  end
+end