Merge pull request #561 from puppetlabs/update_redis

(RE-15162) Update Redis gem to version 5.0.

Author: yachub

Gemfile.lock

@@ -3,7 +3,7 @@ PATH
   specs:
     vmpooler (3.2.0)
       concurrent-ruby (~> 1.1)
-      connection_pool (~> 2.2)
+      connection_pool (~> 2.4)
       deep_merge (~> 1.2)
       net-ldap (~> 0.16)
       opentelemetry-exporter-jaeger (= 0.23.0)
@@ -18,7 +18,7 @@ PATH
       puma (>= 5.0.4, < 7)
       rack (>= 2.2, < 4.0)
       rake (~> 13.0)
-      redis (~> 4.1)
+      redis (~> 5.0)
       sinatra (>= 2, < 4)
       spicy-proton (~> 2.1)
       statsd-ruby (~> 1.4)
@@ -124,7 +124,10 @@ GEM
       rack (>= 1.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.8.1)
+    redis (5.0.7)
+      redis-client (>= 0.9.0)
+    redis-client (0.15.0)
+      connection_pool
     regexp_parser (2.8.1)
     rexml (3.2.6)
     rspec (3.12.0)

lib/vmpooler.rb

@@ -103,7 +103,7 @@ def self.config(filepath = 'vmpooler.yaml')
     parsed_config[:redis]['data_ttl']                = string_to_int(ENV['REDIS_DATA_TTL']) || parsed_config[:redis]['data_ttl'] || 168
     parsed_config[:redis]['connection_pool_size']    = string_to_int(ENV['REDIS_CONNECTION_POOL_SIZE']) || parsed_config[:redis]['connection_pool_size'] || 10
     parsed_config[:redis]['connection_pool_timeout'] = string_to_int(ENV['REDIS_CONNECTION_POOL_TIMEOUT']) || parsed_config[:redis]['connection_pool_timeout'] || 5
-    parsed_config[:redis]['reconnect_attempts']      = string_to_int(ENV['REDIS_RECONNECT_ATTEMPTS']) || parsed_config[:redis]['reconnect_attempts'] || 10
+    parsed_config[:redis]['reconnect_attempts']      = string_array_to_array(ENV['REDIS_RECONNECT_ATTEMPTS']) || parsed_config[:redis]['reconnect_attempts'] || 10
 
     parsed_config[:statsd]           = parsed_config[:statsd] || {} if ENV['STATSD_SERVER']
     parsed_config[:statsd]['server'] = ENV['STATSD_SERVER'] if ENV['STATSD_SERVER']
@@ -209,8 +209,13 @@ def self.redis_connection_pool(host, port, password, size, timeout, metrics, red
   end
 
   def self.new_redis(host = 'localhost', port = nil, password = nil, redis_reconnect_attempts = 10)
-    Redis.new(host: host, port: port, password: password, reconnect_attempts: redis_reconnect_attempts, reconnect_delay: 1.5,
-              reconnect_delay_max: 10.0)
+    Redis.new(
+      host: host,
+      port: port,
+      password: password,
+      reconnect_attempts: redis_reconnect_attempts,
+      connect_timeout: 300
+    )
   end
 
   def self.pools(conf)
@@ -235,6 +240,13 @@ def self.string_to_int(s)
     Integer(s)
   end
 
+  def self.string_array_to_array(s)
+    # Returns an array from an array like string
+    return if s.nil?
+
+    JSON.parse(s)
+  end
+
   def self.true?(obj)
     obj.to_s.downcase == 'true'
   end

lib/vmpooler/api/helpers.rb

@@ -25,7 +25,7 @@ def valid_token?(backend)
       def validate_token(backend)
         tracer.in_span("Vmpooler::API::Helpers.#{__method__}") do
           if valid_token?(backend)
-            backend.hset("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'last', Time.now)
+            backend.hset("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'last', Time.now.to_s)
 
             return true
           end

lib/vmpooler/api/v3.rb

@@ -189,8 +189,8 @@ def account_for_starting_vm(template, vm)
           span.set_attribute('enduser.id', user)
           has_token_result = has_token?
           backend.sadd("vmpooler__migrating__#{template}", vm)
-          backend.hset("vmpooler__active__#{template}", vm, Time.now)
-          backend.hset("vmpooler__vm__#{vm}", 'checkout', Time.now)
+          backend.hset("vmpooler__active__#{template}", vm, Time.now.to_s)
+          backend.hset("vmpooler__vm__#{vm}", 'checkout', Time.now.to_s)
 
           if Vmpooler::API.settings.config[:auth] and has_token_result
             backend.hset("vmpooler__vm__#{vm}", 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
@@ -971,7 +971,7 @@ def generate_request_id
           result['token'] = o[rand(25)] + (0...31).map { o[rand(o.length)] }.join
 
           backend.hset("vmpooler__token__#{result['token']}", 'user', @auth.username)
-          backend.hset("vmpooler__token__#{result['token']}", 'created', Time.now)
+          backend.hset("vmpooler__token__#{result['token']}", 'created', Time.now.to_s)
           span = OpenTelemetry::Trace.current_span
           span.set_attribute('enduser.id', @auth.username)
 

lib/vmpooler/pool_manager.rb

@@ -59,7 +59,7 @@ def load_pools_to_redis
         currently_configured_pools = []
         config[:pools].each do |pool|
           currently_configured_pools << pool['name']
-          redis.sadd('vmpooler__pools', pool['name'])
+          redis.sadd('vmpooler__pools', pool['name'].to_s)
           pool_keys = pool.keys
           pool_keys.delete('alias')
           to_set = {}
@@ -68,11 +68,12 @@ def load_pools_to_redis
           end
           to_set['alias'] = pool['alias'].join(',') if to_set.key?('alias')
           to_set['domain'] = Vmpooler::Dns.get_domain_for_pool(config, pool['name'])
-          redis.hmset("vmpooler__pool__#{pool['name']}", to_set.to_a.flatten) unless to_set.empty?
+
+          redis.hmset("vmpooler__pool__#{pool['name']}", *to_set.to_a.flatten) unless to_set.empty?
         end
         previously_configured_pools.each do |pool|
           unless currently_configured_pools.include? pool
-            redis.srem('vmpooler__pools', pool)
+            redis.srem('vmpooler__pools', pool.to_s)
             redis.del("vmpooler__pool__#{pool}")
           end
         end
@@ -129,7 +130,6 @@ def fail_pending_vm(vm, pool, timeout, redis, exists: true)
         if exists
           request_id = redis.hget("vmpooler__vm__#{vm}", 'request_id')
           pool_alias = redis.hget("vmpooler__vm__#{vm}", 'pool_alias') if request_id
-          redis.multi
           redis.smove("vmpooler__pending__#{pool}", "vmpooler__completed__#{pool}", vm)
           if request_id
             ondemandrequest_hash = redis.hgetall("vmpooler__odrequest__#{request_id}")
@@ -138,7 +138,6 @@ def fail_pending_vm(vm, pool, timeout, redis, exists: true)
               redis.zadd('vmpooler__odcreate__task', 1, "#{pool_alias}:#{pool}:1:#{request_id}")
             end
           end
-          redis.exec
           $metrics.increment("errors.markedasfailed.#{pool}")
           $logger.log('d', "[!] [#{pool}] '#{vm}' marked as 'failed' after #{timeout} minutes")
         else
@@ -168,8 +167,8 @@ def move_pending_vm_to_ready(vm, pool, redis, request_id = nil)
         pool_alias = redis.hget("vmpooler__vm__#{vm}", 'pool_alias')
 
         redis.pipelined do |pipeline|
-          pipeline.hset("vmpooler__active__#{pool}", vm, Time.now)
-          pipeline.hset("vmpooler__vm__#{vm}", 'checkout', Time.now)
+          pipeline.hset("vmpooler__active__#{pool}", vm, Time.now.to_s)
+          pipeline.hset("vmpooler__vm__#{vm}", 'checkout', Time.now.to_s)
           if ondemandrequest_hash['token:token']
             pipeline.hset("vmpooler__vm__#{vm}", 'token:token', ondemandrequest_hash['token:token'])
             pipeline.hset("vmpooler__vm__#{vm}", 'token:user', ondemandrequest_hash['token:user'])
@@ -185,10 +184,10 @@ def move_pending_vm_to_ready(vm, pool, redis, request_id = nil)
 
       redis.pipelined do |pipeline|
         pipeline.hset("vmpooler__boot__#{Date.today}", "#{pool}:#{vm}", finish) # maybe remove as this is never used by vmpooler itself?
-        pipeline.hset("vmpooler__vm__#{vm}", 'ready', Time.now)
+        pipeline.hset("vmpooler__vm__#{vm}", 'ready', Time.now.to_s)
 
         # last boot time is displayed in API, and used by alarming script
-        pipeline.hset('vmpooler__lastboot', pool, Time.now)
+        pipeline.hset('vmpooler__lastboot', pool, Time.now.to_s)
       end
 
       $metrics.timing("time_to_ready_state.#{pool}", finish)
@@ -227,7 +226,7 @@ def _check_ready_vm(vm, pool_name, ttl, provider)
           last_checked_too_soon = ((Time.now - Time.parse(check_stamp)).to_i < $config[:config]['vm_checktime'] * 60) if check_stamp
           break if check_stamp && last_checked_too_soon
 
-          redis.hset("vmpooler__vm__#{vm}", 'check', Time.now)
+          redis.hset("vmpooler__vm__#{vm}", 'check', Time.now.to_s)
           # Check if the hosts TTL has expired
           # if 'boottime' is nil, set bootime to beginning of unix epoch, forces TTL to be assumed expired
           boottime = redis.hget("vmpooler__vm__#{vm}", 'ready')
@@ -428,16 +427,15 @@ def _clone_vm(pool_name, provider, dns_plugin, request_id = nil, pool_alias = ni
       mutex = vm_mutex(new_vmname)
       mutex.synchronize do
         @redis.with_metrics do |redis|
-          # Add VM to Redis inventory ('pending' pool)
-          redis.multi
-          redis.sadd("vmpooler__pending__#{pool_name}", new_vmname)
-          redis.hset("vmpooler__vm__#{new_vmname}", 'clone', Time.now)
-          redis.hset("vmpooler__vm__#{new_vmname}", 'template', pool_name) # This value is used to represent the pool.
-          redis.hset("vmpooler__vm__#{new_vmname}", 'pool', pool_name)
-          redis.hset("vmpooler__vm__#{new_vmname}", 'domain', pool_domain)
-          redis.hset("vmpooler__vm__#{new_vmname}", 'request_id', request_id) if request_id
-          redis.hset("vmpooler__vm__#{new_vmname}", 'pool_alias', pool_alias) if pool_alias
-          redis.exec
+          redis.multi do |transaction|
+            transaction.sadd("vmpooler__pending__#{pool_name}", new_vmname)
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'clone', Time.now.to_s)
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'template', pool_name) # This value is used to represent the pool.
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'pool', pool_name)
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'domain', pool_domain)
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'request_id', request_id) if request_id
+            transaction.hset("vmpooler__vm__#{new_vmname}", 'pool_alias', pool_alias) if pool_alias
+          end
         end
 
         begin
@@ -502,7 +500,7 @@ def _destroy_vm(vm, pool, provider, dns_plugin)
         @redis.with_metrics do |redis|
           redis.pipelined do |pipeline|
             pipeline.hdel("vmpooler__active__#{pool}", vm)
-            pipeline.hset("vmpooler__vm__#{vm}", 'destroy', Time.now)
+            pipeline.hset("vmpooler__vm__#{vm}", 'destroy', Time.now.to_s)
 
             # Auto-expire metadata key
             pipeline.expire("vmpooler__vm__#{vm}", ($config[:redis]['data_ttl'].to_i * 60 * 60))
@@ -868,12 +866,13 @@ def time_passed?(_event, time)
     def sleep_with_wakeup_events(loop_delay, wakeup_period = 5, options = {})
       exit_by = Time.now + loop_delay
       wakeup_by = Time.now + wakeup_period
+
       return if time_passed?(:exit_by, exit_by)
 
       @redis.with_metrics do |redis|
         initial_ready_size = redis.scard("vmpooler__ready__#{options[:poolname]}") if options[:pool_size_change]
 
-        initial_clone_target = redis.hget("vmpooler__pool__#{options[:poolname]}", options[:clone_target]) if options[:clone_target_change]
+        initial_clone_target = redis.hget("vmpooler__pool__#{options[:poolname]}", options[:clone_target].to_s) if options[:clone_target_change]
 
         initial_template = redis.hget('vmpooler__template__prepared', options[:poolname]) if options[:pool_template_change]
 
@@ -917,11 +916,10 @@ def sleep_with_wakeup_events(loop_delay, wakeup_period = 5, options = {})
             end
 
             if options[:ondemand_request]
-              redis.multi
-              redis.zcard('vmpooler__provisioning__request')
-              redis.zcard('vmpooler__provisioning__processing')
-              redis.zcard('vmpooler__odcreate__task')
-              od_request, od_processing, od_createtask = redis.exec
+              od_request = redis.zcard('vmpooler__provisioning__request')
+              od_processing = redis.zcard('vmpooler__provisioning__processing')
+              od_createtask = redis.zcard('vmpooler__odcreate__task')
+
               break unless od_request == 0
               break unless od_processing == 0
               break unless od_createtask == 0
@@ -1093,10 +1091,8 @@ def update_clone_target(pool)
 
     def remove_excess_vms(pool)
       @redis.with_metrics do |redis|
-        redis.multi
-        redis.scard("vmpooler__ready__#{pool['name']}")
-        redis.scard("vmpooler__pending__#{pool['name']}")
-        ready, pending = redis.exec
+        ready = redis.scard("vmpooler__ready__#{pool['name']}")
+        pending = redis.scard("vmpooler__pending__#{pool['name']}")
         total = pending.to_i + ready.to_i
         break if total.nil?
         break if total == 0
@@ -1334,11 +1330,10 @@ def repopulate_pool_vms(pool_name, provider, pool_check_response, pool_size)
       return if pool_mutex(pool_name).locked?
 
       @redis.with_metrics do |redis|
-        redis.multi
-        redis.scard("vmpooler__ready__#{pool_name}")
-        redis.scard("vmpooler__pending__#{pool_name}")
-        redis.scard("vmpooler__running__#{pool_name}")
-        ready, pending, running = redis.exec
+        ready = redis.scard("vmpooler__ready__#{pool_name}")
+        pending = redis.scard("vmpooler__pending__#{pool_name}")
+        running = redis.scard("vmpooler__running__#{pool_name}")
+
         total = pending.to_i + ready.to_i
 
         $metrics.gauge("ready.#{pool_name}", ready)
@@ -1596,11 +1591,9 @@ def check_ondemand_request_ready(request_id, redis, score = nil)
 
       return unless vms_ready?(request_id, redis)
 
-      redis.multi
       redis.hset(ondemand_hash_key, 'status', 'ready')
       redis.expire(ondemand_hash_key, default_expiration)
       redis.zrem(processing_key, request_id)
-      redis.exec
     end
 
     def request_expired?(request_id, score, redis)

spec/unit/pool_manager_spec.rb

@@ -3594,8 +3594,9 @@
       it 'should sleep until the provisioning request is detected' do
         redis_connection_pool.with do |redis|
           expect(subject).to receive(:sleep).exactly(3).times
-          expect(redis).to receive(:multi).and_return('OK').exactly(3).times
-          expect(redis).to receive(:exec).and_return([0,0,0],[0,0,0],[1,0,0])
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__request').and_return(0,0,1)
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__processing').and_return(0,0,0)
+          expect(redis).to receive(:zcard).with('vmpooler__odcreate__task').and_return(0,0,0)
         end
 
         subject.sleep_with_wakeup_events(loop_delay, wakeup_period, wakeup_option)
@@ -3604,17 +3605,20 @@
       it 'should sleep until provisioning processing is detected' do
         redis_connection_pool.with do |redis|
           expect(subject).to receive(:sleep).exactly(3).times
-          expect(redis).to receive(:multi).and_return('OK').exactly(3).times
-          expect(redis).to receive(:exec).and_return([0,0,0],[0,0,0],[0,1,0])
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__request').and_return(0,0,0)
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__processing').and_return(0,0,1)
+          expect(redis).to receive(:zcard).with('vmpooler__odcreate__task').and_return(0,0,0)
         end
+
         subject.sleep_with_wakeup_events(loop_delay, wakeup_period, wakeup_option)
       end
 
       it 'should sleep until ondemand creation task is detected' do
         redis_connection_pool.with do |redis|
           expect(subject).to receive(:sleep).exactly(3).times
-          expect(redis).to receive(:multi).and_return('OK').exactly(3).times
-          expect(redis).to receive(:exec).and_return([0,0,0],[0,0,0],[0,0,1])
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__request').and_return(0,0,0)
+          expect(redis).to receive(:zcard).with('vmpooler__provisioning__processing').and_return(0,0,0)
+          expect(redis).to receive(:zcard).with('vmpooler__odcreate__task').and_return(0,0,1)
         end
 
         subject.sleep_with_wakeup_events(loop_delay, wakeup_period, wakeup_option)

vmpooler.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = 'vmpooler'
   s.require_paths = ["lib"]
   s.add_dependency 'concurrent-ruby', '~> 1.1'
-  s.add_dependency 'connection_pool', '~> 2.2'
+  s.add_dependency 'connection_pool', '~> 2.4'
   s.add_dependency 'deep_merge', '~> 1.2'
   s.add_dependency 'net-ldap', '~> 0.16'
   s.add_dependency 'opentelemetry-exporter-jaeger', '= 0.23.0'
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'puma', '>= 5.0.4', '< 7'
   s.add_dependency 'rack', '>= 2.2', '< 4.0'
   s.add_dependency 'rake', '~> 13.0'
-  s.add_dependency 'redis', '~> 4.1'
+  s.add_dependency 'redis', '~> 5.0'
   s.add_dependency 'sinatra', '>= 2', '< 4'
   s.add_dependency 'spicy-proton', '~> 2.1'
   s.add_dependency 'statsd-ruby', '~> 1.4'