Class: Minitest::Distributed::Configuration

Inherits:
T::Struct
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/minitest/distributed/configuration.rb

Constant Summary collapse

DEFAULT_BATCH_SIZE = 
10
DEFAULT_MAX_ATTEMPTS = 
1
DEFAULT_TEST_TIMEOUT_SECONDS =

seconds

30.0
DEFAULT_KEY_TTL_SECONDS =

Expiry applied to every Redis key the coordinator writes, refreshed on every write, so a finished run's bookkeeping does not live in the coordinator forever.

86_400
DEFAULT_STALL_TIMEOUT_SECONDS =

24 hours

300.0
DEFAULT_COMPLETION_GRACE_SECONDS =

5 minutes

30.0
MIN_COMPLETION_GRACE_TTL_MARGIN_SECONDS = 
1.0

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.from_command_line_options(opts, options) ⇒ Object 



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
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
 
# File 'lib/minitest/distributed/configuration.rb', line 44

def from_command_line_options(opts, options)
  configuration = from_env
  configuration.progress = options[:io].tty?

  opts.on("--coordinator=URI", "The URI pointing to the coordinator") do |uri|
    configuration.coordinator_uri = URI.parse(uri)
  end

  opts.on("--test-timeout=TIMEOUT", "The maximum run time for a single test in seconds") do |timeout|
    configuration.test_timeout_seconds = Float(timeout)
  end

  opts.on("--max-attempts=ATTEMPTS", "The maximum number of attempts to run a test") do |attempts|
    configuration.max_attempts = Integer(attempts)
  end

  opts.on("--test-batch-size=NUMBER", "The number of tests to process per batch") do |batch_size|
    configuration.test_batch_size = Integer(batch_size)
  end

  opts.on("--max-failures=FAILURES", "The maximum allowed failure before aborting a run") do |failures|
    configuration.max_failures = Integer(failures)
  end

  opts.on("--run-id=ID", "The ID for this run shared between coordinated workers") do |id|
    configuration.run_id = id
  end

  opts.on("--worker-id=ID", "The unique ID for this worker") do |id|
    configuration.worker_id = id
  end

  opts.on(
    "--[no-]retry-failures", "Retry failed and errored tests from a previous run attempt " \
      "with the same run ID (default: enabled)"
  ) do |enabled|
    configuration.retry_failures = enabled
  end

  opts.on("--[no-]progress", "Show progress during the test run") do |enabled|
    configuration.progress = enabled
  end

  opts.on("--exclude-file=FILE_PATH", "Specify a file of tests to be excluded from running") do |file_path|
    configuration.exclude_file = file_path
  end

  opts.on("--include-file=FILE_PATH", "Specify a file of tests to be included in the test run") do |file_path|
    configuration.include_file = file_path
  end

  opts.on("--[no-]shuffle-suites", "Shuffle test suites as well") do |enabled|
    configuration.shuffle_suites = enabled
  end

  opts.on("--key-ttl=SECONDS", "Expiry for the coordinator's Redis keys, refreshed on every write") do |ttl|
    configuration.key_ttl_seconds = Integer(ttl)
  end

  opts.on("--stall-timeout=SECONDS", "Abort a drained Redis queue that has stopped making progress") do |timeout|
    configuration.stall_timeout_seconds = Float(timeout)
  end

  opts.on("--completion-grace=SECONDS", "Wait before reusing a recently completed run ID") do |grace|
    configuration.completion_grace_seconds = Float(grace)
  end

  configuration
end

.from_env(env = ENV.to_h) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/minitest/distributed/configuration.rb', line 26

def from_env(env = ENV.to_h)
  new(
    coordinator_uri: URI(env["MINITEST_COORDINATOR"] || "memory:"),
    run_id: env["MINITEST_RUN_ID"] || SecureRandom.uuid,
    worker_id: env["MINITEST_WORKER_ID"] || SecureRandom.uuid,
    test_timeout_seconds: Float(env["MINITEST_TEST_TIMEOUT_SECONDS"] || DEFAULT_TEST_TIMEOUT_SECONDS),
    test_batch_size: Integer(env["MINITEST_TEST_BATCH_SIZE"] || DEFAULT_BATCH_SIZE),
    max_attempts: Integer(env["MINITEST_MAX_ATTEMPTS"] || DEFAULT_MAX_ATTEMPTS),
    max_failures: (max_failures_env = env["MINITEST_MAX_FAILURES"]) ? Integer(max_failures_env) : nil,
    key_ttl_seconds: Integer(env["MINITEST_KEY_TTL_SECONDS"] || DEFAULT_KEY_TTL_SECONDS),
    stall_timeout_seconds: Float(env["MINITEST_STALL_TIMEOUT_SECONDS"] || DEFAULT_STALL_TIMEOUT_SECONDS),
    completion_grace_seconds: Float(
      env["MINITEST_COMPLETION_GRACE_SECONDS"] || DEFAULT_COMPLETION_GRACE_SECONDS,
    ),
  )
end

Instance Method Details

#coordinator ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/minitest/distributed/configuration.rb', line 135

def coordinator
  validate!
  @coordinator ||= T.let(
    case coordinator_uri.scheme
    when "redis"
      Coordinators::RedisCoordinator.new(configuration: self)
    when "memory"
      Coordinators::MemoryCoordinator.new(configuration: self)
    else
      raise NotImplementedError, "Unknown coordinator implementation: #{coordinator_uri.scheme}"
    end,
    T.nilable(Coordinators::CoordinatorInterface),
  )
end

#validate! ⇒ Object

Raises:

  • (ArgumentError) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/minitest/distributed/configuration.rb', line 151

def validate!
  raise ArgumentError, "key_ttl_seconds must be greater than zero" unless key_ttl_seconds.positive?

  unless stall_timeout_seconds.positive? && stall_timeout_seconds.finite?
    raise ArgumentError, "stall_timeout_seconds must be finite and greater than zero"
  end

  unless completion_grace_seconds.positive? && completion_grace_seconds.finite?
    raise ArgumentError, "completion_grace_seconds must be finite and greater than zero"
  end

  if key_ttl_seconds < completion_grace_seconds + MIN_COMPLETION_GRACE_TTL_MARGIN_SECONDS
    raise ArgumentError, "key_ttl_seconds must exceed completion_grace_seconds by at least one second"
  end
end