Class: Chef::Compliance::Reporter::ChefServerAutomate

Inherits:
Automate
  • Object
show all
Defined in:
lib/chef/compliance/reporter/chef_server_automate.rb

Overview

Used to send inspec reports to Chef Automate server via Chef Server

Constant Summary

Constants inherited from Automate

Automate::CONTROL_RESULT_SORT_ORDER, Automate::SEEN_PROFILE_UNNECESSARY_CONTROL_FIELDS, Automate::SEEN_PROFILE_UNNECESSARY_FIELDS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Automate

#enriched_report, #missing_automate_profiles, #strip_profiles_meta, #truncate_controls_results

Constructor Details

#initialize(opts) ⇒ ChefServerAutomate

Returns a new instance of ChefServerAutomate.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 12

def initialize(opts)
  @entity_uuid           = opts[:entity_uuid]
  @run_id                = opts[:run_id]
  @node_name             = opts[:node_info][:node]
  @insecure              = opts[:insecure]
  @environment           = opts[:node_info][:environment]
  @roles                 = opts[:node_info][:roles]
  @recipes               = opts[:node_info][:recipes]
  @url                   = opts[:url]
  @chef_tags             = opts[:node_info][:chef_tags]
  @policy_group          = opts[:node_info][:policy_group]
  @policy_name           = opts[:node_info][:policy_name]
  @source_fqdn           = opts[:node_info][:source_fqdn]
  @organization_name     = opts[:node_info][:organization_name]
  @ipaddress             = opts[:node_info][:ipaddress]
  @fqdn                  = opts[:node_info][:fqdn]
  @control_results_limit = opts[:control_results_limit]
  @timestamp             = opts.fetch(:timestamp) { Time.now }
end

Instance Attribute Details

#url ⇒ Object (readonly)

Returns the value of attribute url.



10
11
12
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 10

def url
  @url
end

Instance Method Details

#handle_http_error_code(code) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 81

def handle_http_error_code(code)
  case code
  when /401|403/
    Chef::Log.error "Auth issue: see the Compliance Phase troubleshooting documentation (http://docs.chef.io/chef_compliance_phase/#troubleshooting)."
  when /404/
    Chef::Log.error "Object does not exist on remote server."
  when /413/
    Chef::Log.error "You most likely hit the request size limit in #{ChefUtils::Dist::Server::PRODUCT} that defaults to ~2MB. To increase this limit see the Compliance Phase troubleshooting documentation (http://docs.chef.io/chef_compliance_phase/#troubleshooting) or the Chef Infra Server configuration documentation (https://docs.chef.io/server/config_rb_server/)"
  when /429/
    Chef::Log.error "This error typically means the data sent was larger than #{ChefUtils::Dist::Automate::PRODUCT}'s limit (4 MB). Run InSpec locally to identify any controls producing large diffs."
  end
  msg = "Received HTTP error #{code}"
  Chef::Log.error msg
  raise msg
end

#http_client ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 59

def http_client
  config = if @insecure
             Chef::Config.merge(ssl_verify_mode: :verify_none)
           else
             Chef::Config
           end

  Chef::ServerAPI.new(@url, config)
end

#send_report(report) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 32

def send_report(report)
  automate_report = truncate_controls_results(enriched_report(report), @control_results_limit)

  report_size = Chef::JSONCompat.to_json(automate_report, validate_utf8: false).bytesize
  # this is set to slightly less than the oc_erchef limit
  if report_size > 900 * 1024
    Chef::Log.warn "Generated report size is #{(report_size / (1024 * 1024.0)).round(2)} MB. #{ChefUtils::Dist::Server::PRODUCT} < 13.0 defaults to a limit of ~1MB, 13.0+ defaults to a limit of ~2MB."
  end

  Chef::Log.info "Report to #{ChefUtils::Dist::Automate::PRODUCT} via #{ChefUtils::Dist::Server::PRODUCT}: #{@url}"
  with_http_rescue do
    http_client.post(@url, automate_report)
    return true
  end
  false
end

#validate_config! ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 49

def validate_config!
  unless @entity_uuid
    raise "CMPL007: chef_server_automate reporter: chef_guid is not available and must be provided. Aborting because we cannot report the scan"
  end

  unless @run_id
    raise "CMPL008: chef_server_automate reporter: run_id is not available, aborting because we cannot report the scan."
  end
end

#with_http_rescue ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/chef/compliance/reporter/chef_server_automate.rb', line 69

def with_http_rescue
  response = yield
  if response.respond_to?(:code)
    # handle non 200 error codes, they are not raised as Net::HTTPClientException
    handle_http_error_code(response.code) if response.code.to_i >= 300
  end
  response
rescue Net::HTTPClientException => e
  Chef::Log.error e
  handle_http_error_code(e.response.code)
end