test: add ruby client test (#14859)

Author: xuefengze

integration_tests/client-library/client_test.py

@@ -25,15 +25,22 @@ def check_nodejs():
 
 
 def check_php():
-    subprocess.run(["docker", "compose", "exec", "php", "bash", "-c", "cd /php-client && phpunit tests/RWClientTest.php"], check=True)
+    subprocess.run(
+        ["docker", "compose", "exec", "php", "bash", "-c", "cd /php-client && phpunit tests/RWClientTest.php"],
+        check=True)
+
+
+def check_ruby():
+    subprocess.run(["docker", "compose", "exec", "ruby", "bash", "-c", "cd /ruby-client && ruby test/crud_test.rb"],
+                   check=True)
 
 
 subprocess.run(["docker", "compose", "up", "-d"], check=True)
 sleep(10)
 
 failed_cases = []
 
-for client in ['go', 'python', 'java', 'nodejs', 'php']:
+for client in ['go', 'python', 'java', 'nodejs', 'php', 'ruby']:
     print(f"--- {client} client test")
     try:
         if client == 'go':
@@ -46,6 +53,8 @@ def check_php():
             check_nodejs()
         elif client == 'php':
             check_php()
+        elif client == 'ruby':
+            check_ruby()
     except Exception as e:
         print(e)
         failed_cases.append(f"{client} client failed")

integration_tests/client-library/docker-compose.yml

@@ -48,6 +48,12 @@ services:
     command: tail -f /dev/null
     volumes:
       - ./php:/php-client
+  ruby:
+    image: ruby-library
+    build: ./ruby
+    command: tail -f /dev/null
+    volumes:
+      - ./ruby:/ruby-client
 
 volumes:
   risingwave-standalone:

integration_tests/client-library/ruby/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:3.2-slim-bullseye
+
+# install ruby-pg
+RUN apt-get update && \
+    apt-get install -y libpq-dev && \
+    apt-get install -y build-essential && \
+    gem install pg
+
+CMD ["irb"]

integration_tests/client-library/ruby/rw_conn.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'pg'
+
+def get_rw_conn(host: 'localhost', port: 4566, options: '', tty: '', dbname: 'dev', user: 'root', password: '')
+  conn = PG.connect(host: host, port: port, options: options, tty: tty, dbname: dbname, user: user, password: password)
+  # https://github.com/risingwavelabs/risingwave/issues/14682
+  # conn.type_map_for_results = PG::BasicTypeMapForResults.new(conn)
+  conn
+end

integration_tests/client-library/ruby/test/crud_test.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+require_relative '../rw_conn'
+require_relative 'util'
+require 'date'
+require 'test/unit'
+
+class SQLTest < Test::Unit::TestCase
+  def setup
+    @conn = get_rw_conn(host: 'risingwave-standalone')
+  end
+
+  def test_crud
+    create_table(@conn)
+
+    name = 'John Doe'
+    age = 30
+    salary = 50000
+    tripIDs = ['12345', '67890']
+    fareData = {
+      "initial_charge"    => 3.0,
+      "subsequent_charge" => 1.5,
+      "surcharge"         => 0.5,
+      "tolls"             => 2.0,
+    }
+    deci = 2.14159
+    birthdate = Date.parse('1993-01-02')
+    starttime = "20:00:00"
+    timest = DateTime.now()
+    timestz = DateTime.now()
+    timegap = '02:00:00'
+
+    insert_data(@conn, name, age, salary, tripIDs, birthdate, deci, fareData, starttime, timest, timestz, timegap)
+    check_data(name, age, salary, tripIDs, birthdate, deci, fareData, starttime, timest, timestz, timegap)
+
+    # Insert data with null values
+    nullName = "Null Person";
+    nullAge = 0
+    nullSalary = 0
+    nullTripIDs = []
+    nullFareData = {}
+    nullBirthdate = Date.parse('0001-01-01')
+    nullStarttime = '00:00:00'
+    nullTimest = DateTime.parse('0001-01-01 00:00:00')
+    nullTimestz = DateTime.parse('1970-01-01T00:00:00Z')
+    nullTimegap = '00:00:00';
+    nullDeci = 0.0;
+
+    insert_data(@conn, nullName, nullAge, nullSalary, nullTripIDs, nullBirthdate, nullDeci, nullFareData, nullStarttime, nullTimest, nullTimestz, nullTimegap)
+    check_data(nullName, nullAge, nullSalary, nullTripIDs, nullBirthdate, nullDeci, nullFareData, nullStarttime, nullTimest, nullTimestz, nullTimegap)
+
+    update_data(@conn, name, 60000)
+    delete_data(@conn, name)
+    drop_table(@conn)
+  end
+
+  def check_data(name, age, salary, tripIDs, birthdate, deci, fareData, starttime, timest, timestz, timegap)
+    @conn.exec('FLUSH;')
+
+    select_query = "SELECT name, age, salary, trip_id, birthdate, deci, fare, starttime, timest, timestz, timegap FROM sample_table_ruby WHERE name=$1"
+
+    res = @conn.exec_params(select_query, [name])
+
+    res.each do |row|
+      retrievedName = row['name']
+      assert_equal(name, retrievedName)
+
+      retrievedAge = row['age'].to_i
+      assert_equal(age, retrievedAge)
+
+      retrievedSalary = row['salary'].to_i
+      assert_equal(salary, retrievedSalary)
+
+      retrievedTripIDs = row['trip_id']
+      assert_equal('{' + tripIDs.join(',') + '}', retrievedTripIDs)
+
+      retrievedBirthdate = row['birthdate']
+      assert_equal(birthdate, Date.parse(retrievedBirthdate))
+
+      retrievedDeci = row['deci']
+      assert_equal(deci, retrievedDeci.to_f)
+
+      retrievedFareData = row['fare']
+
+      retrievedStarttime = row['starttime']
+      assert_equal(starttime, retrievedStarttime)
+
+      retrievedTimest = row['timest']
+      assert_equal(timest.strftime('%Y-%m-%d %H:%M:%S%z'), DateTime.parse(retrievedTimest).strftime('%Y-%m-%d %H:%M:%S%z'))
+
+      retrievedTimestz = row['timestz']
+      assert_equal(timestz.strftime('%Y-%m-%dT%H:%M:%S%zZ'), DateTime.parse(retrievedTimestz).strftime('%Y-%m-%dT%H:%M:%S%zZ'))
+
+      retrievedTimegap = row['timegap']
+      assert_equal(timegap, retrievedTimegap)
+    end
+    puts "Data checked successfully."
+  end
+end

integration_tests/client-library/ruby/test/util.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+def create_table(conn)
+  query = <<-EOF
+    CREATE TABLE sample_table_ruby
+    (
+        name              VARCHAR,
+        age               INTEGER,
+        salary            BIGINT,
+        trip_id           VARCHAR[],
+        birthdate         DATE,
+        deci              DOUBLE PRECISION,
+        fare              STRUCT < initial_charge DOUBLE PRECISION,
+        subsequent_charge DOUBLE PRECISION,
+        surcharge         DOUBLE PRECISION,
+        tolls             DOUBLE PRECISION >,
+        starttime         TIME,
+        timest            TIMESTAMP,
+        timestz           TIMESTAMPTZ,
+        timegap           INTERVAL
+    )
+  EOF
+  conn.exec(query)
+  puts "Table created successfully."
+end
+
+def drop_table(conn)
+  conn.exec('DROP TABLE sample_table_ruby;')
+  puts "Table dropped successfully."
+end
+
+def insert_data(conn, name, age, salary, tripIDs, birthdate, deci, fareData, starttime, timest, timestz, timegap)
+  insert_query = <<-EOF
+    INSERT INTO sample_table_ruby (name, age, salary, trip_id, birthdate, deci, fare, starttime, timest, timestz, timegap)
+    VALUES ($1, $2, $3, $4, $5, $6, ROW($7, $8, $9, $10), $11, $12, $13, $14);
+  EOF
+  conn.exec_params(insert_query, [name, age, salary,
+    "{#{tripIDs.join(',')}}",
+    birthdate,
+    deci,
+    fareData["initial_charge"],
+    fareData["subsequent_charge"],
+    fareData["surcharge"],
+    fareData["tolls"],
+    starttime,
+    timest.strftime('%Y-%m-%d %H:%M:%S'),
+    timestz,
+    timegap
+  ])
+
+  puts "Data inserted successfully."
+end
+
+def update_data(conn, name, salary)
+  update_query = "UPDATE sample_table_ruby SET salary=$1 WHERE name=$2"
+
+  conn.exec_params(update_query, [salary, name])
+  puts "Data updated successfully."
+end
+
+def delete_data(conn, name)
+  conn.exec_params('DELETE FROM sample_table_ruby WHERE name=$1;', [name])
+
+  puts "Data deletion successfully."
+end