coverband-service-client 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d70bb9e3268a13b06640e0437e517cf00ccc4030f2b7f2c20e7b314d26828e2
-  data.tar.gz: 3400abcd93c90f5f8bb011757933dd08b0619ef907d3f2675a1326bb5eb7a102
+  metadata.gz: 613941985d4fb60122f3e35a84c5139a7aa1395008a443b3a3478eef59df2b30
+  data.tar.gz: 03eabff6d96401aede1ed1263fdc26a400e93fc4e26ad164977e6b77a4b9a4a7
 SHA512:
-  metadata.gz: fd6972fc75a2e8320a6ce2f991e871df0fed4c6a1298e0d2a443c479d309aca58d56f6c9c0aa346731fec7e1a9e12836e2cdb18480bd687667804f7b3d2a802d
-  data.tar.gz: e4bd36b15a82c5ab95fcc770909d04b3426d818a1468b90cf1f45667facd1f4fda9d37809c667c85b822b7b8651f3f8576d8323914c331bf207a6458bad81e99
+  metadata.gz: 2d800e7c8abc0056866a6f9f96b1c89b9c1fc2ebcd7f5bdc17477199445f5740cc968d795cca1ad9a2ca9951480f32b8960f8e4729e975c2f19eea69aa57c8e7
+  data.tar.gz: 32d5360aa6a50d722d53481f22736e8c47c05844b9372fdd3d1e993ea2209fbdd3043e66dd2c016aad04df7195cffeb124d9fa8ca4bd66ce361f75462a368ffa

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    coverband-service-client (0.0.8)
+    coverband-service-client (0.0.9)
       coverband (~> 4.2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coverband (4.2.4)
+    coverband (4.2.5)
       redis
     minitest (5.14.0)
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.1.4)
 
 PLATFORMS
   ruby

data/lib/coverband-service-client.rb

@@ -4,21 +4,26 @@ require 'coverband'
 require 'coverband/service/client/version'
 require 'securerandom'
 
-COVERBAND_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || (defined?(Rails) ? Rails.env : 'unknown')
-COVERBAND_SERVICE_URL = ENV['COVERBAND_URL'] || 'https://coverband.io'
-COVERBAND_TIMEOUT = (COVERBAND_ENV == 'development') ? 5 : 1
-COVERBAND_ENABLE_DEV_MODE = ENV['COVERBAND_ENABLE_DEV_MODE'] || false
-COVERBAND_ENABLE_TEST_MODE = ENV['COVERBAND_ENABLE_TEST_MODE'] || false
-COVERBAND_PROCESS_TYPE = ENV['PROCESS_TYPE'] || 'unknown'
-COVERBAND_REPORT_PERIOD = (ENV['COVERBAND_REPORT_PERIOD'] || 600).to_i
-
 module Coverband
+  COVERBAND_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || (defined?(Rails) ? Rails.env : 'unknown')
+  COVERBAND_SERVICE_URL = ENV['COVERBAND_URL'] || 'https://coverband.io'
+  COVERBAND_TIMEOUT = (COVERBAND_ENV == 'development') ? 5 : 1
+  COVERBAND_ENABLE_DEV_MODE = ENV['COVERBAND_ENABLE_DEV_MODE'] || false
+  COVERBAND_ENABLE_TEST_MODE = ENV['COVERBAND_ENABLE_TEST_MODE'] || false
+  COVERBAND_PROCESS_TYPE = ENV['PROCESS_TYPE'] || 'unknown'
+  COVERBAND_REPORT_PERIOD = (ENV['COVERBAND_REPORT_PERIOD'] || 600).to_i
+
+  def self.service_disabled_dev_test_env?
+    (COVERBAND_ENV == 'test' && !COVERBAND_ENABLE_TEST_MODE) ||
+      (COVERBAND_ENV == 'development' && !COVERBAND_ENABLE_DEV_MODE)
+  end
 
-  if ((COVERBAND_ENV == 'test' && !COVERBAND_ENABLE_TEST_MODE) ||
-       COVERBAND_ENV == 'development' && !COVERBAND_ENABLE_DEV_MODE
-     )
+  if service_disabled_dev_test_env?
     def self.report_coverage
-      # for now disable coverband reporting in test env by default
+      # for now disable coverband reporting in test & dev env by default
+      if Coverband.configuration.verbose
+        puts "Coverband: disabled for #{COVERBAND_ENV}, set COVERBAND_ENABLE_DEV_MODE or COVERBAND_ENABLE_TEST_MODE to enable"
+      end
     end
   end
 
@@ -40,6 +45,10 @@ module Coverband
           @runtime_env = opts.fetch(:runtime_env) { COVERBAND_ENV }
         end
 
+        def logger
+          Coverband.configuration.logger
+        end
+
         def clear!
           # TBD
         end
@@ -53,11 +62,15 @@ module Coverband
           0
         end
 
+        def api_key
+          ENV['COVERBAND_API_KEY'] || Coverband.configuration.api_key
+        end
+
         # TODO: no longer get by type just get both reports in a single request
         def coverage(local_type = nil, opts = {})
           local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
           uri = URI("#{coverband_url}/api/coverage/#{ENV['COVERBAND_ID']}?type=#{local_type}")
-          req = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+          req = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => api_key)
           res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
             http.request(req)
           end
@@ -70,7 +83,6 @@ module Coverband
         end
 
         def save_report(report)
-          #puts caller.join(',')
           return if report.empty?
 
           # TODO: do we need dup
@@ -99,12 +111,18 @@ module Coverband
         private
 
         def save_coverage(data)
+          if api_key.nil?
+            puts "Coverband: Error: no Coverband API key was found!"
+          end
+
           uri = URI("#{coverband_url}/api/collector")
+          logger&.info "Coverband: saving #{uri}" if Coverband.configuration.verbose
           req = Net::HTTP::Post.new(uri,
                                     'Content-Type' => 'application/json',
-                                    'Coverband-Token' => ENV['COVERBAND_API_KEY'])
-          # puts "sending #{data}"
+                                    'Coverband-Token' => api_key)
           req.body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+
+          logger&.info "Coverband: saving #{req.body}" if Coverband.configuration.verbose
           res = Net::HTTP.start(
             uri.hostname,
             uri.port,
@@ -155,6 +173,10 @@ module Coverband
 
       private
 
+      def logger
+        Coverband.configuration.logger
+      end
+
       def save_tracked_views(views:, reported_time:)
         uri = URI("#{COVERBAND_SERVICE_URL}/api/collector")
         req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
@@ -180,19 +202,39 @@ module Coverband
   end
 end
 
+module Coverband
+  class Configuration
+    attr_accessor :api_key
+  end
+end
+
 Coverband.configure do |config|
   # Use The Test Service Adapter
-  config.store = Coverband::Adapters::Service.new(COVERBAND_SERVICE_URL)
+  config.store = Coverband::Adapters::Service.new(Coverband::COVERBAND_SERVICE_URL)
 
   # default to tracking views true
-  config.track_views = ENV['COVERBAND_DISABLE_VIEW_TRACKER'] ? false : true
+  config.track_views = if ENV['COVERBAND_DISABLE_VIEW_TRACKER']
+      false
+    elsif Coverband.service_disabled_dev_test_env?
+      false
+    else
+      true
+    end
 
   # report every 10m by default
-  config.background_reporting_sleep_seconds = COVERBAND_ENV == 'production' ? COVERBAND_REPORT_PERIOD : 60
+  config.background_reporting_sleep_seconds = Coverband::COVERBAND_ENV == 'production' ? Coverband::COVERBAND_REPORT_PERIOD : 60
   # add a wiggle to avoid service stampede
-  config.reporting_wiggle = COVERBAND_ENV == 'production' ? 90 : 6
+  config.reporting_wiggle = Coverband::COVERBAND_ENV == 'production' ? 90 : 6
 
-  if COVERBAND_ENV == 'test'
+  if Coverband::COVERBAND_ENV == 'test'
     config.background_reporting_enabled = false
   end
 end
+
+# NOTE: it is really hard to bypass / overload our config we should fix this in Coverband
+# this hopefully detects anyone that has both gems and was trying to configure Coverband themselves.
+if File.exist?('./config/coverband.rb')
+  puts "Warning: config/coverband.rb found, this overrides coverband service allowing one to setup open source Coverband"
+end
+
+Coverband.configure('./config/coverband_service.rb') if File.exist?('./config/coverband_service.rb')

data/lib/coverband/service/client/version.rb

@@ -1,7 +1,7 @@
 module Coverband
   module Service
     module Client
-      VERSION = '0.0.8'
+      VERSION = '0.0.9'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband-service-client
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler