tooling/rspec_flaky/flaky_example.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
49
50
51
52
53

# frozen_string_literal: true

require 'ostruct'

module RspecFlaky
  ALLOWED_ATTRIBUTES = %i[
    example_id
    file
    line
    description
    first_flaky_at
    last_flaky_at
    last_flaky_job
    last_attempts_count
    flaky_reports
  ].freeze

  # This represents a flaky RSpec example and is mainly meant to be saved in a JSON file
  class FlakyExample
    def initialize(example_hash)
      @attributes = {
        first_flaky_at: Time.now,
        last_flaky_at: Time.now,
        last_flaky_job: nil,
        last_attempts_count: example_hash[:attempts],
        flaky_reports: 0
      }.merge(example_hash.slice(*ALLOWED_ATTRIBUTES))

      %i[first_flaky_at last_flaky_at].each do |attr|
        attributes[attr] = Time.parse(attributes[attr]) if attributes[attr].is_a?(String)
      end
    end

    def update_flakiness!(last_attempts_count: nil)
      attributes[:first_flaky_at] ||= Time.now
      attributes[:last_flaky_at] = Time.now
      attributes[:flaky_reports] += 1
      attributes[:last_attempts_count] = last_attempts_count if last_attempts_count

      if ENV['CI_JOB_URL']
        attributes[:last_flaky_job] = "#{ENV['CI_JOB_URL']}"
      end
    end

    def to_h
      attributes.dup
    end

    private

    attr_reader :attributes
  end
end