Class: Coverband::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/coverband/configuration.rb

Overview

Configuration parsing and options for the coverband gem.

Constant Summary collapse

IGNORE_TASKS =

TODO: This is is brittle and not a great solution to avoid deploy time actions polluting the ‘runtime’ metrics

  • Perhaps detect heroku deployment ENV var opposed to tasks?

["coverband:clear",
"coverband:coverage",
"coverband:coverage_server",
"coverband:migrate",
"assets:precompile",
"webpacker:compile",
"db:version",
"db:create",
"db:drop",
"db:seed",
"db:setup",
"db:test:prepare",
"db:structure:dump",
"db:structure:load",
"db:version"]
IGNORE_DEFAULTS =

Heroku when building assets runs code from a dynamic directory /tmp was added to avoid coverage from /tmp/build directories during heroku asset compilation

%w[vendor/ .erb$ .slim$ /tmp internal:prelude db/schema.rb]
TRACKED_DEFAULT_PATHS =

Add in missing files which were never loaded we need to know what all paths to check for unloaded files

%w[app lib config]
SKIPPED_SETTINGS = 
%w[@s3_secret_access_key @store @api_key @password]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



58
59
60
 
# File 'lib/coverband/configuration.rb', line 58

def initialize
  reset
end

Instance Attribute Details

#api_key ⇒ Object 



273
274
275
 
# File 'lib/coverband/configuration.rb', line 273

def api_key
  @api_key ||= ENV["COVERBAND_API_KEY"]
end

#background_reporting_enabled ⇒ Object

Returns the value of attribute background_reporting_enabled.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def background_reporting_enabled
  @background_reporting_enabled
end

#background_reporting_sleep_seconds ⇒ Object

The adjustments here either protect the redis or service from being overloaded the tradeoff being the delay in when reporting data is available if running your own redis increasing this number reduces load on the redis CPU



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/coverband/configuration.rb', line 159

def background_reporting_sleep_seconds
  @background_reporting_sleep_seconds ||= if service?
    # default to 10m for service
    (Coverband.configuration.coverband_env == "production") ? 600 : 60
  elsif store.is_a?(Coverband::Adapters::HashRedisStore)
    # Default to 5 minutes if using the hash redis store
    300
  else
    60
  end
end

#coverband_timeout ⇒ Object 



285
286
287
 
# File 'lib/coverband/configuration.rb', line 285

def coverband_timeout
  @coverband_timeout ||= (coverband_env == "development") ? 5 : 2
end

#csp_policy ⇒ Object

Returns the value of attribute csp_policy.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def csp_policy
  @csp_policy
end

#defer_eager_loading_data ⇒ Object

Returns the value of attribute defer_eager_loading_data.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def defer_eager_loading_data
  @defer_eager_loading_data
end

#gem_details ⇒ Object

Returns the value of attribute gem_details.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def gem_details
  @gem_details
end

#hide_settings ⇒ Object

Returns the value of attribute hide_settings.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def hide_settings
  @hide_settings
end

#ignore ⇒ Object

Returns the value of attribute ignore.



25
26
27
 
# File 'lib/coverband/configuration.rb', line 25

def ignore
  @ignore
end

#logger ⇒ Object 



144
145
146
147
148
149
150
 
# File 'lib/coverband/configuration.rb', line 144

def logger
  @logger ||= if defined?(Rails.logger) && Rails.logger
    Rails.logger
  else
    Logger.new(STDOUT)
  end
end

#paged_reporting ⇒ Object 



313
314
315
 
# File 'lib/coverband/configuration.rb', line 313

def paged_reporting
  !!@paged_reporting
end

#password ⇒ Object 



152
153
154
 
# File 'lib/coverband/configuration.rb', line 152

def password
  @password || ENV["COVERBAND_PASSWORD"]
end

#process_type ⇒ Object 



297
298
299
 
# File 'lib/coverband/configuration.rb', line 297

def process_type
  @process_type ||= ENV["PROCESS_TYPE"] || "unknown"
end

#redis_namespace ⇒ Object

Returns the value of attribute redis_namespace.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def redis_namespace
  @redis_namespace
end

#redis_ttl ⇒ Object

Returns the value of attribute redis_ttl.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def redis_ttl
  @redis_ttl
end

#redis_url ⇒ Object 



269
270
271
 
# File 'lib/coverband/configuration.rb', line 269

def redis_url
  @redis_url ||= ENV["COVERBAND_REDIS_URL"] || ENV["REDIS_URL"]
end

#report_on_exit ⇒ Object

Returns the value of attribute report_on_exit.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def report_on_exit
  @report_on_exit
end

#reporter ⇒ Object

Returns the value of attribute reporter.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def reporter
  @reporter
end

#reporting_wiggle ⇒ Object 



171
172
173
 
# File 'lib/coverband/configuration.rb', line 171

def reporting_wiggle
  @reporting_wiggle ||= 30
end

#root ⇒ Object

Returns the value of attribute root.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def root
  @root
end

#root_paths ⇒ Object

Returns the value of attribute root_paths.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def root_paths
  @root_paths
end

#route_tracker ⇒ Object

Returns the value of attribute route_tracker.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def route_tracker
  @route_tracker
end

#s3_access_key_id ⇒ Object 



332
333
334
 
# File 'lib/coverband/configuration.rb', line 332

def s3_access_key_id
  puts "deprecated, s3 is no longer support"
end

#s3_bucket ⇒ Object 



324
325
326
 
# File 'lib/coverband/configuration.rb', line 324

def s3_bucket
  puts "deprecated, s3 is no longer support"
end

#s3_region ⇒ Object 



328
329
330
 
# File 'lib/coverband/configuration.rb', line 328

def s3_region
  puts "deprecated, s3 is no longer support"
end

#s3_secret_access_key ⇒ Object 



336
337
338
 
# File 'lib/coverband/configuration.rb', line 336

def s3_secret_access_key
  puts "deprecated, s3 is no longer support"
end

#send_deferred_eager_loading_data=(value) ⇒ Object (writeonly)

Sets the attribute send_deferred_eager_loading_data

Parameters:

  • value —

    the value to set the attribute send_deferred_eager_loading_data to.



19
20
21
 
# File 'lib/coverband/configuration.rb', line 19

def send_deferred_eager_loading_data=(value)
  @send_deferred_eager_loading_data = value
end

#service_dev_mode ⇒ Object 



289
290
291
 
# File 'lib/coverband/configuration.rb', line 289

def service_dev_mode
  @service_dev_mode ||= ENV["COVERBAND_ENABLE_DEV_MODE"] || false
end

#service_test_mode ⇒ Object 



293
294
295
 
# File 'lib/coverband/configuration.rb', line 293

def service_test_mode
  @service_test_mode ||= ENV["COVERBAND_ENABLE_TEST_MODE"] || false
end

#service_url ⇒ Object 



277
278
279
 
# File 'lib/coverband/configuration.rb', line 277

def service_url
  @service_url ||= ENV["COVERBAND_URL"] || "https://coverband.io"
end

#simulate_oneshot_lines_coverage ⇒ Object

Returns the value of attribute simulate_oneshot_lines_coverage.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def simulate_oneshot_lines_coverage
  @simulate_oneshot_lines_coverage
end

#test_env ⇒ Object

Returns the value of attribute test_env.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def test_env
  @test_env
end

#track_gems ⇒ Object

Returns the value of attribute track_gems.



25
26
27
 
# File 'lib/coverband/configuration.rb', line 25

def track_gems
  @track_gems
end

#track_redirect_routes ⇒ Object

Returns the value of attribute track_redirect_routes.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def track_redirect_routes
  @track_redirect_routes
end

#track_routes ⇒ Object

Returns the value of attribute track_routes.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def track_routes
  @track_routes
end

#track_translations ⇒ Object

Returns the value of attribute track_translations.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def track_translations
  @track_translations
end

#track_views ⇒ Object 



202
203
204
205
206
 
# File 'lib/coverband/configuration.rb', line 202

def track_views
  return false if service_disabled_dev_test_env?

  @track_views
end

#trackers ⇒ Object

Returns the value of attribute trackers.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def trackers
  @trackers
end

#translations_tracker ⇒ Object

Returns the value of attribute translations_tracker.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def translations_tracker
  @translations_tracker
end

#use_oneshot_lines_coverage ⇒ Object

Returns the value of attribute use_oneshot_lines_coverage.



25
26
27
 
# File 'lib/coverband/configuration.rb', line 25

def use_oneshot_lines_coverage
  @use_oneshot_lines_coverage
end

#verbose ⇒ Object

Returns the value of attribute verbose.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def verbose
  @verbose
end

#view_tracker ⇒ Object

Returns the value of attribute view_tracker.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def view_tracker
  @view_tracker
end

#web_debug ⇒ Object

Returns the value of attribute web_debug.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def web_debug
  @web_debug
end

#web_enable_clear ⇒ Object

Returns the value of attribute web_enable_clear.



8
9
10
 
# File 'lib/coverband/configuration.rb', line 8

def web_enable_clear
  @web_enable_clear
end

Instance Method Details

#all_root_paths ⇒ Object 



236
237
238
239
240
241
242
 
# File 'lib/coverband/configuration.rb', line 236

def all_root_paths
  return @all_root_paths if @all_root_paths

  @all_root_paths = Coverband.configuration.root_paths.dup
  @all_root_paths << "#{Coverband.configuration.current_root}/"
  @all_root_paths
end

#all_root_patterns ⇒ Object 



244
245
246
 
# File 'lib/coverband/configuration.rb', line 244

def all_root_patterns
  @all_root_patterns ||= all_root_paths.map { |path| /^#{path}/ }.freeze
end

#coverband_env ⇒ Object 



281
282
283
 
# File 'lib/coverband/configuration.rb', line 281

def coverband_env
  ENV["RACK_ENV"] || ENV["RAILS_ENV"] || ((defined?(Rails) && Rails.respond_to?(:env)) ? Rails.env : "unknown")
end

#current_root ⇒ Object 



232
233
234
 
# File 'lib/coverband/configuration.rb', line 232

def current_root
  @current_root ||= File.expand_path(Coverband.configuration.root).freeze
end

#defer_eager_loading_data? ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
 
# File 'lib/coverband/configuration.rb', line 305

def defer_eager_loading_data?
  @defer_eager_loading_data
end

#one_shot_coverage_implemented_in_ruby_version? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'lib/coverband/configuration.rb', line 265

def one_shot_coverage_implemented_in_ruby_version?
  Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
end

#railtie! ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/coverband/configuration.rb', line 119

def railtie!
  if Coverband.configuration.track_routes
    Coverband.configuration.route_tracker = Coverband::Collectors::RouteTracker.new
    trackers << Coverband.configuration.route_tracker
  end

  if Coverband.configuration.track_translations
    Coverband.configuration.translations_tracker = Coverband::Collectors::TranslationTracker.new
    trackers << Coverband.configuration.translations_tracker
  end

  if Coverband.configuration.track_views
    Coverband.configuration.view_tracker = if Coverband.coverband_service?
      Coverband::Collectors::ViewTrackerService.new
    else
      Coverband::Collectors::ViewTracker.new
    end
    trackers << Coverband.configuration.view_tracker
  end
  trackers.each { |tracker| tracker.railtie! }
rescue Redis::CannotConnectError => e
  Coverband.configuration.logger.info "Redis is not available (#{e}), Coverband not configured"
  Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
end

#reset ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/coverband/configuration.rb', line 62

def reset
  @root = Dir.pwd
  @root_paths = []
  @ignore = IGNORE_DEFAULTS.dup
  @search_paths = TRACKED_DEFAULT_PATHS.dup
  @verbose = false
  @reporter = "scov"
  @logger = nil
  @store = nil
  @background_reporting_enabled = true
  @background_reporting_sleep_seconds = nil
  @defer_eager_loading_data = false
  @send_deferred_eager_loading_data = true
  @test_env = nil
  @web_enable_clear = false
  @track_views = true
  @view_tracker = nil
  @track_routes = false
  @track_redirect_routes = true
  @route_tracker = nil
  @track_translations = false
  @translations_tracker = nil
  @web_debug = false
  @report_on_exit = true
  @use_oneshot_lines_coverage = ENV["ONESHOT"] || false
  @simulate_oneshot_lines_coverage = ENV["SIMULATE_ONESHOT"] || false
  @current_root = nil
  @all_root_paths = nil
  @all_root_patterns = nil
  @password = nil
  @csp_policy = false
  @hide_settings = false

  # coverband service settings
  @api_key = nil
  @service_url = nil
  @coverband_timeout = nil
  @service_dev_mode = nil
  @service_test_mode = nil
  @process_type = nil

  @redis_url = nil
  @redis_namespace = nil
  @redis_ttl = 2_592_000 # in seconds. Default is 30 days.
  @reporting_wiggle = nil

  @trackers = []

  # TODO: these are deprecated
  @s3_region = nil
  @s3_bucket = nil
  @s3_access_key_id = nil
  @s3_secret_access_key = nil
  @track_gems = false
  @gem_details = false
end

#search_paths=(path_array) ⇒ Object

Don’t allow the to override defaults



218
219
220
 
# File 'lib/coverband/configuration.rb', line 218

def search_paths=(path_array)
  @search_paths = (@search_paths + path_array).uniq
end

#send_deferred_eager_loading_data? ⇒ Boolean

Returns:

  • (Boolean) 


309
310
311
 
# File 'lib/coverband/configuration.rb', line 309

def send_deferred_eager_loading_data?
  @send_deferred_eager_loading_data
end

#service? ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
 
# File 'lib/coverband/configuration.rb', line 301

def service?
  Coverband.coverband_service? || !api_key.nil?
end

#service_disabled_dev_test_env? ⇒ Boolean

Returns:

  • (Boolean) 


317
318
319
320
321
322
 
# File 'lib/coverband/configuration.rb', line 317

def service_disabled_dev_test_env?
  return false unless service?

  (coverband_env == "test" && !Coverband.configuration.service_test_mode) ||
    (coverband_env == "development" && !Coverband.configuration.service_dev_mode)
end

#store ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/coverband/configuration.rb', line 175

def store
  @store ||= if service?
    if ENV["COVERBAND_REDIS_URL"]
      raise "invalid configuration: unclear default store coverband expects either api_key or redis_url"
    end

    require "coverband/adapters/web_service_store"
    Coverband::Adapters::WebServiceStore.new(service_url)
  else
    Coverband::Adapters::RedisStore.new(Redis.new(url: redis_url), redis_store_options)
  end
end

#store=(store) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/coverband/configuration.rb', line 188

def store=(store)
  raise "Pass in an instance of Coverband::Adapters" unless store.is_a?(Coverband::Adapters::Base)
  if api_key && store.class.to_s != "Coverband::Adapters::WebServiceStore"
    raise "invalid configuration: only coverband service expects an API Key"
  end
  if ENV["COVERBAND_REDIS_URL"] &&
      defined?(::Coverband::Adapters::WebServiceStore) &&
      store.instance_of?(::Coverband::Adapters::WebServiceStore)
    raise "invalid configuration: coverband service shouldn't have redis url set"
  end

  @store = store
end

#to_h ⇒ Object 



249
250
251
252
253
254
 
# File 'lib/coverband/configuration.rb', line 249

def to_h
  instance_variables
    .each_with_object({}) do |var, hash|
      hash[var.to_s.delete("@")] = instance_variable_get(var) unless SKIPPED_SETTINGS.include?(var.to_s)
    end
end

#tracked_search_paths ⇒ Object

Search Paths



211
212
213
 
# File 'lib/coverband/configuration.rb', line 211

def tracked_search_paths
  "#{Coverband.configuration.current_root}/{#{@search_paths.join(",")}}/**/*.{rb}"
end