influxdb_data_harvester 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b359dcd1335973eb36a54826e14e9a675e5aaf31
+  data.tar.gz: ab055deb8fe63127cd4756bdf20c6f460e20dba9
+SHA512:
+  metadata.gz: 520357f4eb4749663cdf6fcdf0ff8fa64d1c7800f9a1d69fe6070cb421a1a8d264ea208cd8da56c70048092d1ca1b0dc487b6585d474661038c0e59e143cad0a
+  data.tar.gz: 42983fc0327640d488925c1ad7821368f4afaca1ca7fafd9a8d140a01fc5b30cc94d4da0cef3ce60159ea4c5b28ee95d07677222ff7020ae883c7db77f38da9f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/influxdb_data_harvester.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'influxdb'
+require 'concurrent/promise'
+
+# InfluxdbDataHarvester sends rspec result data to a database (InfluxDB)
+# Allows aggregating the results of Rspec tests in one location.
+class InfluxDBDataHarvester
+  attr_reader :database_client
+
+  def initialize(database: 'master', host: '127.0.0.1')
+    @database_client = InfluxDB::Client.new database: database,
+                                            host: host,
+                                            time_precision: 'u'
+  end
+
+  def generate_payload(example, extra_data: nil, tags: nil)
+    # Rspec status is populated when the rspec after hooks complete, wait until then
+    Timeout.timeout(5) { sleep 0.0001 while example.execution_result.status.nil? }
+
+    data = default_data(example)
+    data[:values].merge! extra_data if extra_data
+    data[:tags] = tags if tags
+    data
+  end
+
+  def queue_send_data(example, series: 'test_results', extra_data: nil, tags: nil)
+    Concurrent::Promise.execute { send_data(example, series, extra_data: extra_data, tags: tags) }
+  end
+
+  private
+
+  def default_data(example)
+    {
+      values: { duration: example.execution_result.run_time,
+                result: example.execution_result.status.to_s,
+                name: example.metadata[:full_description],
+                source_environment: source_environment }
+    }
+  end
+
+  def send_data(example, series, extra_data: nil, tags: nil)
+    return if source_environment == 'bitbucket'
+
+    data = generate_payload(example, extra_data: extra_data, tags: tags)
+    @database_client.write_point(series, data)
+  end
+
+  def source_environment
+    ENV['source_environment'] ||= 'local'
+  end
+end

data/spec/influxdb_data_harvester_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'influxdb_data_harvester'
+require 'rspec/eventually'
+require 'webmock/rspec'
+
+describe InfluxDBDataHarvester do
+  subject(:harvester) { described_class.new }
+
+  let(:current_example) do
+    metadata = {
+      description: 'can send test data',
+      full_description: 'InfluxdbDataHarvester can send test data',
+      file_path: './spec/data_harvester_spec.rb',
+      line_number: 26,
+      location: './spec/data_harvester_spec.rb:26',
+      absolute_file_path: '/Development/spec/data_harvester_spec.rb',
+      rerun_file_path: './spec/data_harvester_spec.rb',
+      last_run_status: 'passed'
+    }
+    current_example = RSpec.current_example
+    metadata.each do |key, value|
+      current_example.metadata[key] = value
+    end
+    current_example.execution_result.status = 'passed'
+    current_example
+  end
+
+  before do
+    stub_request(:any, '127.0.0.1')
+    query = { db: 'master', p: 'root', precision: 'u', u: 'root' }
+    body  = 'test_results duration=,result="passed",'
+    body += 'name="InfluxdbDataHarvester can send test data",source_environment="local"'
+    @request = a_request(:post, '127.0.0.1:8086/write').with(body: body, query: query)
+  end
+
+  it 'can send test data' do
+    harvester.queue_send_data(current_example)
+    # Need to find out what expectation to check here
+    expect { @request }.to eventually(have_been_made.once).within 2
+  end
+
+  context 'can be customized' do
+    subject(:custom_database_harvester) { described_class.new database: 'test_run_results' }
+
+    before do
+      query = { db: 'test_run_results', p: 'root', precision: 'u', u: 'root' }
+      body  = 'test_results duration=,result="passed",'
+      body += 'name="InfluxdbDataHarvester can send test data",source_environment="local"'
+      @request = a_request(:post, '127.0.0.1:8086/write').with(body: body, query: query)
+    end
+
+    it 'to use a different database' do
+      custom_database_harvester.queue_send_data(current_example)
+      expect { @request }.to eventually(have_been_made.once).within 2
+    end
+  end
+
+  it 'generates payload that includes full description' do
+    data = harvester.generate_payload(current_example)
+    expect(data[:values][:name]).to eq 'InfluxdbDataHarvester can send test data'
+  end
+
+  it 'supports custom data in the payload' do
+    query = { db: 'master', p: 'root', precision: 'u', u: 'root' }
+    body  = 'test_results duration=,result="passed",'
+    body += 'name="InfluxdbDataHarvester can send test data",source_environment="local"'
+    body += ',custom_field="custom_data"'
+    request = a_request(:post, '127.0.0.1:8086/write').with(body: body, query: query)
+
+    custom_data = {
+      custom_field: 'custom_data'
+    }
+
+    harvester.queue_send_data(current_example, extra_data: custom_data)
+    expect { request }.to eventually(have_been_made.once).within 2
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: influxdb_data_harvester
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Felix Barros
+- Tom Mason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  name: rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: webmock
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  name: concurrent-ruby
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  name: influxdb
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  name: rspec-eventually
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description:
+email:
+- felix.barros@finalsite.com
+- tom.mason@finalsite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- VERSION
+- lib/influxdb_data_harvester.rb
+- spec/influxdb_data_harvester_spec.rb
+homepage: https://finalsite.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.14.1
+signing_key:
+specification_version: 4
+summary: Allows aggregating results of Rspec tests into InfluxDB
+test_files:
+- spec/influxdb_data_harvester_spec.rb