ch-client 0.0.1

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require_relative "test_helper/coverage"
+
+require "minitest"
+require "minitest/autorun"
+require "mocha/setup"
+
+def path(path)
+  File.expand_path "../../#{path}", __FILE__
+end
+
+require "bundler"
+Bundler.require :default, :development, :test
+
+require_relative "test_helper/minitest"
+require_relative "test_helper/simple_connection"

data/test/test_helper/coverage.rb

@@ -0,0 +1,16 @@
+if Dir.pwd == File.expand_path("../../..", __FILE__)
+  if ENV["REPORT"].to_i == 1
+    require "dotenv"
+    Dotenv.load
+
+    require "codeclimate-test-reporter"
+    CodeClimate::TestReporter.start
+  end
+
+  require "simplecov"
+  SimpleCov.coverage_dir "test/coverage"
+  SimpleCov.start do
+    add_group "Clickhouse", "lib"
+    add_group "Test suite", "test"
+  end
+end

data/test/test_helper/minitest.rb

@@ -0,0 +1,13 @@
+class MiniTest::Test
+  def teardown
+    Clickhouse.instance_variables.each do |name|
+      Clickhouse.instance_variable_set name, nil
+    end
+  end
+end
+
+class MiniTest::Spec
+  def assert_query(expected, actual)
+    assert_equal(expected.strip.gsub(/^\s+/, ""), actual)
+  end
+end

data/test/test_helper/simple_connection.rb

@@ -0,0 +1,12 @@
+class SimpleConnection
+  attr_reader :config
+
+  def initialize
+    @config = {
+      :scheme => "http",
+      :host => "localhost",
+      :port => 8123
+    }
+  end
+
+end

data/test/unit/connection/query/test_result_row.rb

@@ -0,0 +1,36 @@
+require_relative "../../../test_helper"
+
+module Unit
+  module Connection
+    module Query
+      class TestResultRow < MiniTest::Test
+
+        describe Clickhouse::Connection::Query::ResultRow do
+          describe "#to_hash" do
+            describe "when passing names" do
+              it "uses the names as hash keys" do
+                result_row = Clickhouse::Connection::Query::ResultRow.new([1, 2, 3], [:a, :b, :c])
+                assert_equal({:a => 1, :b => 2, :c => 3}, result_row.to_hash)
+              end
+            end
+
+            describe "when not passing names" do
+              it "uses 'column<i>' as hash keys" do
+                result_row = Clickhouse::Connection::Query::ResultRow.new([1, 2, 3])
+                assert_equal({"column0" => 1, "column1" => 2, "column2" => 3}, result_row.to_hash)
+              end
+            end
+
+            describe "memoization" do
+              it "memoizes the resulting hash" do
+                result_row = Clickhouse::Connection::Query::ResultRow.new([1, 2, 3])
+                assert_equal result_row.to_hash.object_id, result_row.to_hash.object_id
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/unit/connection/query/test_result_set.rb

@@ -0,0 +1,196 @@
+require_relative "../../../test_helper"
+
+module Unit
+  module Connection
+    module Query
+      class TestResultSet < MiniTest::Test
+
+        describe Clickhouse::Connection::Query::ResultSet do
+          before do
+            @empty_set = Clickhouse::Connection::Query::ResultSet.new
+            @result_set = Clickhouse::Connection::Query::ResultSet.new(
+              [
+                [
+                  "1072649",
+                  "142.94",
+                  "badrequest.io",
+                  "d91d1c90\u0000\u0000\u0000",
+                  "2016-03-20",
+                  "2016-03-20 23:49:11",
+                  [4, 2, 5, 7]
+                ], [
+                  "12948140",
+                  "9320.11",
+                  "engel.pm",
+                  "d91d217c\u0000\u0000",
+                  "2016-03-20",
+                  "2016-03-20 23:58:34",
+                  [6, 2, 9, 8, 1]
+                ], [
+                  "319384",
+                  "101.02",
+                  "archan937.com",
+                  "d91d2294\u0000\u0000\u0000",
+                  "2016-03-20",
+                  "2016-03-20 22:55:39",
+                  [3, 1, 2]
+                ]
+              ],
+              %w(
+                SUM(clicks)
+                AVG(price)
+                domain
+                id
+                date
+                MAX(time)
+                groupUniqArray(code)
+              ),
+              %w(
+                UInt32
+                Float32
+                String
+                FixedString(16)
+                Date
+                DateTime
+                Array(8)
+              )
+            )
+          end
+
+          describe "#size" do
+            it "returns the size of the result set" do
+              assert_equal 3, @result_set.size
+            end
+          end
+
+          describe "#empty?" do
+            it "returns whether the result set is empty or not" do
+              assert_equal true, @empty_set.empty?
+              assert_equal false, @result_set.empty?
+            end
+          end
+
+          describe "#present?" do
+            it "returns whether the result set contains rows or not" do
+              assert_equal false, @empty_set.present?
+              assert_equal true, @result_set.present?
+            end
+          end
+
+          describe "#first" do
+            it "returns the first row of the result set" do
+              assert_equal [
+                1072649,
+                142.94,
+                "badrequest.io",
+                "d91d1c90",
+                Date.new(2016, 3, 20),
+                Time.new(2016, 3, 20, 23, 49, 11),
+                [4, 2, 5, 7]
+              ], @result_set.first
+            end
+          end
+
+          describe "#last" do
+            it "returns the size of the result set" do
+              assert_equal [
+                319384,
+                101.02,
+                "archan937.com",
+                "d91d2294",
+                Date.new(2016, 3, 20),
+                Time.new(2016, 3, 20, 22, 55, 39),
+                [3, 1, 2]
+              ], @result_set.last
+            end
+          end
+
+          describe "#flatten" do
+            it "returns the size of the result set" do
+              assert_equal [
+                1072649,
+                142.94,
+                "badrequest.io",
+                "d91d1c90",
+                Date.new(2016, 3, 20),
+                Time.new(2016, 3, 20, 23, 49, 11),
+                4,
+                2,
+                5,
+                7,
+                12948140,
+                9320.11,
+                "engel.pm",
+                "d91d217c",
+                Date.new(2016, 3, 20),
+                Time.new(2016, 3, 20, 23, 58, 34),
+                6,
+                2,
+                9,
+                8,
+                1,
+                319384,
+                101.02,
+                "archan937.com",
+                "d91d2294",
+                Date.new(2016, 3, 20),
+                Time.new(2016, 3, 20, 22, 55, 39),
+                3,
+                1,
+                2
+              ], @result_set.flatten
+            end
+          end
+
+          describe "#to_hashes" do
+            it "returns an array containing the rows as hashes" do
+              assert_equal [
+                {
+                  "SUM(clicks)" => 1072649,
+                  "AVG(price)" => 142.94,
+                  "domain" => "badrequest.io",
+                  "id" => "d91d1c90",
+                  "date" => Date.new(2016, 3, 20),
+                  "MAX(time)" => Time.new(2016, 3, 20, 23, 49, 11),
+                  "groupUniqArray(code)" => [4, 2, 5, 7]
+                }, {
+                  "SUM(clicks)" => 12948140,
+                  "AVG(price)" => 9320.11,
+                  "domain" => "engel.pm",
+                  "id" => "d91d217c",
+                  "date" => Date.new(2016, 3, 20),
+                  "MAX(time)" => Time.new(2016, 3, 20, 23, 58, 34),
+                  "groupUniqArray(code)" => [6, 2, 9, 8, 1]
+                }, {
+                  "SUM(clicks)" => 319384,
+                  "AVG(price)" => 101.02,
+                  "domain" => "archan937.com",
+                  "id" => "d91d2294",
+                  "date" => Date.new(2016, 3, 20),
+                  "MAX(time)" => Time.new(2016, 3, 20, 22, 55, 39),
+                  "groupUniqArray(code)" => [3, 1, 2]
+                }
+              ], @result_set.to_hashes
+            end
+          end
+
+          describe "memoization" do
+            it "memoizes the parsed rows" do
+              assert_equal @result_set.to_a[-1].object_id, @result_set.each{}[-1].object_id
+              assert_equal @result_set.first.object_id, @result_set[0].object_id
+            end
+          end
+
+          describe "non-supported data types" do
+            it "raises a NotImplementedError error" do
+              assert_raises NotImplementedError do
+                Clickhouse::Connection::Query::ResultSet.new([[1]], ["Foo"], ["Bar"])[0]
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/unit/connection/query/test_table.rb

@@ -0,0 +1,39 @@
+require_relative "../../../test_helper"
+
+module Unit
+  module Connection
+    module Query
+      class TestTable < MiniTest::Test
+
+        describe Clickhouse::Connection::Query::Table do
+          it "generates a 'CREATE TABLE' statement" do
+            table = Clickhouse::Connection::Query::Table.new("logs_test") do |t|
+              t.uint8        :id
+              t.float32      :price
+              t.string       :name
+              t.date         :date
+              t.date_time    :time
+              t.fixed_string :hex_id, 8
+              t.engine       "MergeTree(date, 8192)"
+            end
+
+            sql = <<-SQL
+CREATE TABLE logs_test (
+  id     UInt8,
+  price  Float32,
+  name   String,
+  date   Date,
+  time   DateTime,
+  hex_id FixedString(8)
+)
+ENGINE = MergeTree(date, 8192)
+            SQL
+
+            assert_equal sql.strip, table.to_sql.strip
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/unit/connection/test_client.rb

@@ -0,0 +1,206 @@
+require_relative "../../test_helper"
+
+module Unit
+  module Connection
+    class TestClient < MiniTest::Test
+
+      class Connection < SimpleConnection
+        include Clickhouse::Connection::Client
+      end
+
+      describe Clickhouse::Connection::Client do
+        before do
+          @connection = Connection.new
+          @connection.stubs(:parse_stats)
+          @connection.stubs(:write_log)
+        end
+
+        describe "#connect!" do
+          describe "when failed to connect" do
+            it "returns true" do
+              Faraday::Connection.any_instance.expects(:get).raises(Faraday::ConnectionFailed.new("Failed to connect"))
+              assert_raises Clickhouse::ConnectionError do
+                @connection.connect!
+              end
+            end
+          end
+
+          describe "when receiving 200" do
+            it "returns true" do
+              Faraday::Connection.any_instance.expects(:get).returns(stub(:status => 200))
+              assert_equal true, @connection.connect!
+            end
+          end
+
+          describe "when receiving 500" do
+            it "raises a Clickhouse::ConnectionError" do
+              Faraday::Connection.any_instance.expects(:get).returns(stub(:status => 500))
+              assert_raises Clickhouse::ConnectionError do
+                @connection.connect!
+              end
+            end
+          end
+
+          describe "when already connected" do
+            it "returns nil" do
+              @connection.instance_variable_set :@client, mock
+              assert_nil @connection.connect!
+            end
+          end
+        end
+
+        describe "#connected?" do
+          it "returns whether it has an connected socket" do
+            assert_equal false, @connection.connected?
+            @connection.instance_variable_set :@client, mock
+            assert_equal true, @connection.connected?
+            @connection.instance_variable_set :@client, nil
+            assert_equal false, @connection.connected?
+          end
+        end
+
+        describe "#get" do
+          it "sends a GET request the server" do
+            @connection.instance_variable_set :@client, (client = mock)
+            client.expects(:get).with("/?query=foo&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
+            @connection.stubs(:log)
+            @connection.get("foo")
+          end
+        end
+
+        describe "#post" do
+          it "sends a POST request the server" do
+            @connection.instance_variable_set :@client, (client = mock)
+            client.expects(:post).with("/?query=foo&output_format_write_statistics=1", "body").returns(stub(:status => 200, :body => ""))
+            @connection.stubs(:log)
+            @connection.post("foo", "body")
+          end
+        end
+
+        describe "#request" do
+          before do
+            @connection.stubs(:log)
+          end
+
+          it "connects to the server first" do
+            @connection.instance_variable_set :@client, (client = mock)
+            @connection.expects(:connect!)
+            client.stubs(:get).returns(stub(:status => 200, :body => ""))
+            @connection.send :request, :get, "/", "query"
+          end
+
+          it "queries the server returning the response" do
+            @connection.instance_variable_set :@client, (client = mock)
+            client.expects(:get).with("/?query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
+            @connection.expects(:parse_body).returns(data = mock)
+            assert_equal data, @connection.send(:request, :get, "SELECT 1")
+          end
+
+          describe "when not receiving status 200" do
+            it "raises a Clickhouse::QueryError" do
+              @connection.instance_variable_set :@client, (client = mock)
+              client.expects(:get).with("/?query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 500, :body => ""))
+              assert_raises Clickhouse::QueryError do
+                @connection.send(:request, :get, "SELECT 1")
+              end
+            end
+          end
+
+          describe "when getting Faraday::Error" do
+            it "raises a Clickhouse::ConnectionError" do
+              @connection.instance_variable_set :@client, (client = mock)
+              client.expects(:get).raises(Faraday::ConnectionFailed.new("Failed to connect"))
+              assert_raises Clickhouse::ConnectionError do
+                @connection.send(:request, :get, "SELECT 1")
+              end
+            end
+          end
+
+          it "parses the body" do
+            json = <<-JSON
+              {"meta": []}
+            JSON
+            @connection.instance_variable_set :@client, (client = mock)
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => json))
+            assert_equal({"meta" => []}, @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact"))
+          end
+        end
+
+        describe "configuration" do
+          describe "database" do
+            it "includes the database in the querystring" do
+              @connection.instance_variable_get(:@config)[:database] = "system"
+              @connection.instance_variable_set(:@client, (client = mock))
+              client.expects(:get).with("/?database=system&query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
+              @connection.expects(:parse_body).returns(data = mock)
+              assert_equal data, @connection.send(:request, :get, "SELECT 1")
+            end
+          end
+
+          describe "authentication" do
+            it "includes the credentials in the request headers" do
+              Faraday::Connection.any_instance.expects(:get).returns(stub(status: 200))
+              connection = Clickhouse::Connection.new :password => "awesomepassword"
+              connection.connect!
+              assert_equal "Basic ZGVmYXVsdDphd2Vzb21lcGFzc3dvcmQ=", connection.send(:client).headers["Authorization"].force_encoding("UTF-8")
+            end
+          end
+        end
+
+        describe "statistics" do
+          before do
+            @connection = Connection.new
+            @json = <<-JSON
+              {
+                "rows": 1947,
+                "statistics": {
+                  "elapsed": 0.1882,
+                  "rows_read": 1982,
+                  "bytes_read": 2003
+                }
+              }
+            JSON
+          end
+
+          it "parses the statistics" do
+            @connection.stubs(:log)
+            @connection.instance_variable_set :@client, (client = mock)
+            Time.expects(:now).returns(1882).twice
+
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => @json))
+            @connection.expects(:write_log).with(
+              0, "SELECT 1", {
+                "elapsed" => "188.2ms",
+                "rows_read" => "1.98 thousand",
+                "bytes_read" => 2003,
+                "rows" => 1947,
+                "rows_per_second" => "10.53 thousand",
+                "data_per_second" => "10.39 KB",
+                "data_read" => "1.96 KB"
+              }
+            )
+            @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact")
+          end
+
+          it "write the expected logs" do
+            @connection.instance_variable_set :@client, (client = mock)
+            Time.expects(:now).returns(1882).twice
+
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => @json))
+            log = "\n \e[1m\e[35mSQL (0.0ms)\e\e[0m  SELECT 1;\e\n  \e[1m\e[36m1947 rows in set. Elapsed: 188.2ms. Processed: 1.98 thousand rows, 1.96 KB (10.53 thousand rows/s, 10.39 KB/s)\e[0m "
+
+            @connection.expects(:log).with(:debug, log)
+            @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact")
+          end
+
+          describe "#number_to_human_duration" do
+            it "returns in seconds when more than 1 seconds" do
+              assert_equal "2.0s", @connection.send(:number_to_human_duration, 2)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end