Prepare test (#10)

Author: supercaracal

.github/workflows/test.yaml

@@ -0,0 +1,56 @@
+---
+# @see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+name: Test
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+jobs:
+  lint:
+    name: Lint
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    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: Run rubocop
+        run: bundle exec rubocop
+  main:
+    name: Main
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest']
+        redis: ['6.2.7', '7.0.1']
+        ruby: ['3.1', '3.0', '2.7']
+    runs-on: ${{ matrix.os }}
+    env:
+      REDIS_VERSION: ${{ matrix.redis }}
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      # Services feature of GitHub Actions isn't fit for our purposes for testing.
+      # We cannot overwrite arguments of ENTRYPOINT.
+      # @see https://docs.docker.com/engine/reference/commandline/create/#options
+      - name: Pull Docker images
+        run: docker pull redis:$REDIS_VERSION
+      - name: Docker compose up
+        run: docker compose up -d
+      - name: Wait for Redis cluster to be ready
+        run: docker compose ps
+      - name: Run minitest
+        run: bundle exec rake test

README.md

@@ -1,10 +1,13 @@
 [![Gem Version](https://badge.fury.io/rb/redis-cluster-client.svg)](https://badge.fury.io/rb/redis-cluster-client)
+![Test status](https://github.com/redis-rb/redis-cluster-client/workflows/Test/badge.svg?branch=master)
 
-TODO
+Redis Cluster Client
 ===============================================================================
 
+TODO
+
 ```ruby
-cli = RedisClient.cluster(nodes: %w[redis://127.0.0.1:7000], replica: false).new_client
+cli = RedisClient.cluster(nodes: %w[redis://127.0.0.1:7000]).new_client
 
 cli.call('PING')
 #=> PONG

docker-compose.yaml

@@ -1,7 +1,7 @@
 ---
 services:
   node1: &node
-    image: "redis:7"
+    image: "redis:${REDIS_VERSION:-7}"
     command: >
       redis-server
       --maxmemory            64mb
@@ -38,7 +38,7 @@ services:
     ports:
       - "7005:6379"
   clustering:
-    image: "redis:7"
+    image: "redis:${REDIS_VERSION:-7}"
     command: >
       bash -c "apt-get update > /dev/null
       && apt-get install --no-install-recommends --no-install-suggests -y dnsutils > /dev/null

docs/CLASS_DIAGRAM.md renamed to docs/CLASS_DIAGRAMS.md

@@ -1,3 +1,5 @@
+# [RedisClient](https://github.com/redis-rb/redis-client)
+
 ```mermaid
 classDiagram
   class RedisClient {

docs/CLOUD_SERVICES.md

@@ -0,0 +1,51 @@
+# Architectures of Redis cluster with SSL/TLS as imagined
+
+## AWS
+The client can connect to the nodes directly.
+The endpoint is just a CNAME record of DNS.
+It is as simple as that.
+
+```mermaid
+graph TB
+  client(Cluster Client)
+
+  subgraph Amazon ElastiCache for Redis
+    node0(Node0)
+    node1(Node1)
+    node2(Node2)
+  end
+
+  node0-.-node1-.-node2-.-node0
+  client--rediss://node0.example.com:6379-->node0
+  client--rediss://node1.example.com:6379-->node1
+  client--rediss://node2.example.com:6379-->node2
+```
+
+## Microsoft Azure
+The service provides a single IP address and multiple ports mapped to each node.
+The endpoint doesn't support redirection.
+It does only SSL/TLS termination.
+
+```mermaid
+graph TB
+  client(Cluster Client)
+
+  subgraph Azure Cache for Redis
+    subgraph Endpoint
+      endpoint(Active)
+      endpoint_sb(Standby)
+    end
+
+    subgraph Cluster
+      node0(Node0)
+      node1(Node1)
+      node2(Node2)
+    end
+  end
+
+  endpoint-.-endpoint_sb
+  node0-.-node1-.-node2-.-node0
+  client--rediss://endpoint.example.com:15000-->endpoint--redis://node0:6379-->node0
+  client--rediss://endpoint.example.com:15001-->endpoint--redis://node1:6379-->node1
+  client--rediss://endpoint.example.com:15002-->endpoint--redis://node2:6379-->node2
+```

docs/SEQUENCE_DIAGRAMS.md

@@ -0,0 +1,24 @@
+# How does cluster client work?
+
+```mermaid
+sequenceDiagram
+    participant Client
+    participant Server Shard 1
+    participant Server Shard 2
+    participant Server Shard 3
+    Note over Client,Server Shard 3: Redis.new(cluster: %w[redis://node1:6379])
+    Client->>+Server Shard 1: CLUSTER SLOTS
+    Server Shard 1-->>-Client: nodes and slots data
+    Client->>+Server Shard 1: GET key1
+    Server Shard 1-->>-Client: value1
+    Client->>+Server Shard 2: GET key2
+    Server Shard 2-->>-Client: value2
+    Client->>+Server Shard 3: GET key3
+    Server Shard 3-->>-Client: value3
+    Client->>+Server Shard 3: GET key1
+    Server Shard 3-->>-Client: MOVED Server Shard 1
+    Note over Client,Server Shard 3: Client needs to redirect to correct node
+    Client->>+Server Shard 2: MGET key2 key3
+    Server Shard 2-->>-Client: CROSSSLOTS
+    Note over Client,Server Shard 2: Cannot command across shards
+```

redis-cluster-client.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name                              = 'redis-cluster-client'
   s.summary                           = 'A Redis cluster client for Ruby'
-  s.version                           = '0.0.0'
+  s.version                           = '0.0.1'
   s.license                           = 'MIT'
   s.homepage                          = 'https://github.com/redis-rb/redis-cluster-client'
   s.authors                           = ['Taishi Kasuga']