ci-queue 0.21.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb09b44ca70cde6218873faed3b7067295088a115b2b33ddc93b3853ad318042
-  data.tar.gz: d0eb4a637fb89aa8c2858e5f1c363b86518cb310729d417fc6e7847c7bd261b8
+  metadata.gz: 652049f77362ba8fa3fd01b79a0260c5ff17ba678751ee2424de463afe035d38
+  data.tar.gz: 745b2c493350d2315a10f36147d5d3b4cc74df74d5f38e82d2250f10be219d4a
 SHA512:
-  metadata.gz: e3b35848df951df70cddc2bab778f5160dc0293f09cc66218b31567ce8b2fe7e7a020f5aeec9fb2b6890e53a175b70ada164b404306ee5582cc1a40601515643
-  data.tar.gz: 8f5ffdaaad075ddcc724117f3b2414f7a15b49509d0b0df5b4415827b6452efc251974398a58b2203c776fdb70819ab53c8042ce4d3add056b245ff8cafed179
+  metadata.gz: d47070eca76cfd6191cc003191af153ba2b40596dca4c3408325389a110ae1b798e99dcdb7e27b33c23d5bf457d6eab003dd608602a5df9de38741408d7bb48a
+  data.tar.gz: 0d2f4f69af4fc3714dbd6d5660d0e3106890a7bd5cef5782bae41847aa1552b35a8c9af6e77b7d8d18264b2100463062cb205f7ed45cef7646aeb2ff4ffe3bd3

data/README.md

@@ -70,3 +70,9 @@ rspec-queue --queue redis://example.com --timeout 600 --report
 #### Limitations
 
 Because of how `ci-queue` executes the examples, `before(:all)` and `after(:all)` hooks are not supported. `rspec-queue` will explicitly reject them.
+
+## Custom Redis Expiry
+
+`ci-queue` expects the Redis server to have an [eviction policy](https://redis.io/docs/manual/eviction/#eviction-policies) of `allkeys-lru`.
+
+You can also use `--redis-ttl` to set a custom expiration time for all CI Queue keys, this defaults to 8 hours (28,800 seconds)

data/ci-queue.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest', ENV.fetch('MINITEST_VERSION', '~> 5.11')
-  spec.add_development_dependency 'rspec', '~> 3.7.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'redis'
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'

data/lib/ci/queue/bisect.rb

@@ -31,6 +31,10 @@ module CI
         Static.new(first_half + [config.failing_test], config).populate(@all_tests)
       end
 
+      def release!
+        # noop
+      end
+
       def failed!
         @tests = first_half
       end

data/lib/ci/queue/common.rb

@@ -11,6 +11,10 @@ module CI
         false
       end
 
+      def release!
+        # noop
+      end
+
       def flaky?(test)
         @config.flaky?(test)
       end

data/lib/ci/queue/configuration.rb

@@ -5,7 +5,7 @@ module CI
       attr_accessor :timeout, :worker_id, :max_requeues, :grind_count, :failure_file
       attr_accessor :requeue_tolerance, :namespace, :failing_test, :statsd_endpoint
       attr_accessor :max_test_duration, :max_test_duration_percentile, :track_test_duration
-      attr_accessor :max_test_failed
+      attr_accessor :max_test_failed, :redis_ttl
       attr_reader :circuit_breakers
       attr_writer :seed, :build_id
       attr_writer :queue_init_timeout
@@ -18,6 +18,7 @@ module CI
             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,
           )
         end
 
@@ -34,7 +35,7 @@ module CI
         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
+        queue_init_timeout: nil, redis_ttl: 8 * 60 * 60
       )
         @build_id = build_id
         @circuit_breakers = [CircuitBreaker::Disabled]
@@ -55,6 +56,7 @@ module CI
         @worker_id = worker_id
         self.max_consecutive_failures = max_consecutive_failures
         self.max_duration = max_duration
+        @redis_ttl = redis_ttl
       end
 
       def queue_init_timeout

data/lib/ci/queue/redis/acknowledge.lua

@@ -1,8 +1,10 @@
 -- AUTOGENERATED FILE DO NOT EDIT DIRECTLY
 local zset_key = KEYS[1]
 local processed_key = KEYS[2]
+local owners_key = KEYS[3]
 
 local test = ARGV[1]
 
 redis.call('zrem', zset_key, test)
+redis.call('hdel', owners_key, test)  -- Doesn't matter if it was reclaimed by another workers
 return redis.call('sadd', processed_key, test)

data/lib/ci/queue/redis/base.rb

@@ -21,16 +21,16 @@ module CI
         end
 
         def size
-          redis.multi do
-            redis.llen(key('queue'))
-            redis.zcard(key('running'))
+          redis.multi do |transaction|
+            transaction.llen(key('queue'))
+            transaction.zcard(key('running'))
           end.inject(:+)
         end
 
         def to_a
-          redis.multi do
-            redis.lrange(key('queue'), 0, -1)
-            redis.zrange(key('running'), 0, -1)
+          redis.multi do |transaction|
+            transaction.lrange(key('queue'), 0, -1)
+            transaction.zrange(key('running'), 0, -1)
           end.flatten.reverse.map { |k| index.fetch(k) }
         end
 

data/lib/ci/queue/redis/build_record.rb

@@ -22,9 +22,9 @@ module CI
         end
 
         def pop_warnings
-          warnings = redis.multi do
-            redis.lrange(key('warnings'), 0, -1)
-            redis.del(key('warnings'))
+          warnings = redis.multi do |transaction|
+            transaction.lrange(key('warnings'), 0, -1)
+            transaction.del(key('warnings'))
           end.first
 
           warnings.map { |p| Marshal.load(p) }
@@ -35,21 +35,22 @@ module CI
         end
 
         def record_error(id, payload, stats: nil)
-          redis.pipelined do
-            redis.hset(
+          redis.pipelined do |pipeline|
+            pipeline.hset(
               key('error-reports'),
               id.dup.force_encoding(Encoding::BINARY),
               payload.dup.force_encoding(Encoding::BINARY),
             )
-            record_stats(stats)
+            pipeline.expire(key('error-reports'), config.redis_ttl)
+            record_stats(stats, pipeline: pipeline)
           end
           nil
         end
 
         def record_success(id, stats: nil)
-          redis.pipelined do
-            redis.hdel(key('error-reports'), id.dup.force_encoding(Encoding::BINARY))
-            record_stats(stats)
+          redis.pipelined do |pipeline|
+            pipeline.hdel(key('error-reports'), id.dup.force_encoding(Encoding::BINARY))
+            record_stats(stats, pipeline: pipeline)
           end
           nil
         end
@@ -65,8 +66,8 @@ module CI
         end
 
         def fetch_stats(stat_names)
-          counts = redis.pipelined do
-            stat_names.each { |c| redis.hvals(key(c)) }
+          counts = redis.pipelined do |pipeline|
+            stat_names.each { |c| pipeline.hvals(key(c)) }
           end
           sum_counts = counts.map do |values|
             values.map(&:to_f).inject(:+).to_f
@@ -75,9 +76,9 @@ module CI
         end
 
         def reset_stats(stat_names)
-          redis.pipelined do
+          redis.pipelined do |pipeline|
             stat_names.each do |stat_name|
-              redis.hdel(key(stat_name), config.worker_id)
+              pipeline.hdel(key(stat_name), config.worker_id)
             end
           end
         end
@@ -86,10 +87,11 @@ module CI
 
         attr_reader :config, :redis
 
-        def record_stats(stats)
+        def record_stats(stats, pipeline: redis)
           return unless stats
           stats.each do |stat_name, stat_value|
-            redis.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.expire(key(stat_name), config.redis_ttl)
           end
         end
 

data/lib/ci/queue/redis/grind_record.rb

@@ -11,12 +11,13 @@ module CI
         end
 
         def record_error(payload, stats: nil)
-          redis.pipelined do
-            redis.lpush(
+          redis.pipelined do |pipeline|
+            pipeline.lpush(
               key('error-reports'),
               payload.force_encoding(Encoding::BINARY),
             )
-            record_stats(stats)
+            pipeline.expire(key('error-reports'), config.redis_ttl)
+            record_stats(stats, pipeline: pipeline)
           end
           nil
         end
@@ -34,8 +35,8 @@ module CI
         end
 
         def fetch_stats(stat_names)
-          counts = redis.pipelined do
-            stat_names.each { |c| redis.hvals(key(c)) }
+          counts = redis.pipelined do |pipeline|
+            stat_names.each { |c| pipeline.hvals(key(c)) }
           end
           stat_names.zip(counts.map { |values| values.map(&:to_f).inject(:+).to_f }).to_h
         end
@@ -54,10 +55,11 @@ module CI
           ['build', config.build_id, *args].join(':')
         end
 
-        def record_stats(stats)
+        def record_stats(stats, pipeline: redis)
           return unless stats
           stats.each do |stat_name, stat_value|
-            redis.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.hset(key(stat_name), config.worker_id, stat_value)
+            pipeline.expire(key(stat_name), config.redis_ttl)
           end
         end
       end

data/lib/ci/queue/redis/release.lua

@@ -0,0 +1,16 @@
+-- AUTOGENERATED FILE DO NOT EDIT DIRECTLY
+local zset_key = KEYS[1]
+local worker_queue_key = KEYS[2]
+local owners_key = KEYS[3]
+
+-- owned_tests = {"SomeTest", "worker:1", "SomeOtherTest", "worker:2", ...}
+local owned_tests = redis.call('hgetall', owners_key)
+for index, owner_or_test in ipairs(owned_tests) do
+  if owner_or_test == worker_queue_key then -- If we owned a test
+    local test = owned_tests[index - 1]
+    redis.call('zadd', zset_key, "0", test) -- We expire the lease immediately
+    return nil
+  end
+end
+
+return nil

data/lib/ci/queue/redis/requeue.lua

@@ -3,12 +3,18 @@ local processed_key = KEYS[1]
 local requeues_count_key = KEYS[2]
 local queue_key = KEYS[3]
 local zset_key = KEYS[4]
+local worker_queue_key = KEYS[5]
+local owners_key = KEYS[6]
 
 local max_requeues = tonumber(ARGV[1])
 local global_max_requeues = tonumber(ARGV[2])
 local test = ARGV[3]
 local offset = ARGV[4]
 
+if redis.call('hget', owners_key, test) == worker_queue_key then
+   redis.call('hdel', owners_key, test)
+end
+
 if redis.call('sismember', processed_key, test) == 1 then
   return false
 end

data/lib/ci/queue/redis/reserve.lua

@@ -3,6 +3,7 @@ local queue_key = KEYS[1]
 local zset_key = KEYS[2]
 local processed_key = KEYS[3]
 local worker_queue_key = KEYS[4]
+local owners_key = KEYS[5]
 
 local current_time = ARGV[1]
 
@@ -10,6 +11,7 @@ local test = redis.call('rpop', queue_key)
 if test then
   redis.call('zadd', zset_key, current_time, test)
   redis.call('lpush', worker_queue_key, test)
+  redis.call('hset', owners_key, test, worker_queue_key)
   return test
 else
   return nil

data/lib/ci/queue/redis/reserve_lost.lua

@@ -2,6 +2,7 @@
 local zset_key = KEYS[1]
 local processed_key = KEYS[2]
 local worker_queue_key = KEYS[3]
+local owners_key = KEYS[4]
 
 local current_time = ARGV[1]
 local timeout = ARGV[2]
@@ -11,6 +12,7 @@ for _, test in ipairs(lost_tests) do
   if redis.call('sismember', processed_key, test) == 0 then
     redis.call('zadd', zset_key, current_time, test)
     redis.call('lpush', worker_queue_key, test)
+    redis.call('hset', owners_key, test, worker_queue_key) -- Take ownership
     return test
   end
 end

data/lib/ci/queue/redis/test_time_record.rb

@@ -19,38 +19,37 @@ module CI
         attr_reader :redis
 
         def record_test_time(test_name, duration)
-          redis.pipelined do
-            redis.lpush(
+          redis.pipelined do |pipeline|
+            pipeline.lpush(
               test_time_key(test_name),
               duration.to_s.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(test_time_key(test_name), config.redis_ttl)
           end
           nil
         end
 
         def record_test_name(test_name)
-          redis.pipelined do
-            redis.lpush(
+          redis.pipelined do |pipeline|
+            pipeline.lpush(
               all_test_names_key,
               test_name.dup.force_encoding(Encoding::BINARY),
             )
+            pipeline.expire(all_test_names_key, config.redis_ttl)
           end
           nil
         end
 
         def fetch_all_test_names
-          values = redis.pipelined do
-            redis.lrange(all_test_names_key, 0, -1)
+          values = redis.pipelined do |pipeline|
+            pipeline.lrange(all_test_names_key, 0, -1)
           end
           values.flatten.map(&:to_s)
         end
 
         def fetch_test_time(test_name)
-          values = redis.pipelined do
-            key = test_time_key(test_name)
-            redis.lrange(key, 0, -1)
-          end
-          values.flatten.map(&:to_f)
+          key = test_time_key(test_name)
+          redis.lrange(key, 0, -1).map(&:to_f)
         end
 
         def all_test_names_key

data/lib/ci/queue/redis/worker.rb

@@ -53,6 +53,10 @@ module CI
               sleep 0.05
             end
           end
+          redis.pipelined do |pipeline|
+            pipeline.expire(key('worker', worker_id, 'queue'), config.redis_ttl)
+            pipeline.expire(key('processed'), config.redis_ttl)
+          end
         rescue *CONNECTION_ERRORS
         end
 
@@ -92,7 +96,7 @@ module CI
           raise_on_mismatching_test(test_key)
           eval_script(
             :acknowledge,
-            keys: [key('running'), key('processed')],
+            keys: [key('running'), key('processed'), key('owners')],
             argv: [test_key],
           ) == 1
         end
@@ -104,7 +108,14 @@ module CI
 
           requeued = config.max_requeues > 0 && global_max_requeues > 0 && eval_script(
             :requeue,
-            keys: [key('processed'), key('requeues-count'), key('queue'), key('running')],
+            keys: [
+              key('processed'),
+              key('requeues-count'),
+              key('queue'),
+              key('running'),
+              key('worker', worker_id, 'queue'),
+              key('owners'),
+            ],
             argv: [config.max_requeues, global_max_requeues, test_key, offset],
           ) == 1
 
@@ -112,6 +123,15 @@ module CI
           requeued
         end
 
+        def release!
+          eval_script(
+            :release,
+            keys: [key('running'), key('worker', worker_id, 'queue'), key('owners')],
+            argv: [],
+          )
+          nil
+        end
+
         private
 
         attr_reader :index
@@ -144,7 +164,13 @@ module CI
         def try_to_reserve_test
           eval_script(
             :reserve,
-            keys: [key('queue'), key('running'), key('processed'), key('worker', worker_id, 'queue')],
+            keys: [
+              key('queue'),
+              key('running'),
+              key('processed'),
+              key('worker', worker_id, 'queue'),
+              key('owners'),
+            ],
             argv: [Time.now.to_f],
           )
         end
@@ -152,7 +178,12 @@ module CI
         def try_to_reserve_lost_test
           lost_test = eval_script(
             :reserve_lost,
-            keys: [key('running'), key('completed'), key('worker', worker_id, 'queue')],
+            keys: [
+              key('running'),
+              key('completed'),
+              key('worker', worker_id, 'queue'),
+              key('owners'),
+            ],
             argv: [Time.now.to_f, timeout],
           )
 
@@ -167,13 +198,18 @@ module CI
           @total = tests.size
 
           if @master = redis.setnx(key('master-status'), 'setup')
-            redis.multi do
-              redis.lpush(key('queue'), tests) unless tests.empty?
-              redis.set(key('total'), @total)
-              redis.set(key('master-status'), 'ready')
+            redis.multi do |transaction|
+              transaction.lpush(key('queue'), tests) unless tests.empty?
+              transaction.set(key('total'), @total)
+              transaction.set(key('master-status'), 'ready')
+
+              transaction.expire(key('queue'), config.redis_ttl)
+              transaction.expire(key('total'), config.redis_ttl)
+              transaction.expire(key('master-status'), config.redis_ttl)
             end
           end
           register
+          redis.expire(key('workers'), config.redis_ttl)
         rescue *CONNECTION_ERRORS
           raise if @master
         end

data/lib/ci/queue/version.rb

@@ -2,7 +2,7 @@
 
 module CI
   module Queue
-    VERSION = '0.21.1'
+    VERSION = '0.23.0'
     DEV_SCRIPTS_ROOT = ::File.expand_path('../../../../../redis', __FILE__)
     RELEASE_SCRIPTS_ROOT = ::File.expand_path('../redis', __FILE__)
   end

data/lib/minitest/queue/runner.rb

@@ -22,6 +22,9 @@ module Minitest
       def initialize(argv)
         @queue_config = CI::Queue::Configuration.from_env(ENV)
         @command, @argv = parse(argv)
+        if Minitest.respond_to?(:seed=)
+          Minitest.seed = @queue_config.seed.to_i
+        end
       end
 
       def run!
@@ -81,6 +84,10 @@ module Minitest
         # Let minitest's at_exit hook trigger
       end
 
+      def release_command
+        queue.release!
+      end
+
       def grind_command
         invalid_usage!('No list to grind provided') if grind_list.nil?
         invalid_usage!('No grind count provided') if grind_count.nil?
@@ -483,6 +490,14 @@ module Minitest
             end
           end
 
+          help = <<~EOS
+            Defines how long the test report remain after the test run, in seconds.
+            Defaults to 28,800 (8 hours)
+          EOS
+          opts.on("--redis-ttl SECONDS", Integer, help) do |time|
+            queue.config.redis_ttl = time
+          end
+
           opts.separator ""
           opts.separator "    retry: Replays a previous run in the same order."
 

data/lib/rspec/queue.rb

@@ -157,6 +157,15 @@ module RSpec
           queue_config.max_consecutive_failures = Integer(max)
         end
 
+        help = <<~EOS
+          Defines how long the test report remain after the test run, in seconds.
+          Defaults to 28,800 (8 hours)
+        EOS
+        parser.separator ""
+        parser.on("--redis-ttl SECONDS", Integer, help) do |time|
+          queue.config.redis_ttl = time
+        end
+
         parser
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci-queue
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,7 @@ files:
 - lib/ci/queue/redis/grind.rb
 - lib/ci/queue/redis/grind_record.rb
 - lib/ci/queue/redis/grind_supervisor.rb
+- lib/ci/queue/redis/release.lua
 - lib/ci/queue/redis/requeue.lua
 - lib/ci/queue/redis/reserve.lua
 - lib/ci/queue/redis/reserve_lost.lua
@@ -238,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Distribute tests over many workers using a queue