Class: Inferno::CLI::RequirementsCoverageChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/inferno/apps/cli/requirements_coverage_checker.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test_suite_id) ⇒ RequirementsCoverageChecker

Returns a new instance of RequirementsCoverageChecker.



8
9
10
11
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 8

def initialize(test_suite_id)
  self.test_suite_id = test_suite_id
  self.test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id)
end

Instance Attribute Details

#test_suite ⇒ Object

Returns the value of attribute test_suite.



6
7
8
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 6

def test_suite
  @test_suite
end

#test_suite_id ⇒ Object

Returns the value of attribute test_suite_id.



6
7
8
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 6

def test_suite_id
  @test_suite_id
end

Instance Method Details

#base_requirements_folder ⇒ Object 



33
34
35
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 33

def base_requirements_folder
  RequirementsExporter.new.base_requirements_folder
end

#full_id_header ⇒ Object 



17
18
19
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 17

def full_id_header
  "#{test_suite.title} Full ID(s)"
end

#input_requirement_ids ⇒ Object 



106
107
108
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 106

def input_requirement_ids
  @input_requirement_ids ||= input_rows.map { |row| "#{row['Req Set']}@#{row['ID']}" }
end

#new_csv ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 66

def new_csv # rubocop:disable Metrics/CyclomaticComplexity
  @new_csv ||=
    CSV.generate(+"\xEF\xBB\xBF") do |csv|
      csv << output_headers

      suite_requirements.each do |requirement|
        if requirement.not_tested_reason.present?
          long_ids = 'NA'
          short_ids = 'NA'
        else
          runnables_for_requirement =
            suite_runnables.select { |runnable| runnable.verifies_requirements.include? requirement.id }
          long_ids = runnables_for_requirement&.map(&:id)&.join(', ')
          short_ids =
            runnables_for_requirement
              &.map { |runnable| runnable < Inferno::Entities::TestSuite ? 'suite' : runnable.short_id }
              &.join(', ')
        end

        untested_requirements << runnables_for_requirement if runnables_for_requirement.blank?

        row = [
          requirement.requirement_set,
          requirement.id.delete_prefix("#{requirement.requirement_set}@"),
          requirement.url,
          requirement.requirement,
          requirement.conformance,
          requirement.actors.join(','),
          requirement.conditionality,
          requirement.not_tested_reason,
          requirement.not_tested_details,
          short_ids,
          long_ids
        ]

        csv << row
      end
    end
end

#old_csv ⇒ Object 



127
128
129
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 127

def old_csv
  @old_csv ||= File.read(output_file_path)
end

#output_file_name ⇒ Object 



41
42
43
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 41

def output_file_name
  "#{test_suite_id}_requirements_coverage.csv"
end

#output_file_path ⇒ Object 



45
46
47
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 45

def output_file_path
  @output_file_path ||= File.join(output_folder, output_file_name)
end

#output_folder ⇒ Object 



37
38
39
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 37

def output_folder
  @output_folder ||= File.join(base_requirements_folder, 'generated')
end

#output_headers ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 21

def output_headers
  [
    *(RequirementsExporter::REQUIREMENTS_OUTPUT_HEADERS - ['Sub-Requirement(s)']),
    short_id_header,
    full_id_header
  ]
end

#output_requirements_map_table(requirements_rows) ⇒ Object

Output the requirements in the map like so:

requirement_id | short_id | full_id —————+————+———- req-id-1 | short-id-1 | full-id-1 req-id-2 | short-id-2 | full-id-2



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 210

def output_requirements_map_table(requirements_rows)
  headers = %w[requirement_id short_id full_id]
  col_widths = headers.map(&:length)
  col_widths[0] = [col_widths[0], *requirements_rows.map { |row| row[0].length }].max
  col_widths[1] = [col_widths[1], *requirements_rows.map { |row| row[1].length }].max
  col_widths[2] = [col_widths[2], *requirements_rows.map { |row| row[2].length }].max
  col_widths.map! { |width| width + 3 }

  puts [
    headers[0].ljust(col_widths[0]),
    headers[1].ljust(col_widths[1]),
    headers[2].ljust(col_widths[2])
  ].join(' | ')
  puts col_widths.map { |width| '-' * width }.join('-+-')
  output_requirements_map_table_contents(requirements_rows, col_widths)
end

#output_requirements_map_table_contents(requirements_rows, col_widths) ⇒ Object 



227
228
229
230
231
232
233
234
235
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 227

def output_requirements_map_table_contents(requirements_rows, col_widths)
  requirements_rows.each do |requirements_row|
    puts [
      requirements_row[0].ljust(col_widths[0]),
      requirements_row[1].ljust(col_widths[1]),
      requirements_row[2].ljust(col_widths[2])
    ].join(' | ')
  end
end

#run ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 131

def run
  unless test_suite.present?
    puts "Could not find test suite: #{test_suite_id}. Aborting requirements coverage generation..."
    exit(1)
  end

  puts

  if unmatched_requirement_ids.present?
    puts "WARNING: The following requirements indicated in the test suite #{test_suite_id} are not present in " \
         "the suite's requirement sets:"
    output_requirements_map_table(unmatched_requirement_rows)
  end

  if File.exist?(output_file_path)
    if old_csv == new_csv
      puts "'#{output_file_name}' file is up to date."
      return
    else
      puts 'Requirements coverage has changed.'
    end
  else
    puts "No existing #{output_file_name}."
  end

  puts "Writing to file #{output_file_path}..."
  FileUtils.mkdir_p(output_folder)
  File.write(output_file_path, new_csv)
  puts 'Done.'
end

#run_check ⇒ Object 



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
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 162

def run_check
  unless test_suite.present?
    puts "Could not find test suite: #{test_suite_id}. Aborting requirements coverage generation..."
    exit(1)
  end

  puts

  if unmatched_requirement_ids.any?
    puts "WARNING: The following requirements indicated in the test suite #{test_suite_id} are not present in " \
         "the suite's requirement sets:"
    output_requirements_map_table(unmatched_requirement_rows)
  end

  if File.exist?(output_file_path)
    if old_csv == new_csv
      puts "'#{output_file_name}' file is up to date."
      return
    else
      puts <<~MESSAGE
        #{output_file_name} file is out of date.
        To regenerate the file, run:

            bundle exec inferno requirements coverage

      MESSAGE
    end
  else
    puts <<~MESSAGE
      No existing #{output_file_name} file.
      To generate the file, run:

            bundle exec inferno requirements coverage

    MESSAGE
  end

  puts 'Check failed.'
  exit(1)
end

#short_id_header ⇒ Object 



13
14
15
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 13

def short_id_header
  "#{test_suite.title} Short ID(s)"
end

#suite_requirements ⇒ Object 



49
50
51
52
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 49

def suite_requirements
  @suite_requirements ||=
    Inferno::Repositories::Requirements.new.requirements_for_suite(test_suite_id)
end

#suite_runnables ⇒ Object 



58
59
60
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 58

def suite_runnables
  @suite_runnables ||= [test_suite] + test_suite.all_descendants
end

#test_kit_name ⇒ Object 



29
30
31
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 29

def test_kit_name
  local_test_kit_gem.name
end

#tested_requirement_ids ⇒ Object 



54
55
56
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 54

def tested_requirement_ids
  @tested_requirement_ids ||= test_suite.all_verified_requirements
end

#unmatched_requirement_ids ⇒ Object

The requirements present in Inferno that aren’t in the input spreadsheet



111
112
113
114
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 111

def unmatched_requirement_ids
  @unmatched_requirement_ids ||=
    tested_requirement_ids - suite_requirements.map(&:id)
end

#unmatched_requirement_rows ⇒ Object 



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 116

def unmatched_requirement_rows
  unmatched_requirement_ids.flat_map do |requirement_id|
    runnables_for_requirement =
      suite_runnables.select { |runnable| runnable.verifies_requirements.include? requirement_id }

    runnables_for_requirement.map do |runnable|
      [requirement_id, runnable.short_id, runnable.id]
    end
  end
end

#untested_requirements ⇒ Object 



62
63
64
 
# File 'lib/inferno/apps/cli/requirements_coverage_checker.rb', line 62

def untested_requirements
  @untested_requirements ||= []
end