Class: CI::Queue::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/ci/queue/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(timeout: 30, build_id: nil, worker_id: nil, max_requeues: 0, requeue_tolerance: 0, namespace: nil, seed: nil, flaky_tests: [], statsd_endpoint: nil, max_consecutive_failures: nil, grind_count: nil, max_duration: nil, failure_file: nil, max_test_duration: nil, max_test_duration_percentile: 0.5, track_test_duration: false, max_test_failed: nil, queue_init_timeout: nil, redis_ttl: 8 * 60 * 60, report_timeout: nil, inactive_workers_timeout: nil, export_flaky_tests_file: nil, warnings_file: nil, debug_log: nil, max_missed_heartbeat_seconds: nil) ⇒ Configuration

Returns a new instance of Configuration.



43
44
45
46
47
48
49
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
 
# File 'lib/ci/queue/configuration.rb', line 43

def initialize(
  timeout: 30, build_id: nil, worker_id: nil, max_requeues: 0, requeue_tolerance: 0,
  namespace: nil, seed: nil, flaky_tests: [], statsd_endpoint: nil, max_consecutive_failures: nil,
  grind_count: nil, max_duration: nil, failure_file: nil, max_test_duration: nil,
  max_test_duration_percentile: 0.5, track_test_duration: false, max_test_failed: nil,
  queue_init_timeout: nil, redis_ttl: 8 * 60 * 60, report_timeout: nil, inactive_workers_timeout: nil,
  export_flaky_tests_file: nil, warnings_file: nil, debug_log: nil, max_missed_heartbeat_seconds: nil)
  @build_id = build_id
  @circuit_breakers = [CircuitBreaker::Disabled]
  @failure_file = failure_file
  @flaky_tests = flaky_tests
  @grind_count = grind_count
  @max_requeues = max_requeues
  @max_test_duration = max_test_duration
  @max_test_duration_percentile = max_test_duration_percentile
  @max_test_failed = max_test_failed
  @namespace = namespace
  @requeue_tolerance = requeue_tolerance
  @seed = seed
  @statsd_endpoint = statsd_endpoint
  @timeout = timeout
  @queue_init_timeout = queue_init_timeout
  @track_test_duration = track_test_duration
  @worker_id = worker_id
  self.max_consecutive_failures = max_consecutive_failures
  self.max_duration = max_duration
  @redis_ttl = redis_ttl
  @report_timeout = report_timeout
  @inactive_workers_timeout = inactive_workers_timeout
  @export_flaky_tests_file = export_flaky_tests_file
  @warnings_file = warnings_file
  @debug_log = debug_log
  @max_missed_heartbeat_seconds = max_missed_heartbeat_seconds
end

Instance Attribute Details

#build_id ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/ci/queue/configuration.rb', line 110

def build_id
  if namespace
    "#{namespace}:#{@build_id}"
  else
    @build_id
  end
end

#circuit_breakers ⇒ Object (readonly)

Returns the value of attribute circuit_breakers.



9
10
11
 
# File 'lib/ci/queue/configuration.rb', line 9

def circuit_breakers
  @circuit_breakers
end

#debug_log ⇒ Object

Returns the value of attribute debug_log.



8
9
10
 
# File 'lib/ci/queue/configuration.rb', line 8

def debug_log
  @debug_log
end

#export_flaky_tests_file ⇒ Object

Returns the value of attribute export_flaky_tests_file.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def export_flaky_tests_file
  @export_flaky_tests_file
end

#failing_test ⇒ Object

Returns the value of attribute failing_test.



6
7
8
 
# File 'lib/ci/queue/configuration.rb', line 6

def failing_test
  @failing_test
end

#failure_file ⇒ Object

Returns the value of attribute failure_file.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def failure_file
  @failure_file
end

#grind_count ⇒ Object

Returns the value of attribute grind_count.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def grind_count
  @grind_count
end

#inactive_workers_timeout ⇒ Object 



86
87
88
 
# File 'lib/ci/queue/configuration.rb', line 86

def inactive_workers_timeout
  @inactive_workers_timeout || timeout
end

#max_missed_heartbeat_seconds ⇒ Object

Returns the value of attribute max_missed_heartbeat_seconds.



8
9
10
 
# File 'lib/ci/queue/configuration.rb', line 8

def max_missed_heartbeat_seconds
  @max_missed_heartbeat_seconds
end

#max_requeues ⇒ Object

Returns the value of attribute max_requeues.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def max_requeues
  @max_requeues
end

#max_test_duration ⇒ Object

Returns the value of attribute max_test_duration.



7
8
9
 
# File 'lib/ci/queue/configuration.rb', line 7

def max_test_duration
  @max_test_duration
end

#max_test_duration_percentile ⇒ Object

Returns the value of attribute max_test_duration_percentile.



7
8
9
 
# File 'lib/ci/queue/configuration.rb', line 7

def max_test_duration_percentile
  @max_test_duration_percentile
end

#max_test_failed ⇒ Object

Returns the value of attribute max_test_failed.



8
9
10
 
# File 'lib/ci/queue/configuration.rb', line 8

def max_test_failed
  @max_test_failed
end

#namespace ⇒ Object

Returns the value of attribute namespace.



6
7
8
 
# File 'lib/ci/queue/configuration.rb', line 6

def namespace
  @namespace
end

#queue_init_timeout ⇒ Object 



78
79
80
 
# File 'lib/ci/queue/configuration.rb', line 78

def queue_init_timeout
  @queue_init_timeout || timeout
end

#redis_ttl ⇒ Object

Returns the value of attribute redis_ttl.



8
9
10
 
# File 'lib/ci/queue/configuration.rb', line 8

def redis_ttl
  @redis_ttl
end

#report_timeout ⇒ Object 



82
83
84
 
# File 'lib/ci/queue/configuration.rb', line 82

def report_timeout
  @report_timeout || timeout
end

#requeue_tolerance ⇒ Object

Returns the value of attribute requeue_tolerance.



6
7
8
 
# File 'lib/ci/queue/configuration.rb', line 6

def requeue_tolerance
  @requeue_tolerance
end

#seed ⇒ Object 



106
107
108
 
# File 'lib/ci/queue/configuration.rb', line 106

def seed
  @seed || build_id
end

#statsd_endpoint ⇒ Object

Returns the value of attribute statsd_endpoint.



6
7
8
 
# File 'lib/ci/queue/configuration.rb', line 6

def statsd_endpoint
  @statsd_endpoint
end

#timeout ⇒ Object

Returns the value of attribute timeout.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def timeout
  @timeout
end

#track_test_duration ⇒ Object

Returns the value of attribute track_test_duration.



7
8
9
 
# File 'lib/ci/queue/configuration.rb', line 7

def track_test_duration
  @track_test_duration
end

#warnings_file ⇒ Object

Returns the value of attribute warnings_file.



8
9
10
 
# File 'lib/ci/queue/configuration.rb', line 8

def warnings_file
  @warnings_file
end

#worker_id ⇒ Object

Returns the value of attribute worker_id.



5
6
7
 
# File 'lib/ci/queue/configuration.rb', line 5

def worker_id
  @worker_id
end

Class Method Details

.from_env(env) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/ci/queue/configuration.rb', line 14

def from_env(env)
  new(
    build_id: env['CIRCLE_BUILD_URL'] || env['BUILDKITE_BUILD_ID'] || env['TRAVIS_BUILD_ID'] || env['HEROKU_TEST_RUN_ID'] || env['SEMAPHORE_PIPELINE_ID'],
    worker_id: env['CIRCLE_NODE_INDEX'] || env['BUILDKITE_PARALLEL_JOB'] || env['CI_NODE_INDEX'] || env['SEMAPHORE_JOB_ID'],
    seed: env['CIRCLE_SHA1'] || env['BUILDKITE_COMMIT'] || env['TRAVIS_COMMIT'] || env['HEROKU_TEST_RUN_COMMIT_VERSION'] || env['SEMAPHORE_GIT_SHA'],
    flaky_tests: load_flaky_tests(env['CI_QUEUE_FLAKY_TESTS']),
    statsd_endpoint: env['CI_QUEUE_STATSD_ADDR'],
    redis_ttl: env['CI_QUEUE_REDIS_TTL']&.to_i ||  8 * 60 * 60,
    debug_log: env['CI_QUEUE_DEBUG_LOG'],
    max_requeues: env['CI_QUEUE_MAX_REQUEUES']&.to_i || 0,
    requeue_tolerance: env['CI_QUEUE_REQUEUE_TOLERANCE']&.to_f || 0,
  )
end

.load_flaky_tests(path) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/ci/queue/configuration.rb', line 28

def load_flaky_tests(path)
  return [] unless path
  if ::File.extname(path) == ".xml"
    require 'rexml/document'
    REXML::Document.new(::File.read(path)).elements.to_a("//testcase").map do |element|
      "#{element.attributes['classname']}##{element.attributes['name']}"
    end.to_set
  else
    ::File.readlines(path).map(&:chomp).to_set
  end
rescue SystemCallError
  []
end

Instance Method Details

#flaky?(test) ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/ci/queue/configuration.rb', line 102

def flaky?(test)
  @flaky_tests.include?(test.id)
end

#global_max_requeues(tests_count) ⇒ Object 



118
119
120
 
# File 'lib/ci/queue/configuration.rb', line 118

def global_max_requeues(tests_count)
  (tests_count * Float(requeue_tolerance)).ceil
end

#max_consecutive_failures=(max) ⇒ Object 



90
91
92
93
94
 
# File 'lib/ci/queue/configuration.rb', line 90

def max_consecutive_failures=(max)
  if max
    @circuit_breakers << CircuitBreaker::MaxConsecutiveFailures.new(max_consecutive_failures: max)
  end
end

#max_duration=(duration) ⇒ Object 



96
97
98
99
100
 
# File 'lib/ci/queue/configuration.rb', line 96

def max_duration=(duration)
  if duration
    @circuit_breakers << CircuitBreaker::Timeout.new(duration: duration)
  end
end