Class: KnapsackPro::Adapters::RSpecAdapter

Inherits:
BaseAdapter
  • Object
show all
Defined in:
lib/knapsack_pro/adapters/rspec_adapter.rb

Direct Known Subclasses

RspecAdapter

Constant Summary collapse

TEST_DIR_PATTERN = 
'spec/**{,/*/**}/*_spec.rb'
ID_PATH_REGEX = 
/.+_spec\.rb\[.+\]$/

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseAdapter

adapter_bind_method_called_file, bind, #bind, #bind_queue_mode, slow_test_file?, verify_bind_method_called

Class Method Details

.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 40

def self.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
  if KnapsackPro::Config::Env.rspec_split_by_test_examples? && has_tag_option?(cli_args)
    error_message = "It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: #{KnapsackPro::Urls::RSPEC__SPLIT_BY_TEST_EXAMPLES__TAG}"
    KnapsackPro.logger.error(error_message)
    raise error_message
  end
end

.file_path_for(example) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 64

def self.file_path_for(example)
  [
    -> { parse_file_path(example.id) },
    -> { example.metadata[:file_path] },
    -> { example.metadata[:example_group][:file_path] },
    -> { top_level_group(example)[:file_path] },
  ]
    .each do |path|
      p = path.call
      return p if p.include?('_spec.rb') || p.include?('.feature')
    end

  return ''
end

.has_format_option?(cli_args) ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 52

def self.has_format_option?(cli_args)
  !!parsed_options(cli_args)&.[](:formatters)
end

.has_require_rails_helper_option?(cli_args) ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 56

def self.has_require_rails_helper_option?(cli_args)
  (parsed_options(cli_args)&.[](:requires) || []).include?("rails_helper")
end

.has_tag_option?(cli_args) ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 48

def self.has_tag_option?(cli_args)
  !!parsed_options(cli_args)&.[](:inclusion_filter)
end

.id_path?(path) ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 84

def self.id_path?(path)
  ID_PATH_REGEX.match?(path)
end

.order_option(cli_args) ⇒ Object 



60
61
62
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 60

def self.order_option(cli_args)
  parsed_options(cli_args)&.[](:order)
end

.parse_file_path(id) ⇒ Object 



79
80
81
82
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 79

def self.parse_file_path(id)
  # https://github.com/rspec/rspec-core/blob/1eeadce5aa7137ead054783c31ff35cbfe9d07cc/lib/rspec/core/example.rb#L122
  id.match(/\A(.*?)(?:\[([\d\s:,]+)\])?\z/).captures.first
end

.rails_helper_exists?(test_dir) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 88

def self.rails_helper_exists?(test_dir)
  File.exist?("#{test_dir}/rails_helper.rb")
end

.split_by_test_cases_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
14
15
16
17
18
19
20
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 11

def self.split_by_test_cases_enabled?
  return false unless KnapsackPro::Config::Env.rspec_split_by_test_examples?

  require 'rspec/core/version'
  unless Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
    raise "RSpec >= 3.3.0 is required to split test files by test examples. Learn more: #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
  end

  true
end

.test_file_cases_for(slow_test_files) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 22

def self.test_file_cases_for(slow_test_files)
  KnapsackPro.logger.info("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing #{slow_test_files.size} slow test files.")

  # generate the RSpec JSON report in a separate process to not pollute the RSpec state
  cmd = [
    'RACK_ENV=test',
    'RAILS_ENV=test',
    KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
    'rake knapsack_pro:rspec_test_example_detector',
  ].join(' ')
  unless Kernel.system(cmd)
    raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
  end

  # read the JSON report
  KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new.test_file_example_paths
end

.top_level_group(example) ⇒ Object

private



93
94
95
96
97
98
99
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 93

def self.top_level_group(example)
  group = example.metadata[:example_group]
  until group[:parent_example_group].nil?
    group = group[:parent_example_group]
  end
  group
end

Instance Method Details

#bind_after_queue_hook ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 160

def bind_after_queue_hook
  ::RSpec.configure do |config|
    config.after(:suite) do
      KnapsackPro::Hooks::Queue.call_after_queue
    end
  end
end

#bind_before_queue_hook ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 152

def bind_before_queue_hook
  ::RSpec.configure do |config|
    config.before(:suite) do
      KnapsackPro::Hooks::Queue.call_before_queue
    end
  end
end

#bind_regular_mode_time_tracker ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 132

def bind_regular_mode_time_tracker
  return unless KnapsackPro::Config::Env.regular_mode?

  ::RSpec.configure do |config|
    config.append_before(:suite) do
      time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
      time_tracker.scheduled_paths = KnapsackPro::Adapters::RSpecAdapter.scheduled_paths
    end
  end
end

#bind_save_report ⇒ Object 



143
144
145
146
147
148
149
150
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 143

def bind_save_report
  ::RSpec.configure do |config|
    config.after(:suite) do
      time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
      KnapsackPro::Report.save(time_tracker.batch)
    end
  end
end

#bind_time_tracker ⇒ Object 



101
102
103
104
105
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 101

def bind_time_tracker
  ensure_no_focus!
  bind_regular_mode_time_tracker
  log_tests_duration
end

#ensure_no_focus! ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 107

def ensure_no_focus!
  ::RSpec.configure do |config|
    config.around(:each) do |example|
      if example.metadata[:focus] && KnapsackPro::Adapters::RSpecAdapter.rspec_configuration.filter.rules[:focus]
        file_path = KnapsackPro::Adapters::RSpecAdapter.file_path_for(example)
        file_path = KnapsackPro::TestFileCleaner.clean(file_path)

        raise "Knapsack Pro found an example tagged with focus in #{file_path}, please remove it. See more: #{KnapsackPro::Urls::RSPEC__SKIPS_TESTS}"
      end

      example.run
    end
  end
end

#log_tests_duration ⇒ Object 



122
123
124
125
126
127
128
129
130
 
# File 'lib/knapsack_pro/adapters/rspec_adapter.rb', line 122

def log_tests_duration
  ::RSpec.configure do |config|
    config.append_after(:suite) do
      time_tracker = KnapsackPro::Formatters::TimeTrackerFetcher.call
      formatted = KnapsackPro::Presenter.global_time(time_tracker.duration)
      KnapsackPro.logger.debug(formatted)
    end
  end
end