td-client 1.0.0-java

data/spec/td/client/model_job_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'Job Model' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+  include_context 'job resources'
+
+  before do
+    stub_api_request(:post, "/v3/user/authenticate").
+      to_return(:body => {'apikey' => 'apikey'}.to_json)
+  end
+
+  describe '#client' do
+    subject do
+      Job.new(client, *arguments).client
+    end
+
+    let :client do
+      Client.authenticate('user', 'password')
+    end
+
+    let :arguments do
+      job_attributes = raw_jobs.first
+      [
+        'job_id', 'type', 'query', 'status', 'url', 'debug',
+        'start_at', 'end_at', 'cpu_time', 'result_size', 'result', 'result_url',
+        'hive_result_schema', 'priority', 'retry_limit', 'org_name', 'db_name',
+        'duration', 'num_records'
+      ].map {|name| job_attributes[name]}
+    end
+
+    it 'returns Job object having client' do
+      expect(subject).to eq client
+    end
+  end
+
+  describe '#result_raw' do
+    let(:client) { Client.authenticate('user', 'password') }
+    let(:job_id) { 12345678 }
+    let(:job)    { Job.new(client, job_id, nil, nil) }
+    let(:format) { 'json' }
+    let(:io)     { StringIO.new }
+
+    context 'not finished?' do
+      before { allow(job).to receive(:finished?) { false } }
+
+      it 'do not call #job_result_raw' do
+        expect(client).not_to receive(:job_result_raw)
+
+        expect(job.result_raw(format, io)).to_not be
+      end
+    end
+
+    context 'finished?' do
+      before { allow(job).to receive(:finished?) { true } }
+
+      it 'call #job_result_raw' do
+        expect(client).to receive(:job_result_raw).with(job_id, format, io)
+
+        job.result_raw(format, io)
+      end
+    end
+  end
+
+  describe '#wait' do
+    let(:client) { Client.authenticate('user', 'password') }
+    let(:job_id) { 12345678 }
+    let(:job)    { Job.new(client, job_id, nil, nil) }
+
+    def change_job_status(status)
+      allow(client).to receive(:job_status).with(job_id).and_return(status)
+    end
+
+    before do
+      change_job_status(Job::STATUS_QUEUED)
+    end
+
+    context 'without timeout' do
+      it 'waits the job to be finished' do
+        begin
+          thread = Thread.start { job.wait }
+          expect(thread).to be_alive
+          change_job_status(Job::STATUS_SUCCESS)
+          thread.join(1)
+          expect(thread).to be_stop
+        ensure
+          thread.kill # just in case
+        end
+      end
+
+      it 'calls a given block in every wait_interval second' do
+        now = 1_400_000_000
+        allow(self).to receive(:sleep){|arg| now += arg }
+        allow(Process).to receive(:clock_gettime){ now }
+        expect { |b|
+          begin
+            thread = Thread.start {
+              job.wait(nil, 2, &b)
+            }
+            sleep 6
+            change_job_status(Job::STATUS_SUCCESS)
+            thread.join(1)
+            expect(thread).to be_stop
+          ensure
+            thread.kill # just in case
+          end
+        }.to yield_control.at_least(2).at_most(3).times
+      end
+    end
+
+    context 'with timeout' do
+      context 'the job running time is too long' do
+        it 'raise Timeout::Error' do
+          expect {
+            job.wait(0.1)
+          }.to raise_error(Timeout::Error)
+        end
+      end
+
+      it 'calls a given block in every wait_interval second, and timeout' do
+        expect { |b|
+          begin
+            thread = Thread.start {
+              job.wait(0.3, 0.1, &b)
+            }
+            expect{ thread.value }.to raise_error(Timeout::Error)
+            expect(thread).to be_stop
+          ensure
+            thread.kill # just in case
+          end
+        }.to yield_control.at_least(2).times
+      end
+    end
+  end
+end

data/spec/td/client/model_schedule_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'Schedule Model' do
+  describe '#run' do
+    let(:api_key) { '1234567890abcd' }
+    let(:api) { double(:api) }
+    let(:client) { Client.new(api_key) }
+    let(:name) { 'schedule' }
+    let(:schedule) {
+      Schedule.new(client, name, '0 0 * * * *', 'select 1')
+    }
+    let(:time) { "2013-01-01 00:00:00"  }
+    let(:num) { 1 }
+
+    before do
+      allow(API).to receive(:new).with(api_key, {}).and_return(api)
+    end
+
+    it 'success call api' do
+      expect(api).to receive(:run_schedule).with(name, time, num).and_return([])
+
+      schedule.run(time, num)
+    end
+  end
+end

data/spec/td/client/model_schema_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'TreasureData::Schema::Field' do
+  describe '.new' do
+    context 'name="v"' do
+      it 'raises ParameterValidationError' do
+        expect{ Schema::Field.new('v', 'int') }.to raise_error(ParameterValidationError)
+      end
+    end
+    context 'name="time"' do
+      it 'raises ParameterValidationError' do
+        expect{ Schema::Field.new('time', 'int') }.to raise_error(ParameterValidationError)
+      end
+    end
+    context 'name with UTF-8' do
+      it 'works' do
+        name = "\u3042\u3044\u3046"
+        f = Schema::Field.new(name, 'int')
+        expect(f.name).to eq name
+        expect(f.type).to eq 'int'
+        expect(f.sql_alias).to be_nil
+      end
+    end
+    context 'with sql_alias' do
+      it 'raises' do
+        f = Schema::Field.new('t:t', 'int', 'alice')
+        expect(f.name).to eq 't:t'
+        expect(f.type).to eq 'int'
+        expect(f.sql_alias).to eq 'alice'
+      end
+    end
+    context 'with invalid sql_alias' do
+      it 'raises' do
+        expect{ Schema::Field.new('t:t', 'int', 't:t') }.to raise_error(ParameterValidationError)
+      end
+    end
+  end
+end
+
+describe 'TreasureData::Schema' do
+  describe '.parse' do
+    let(:columns){ ["foo:int", "BAR\u3070\u30FC:string@bar", "baz:baz!:array<double>@baz"] }
+    it do
+      sc = Schema.parse(columns)
+      expect(sc.fields.size).to eq 3
+      expect(sc.fields[0].name).to eq 'foo'
+      expect(sc.fields[0].type).to eq 'int'
+      expect(sc.fields[0].sql_alias).to be_nil
+      expect(sc.fields[1].name).to eq "BAR\u3070\u30FC"
+      expect(sc.fields[1].type).to eq 'string'
+      expect(sc.fields[1].sql_alias).to eq 'bar'
+      expect(sc.fields[2].name).to eq 'baz:baz!'
+      expect(sc.fields[2].type).to eq 'array<double>'
+      expect(sc.fields[2].sql_alias).to eq 'baz'
+    end
+  end
+
+  describe '.new' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect(sc.fields[0]).to eq f
+    end
+  end
+
+  describe '#fields' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect(sc.fields[0]).to eq f
+    end
+  end
+
+  describe '#add_field' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      sc.add_field('b', 'double', 'bb')
+      expect(sc.fields[1].name).to eq 'b'
+    end
+    it 'raises ParameterValidationError if name is duplicated' do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect{ sc.add_field('a', 'double') }.to raise_error(ParameterValidationError)
+    end
+    it 'raises ParameterValidationError if sql_alias is duplicated' do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect{ sc.add_field('abc', 'double', 'a') }.to raise_error(ParameterValidationError)
+    end
+  end
+
+  describe '#merge' do
+    it do
+      sc1 = Schema.parse(['foo:int', 'bar:float'])
+      sc2 = Schema.parse(['bar:double', 'baz:string'])
+      sc3 = sc1.merge(sc2)
+      expect(sc3.fields.size).to eq 3
+      expect(sc3.fields[0].name).to eq 'foo'
+      expect(sc3.fields[0].type).to eq 'int'
+      expect(sc3.fields[1].name).to eq 'bar'
+      expect(sc3.fields[1].type).to eq 'double'
+      expect(sc3.fields[2].name).to eq 'baz'
+      expect(sc3.fields[2].type).to eq 'string'
+    end
+    it do
+      sc1 = Schema.parse(['foo:int', 'bar:float'])
+      sc2 = Schema.parse(['bar:double@foo'])
+      expect{ sc1.merge(sc2) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#to_json' do
+    it do
+      sc = Schema.parse(['foo:int', 'bar:float@baz'])
+      expect(sc.to_json).to eq '[["foo","int"],["bar","float","baz"]]'
+    end
+  end
+
+  describe '#from_json' do
+    it do
+      sc = Schema.new
+      sc.from_json [["foo","int"],["bar","float","baz"]]
+      expect(sc.fields.size).to eq 2
+      expect(sc.fields[0].name).to eq 'foo'
+      expect(sc.fields[0].type).to eq 'int'
+      expect(sc.fields[0].sql_alias).to be_nil
+      expect(sc.fields[1].name).to eq 'bar'
+      expect(sc.fields[1].type).to eq 'float'
+      expect(sc.fields[1].sql_alias).to eq 'baz'
+    end
+  end
+end

data/spec/td/client/partial_delete_api_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'PartialDelete API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil)
+  end
+
+  describe 'partialdelete' do
+    let :from do
+      0
+    end
+
+    let :to do
+      3600 * 10
+    end
+
+    let :from_to do
+      {'from' => from.to_s, 'to' => to.to_s}
+    end
+
+    it 'should partial_delete successfully' do
+      # TODO: Use correnty values
+      stub_api_request(:post, "/v3/table/partialdelete/#{e(db_name)}/#{e(table_name)}").with(:body => from_to).
+        to_return(:body => {'database' => db_name, 'table' => table_name, 'job_id' => '1'}.to_json)
+
+      expect(api.partial_delete(db_name, table_name, to, from)).to eq('1')
+    end
+
+    it 'should return 404 error with non exist database name' do
+      db = 'no_such_db'
+      err_msg = "Couldn't find UserDatabase with name = #{db}"
+      stub_api_request(:post, "/v3/table/partialdelete/#{e(db)}/#{e(table_name)}").with(:body => from_to).
+        to_return(:status => 404, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.partial_delete(db, table_name, to, from)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+
+    it 'should return 404 error with non exist table name' do
+      table = 'no_such_table'
+      err_msg = "Unknown table: #{table}"
+      stub_api_request(:post, "/v3/table/partialdelete/#{e(db_name)}/#{e(table)}").with(:body => from_to).
+        to_return(:status => 404, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.partial_delete(db_name, table, to, from)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+
+    # TODO: Add from / to parameters spec
+  end
+end
+

data/spec/td/client/result_api_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'Result API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil)
+  end
+
+  describe 'create_result' do
+    it 'should create a new result' do
+      params = {'url' => result_url}
+      stub_api_request(:post, "/v3/result/create/#{e(result_name)}").with(:body => params).to_return(:body => {'result' => result_name}.to_json)
+
+      expect(api.create_result(result_name, result_url)).to be true
+    end
+
+    it 'should return 422 error with invalid name' do
+      name = '1'
+      params = {'url' => result_url}
+      err_msg = "Validation failed: Name is too short" # " (minimum is 3 characters)"
+      stub_api_request(:post, "/v3/result/create/#{e(name)}").with(:body => params).
+        to_return(:status => 422, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_result(name, result_url)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+
+    it 'should return 422 error without url' do
+      params = {'url' => 'false'} # I want to use nil, but nil doesn't work on WebMock...
+      err_msg = "'url' parameter is required"
+      stub_api_request(:post, "/v3/result/create/#{e(result_name)}").with(:body => params).
+        to_return(:status => 422, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_result(result_name, false)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+
+    it 'should return 409 error with duplicated name' do
+      params = {'url' => result_url}
+      err_msg = "Result must be unique"
+      stub_api_request(:post, "/v3/result/create/#{e(result_name)}").with(:body => params).
+        to_return(:status => 409, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_result(result_name, result_url)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+  end
+
+  describe 'list_result' do
+    it 'should return name and url' do
+      stub_api_request(:get, '/v3/result/list').
+        to_return(:body => {'results' => [{'name' => 'name', 'url' => 'url'}]}.to_json)
+      expect(api.list_result).to eq([['name', 'url', nil]])
+    end
+  end
+
+  describe 'delete_result' do
+    it 'should delete the result' do
+      stub_api_request(:post, "/v3/result/delete/#{e(result_name)}")
+      expect(api.delete_result(result_name)).to eq(true)
+    end
+
+    it 'should raise error' do
+      stub_api_request(:post, "/v3/result/delete/#{e(result_name)}").
+        to_return(:status => 404)
+      expect {
+        api.delete_result(result_name)
+      }.to raise_error(TreasureData::APIError)
+    end
+  end
+end

data/spec/td/client/sched_api_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'Schedule API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil)
+  end
+
+  describe 'create_schedule' do
+    let :opts do
+      {'cron' => cron, 'query' => query, 'database' => db_name}
+    end
+
+    it 'should create a new schedule' do
+      start = Time.now
+      stub_api_request(:post, "/v3/schedule/create/#{e(sched_name)}").
+        with(:body => opts.merge('type' => 'hive')).
+        to_return(:body => {'name' => sched_name, 'start' => start.to_s}.to_json)
+
+      expect(api.create_schedule(sched_name, opts.merge('type' => 'hive'))).to eq(start.to_s)
+    end
+
+    it 'should create a dummy schedule' do
+      stub_api_request(:post, "/v3/schedule/create/#{e(sched_name)}").
+        with(:body => opts.merge('type' => 'hive')).
+        to_return(:body => {'name' => sched_name, 'start' => nil}.to_json)
+
+      expect(api.create_schedule(sched_name, opts.merge('type' => 'hive'))).to be_nil
+    end
+
+    it 'should return 422 error with invalid name' do
+      name = '1'
+      err_msg = "Validation failed: Name is too short" # " (minimum is 3 characters)"
+      stub_api_request(:post, "/v3/schedule/create/#{e(name)}").
+        with(:body => opts.merge('type' => 'hive')).
+        to_return(:status => 422, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_schedule(name, opts.merge('type' => 'hive'))
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+  end
+
+  describe 'delete_schedule' do
+    it 'should delete the schedule' do
+      stub_api_request(:post, "/v3/schedule/delete/#{e(sched_name)}").
+        to_return(:body => {'cron' => 'cron', 'query' => 'query'}.to_json)
+      expect(api.delete_schedule(sched_name)).to eq(['cron', 'query'])
+    end
+  end
+
+  describe 'update_schedule' do
+    let :pig_query do
+      "OUT = FOREACH (GROUP plt364 ALL) GENERATE COUNT(plt364);\n" * 200
+    end
+    let :opts do
+      {'cron' => cron, 'query' => pig_query, 'database' => db_name}
+    end
+
+    it 'should not return 414 even if the query text is very long' do
+      stub_api_request(:post, "/v3/schedule/update/#{e(sched_name)}").
+        with(:body => opts.merge('type' => 'pig')).
+        to_return(:body => {'name' => sched_name, 'query' => pig_query}.to_json)
+
+      expect {
+        api.update_schedule(sched_name, opts.merge('type' => 'pig'))
+      }.not_to raise_error
+    end
+
+    it 'should update the schedule with the new query' do
+      stub_api_request(:post, "/v3/schedule/update/#{e(sched_name)}").
+        with(:body => opts.merge('type' => 'pig')).
+        to_return(:body => {'name' => sched_name, 'query' => pig_query}.to_json)
+
+      stub_api_request(:get, "/v3/schedule/list").
+        to_return(:body => {'schedules' => [{'name' => sched_name, 'query' => pig_query}]}.to_json)
+
+      expect(api.list_schedules.first[2]).to eq(pig_query)
+    end
+  end
+
+  describe 'history' do
+    let :history do
+      ['history', 'job_id', 'type', 'database', 'status', 'query', 'start_at', 'end_at', 'result', 'priority'].inject({}) { |r, e|
+        r[e] = e
+        r
+      }
+    end
+
+    it 'should return history records' do
+      stub_api_request(:get, "/v3/schedule/history/#{e(sched_name)}").
+        with(:query => {'from' => 0, 'to' => 100}).
+        to_return(:body => {'history' => [history]}.to_json)
+        expect(api.history(sched_name, 0, 100)).to eq([[nil, 'job_id', :type, 'status', 'query', 'start_at', 'end_at', 'result', 'priority', 'database']])
+    end
+  end
+
+  describe 'run_schedule' do
+    it 'should return history records' do
+      stub_api_request(:post, "/v3/schedule/run/#{e(sched_name)}/123456789").
+        with(:body => {'num' => '5'}).
+        to_return(:body => {'jobs' => [{'job_id' => 'job_id', 'scheduled_at' => 'scheduled_at', 'type' => 'type'}]}.to_json)
+        expect(api.run_schedule(sched_name, 123456789, 5)).to eq([['job_id', :type, 'scheduled_at']])
+    end
+  end
+end