Class: RailVerdict::Analyzers::Minitest

Inherits:
Object
  • Object
show all
Defined in:
lib/rail_verdict/analyzers/minitest.rb

Defined Under Namespace

Classes: MalformedOutput, Probe

Constant Summary collapse

ANALYZER_ID = 
"minitest"
SUPPORTED_VERSIONS = 
Gem::Requirement.new(">= 5", "< 7")

Instance Method Summary collapse

Constructor Details

#initialize(command_resolver: nil) ⇒ Minitest

Returns a new instance of Minitest.



19
20
21
 
# File 'lib/rail_verdict/analyzers/minitest.rb', line 19

def initialize(command_resolver: nil)
  @command_resolver = command_resolver || method(:default_command)
end

Instance Method Details

#probe(repository_root, runner: ProcessRunner, timeout_seconds: 15.0) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rail_verdict/analyzers/minitest.rb', line 23

def probe(repository_root, runner: ProcessRunner, timeout_seconds: 15.0)
  command = @command_resolver.call(repository_root)
  probe_argv = probe_argv_for(command, repository_root)
  result = runner.run(
    command.fetch(:executable),
    probe_argv,
    chdir: repository_root,
    timeout_seconds: timeout_seconds
  )

  return Probe.new(status: "unavailable", message: Shared.detail_for(result)) if result.status == :spawn_failed
  return Probe.new(status: "timed_out", message: Shared.detail_for(result)) if result.status == :timed_out
  return Probe.new(status: "signaled", message: Shared.detail_for(result)) if result.status == :signaled
  return Probe.new(status: "truncated", message: Shared.detail_for(result)) if Shared.truncated?(result)
  return Probe.new(status: "unavailable", message: Shared.detail_for(result)) unless result.exit_code == 0

  version = Shared.parse_semver(result.stdout)
  return Probe.new(status: "unsupported", message: "Minitest version could not be parsed") unless version
  return Probe.new(status: "unsupported", version: version, message: "unsupported Minitest version #{version}") unless SUPPORTED_VERSIONS.satisfied_by?(Gem::Version.new(version))

  Probe.new(status: "succeeded", version: version)
rescue ArgumentError
  Probe.new(status: "unsupported", message: "Minitest reported an invalid version")
rescue KeyError, ArgumentError => error
  Probe.new(status: "malformed", message: Shared.bounded_message(error.message))
end

#run(repository_root, runner: ProcessRunner, timeout_seconds: 30.0, probe_result: nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/rail_verdict/analyzers/minitest.rb', line 50

def run(repository_root, runner: ProcessRunner, timeout_seconds: 30.0, probe_result: nil)
  probe_result ||= probe(repository_root, runner: runner, timeout_seconds: timeout_seconds)

  unless probe_result.status == "succeeded"
    fallback_command = @command_resolver.call(repository_root)
    version_invocation = Shared.invocation_for(fallback_command, ["--version"])
    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: version_invocation, status: probe_result.status, message: probe_result.message, tool_version: probe_result.version), []]
  end

  command = @command_resolver.call(repository_root)
  reporter_path = resolve_reporter_path
  unless reporter_path
    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: Shared.invocation_for(command, ["run"]), status: "malformed", message: "installed Minitest reporter is missing", tool_version: probe_result.version), []]
  end

  invocation = Shared.invocation_for(command, ["run"])
  output_path = File.join(repository_root, ".railverdict-minitest-#{SecureRandom.hex(6)}.json")
  env_reset_required = false
  previous_env = ENV["RAILVERDICT_MINITEST_OUTPUT"]
  begin
    ENV["RAILVERDICT_MINITEST_OUTPUT"] = output_path
    env_reset_required = true
    augmented_argv = invocation.fetch("argv").dup
    augmented_argv = inject_reporter_require(augmented_argv, reporter_path)
    result = runner.run(
      command.fetch(:executable),
      augmented_argv,
      chdir: repository_root,
      timeout_seconds: timeout_seconds
    )
    tool_version = probe_result.version

    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: invocation, status: "unavailable", message: Shared.detail_for(result), tool_version: tool_version), []] if result.status == :spawn_failed
    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: invocation, status: "truncated", message: Shared.detail_for(result), tool_version: tool_version), []] if Shared.truncated?(result)
    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: invocation, status: "timed_out", message: Shared.detail_for(result), tool_version: tool_version), []] if result.status == :timed_out
    return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: invocation, status: "signaled", message: Shared.detail_for(result), tool_version: tool_version), []] if result.status == :signaled

    document = load_reporter_document(output_path, result, invocation, tool_version)
    return document if document.is_a?(Array) && document.first.is_a?(AnalyzerResult)

    begin
      summary, findings = normalize_document(document)
    rescue MalformedOutput => error
      return [Shared.failure_result(analyzer_id: ANALYZER_ID, invocation: invocation, status: "malformed", message: Shared.bounded_message(error.message), tool_version: tool_version), []]
    end

    analyzer_result = AnalyzerResult.new(
      analyzer: ANALYZER_ID,
      tool_version: tool_version,
      invocation: invocation,
      execution_status: "succeeded",
      finding_ids: findings.map(&:id),
      evidence_summary: summary
    )
    [analyzer_result, findings]
  ensure
    if env_reset_required
      if previous_env.nil?
        ENV.delete("RAILVERDICT_MINITEST_OUTPUT")
      else
        ENV["RAILVERDICT_MINITEST_OUTPUT"] = previous_env
      end
    end
    begin
      File.unlink(output_path) if File.file?(output_path)
    rescue StandardError
      nil
    end
  end
end