Class: Rdm::SpecRunner::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/rdm/spec_runner/runner.rb

Constant Summary collapse

RUNIGNORE_PATH = 
'tests/.runignore'.freeze
RUNIGNORE_COMMENT = 
'#'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(package: nil, spec_matcher: nil, path: nil, from: nil, show_missing_packages: true, skip_ignored_packages: false, stdout: STDOUT, show_output: true) ⇒ Runner

Returns a new instance of Runner.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rdm/spec_runner/runner.rb', line 8

def initialize(
  package:               nil,
  spec_matcher:          nil,
  path:                  nil,
  from:                  nil,
  show_missing_packages: true,
  skip_ignored_packages: false,
  stdout:                STDOUT,
  show_output:           true
)
  @package_name          = package
  @no_specs_packages     = []
  @spec_matcher          = spec_matcher.to_s.split(':')[0]
  @spec_string_number    = spec_matcher.to_s.split(':')[1].to_i
  @path                  = path
  @run_all               = @package_name.nil?
  @show_missing_packages = show_missing_packages && !@package_name
  @skip_ignored_packages = skip_ignored_packages
  @skipped_packages      = []
  @stdout                = stdout
  @show_output           = show_output
  @from                  = from
  @command_list          = []
end

Instance Attribute Details

#no_specs_packages ⇒ Object

Returns the value of attribute no_specs_packages.



5
6
7
 
# File 'lib/rdm/spec_runner/runner.rb', line 5

def no_specs_packages
  @no_specs_packages
end

#prepared_command_params ⇒ Object

Returns the value of attribute prepared_command_params.



6
7
8
 
# File 'lib/rdm/spec_runner/runner.rb', line 6

def prepared_command_params
  @prepared_command_params
end

Instance Method Details

#check_input_params! ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rdm/spec_runner/runner.rb', line 76

def check_input_params!
  if @package_name
    unless is_package_included?(@package_name)
      exit_with_message(
        view.package_not_found_message(@package_name, prepared_command_params)
      )
    end

    if no_specs_packages.include?(@package_name)
      exit_with_message(
        view.no_specs_for_package(@package_name)
      )
    end
  end
end

#display_ignored_specs ⇒ Object 



199
200
201
202
203
 
# File 'lib/rdm/spec_runner/runner.rb', line 199

def display_ignored_specs
  if !@skipped_packages.empty?
    print_message view.skipping_specs_message(@skipped_packages)
  end
end

#display_missing_specs ⇒ Object 



193
194
195
196
197
 
# File 'lib/rdm/spec_runner/runner.rb', line 193

def display_missing_specs
  if !no_specs_packages.empty?
    print_message view.missing_specs_message(no_specs_packages)
  end
end

#execute_command ⇒ Object 



205
206
207
208
209
210
211
212
 
# File 'lib/rdm/spec_runner/runner.rb', line 205

def execute_command
  has_failed_packages = @command_list
    .map {|cmd| eval(cmd); $?}
    .reject {|result| result.success?}
    .any?

  exit(1) if has_failed_packages
end

#exit_with_message(msg) ⇒ Object 



71
72
73
74
 
# File 'lib/rdm/spec_runner/runner.rb', line 71

def exit_with_message(msg)
  print_message(msg)
  exit 1
end

#is_package_included?(package_name) ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
95
96
 
# File 'lib/rdm/spec_runner/runner.rb', line 92

def is_package_included?(package_name)
  !prepared_command_params.select do |x|
    x.package_name == package_name
  end.empty?
end

#packages ⇒ Object 



58
59
60
 
# File 'lib/rdm/spec_runner/runner.rb', line 58

def packages
  @packages ||= Rdm::SpecRunner::PackageFetcher.new(@path).packages
end

#prepare! ⇒ Object 



98
99
100
101
102
103
104
105
 
# File 'lib/rdm/spec_runner/runner.rb', line 98

def prepare!
  prepared_command_params = []
  no_specs_packages       = []
  @command_list            = []
  prepare_command_params
  prepare_no_specs_packages
  prepare_command
end

#prepare_command ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/rdm/spec_runner/runner.rb', line 126

def prepare_command
  if @package_name
    @command_list += prepare_single_package_command(@package_name)
  else
    @command_list += prepare_commands_for_packages(prepared_command_params)
  end
end

#prepare_command_params ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rdm/spec_runner/runner.rb', line 107

def prepare_command_params
  @prepared_command_params ||= begin
    packages.map do |_name, package|
      Rdm::SpecRunner::CommandGenerator.new(
        package_name: package.name,
        package_path: package.path,
        spec_matcher: @spec_matcher,
        show_output:  @show_output
      ).generate
    end
  end
end

#prepare_commands_for_packages(packages_command_params) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/rdm/spec_runner/runner.rb', line 141

def prepare_commands_for_packages(packages_command_params)
  if @skip_ignored_packages && !@package_name
    runignore_path = File.expand_path(File.join(Rdm.root_dir, RUNIGNORE_PATH))
    package_list   = Rdm::SourceParser.read_and_init_source(Rdm.root).packages.keys

    skipped_package_list = File.read(runignore_path)
      .lines
      .map(&:strip)
      .reject(&:empty?) rescue []

    @skipped_packages       = skipped_package_list.select {|line| package_list.include?(line)}
    comment_runignore_lines = skipped_package_list.select {|line| line.start_with?(RUNIGNORE_COMMENT)}
    invalid_ignore_packages = skipped_package_list - @skipped_packages - comment_runignore_lines

    if !invalid_ignore_packages.empty?
      @stdout.puts "WARNING: #{RUNIGNORE_PATH} contains invalid package names: \n#{invalid_ignore_packages.join("\n")}"
    end
  else
    @skipped_packages = []
  end

  running_packages = packages_command_params
    .select  { |cmd_params| cmd_params.spec_count > 0 }
    .reject  { |cmd_params| @skipped_packages.include?(cmd_params.package_name) }
    .sort_by { |cmd_params| cmd_params.package_name }

  if @from
    start_from = running_packages.index {|cmd_params| cmd_params.package_name == @from}

    if start_from.nil?
      puts "Package :#{@from} does not exists"
      exit(1)
    end

    if @skipped_packages.include?(start_from)
      puts "Package :#{@from} skipped by .runignore file"
      exit(1)
    end

    running_packages = running_packages[start_from..-1]
  end

  if @run_all
    puts "      Rspec tests will run for packages:\n      \#{(packages.keys - no_specs_packages).map {|pkg| \" - \#{pkg}\"}.sort.join(\"\\n\")}\\n\n    EOF\n  end\n\n  running_packages.map(&:command)\nend\n"

#prepare_no_specs_packages ⇒ Object 



120
121
122
123
124
 
# File 'lib/rdm/spec_runner/runner.rb', line 120

def prepare_no_specs_packages
  prepared_command_params
    .select { |cp| cp.spec_count == 0 }
    .map { |cp| no_specs_packages << cp.package_name }
end

#prepare_single_package_command(package_name) ⇒ Object 



134
135
136
137
138
139
 
# File 'lib/rdm/spec_runner/runner.rb', line 134

def prepare_single_package_command(package_name)
  selected = prepared_command_params.detect do |cmd_params|
    cmd_params.package_name == package_name
  end
  prepare_commands_for_packages([selected])
end

#print_message(msg) ⇒ Object 



66
67
68
69
 
# File 'lib/rdm/spec_runner/runner.rb', line 66

def print_message(msg)
  @stdout.puts msg
  true
end

#run ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rdm/spec_runner/runner.rb', line 33

def run
  if !@spec_matcher.nil? && !@spec_matcher.empty?
    @spec_file_matches = Rdm::SpecRunner::SpecFilenameMatcher.find_matches(package_path: packages[@package_name].path, spec_matcher: @spec_matcher)
    case @spec_file_matches.size
    when 0
      raise Rdm::Errors::SpecMatcherNoFiles, "No specs were found for '#{@spec_matcher}'"
    when 1
      format_string_number = @spec_string_number == 0 ? "" : ":#{@spec_string_number}"
      @spec_matcher = @spec_file_matches.first + format_string_number

      @stdout.puts "Following spec matches your input: #{@spec_matcher}"
    else
      raise Rdm::Errors::SpecMatcherMultipleFiles, @spec_file_matches.join("\n")
    end
  end

  prepare!
  check_input_params!
  display_missing_specs if @show_missing_packages
  display_ignored_specs if @skip_ignored_packages
  print_message view.specs_header_message if @show_missing_packages || @skip_ignored_packages

  execute_command
end

#view ⇒ Object 



62
63
64
 
# File 'lib/rdm/spec_runner/runner.rb', line 62

def view
  @view ||= Rdm::SpecRunner::View.new
end