influxdb 0.6.2 → 0.8.1

data/spec/influxdb/cases/async_client_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "timeout"
 
 describe InfluxDB::Client do
-  let(:async_options) { true }
+  let(:async_options) { { sleep_interval: 0.1 } }
   let(:client) { described_class.new(async: async_options) }
   let(:subject) { client }
   let(:stub_url) { "http://localhost:8086/write?db=&p=root&precision=s&u=root" }
@@ -14,18 +14,13 @@ describe InfluxDB::Client do
     it "sends writes to client" do
       post_request = stub_request(:post, stub_url).to_return(status: 204)
 
-      (worker.max_post_points + 100).times do
-        subject.write_point('a', {})
+      (worker.max_post_points + 100).times do |i|
+        subject.write_point('a', values: { i: i })
       end
 
-      # The timout code is fragile, and heavily dependent on system load
-      # (and scheduler decisions). On the CI, the system is less
-      # responsive and needs a bit more time.
-      timeout_stretch = ENV["TRAVIS"] == "true" ? 10 : 3
+      sleep 1 until worker.threads.none? { |t| t[:influxdb].nil? }
 
-      Timeout.timeout(timeout_stretch * worker.sleep_interval) do
-        subject.stop!
-      end
+      subject.stop!
 
       worker.threads.each do |t|
         expect(t.stop?).to be true
@@ -41,6 +36,7 @@ describe InfluxDB::Client do
       let(:precision)        { 'test_precision' }
       let(:retention_policy) { 'test_period' }
       let(:database)         { 'test_database' }
+      let(:async_options)    { { num_worker_threads: 1, sleep_interval: 0.1 } }
 
       it "writes aggregate payload to the client" do
         queue = Queue.new
@@ -51,9 +47,11 @@ describe InfluxDB::Client do
         subject.write_point(series, { values: { t: 60 } }, precision, retention_policy, database)
         subject.write_point(series, { values: { t: 61 } }, precision, retention_policy, database)
 
-        Timeout.timeout(worker.sleep_interval) do
-          expect(queue.pop).to eq ["#{series} t=60i\n#{series} t=61i", precision, retention_policy, database]
-        end
+        sleep 1 until worker.threads.none? { |t| t[:influxdb].nil? }
+
+        subject.stop!
+
+        expect(queue.pop).to eq ["#{series} t=60i\n#{series} t=61i", precision, retention_policy, database]
       end
 
       context 'when different precision, retention_policy and database are given' do
@@ -72,36 +70,62 @@ describe InfluxDB::Client do
           subject.write_point(series, { values: { t: 62 } }, precision,  retention_policy2, database)
           subject.write_point(series, { values: { t: 63 } }, precision,  retention_policy,  database2)
 
-          Timeout.timeout(worker.sleep_interval) do
-            expect(queue.pop).to eq ["#{series} t=60i", precision,  retention_policy,  database]
-            expect(queue.pop).to eq ["#{series} t=61i", precision2, retention_policy,  database]
-            expect(queue.pop).to eq ["#{series} t=62i", precision,  retention_policy2, database]
-            expect(queue.pop).to eq ["#{series} t=63i", precision,  retention_policy,  database2]
-          end
+          sleep 1 until worker.threads.none? { |t| t[:influxdb].nil? }
+
+          subject.stop!
+
+          expect(queue.pop).to eq ["#{series} t=60i", precision,  retention_policy,  database]
+          expect(queue.pop).to eq ["#{series} t=61i", precision2, retention_policy,  database]
+          expect(queue.pop).to eq ["#{series} t=62i", precision,  retention_policy2, database]
+          expect(queue.pop).to eq ["#{series} t=63i", precision,  retention_policy,  database2]
         end
       end
     end
   end
 
   describe "async options" do
-    let(:async_options) do
-      {
-        max_post_points:     10,
-        max_queue_size:      100,
-        num_worker_threads:  1,
-        sleep_interval:      0.5,
-        block_on_full_queue: false
-      }
-    end
-
     subject { worker }
     before { worker.stop! }
 
-    specify { expect(subject.max_post_points).to be 10 }
-    specify { expect(subject.max_queue_size).to be 100 }
-    specify { expect(subject.num_worker_threads).to be 1 }
-    specify { expect(subject.sleep_interval).to be_within(0.0001).of(0.5) }
-    specify { expect(subject.block_on_full_queue).to be false }
-    specify { expect(subject.queue).to be_kind_of(InfluxDB::MaxQueue) }
+    context 'when all options are given' do
+      let(:async_options) do
+        {
+          max_post_points:     10,
+          max_queue_size:      100,
+          num_worker_threads:  1,
+          sleep_interval:      0.5,
+          block_on_full_queue: false,
+          shutdown_timeout:    0.6,
+        }
+      end
+
+      it "uses the specified values" do
+        expect(subject.max_post_points).to be 10
+        expect(subject.max_queue_size).to be 100
+        expect(subject.num_worker_threads).to be 1
+        expect(subject.sleep_interval).to be_within(0.0001).of(0.5)
+        expect(subject.block_on_full_queue).to be false
+        expect(subject.queue).to be_kind_of(InfluxDB::MaxQueue)
+        expect(subject.shutdown_timeout).to be_within(0.0001).of(0.6)
+      end
+    end
+
+    context 'when only sleep_interval is given' do
+      let(:async_options) { { sleep_interval: 0.2 } }
+
+      it "uses a value for shutdown_timeout that is 2x sleep_interval" do
+        expect(subject.sleep_interval).to be_within(0.0001).of(0.2)
+        expect(subject.shutdown_timeout).to be_within(0.0001).of(0.4)
+      end
+    end
+
+    context 'when only shutdown_timeout is given' do
+      let(:async_options) { { shutdown_timeout: 0.3 } }
+
+      it "uses that value" do
+        expect(subject.sleep_interval).to be_within(0.0001).of(5)
+        expect(subject.shutdown_timeout).to be_within(0.0001).of(0.3)
+      end
+    end
   end
 end

data/spec/influxdb/cases/query_cluster_spec.rb

@@ -3,7 +3,7 @@ require "json"
 
 describe InfluxDB::Client do
   let(:subject) do
-    described_class.new "database", {
+    described_class.new "database", **{
       host:           "influxdb.test",
       port:           9999,
       username:       "username",
@@ -17,7 +17,7 @@ describe InfluxDB::Client do
   describe "#create_cluster_admin" do
     let(:user) { 'adminadmin' }
     let(:pass) { 'passpass' }
-    let(:query) { "CREATE USER #{user} WITH PASSWORD '#{pass}' WITH ALL PRIVILEGES" }
+    let(:query) { "CREATE USER \"#{user}\" WITH PASSWORD '#{pass}' WITH ALL PRIVILEGES" }
 
     context 'with existing admin user' do
       before do
@@ -67,7 +67,7 @@ describe InfluxDB::Client do
 
   describe "#revoke_cluster_admin_privileges" do
     let(:user) { 'useruser' }
-    let(:query) { "REVOKE ALL PRIVILEGES FROM #{user}" }
+    let(:query) { "REVOKE ALL PRIVILEGES FROM \"#{user}\"" }
 
     before do
       stub_request(:get, "http://influxdb.test:9999/query").with(

data/spec/influxdb/cases/query_continuous_query_spec.rb

@@ -104,7 +104,7 @@ describe InfluxDB::Client do
   describe "#delete_continuous_query" do
     let(:name) { "event_counts_per_10m_by_type" }
     let(:database) { "testdb" }
-    let(:query) { "DROP CONTINUOUS QUERY #{name} ON #{database}" }
+    let(:query) { "DROP CONTINUOUS QUERY \"#{name}\" ON \"#{database}\"" }
 
     before do
       stub_request(:get, "http://influxdb.test:9999/query")

data/spec/influxdb/cases/query_database_spec.rb

@@ -23,7 +23,7 @@ describe InfluxDB::Client do
 
   describe "#create_database" do
     describe "from param" do
-      let(:query) { "CREATE DATABASE foo" }
+      let(:query) { "CREATE DATABASE \"foo\"" }
 
       it "should GET to create a new database" do
         expect(subject.create_database("foo")).to be_a(Net::HTTPOK)
@@ -31,7 +31,7 @@ describe InfluxDB::Client do
     end
 
     describe "from config" do
-      let(:query) { "CREATE DATABASE database" }
+      let(:query) { "CREATE DATABASE \"database\"" }
 
       it "should GET to create a new database using database name from config" do
         expect(subject.create_database).to be_a(Net::HTTPOK)
@@ -41,7 +41,7 @@ describe InfluxDB::Client do
 
   describe "#delete_database" do
     describe "from param" do
-      let(:query) { "DROP DATABASE foo" }
+      let(:query) { "DROP DATABASE \"foo\"" }
 
       it "should GET to remove a database" do
         expect(subject.delete_database("foo")).to be_a(Net::HTTPOK)
@@ -49,7 +49,7 @@ describe InfluxDB::Client do
     end
 
     describe "from config" do
-      let(:query) { "DROP DATABASE database" }
+      let(:query) { "DROP DATABASE \"database\"" }
 
       it "should GET to remove a database using database name from config" do
         expect(subject.delete_database).to be_a(Net::HTTPOK)

data/spec/influxdb/cases/query_series_spec.rb

@@ -5,7 +5,7 @@ describe InfluxDB::Client do
   let(:subject) do
     described_class.new(
       "database",
-      {
+      **{
         host:           "influxdb.test",
         port:           9999,
         username:       "username",
@@ -49,16 +49,32 @@ describe InfluxDB::Client do
   end
 
   describe "#delete_series" do
-    let(:name) { "events" }
-    let(:query) { "DROP SERIES FROM #{name}" }
+    describe "without a where clause" do
+      let(:name) { "events" }
+      let(:query) { "DROP SERIES FROM \"#{name}\"" }
 
-    before do
-      stub_request(:get, "http://influxdb.test:9999/query")
-        .with(query: { u: "username", p: "password", q: query, db: "database" })
+      before do
+        stub_request(:get, "http://influxdb.test:9999/query")
+          .with(query: { u: "username", p: "password", q: query, db: "database" })
+      end
+
+      it "should GET to remove a database" do
+        expect(subject.delete_series(name)).to be_a(Net::HTTPOK)
+      end
     end
 
-    it "should GET to remove a database" do
-      expect(subject.delete_series(name)).to be_a(Net::HTTPOK)
+    describe "with a where clause" do
+      let(:name) { "events" }
+      let(:query) { "DROP SERIES FROM \"#{name}\" WHERE \"tag\"='value'" }
+
+      before do
+        stub_request(:get, "http://influxdb.test:9999/query")
+          .with(query: { u: "username", p: "password", q: query, db: "database" })
+      end
+
+      it "should GET to remove a database" do
+        expect(subject.delete_series(name, where: "\"tag\"='value'")).to be_a(Net::HTTPOK)
+      end
     end
   end
 end

data/spec/influxdb/cases/query_user_spec.rb

@@ -24,7 +24,7 @@ describe InfluxDB::Client do
   describe "#update user password" do
     let(:user) { 'useruser' }
     let(:pass) { 'passpass' }
-    let(:query) { "SET PASSWORD FOR #{user} = '#{pass}'" }
+    let(:query) { "SET PASSWORD FOR \"#{user}\" = '#{pass}'" }
 
     it "should GET to update user password" do
       expect(subject.update_user_password(user, pass)).to be_a(Net::HTTPOK)
@@ -35,7 +35,7 @@ describe InfluxDB::Client do
     let(:user) { 'useruser' }
     let(:perm) { :write }
     let(:db) { 'foo' }
-    let(:query) { "GRANT #{perm.to_s.upcase} ON #{db} TO #{user}" }
+    let(:query) { "GRANT #{perm.to_s.upcase} ON \"#{db}\" TO \"#{user}\"" }
 
     it "should GET to grant privileges for a user on a database" do
       expect(subject.grant_user_privileges(user, db, perm)).to be_a(Net::HTTPOK)
@@ -44,7 +44,7 @@ describe InfluxDB::Client do
 
   describe "#grant_user_admin_privileges" do
     let(:user) { 'useruser' }
-    let(:query) { "GRANT ALL PRIVILEGES TO #{user}" }
+    let(:query) { "GRANT ALL PRIVILEGES TO \"#{user}\"" }
 
     it "should GET to grant privileges for a user on a database" do
       expect(subject.grant_user_admin_privileges(user)).to be_a(Net::HTTPOK)
@@ -55,7 +55,7 @@ describe InfluxDB::Client do
     let(:user) { 'useruser' }
     let(:perm) { :write }
     let(:db) { 'foo' }
-    let(:query) { "REVOKE #{perm.to_s.upcase} ON #{db} FROM #{user}" }
+    let(:query) { "REVOKE #{perm.to_s.upcase} ON \"#{db}\" FROM \"#{user}\"" }
 
     it "should GET to revoke privileges from a user on a database" do
       expect(subject.revoke_user_privileges(user, db, perm)).to be_a(Net::HTTPOK)
@@ -66,7 +66,7 @@ describe InfluxDB::Client do
     let(:user) { 'useruser' }
     let(:pass) { 'passpass' }
     let(:db) { 'foo' }
-    let(:query) { "CREATE user #{user} WITH PASSWORD '#{pass}'; GRANT ALL ON #{db} TO #{user}" }
+    let(:query) { "CREATE user \"#{user}\" WITH PASSWORD '#{pass}'; GRANT ALL ON \"#{db}\" TO \"#{user}\"" }
 
     context "without specifying permissions" do
       it "should GET to create a new database user with all permissions" do
@@ -76,7 +76,7 @@ describe InfluxDB::Client do
 
     context "with passing permission as argument" do
       let(:permission) { :read }
-      let(:query) { "CREATE user #{user} WITH PASSWORD '#{pass}'; GRANT #{permission.to_s.upcase} ON #{db} TO #{user}" }
+      let(:query) { "CREATE user \"#{user}\" WITH PASSWORD '#{pass}'; GRANT #{permission.to_s.upcase} ON \"#{db}\" TO \"#{user}\"" }
 
       it "should GET to create a new database user with permission set" do
         expect(subject.create_database_user(db, user, pass, permissions: permission)).to be_a(Net::HTTPOK)
@@ -86,7 +86,7 @@ describe InfluxDB::Client do
 
   describe "#delete_user" do
     let(:user) { 'useruser' }
-    let(:query) { "DROP USER #{user}" }
+    let(:query) { "DROP USER \"#{user}\"" }
 
     it "should GET to delete a user" do
       expect(subject.delete_user(user)).to be_a(Net::HTTPOK)
@@ -105,7 +105,7 @@ describe InfluxDB::Client do
 
   describe "#list_user_grants" do
     let(:user) { 'useruser' }
-    let(:list_query) { "SHOW GRANTS FOR #{user}" }
+    let(:list_query) { "SHOW GRANTS FOR \"#{user}\"" }
 
     before do
       stub_request(:get, "http://influxdb.test:9999/query")

data/spec/influxdb/cases/querying_issue_7000_spec.rb

@@ -6,7 +6,7 @@ require "json"
 
 describe InfluxDB::Client do
   let(:subject) do
-    described_class.new "database", {
+    described_class.new "database", **{
       host:           "influxdb.test",
       port:           9999,
       username:       "username",

data/spec/influxdb/cases/querying_spec.rb

@@ -3,7 +3,7 @@ require "json"
 
 describe InfluxDB::Client do
   let(:subject) do
-    described_class.new "database", {
+    described_class.new "database", **{
       host:           "influxdb.test",
       port:           9999,
       username:       "username",

data/spec/influxdb/cases/retry_requests_spec.rb

@@ -5,7 +5,7 @@ describe InfluxDB::Client do
   let(:client) do
     described_class.new(
       "database",
-      {
+      **{
         host:           "influxdb.test",
         port:           9999,
         username:       "username",

data/spec/influxdb/cases/udp_client_spec.rb

@@ -1,7 +1,10 @@
 require "spec_helper"
 
 describe InfluxDB::Client do
-  let(:client) { described_class.new(udp: { host: "localhost", port: 44_444 }) }
+  let(:socket) { UDPSocket.new.tap { |s| s.bind "localhost", 0 } }
+  after        { socket.close rescue nil }
+
+  let(:client) { described_class.new(udp: { host: "localhost", port: socket.addr[1] }) }
 
   specify { expect(client.writer).to be_a(InfluxDB::Writer::UDP) }
 
@@ -9,32 +12,23 @@ describe InfluxDB::Client do
     let(:message) { 'responses,region=eu value=5i' }
 
     it "sends a UDP packet" do
-      s = UDPSocket.new
-      s.bind("localhost", 44_444)
-
       client.write_point("responses", values: { value: 5 }, tags: { region: 'eu' })
 
-      rec_message = s.recvfrom(30).first
+      rec_message = socket.recvfrom(30).first
       expect(rec_message).to eq message
-
-      s.close
     end
   end
 
   describe "#write with discard_write_errors" do
     let(:client) do
-      described_class.new(
-        udp:                  { host: "localhost", port: 44_444 },
+      described_class.new \
+        udp:                  { host: "localhost", port: socket.addr[1] },
         discard_write_errors: true
-      )
     end
 
     it "doesn't raise" do
-      s = UDPSocket.new
-      s.bind("localhost", 44_444)
-
       client.write_point("responses", values: { value: 5 }, tags: { region: 'eu' })
-      s.close
+      socket.close
 
       client.write_point("responses", values: { value: 7 }, tags: { region: 'eu' })
 

data/spec/influxdb/client_spec.rb

@@ -5,7 +5,7 @@ describe InfluxDB::Client do
   let(:subject) do
     described_class.new(
       "database",
-      {
+      **{
         host:           "influxdb.test",
         port:           9999,
         username:       "username",
@@ -47,7 +47,7 @@ describe InfluxDB::Client do
     it "escapes params" do
       url = subject.send(:full_url, "/unknown", value: ' !@#$%^&*()/\\_+-=?|`~')
       encoded_fragment = "value=+%21%40%23%24%25%5E%26%2A%28%29%2F%5C_%2B-%3D%3F%7C%60"
-      encoded_fragment << (RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.5.0" ? "~" : "%7E")
+      encoded_fragment << (RUBY_VERSION >= "2.5.0" ? "~" : "%7E")
       expect(url).to include(encoded_fragment)
     end
 

data/spec/influxdb/config_spec.rb

@@ -1,11 +1,15 @@
 require 'spec_helper'
 
 describe InfluxDB::Config do
-  let(:conf) do
-    InfluxDB::Client.new(*args).config
+  after { client.stop! }
+
+  let(:client) do
+    kwargs = args.last.is_a?(Hash) ? args.pop : {}
+    InfluxDB::Client.new(*args, **kwargs)
   end
+  let(:conf) { client.config }
 
-  let(:args) { {} }
+  let(:args) { [] }
 
   context "with no parameters specified" do
     specify { expect(conf.database).to be_nil }
@@ -20,17 +24,19 @@ describe InfluxDB::Config do
     specify { expect(conf).not_to be_udp }
     specify { expect(conf).not_to be_async }
     specify { expect(conf.epoch).to be_falsey }
+    specify { expect(conf.proxy_addr).to be_nil }
+    specify { expect(conf.proxy_port).to be_nil }
   end
 
   context "with no database specified" do
     let(:args) do
-      [{
+      [
         host:           "host",
         port:           "port",
         username:       "username",
         password:       "password",
         time_precision: "m"
-      }]
+      ]
     end
 
     specify { expect(conf.database).to be_nil }
@@ -64,7 +70,7 @@ describe InfluxDB::Config do
   end
 
   context "with ssl option specified" do
-    let(:args) { [{ use_ssl: true }] }
+    let(:args) { [use_ssl: true] }
 
     specify { expect(conf.database).to be_nil }
     specify { expect(conf.hosts).to eq ["localhost"] }
@@ -75,7 +81,7 @@ describe InfluxDB::Config do
   end
 
   context "with multiple hosts specified" do
-    let(:args) { [{ hosts: ["1.1.1.1", "2.2.2.2"] }] }
+    let(:args) { [hosts: ["1.1.1.1", "2.2.2.2"]] }
 
     specify { expect(conf.database).to be_nil }
     specify { expect(conf.port).to eq 8086 }
@@ -85,7 +91,7 @@ describe InfluxDB::Config do
   end
 
   context "with auth_method basic auth specified" do
-    let(:args) { [{ auth_method: 'basic_auth' }] }
+    let(:args) { [auth_method: 'basic_auth'] }
 
     specify { expect(conf.database).to be_nil }
     specify { expect(conf.hosts).to eq ["localhost"] }
@@ -96,38 +102,38 @@ describe InfluxDB::Config do
   end
 
   context "with udp specified with params" do
-    let(:args) { [{ udp: { host: 'localhost', port: 4444 } }] }
+    let(:args) { [udp: { host: 'localhost', port: 4444 }] }
 
     specify { expect(conf).to be_udp }
   end
 
   context "with udp specified as true" do
-    let(:args) { [{ udp: true }] }
+    let(:args) { [udp: true] }
 
     specify { expect(conf).to be_udp }
   end
 
   context "with async specified with params" do
-    let(:args) { [{ async: { max_queue: 20_000 } }] }
+    let(:args) { [async: { max_queue: 20_000 }] }
 
     specify { expect(conf).to be_async }
   end
 
   context "with async specified as true" do
-    let(:args) { [{ async: true }] }
+    let(:args) { [async: true] }
 
     specify { expect(conf).to be_async }
   end
 
   context "with epoch specified as seconds" do
-    let(:args) { [{ epoch: 's' }] }
+    let(:args) { [epoch: 's'] }
 
     specify { expect(conf.epoch).to eq 's' }
   end
 
   context "given a config URL" do
     let(:url) { "https://foo:bar@influx.example.com:8765/testdb?open_timeout=42&unknown=false&denormalize=false" }
-    let(:args) { [{ url: url }] }
+    let(:args) { [url: url] }
 
     it "applies values found in URL" do
       expect(conf.database).to eq "testdb"
@@ -156,6 +162,15 @@ describe InfluxDB::Config do
       expect(conf).not_to be_async
     end
 
+    context "with encoded values" do
+      let(:url) { "https://weird%24user:weird%25pass@influx.example.com:8765/testdb" }
+
+      it "decode encoded values" do
+        expect(conf.username).to eq "weird$user"
+        expect(conf.password).to eq "weird%pass"
+      end
+    end
+
     context "UDP" do
       let(:url) { "udp://test.localhost:2345?discard_write_errors=1" }
       specify { expect(conf).to be_udp }
@@ -205,4 +220,19 @@ describe InfluxDB::Config do
       expect(conf).not_to be_async
     end
   end
+
+  context "given explicit proxy information" do
+    let(:args) do
+      [host:           "host",
+       port:           "port",
+       username:       "username",
+       password:       "password",
+       time_precision: "m",
+       proxy_addr:     "my.proxy.addr",
+       proxy_port:     8080]
+    end
+
+    specify { expect(conf.proxy_addr).to eq("my.proxy.addr") }
+    specify { expect(conf.proxy_port).to eq(8080) }
+  end
 end