test: add benchmark test (#76)

Author: supercaracal

.github/workflows/test.yaml

@@ -189,3 +189,32 @@ jobs:
         run: bundle exec rake test_cluster_scale
       - name: Stop containers
         run: docker compose -f $DOCKER_COMPOSE_FILE down
+  benchmark:
+    name: Benchmark
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    env:
+      REDIS_VERSION: '7.0.1'
+      DOCKER_COMPOSE_FILE: 'docker-compose.yaml'
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Pull Docker images
+        run: docker pull redis:$REDIS_VERSION
+      - name: Run containers
+        run: docker compose -f $DOCKER_COMPOSE_FILE up -d
+      - name: Wait for Redis cluster to be ready
+        run: bundle exec rake wait
+      - name: Print containers
+        run: docker compose -f $DOCKER_COMPOSE_FILE ps
+      - name: Run minitest
+        run: bundle exec rake bench
+      - name: Stop containers
+        run: docker compose -f $DOCKER_COMPOSE_FILE down

Rakefile

@@ -26,6 +26,14 @@ SLUGGISH_TEST_TYPES.each do |type|
   end
 end
 
+Rake::TestTask.new(:bench) do |t|
+  t.libs << :lib
+  t.libs << :test
+  t.options = '-v'
+  t.warning = false
+  t.test_files = ARGV.size > 1 ? ARGV[1..] : Dir['test/**/bench_*.rb']
+end
+
 desc 'Wait for cluster to be ready'
 task :wait do
   $LOAD_PATH.unshift(File.expand_path('test', __dir__))

test/bench_command.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'benchmark_helper'
+
+class BenchCommand
+  module Mixin
+    def setup
+      @client = new_test_client
+      @client.call('FLUSHDB')
+      wait_for_replication
+    end
+
+    def teardown
+      @client.call('FLUSHDB')
+      wait_for_replication
+      @client&.close
+    end
+
+    def bench_ping
+      assert_performance_linear do |n|
+        n.times do
+          @client.call('PING')
+        end
+      end
+    end
+
+    def bench_set
+      assert_performance_linear do |n|
+        n.times do |i|
+          @client.call('SET', "key#{i}", i)
+        end
+      end
+    end
+
+    def bench_get
+      assert_performance_linear do |n|
+        n.times do |i|
+          @client.call('GET', "key#{i}")
+        end
+      end
+    end
+
+    def bench_pipeline_set
+      assert_performance_linear do |n|
+        n.times do |i|
+          @client.pipelined do |pi|
+            pi.call('SET', "key#{i}", i)
+          end
+        end
+      end
+    end
+
+    def bench_pipeline_get
+      assert_performance_linear do |n|
+        n.times do |i|
+          @client.pipelined do |pi|
+            pi.call('GET', "key#{i}")
+          end
+        end
+      end
+    end
+
+    private
+
+    def wait_for_replication
+      client_side_timeout = TEST_TIMEOUT_SEC + 1.0
+      server_side_timeout = (TEST_TIMEOUT_SEC * 1000).to_i
+      @client.blocking_call(client_side_timeout, 'WAIT', TEST_REPLICA_SIZE, server_side_timeout)
+    end
+  end
+
+  class PrimaryOnly < BenchmarkWrapper
+    include Mixin
+
+    private
+
+    def new_test_client
+      config = ::RedisClient::ClusterConfig.new(
+        nodes: TEST_NODE_URIS,
+        fixed_hostname: TEST_FIXED_HOSTNAME,
+        **TEST_GENERIC_OPTIONS
+      )
+      ::RedisClient::Cluster.new(config)
+    end
+  end
+
+  class ScaleRead < BenchmarkWrapper
+    include Mixin
+
+    private
+
+    def new_test_client
+      config = ::RedisClient::ClusterConfig.new(
+        nodes: TEST_NODE_URIS,
+        replica: true,
+        fixed_hostname: TEST_FIXED_HOSTNAME,
+        **TEST_GENERIC_OPTIONS
+      )
+      ::RedisClient::Cluster.new(config)
+    end
+  end
+
+  class Pooled < BenchmarkWrapper
+    include Mixin
+
+    private
+
+    def new_test_client
+      config = ::RedisClient::ClusterConfig.new(
+        nodes: TEST_NODE_URIS,
+        fixed_hostname: TEST_FIXED_HOSTNAME,
+        **TEST_GENERIC_OPTIONS
+      )
+      ::RedisClient::Cluster.new(config, pool: { timeout: TEST_TIMEOUT_SEC, size: 2 })
+    end
+  end
+end

test/benchmark_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# @see https://ruby-doc.org/stdlib-3.0.1/libdoc/minitest/rdoc/Minitest/Benchmark.html
+
+require 'minitest/benchmark'
+require 'minitest/autorun'
+require 'redis_client'
+require 'redis_cluster_client'
+require 'testing_constants'
+
+case ENV.fetch('REDIS_CONNECTION_DRIVER', 'ruby')
+when 'hiredis' then require 'hiredis-client'
+end
+
+class BenchmarkWrapper < Minitest::Benchmark; end