inspec-reporter-tap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2641a1b00b604458410ac1a1a85b5716a30a597aa77108f2a50d90574ee3c984
+  data.tar.gz: f4887becbecfd28c9d37d8b43568d3ec15022898ad8b8f70d91ce3b323b84c3c
+SHA512:
+  metadata.gz: 7598635273306db4368dc6b52ef2b22be2b0f639663cc8a8870961d62fb532b195db618bbc57a464e137617a71c6b4c481c3f403190e64bf8d60bf36eb315977
+  data.tar.gz: f303f7e8ea8602b3f2a45bae517d30cfd747418fd2d982303f05a3e4a48b1f0b0e298745a0ee735bf25d2217959d4bc9c0cfd52bd0f25922de4944ba5fe6be58

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## v0.1.0
+
+- Initial version

data/README.md

@@ -0,0 +1,88 @@
+# inspec-reporter-tap Plugin
+
+InSpec TAP (Test Anything Protocol) reporter.
+
+## To Install This Plugin
+
+Inside InSpec:
+
+```shell
+you@machine $ inspec plugin install inspec-reporter-tap
+```
+
+For use within `kitchen`:
+
+```shell
+you@machine $ gem install inspec-reporter-tap
+```
+
+## How to use this plugin
+
+To generate a TAP13 report using this plugin and save the output to a file named `report.tap`, run:
+
+```shell
+you@machine $ inspec exec some_profile --reporter tap13:/tmp/report.tap
+```
+
+If you prefer the older format, you can generate this as well:
+
+```shell
+you@machine $ inspec exec some_profile --reporter tap:/tmp/report.tap
+```
+
+Note that `tap` and `tap13` are the reporter names.
+
+## Configuring the Plugin
+
+The `tap`/`tap13` reporters requires no configuration to function.
+
+## Example output: TAP13
+
+This is a shortened result from running the devsec.io linux-baseline:
+
+```
+TAP version 13
+1..112
+ok 1 Trusted hosts login
+ok 2 Check owner and permissions for /etc/shadow
+ok 3 Check owner and permissions for /etc/shadow
+
+# ... other lines omitted ...
+
+not ok 108 Magic SysRq
+ ---
+ message: kernel_parameter value is expected to eq 0
+ severity: critical
+ ---
+ok 109 Secure Core Dumps - dump settings
+ok 110 Secure Core Dumps - dump path
+ok 111 kernel.randomize_va_space
+ok 112 CPU No execution Flag or Kernel ExecShield
+FAILED tests 35, 36, 37, 49, 50, 51, 52, 53, 54, 55, 66, 69, 70, 75, 76, 77, 78, 79, 80, 85, 88, 89, 90, 91, 92, 93, 94, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 108
+Failed 39/112, 65.18% okay
+```
+
+## Example output: TAP
+
+This is a shortened result from running the devsec.io linux-baseline:
+
+```
+1..112
+ok 1 Trusted hosts login
+ok 2 Check owner and permissions for /etc/shadow
+ok 3 Check owner and permissions for /etc/shadow
+
+# ... other lines omitted ...
+
+not ok 108 Magic SysRq
+# message: kernel_parameter value is expected to eq 0
+# severity: critical
+ok 109 Secure Core Dumps - dump settings
+ok 110 Secure Core Dumps - dump path
+ok 111 kernel.randomize_va_space
+ok 112 CPU No execution Flag or Kernel ExecShield
+```
+
+## Developing This Plugin
+
+Submit PR and will discuss, thank you!

data/lib/inspec-reporter-tap.rb

@@ -0,0 +1,4 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "inspec-reporter-tap/plugin"

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

@@ -0,0 +1,20 @@
+require_relative "version"
+
+module InspecPlugins
+  module TapReporter
+    class Plugin < ::Inspec.plugin(2)
+      # Internal machine name of the plugin. InSpec will use this in errors, etc.
+      plugin_name :"inspec-reporter-tap"
+
+      reporter :tap do
+        require_relative "reporter"
+        InspecPlugins::TapReporter::Reporter
+      end
+
+      reporter :tap13 do
+        require_relative "reporter13"
+        InspecPlugins::TapReporter::Reporter13
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require "erb" unless defined? ERB
+
+module InspecPlugins::TapReporter
+  class Reporter < Inspec.plugin(2, :reporter)
+    TestResult = Struct.new(:index, :result, :description, :message, :severity, keyword_init: true)
+
+    attr_reader :template_erb
+
+    def initialize(config)
+      super(config)
+
+      @template_erb = "tap.erb"
+    end
+
+    def render
+      tests = []
+      run_data[:profiles].each do |profile|
+        profile.controls.each do |control|
+          control.results.each do |result|
+            tests << TestResult.new(
+              index: tests.count + 1,
+              result: status_to_pass(result.status),
+              description: control.title,
+              message: format("%s %s", result.resource_name, result.expectation_message),
+              severity: impact_to_severity(control.impact)
+            )
+          end
+        end
+      end
+
+      passed_tests = tests.select { |data| data.result == "ok" }
+      failed_tests = tests - passed_tests
+      percent_ok = 100.0 * passed_tests.count / tests.count
+
+      template_file = File.join(template_path, template_erb)
+      template = ERB.new(File.read(template_file))
+
+      output(template.result(binding))
+    end
+
+    def self.run_data_schema_constraints
+      "~> 0.0"
+    end
+
+    private
+
+    def template_path
+      File.expand_path(__FILE__ + "../../../../templates")
+    end
+
+    def status_to_pass(inspec_status)
+      case inspec_status
+      when "passed", "skipped", "waived"
+        "ok"
+      else
+        "not ok"
+      end
+    end
+
+    # @see https://www.first.org/cvss/specification-document#Qualitative-Severity-Rating-Scale
+    def impact_to_severity(inspec_severity)
+      case inspec_severity
+      when 0.0...0.1
+        "none"
+      when 0.1...0.4
+        "low"
+      when 0.4...0.7
+        "medium"
+      when 0.7...0.9
+        "high"
+      when 0.9..1.0
+        "critical"
+      else
+        "unknown"
+      end
+    end
+  end
+end

data/lib/inspec-reporter-tap/reporter13.rb

@@ -0,0 +1,11 @@
+require_relative "reporter"
+
+module InspecPlugins::TapReporter
+  class Reporter13 < Reporter
+    def initialize(config)
+      super(config)
+
+      @template_erb = "tap13.erb"
+    end
+  end
+end

data/lib/inspec-reporter-tap/version.rb

@@ -0,0 +1,5 @@
+module InspecPlugins
+  module TapReporter
+    VERSION = "0.1.0".freeze
+  end
+end

data/templates/tap.erb

@@ -0,0 +1,8 @@
+<%= 1 %>..<%= tests.count %>
+<% tests.each do |test|
+%><%= test.result %> <%= test.index %> <%= test.description %><%
+   if test.result == 'not ok'%>
+# message: <%= test.message %>
+# severity: <%= test.severity %><%
+     end %>
+<% end %>

data/templates/tap13.erb

@@ -0,0 +1,10 @@
+TAP version 13
+<%= 1 %>..<%= tests.count %>
+<% tests.each do |test|
+%><%= test.result %> <%= test.index %> <%= test.description %>
+<% if test.result == 'not ok' %> ---
+ message: <%= test.message %>
+ severity: <%= test.severity %>
+ ---
+<% end %><% end %>FAILED tests <%= failed_tests.map { |t| t.index }.join(', ') %>
+Failed <%= failed_tests.count %>/<%= tests.count %>, <%= format('%2.2f', percent_ok) %>% okay

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: inspec-reporter-tap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Heinen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: chefstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Plugin following TAP/TAP13
+email:
+- theinen@tecracer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/inspec-reporter-tap.rb
+- lib/inspec-reporter-tap/plugin.rb
+- lib/inspec-reporter-tap/reporter.rb
+- lib/inspec-reporter-tap/reporter13.rb
+- lib/inspec-reporter-tap/version.rb
+- templates/tap.erb
+- templates/tap13.erb
+homepage: https://github.com/tecracer-chef/inspec-reporter-tap
+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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: InSpec Reporter for the Test Anything Protocol (TAP)
+test_files: []