influxdb-client 1.3.0

data/test/influxdb/point_test.rb

@@ -0,0 +1,221 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class PointTest < MiniTest::Test
+  def test_to_line_protocol
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5, saturation: '99%' }, time: 123)
+    assert_equal 'h2o,host=aws,region=us level=5i,saturation="99%" 123', point_args.to_line_protocol
+
+    point_hash = InfluxDB2::Point.from_hash(name: 'h2o',
+                                            tags: { host: 'aws', region: 'us' },
+                                            fields: { level: 5, saturation: '99%' }, time: 123)
+    assert_equal 'h2o,host=aws,region=us level=5i,saturation="99%" 123', point_hash.to_line_protocol
+  end
+
+  def test_measurement_escape
+    point = InfluxDB2::Point.new(name: 'h2 o', tags: { location: 'europe' }, fields: { level: 2 })
+    assert_equal 'h2\\ o,location=europe level=2i', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2,o', tags: { location: 'europe' }, fields: { level: 2 })
+    assert_equal 'h2\\,o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_tag_empty_key
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: 2 }).add_tag('location', 'europe').add_tag('', 'warn')
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_tag_empty_value
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: 2 }).add_tag('location', 'europe').add_tag('log', '')
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_override_tag_and_field
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: '1' })
+                            .add_tag('location', 'europe')
+                            .add_tag('location', 'europe2')
+                            .add_field(:level, 2)
+                            .add_field(:level, 3)
+
+    assert_equal 'h2o,location=europe2 level=3i', point.to_line_protocol
+  end
+
+  def test_field_types
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('tag_b', 'b')
+                            .add_tag('tag_a', 'a')
+                            .add_field('n1', -2)
+                            .add_field('n2', 10)
+                            .add_field('n3', 1_265_437_718_438_866_624_512)
+                            .add_field('n4', 5.5)
+                            .add_field('bool', true)
+                            .add_field('string', 'string value')
+
+    expected = 'h2o,tag_a=a,tag_b=b bool=true,n1=-2i,n2=10i,n3=1265437718438866624512i,n4=5.5,string="string value"'
+    assert_equal expected, point.to_line_protocol
+  end
+
+  def test_field_null_value
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .add_field('warning', nil)
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_field_escape
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 'string esc\\ape value')
+
+    assert_equal 'h2o,location=europe level="string esc\\\\ape value"', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 'string esc"ape value')
+
+    assert_equal 'h2o,location=europe level="string esc\"ape value"', point.to_line_protocol
+  end
+
+  def test_time
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 123', point.to_line_protocol
+  end
+
+  def test_time_formatting
+    time = Time.utc(2015, 10, 15, 8, 20, 15)
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::MILLISECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::SECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::MICROSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+  end
+
+  def test_time_formatting_default
+    time = Time.utc(2015, 10, 15, 8, 20, 15)
+
+    point = InfluxDB2::Point.new(name: 'h2o', time: time)
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, nil)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+  end
+
+  def test_time_string
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: '123')
+
+    assert_equal 'h2o,host=aws,region=us level=5i 123', point_args.to_line_protocol
+  end
+
+  def test_time_float
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: 1.444897215e+18)
+
+    assert_equal 'h2o,host=aws,region=us level=5i 1444897215000000000', point_args.to_line_protocol
+
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: 102_030_405_060)
+
+    assert_equal 'h2o,host=aws,region=us level=5i 102030405060', point_args.to_line_protocol
+  end
+
+  def test_utf_8
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'Přerov')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=Přerov level=2i 123', point.to_line_protocol
+  end
+
+  def test_infinity_values
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('infinity_constant', Float::INFINITY)
+                            .add_field('infinity_positive', 1 / 0.0)
+                            .add_field('infinity_negative', -1 / 0.0)
+                            .add_field('level', 2)
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_only_infinity_values
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('infinity_constant', Float::INFINITY)
+                            .add_field('infinity_positive', 1 / 0.0)
+                            .add_field('infinity_negative', -1 / 0.0)
+
+    assert_nil point.to_line_protocol
+  end
+
+  def test_without_tags
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o level=2i 123', point.to_line_protocol
+  end
+end

data/test/influxdb/query_api_integration_test.rb

@@ -0,0 +1,58 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class QueryApiIntegrationTest < MiniTest::Test
+  def setup
+    WebMock.allow_net_connect!
+
+    @client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+  end
+
+  def test_query
+    now = Time.now.utc
+    measurement = 'h2o_query_' + now.to_i.to_s + now.nsec.to_s
+
+    @client.create_write_api.write(data: InfluxDB2::Point.new(name: measurement)
+                                                         .add_tag('location', 'europe')
+                                                         .add_field('level', 2)
+                                                         .time(now, InfluxDB2::WritePrecision::NANOSECOND))
+
+    result = @client.create_query_api.query(query: 'from(bucket: "my-bucket") |> range(start: -1m, stop: now()) '\
+          "|> filter(fn: (r) => r._measurement == \"#{measurement}\")")
+
+    assert_equal 1, result.size
+
+    records = result[0].records
+    assert_equal 1, records.size
+
+    record = records[0]
+
+    assert_equal measurement, record.measurement
+    assert_equal 'europe', record.values['location']
+    assert_equal 2, record.value
+    assert_equal 'level', record.field
+  end
+end

data/test/influxdb/query_api_stream_test.rb

@@ -0,0 +1,98 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class QueryApiStreamTest < MiniTest::Test
+  def setup
+    WebMock.allow_net_connect!
+
+    @client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+    @now = Time.now.utc
+  end
+
+  def test_query_stream
+    measurement = 'h2o_query_stream' + @now.to_i.to_s + @now.nsec.to_s
+    _write(10, measurement: measurement)
+
+    query = 'from(bucket: "my-bucket") |> range(start: -1m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+    count = 0
+    @client.create_query_api.query_stream(query: query).each do |record|
+      count += 1
+      assert_equal measurement, record.measurement
+      assert_equal 'europe', record.values['location']
+      assert_equal count, record.value
+      assert_equal 'level', record.field
+    end
+
+    assert_equal 10, count
+  end
+
+  def test_query_stream_break
+    measurement = 'h2o_query_stream_break' + @now.to_i.to_s + @now.nsec.to_s
+    _write(20, measurement: measurement)
+
+    query = 'from(bucket: "my-bucket") |> range(start: -1m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+    records = []
+
+    parser = @client.create_query_api.query_stream(query: query)
+
+    assert_equal false, parser.closed
+
+    count = 0
+    parser.each do |record|
+      records.push(record)
+      count += 1
+
+      break if count >= 5
+    end
+
+    assert_equal 5, records.size
+    assert_equal true, parser.closed
+
+    # record 1
+    record = records[0]
+    assert_equal measurement, record.measurement
+    assert_equal 'europe', record.values['location']
+    assert_equal 1, record.value
+    assert_equal 'level', record.field
+  end
+
+  private
+
+  def _write(values, measurement:)
+    write_api = @client.create_write_api
+
+    (1..values).each do |value|
+      write_api.write(data: InfluxDB2::Point.new(name: measurement)
+                                 .add_tag('location', 'europe')
+                                 .add_field('level', value)
+                                 .time(@now - values + value, InfluxDB2::WritePrecision::NANOSECOND))
+    end
+  end
+end

data/test/influxdb/query_api_test.rb

@@ -0,0 +1,96 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class QueryApiTest < MiniTest::Test
+  def setup
+    WebMock.disable_net_connect!
+  end
+
+  SUCCESS_DATA = '#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,' \
+    "long,string,string,string,string\n" \
+    "#group,false,false,false,false,false,false,false,false,false,true\n" + "#default,_result,,,,,,,,,\n" \
+    ",result,table,_start,_stop,_time,_value,_field,_measurement,host,region\n" \
+    ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,west\n" \
+    ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,20,free,mem,B,west\n" \
+    ",,0,1970-01-01T00:00:20Z,1970-01-01T00:00:30Z,1970-01-01T00:00:20Z,11,free,mem,A,west\n" \
+    ',,0,1970-01-01T00:00:20Z,1970-01-01T00:00:30Z,1970-01-01T00:00:20Z,22,free,mem,B,west'
+
+  def test_query_raw
+    stub_request(:post, 'http://localhost:9999/api/v2/query?org=my-org')
+      .to_return(body: SUCCESS_DATA)
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    bucket = 'my-bucket'
+    result = client.create_query_api.query_raw(query:
+      'from(bucket:"' + bucket + '") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
+
+    assert_equal result, SUCCESS_DATA
+  end
+
+  def test_query
+    stub_request(:post, 'http://localhost:9999/api/v2/query?org=my-org')
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    bucket = 'my-bucket'
+    result = client.create_query_api.query(query:
+      'from(bucket:"' + bucket + '") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
+
+    assert_equal 1, result.length
+    assert_equal 4, result[0].records.length
+
+    record1 = result[0].records[0]
+
+    assert_equal Time.parse('1970-01-01T00:00:10Z').to_datetime.rfc3339, record1.time
+    assert_equal 'mem', record1.measurement
+    assert_equal 10, record1.value
+    assert_equal 'free', record1.field
+  end
+
+  def test_headers
+    stub_request(:post, 'http://localhost:9999/api/v2/query?org=my-org')
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    client.create_query_api
+          .query(query: 'from(bucket:"my-bucket") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
+
+    headers = {
+      'Authorization' => 'Token my-token',
+      'User-Agent' => "influxdb-client-ruby/#{InfluxDB2::VERSION}",
+      'Content-Type' => 'application/json'
+    }
+    assert_requested(:post, 'http://localhost:9999/api/v2/query?org=my-org',
+                     times: 1, headers: headers)
+  end
+end