inspec-reporter-honeycomb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eb32b04b057f01512ba79db4145ff08b2dcddc65180315cba4fafd6e5a16ee9
+  data.tar.gz: e74b389396a6930562af472ae1fa2c77bac31e5bc6126e0dabb9951277ab9f7d
+SHA512:
+  metadata.gz: 3e2697d9f64be8d886aa04b2bcb5d97d14473d409b8e2e6be172ee4db9ed9894299296d6500bc642ba52fad5c134bded41c808585c9e88243c63b537e77995a9
+  data.tar.gz: ac1d78f88a59a2e754209c2ae91bbc71094956cc3cbfae57d967c88b971e50e160488384de8f87c7a7b278a996d0dc428a8446229bbbcd1ec779cef663c9e3b9

data/lib/inspec-reporter-honeycomb/plugin.rb

@@ -0,0 +1,14 @@
+require 'inspec/plugin/v2'
+
+module InspecPlugins
+  module HoneycombReporter
+    class Plugin < Inspec.plugin(2)
+      plugin_name :'inspec-reporter-honeycomb'
+
+      reporter :honeycomb do
+        require_relative 'reporter.rb'
+        InspecPlugins::HoneycombReporter::Reporter
+      end
+    end
+  end
+end

data/lib/inspec-reporter-honeycomb/reporter.rb

@@ -0,0 +1,135 @@
+
+require 'inspec/plugin/v2'
+require 'json'
+require "securerandom" unless defined?(SecureRandom)
+
+module InspecPlugins::HoneycombReporter
+  # Reporter Plugin Class
+  class Reporter < Inspec.plugin(2, :reporter)
+    def render
+      output(report.to_json, false)
+    end
+    
+    def self.run_data_schema_constraints
+        '~> 0.0' # Accept any non-breaking change
+    end
+    
+    def report
+      report = Inspec::Reporters::Json.new(@config).report
+      trace_id = SecureRandom.hex(16)
+      root_span_id = SecureRandom.hex(8)
+      trace_batch = []
+      root_span_data = Hash.new
+      root_span_data[:data] = {
+        'trace.trace_id' => trace_id,
+        'trace.span_id' => root_span_id,
+        'service.name' => 'compliance',
+        'name' => 'inspec-run',
+        'platform.name' => report[:platform][:name],
+        'duration' => report[:statistics][:duration]*1000,
+        'version' => report[:version],
+      }
+
+      trace_batch << root_span_data
+
+      report[:profiles].each do |profile|
+        profile_span_id = SecureRandom.hex(8)
+        profile[:controls].each do |control|
+            control_span_id = SecureRandom.hex(8)
+            control[:results].each do |result|
+                result_span_id = SecureRandom.hex(8)
+                trace_batch << generate_span_data(
+                    parent_id: control_span_id,
+                    span_id: result_span_id,
+                    trace_id: trace_id,
+                    data: result,
+                    platform: report[:platform][:name],
+                    type: 'result',
+                    name: result[:code_desc],
+                    duration: result[:run_time],
+                )
+            end
+            control.tap { |ct| ct.delete(:results) }
+            trace_batch << generate_span_data(
+                parent_id: profile_span_id,
+                span_id: control_span_id,
+                trace_id: trace_id,
+                data: control,
+                platform: report[:platform][:name],
+                type: 'control',
+                name: control[:title],
+            )
+        end
+        profile.tap { |pf| pf.delete(:controls) }
+        trace_batch << generate_span_data(
+            parent_id: root_span_id,
+            span_id: profile_span_id,
+            trace_id: trace_id,
+            data: profile,
+            platform: report[:platform][:name],
+            type: 'profile',
+        )
+      end
+
+      
+
+      headers = { "Content-Type" => "application/json" }
+      headers["X-Honeycomb-Team"] = ENV['HONEYCOMB_API_KEY']
+
+      uri = URI(ENV['HONEYCOMB_API_URL'])
+      req = Net::HTTP::Post.new(uri.path, headers)
+      req.body = trace_batch.to_json
+      begin
+        Inspec::Log.debug "Posting report to Honeycomb: #{uri.path}"
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        if ENV['VERIFY_SSL'] == true
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        res = http.request(req)
+        if res.is_a?(Net::HTTPSuccess)
+          true
+        else
+          Inspec::Log.error "send_report: POST to #{uri.path} returned: #{res.body}"
+          false
+        end
+      rescue => e
+        Inspec::Log.error "send_report: POST to #{uri.path} returned: #{e.message}"
+        false
+      end
+    end
+
+    private
+
+    def generate_span_data(**args)
+
+        time_in_ms = args[:duration] ? args[:duration] * 1000 : 0
+        span_data = {
+            'trace.trace_id' => args[:trace_id],
+            'trace.span_id' => args[:span_id],
+            'service.name' => 'compliance',
+            'trace.parent_id' => args[:parent_id],
+            'platform.name' => args[:platform],
+            'type' => args[:type],
+            'name' => args[:name],
+            'duration' => time_in_ms,
+        }
+
+        args[:data].each do |k,v|
+            if v.is_a?(Array)
+                value = v.join(",")
+            else
+                value = v
+            end
+            span_data[k] = value.to_s
+        end
+        return_data = Hash.new
+        return_data[:data] = span_data
+        return_data
+    end
+
+  end
+end

data/lib/inspec-reporter-honeycomb.rb

@@ -0,0 +1 @@
+require_relative 'inspec-reporter-honeycomb/plugin'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: inspec-reporter-honeycomb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andy Dufour
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: InSpec Reporter plugin to report Otel formatted traces to Honeycomb.
+email:
+- andy.k.dufour@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/inspec-reporter-honeycomb.rb
+- lib/inspec-reporter-honeycomb/plugin.rb
+- lib/inspec-reporter-honeycomb/reporter.rb
+homepage: https://github.com/andy-dufour/inspec-reporter-honeycomb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: InSpec Reporter plugin for Honeycomb
+test_files: []