sensu-plugins-inspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72e471a2043334f0347c3030d52e0155c5873cf89528fb326e57c28c071bef06
+  data.tar.gz: 5f786896a414c75958da02c7cb743d7734496b3c8020c8182d713d263c0ac250
+SHA512:
+  metadata.gz: 86fb63e67946dff247d229d6459a15f6271ba9b602eb343d707aadfbbe2e7a6855536f7199a53416dad2dd4480172a9085834f2d8d7e00e1d792bdf72ec1d262
+  data.tar.gz: 9bef4c2dab0f8d1163781acf548d4f82ed7e8891809224bac335a0c7dd38c2e0b5d7d38c12177668a2e8a7e6d9baeafb3936e830e744c21152655164e85453c6

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELO
+G.md)
+
+## [Unreleased]
+
+## [0.1.0] - 2020-06-20
+* Initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-inspec/compare/0.1.0...HEAD

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Sensu Inc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+## Sensu-Plugins-inspec
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-disk-checks)
+[ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-inspec.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-inspec)
+[ ![Gem Version](https://badge.fury.io/rb/sensu-plugins-inspec.svg)](http://badge.fury.io/rb/sensu-plugins-inspec)
+
+## Sensu Inspec Check Plugin
+- [Overview](#overview)
+- [Usage examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Sensu Go](#sensu-go)
+    - [Asset definition](#asset-definition)
+    - [Check definition](#check-definition)
+  - [Sensu Core](#sensu-core)
+    - [Check definition](#check-definition)
+- [Functionality](#functionality)
+- [Additional information](#additional-information)
+- [Installation from source and contributing](#installation-from-source-and-contributing)
+
+
+
+### Overview
+
+This check executes [InSpec][1] profiles and generates a Sensu event for each non-passing control.
+
+#### Files
+ * bin/check-inspec.rb
+
+### Usage
+
+#### Help
+
+**check-inspec.rb**
+
+```
+Usage: check-inspec.rb (options)
+    -l, --handler HANDLER
+    -d, --tests-dir /tmp/dir
+
+```
+
+
+#### Examples
+Run a local profile and set Sensu event handler to example_handler:
+
+`check-inspec.rb -d /tmp/my_inspec_profile -l example_handler`
+
+Run a remote profile and set Sensu event handler to example_handler:
+
+`check-inspec.rb -d https://my-inspec-profile.s3.amazonaws.com/example-profile.tar.gz -l example_handler`
+
+### Configuration
+#### Sensu Go
+##### Asset Registration
+Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 or later, you can use the following command to add the asset:
+
+`sensuctl asset add sensu-plugins/sensu-plugins-inspec`
+
+If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai Asset Index page](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-disk-checks).
+
+##### Check definition example
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "check-inspec.rb -d /tmp/my_inspec_profile -l example_handler"
+  handlers: []
+  high_flap_threshold: 0
+  interval: 10
+  low_flap_threshold: 0
+  publish: true
+  runtime_assets:
+  - sensu-plugins/sensu-plugins-disk-checks
+  - sensu/sensu-ruby-runtime
+  subscriptions:
+  - linux
+```
+
+#### Sensu Core
+##### Check definition
+```json
+{
+  "checks": {
+    "check-inspec": {
+      "command": "check-inspec.rb -d /tmp/my_inspec_profile -l example_handler",
+      "subscribers": ["linux"],
+      "interval": 10,
+      "refresh": 10
+    }
+  }
+}
+
+```
+
+### Functionality
+**check-inspec**
+
+Run inspec controls and generate a new Sensu event for each failed inspect test.
+This check will return critical if any inspec tests fail.
+
+The `-l` option sets the handler to use in the generated Sensu events. Defaults to the `default` handler.
+The `-d` option sets the directory containing tests to run.
+
+
+[1]: https://inspec.io

data/bin/check-inspec.rb

@@ -0,0 +1,118 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+# check-inspec
+#
+# DESCRIPTION:
+#   Runs inspec controls against your servers.
+#   Fails with a critical if controls are failing.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: inspec
+#
+# USAGE:
+#   Run entire suite of testd
+#   check-inspec -d /etc/my_tests_dir
+#
+#   Run only one set of tests
+#   check-inspec -d /etc/my_tests_dir -t spec/test_one
+#
+# NOTES:
+#   Does it behave differently on specific platforms, specific use cases, etc
+#
+# LICENSE:
+#   Copyright 2019 Sensu, Inc. and contributors. <support@sensu.io>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'json'
+require 'socket'
+require 'inspec'
+require 'sensu-plugin/check/cli'
+require 'pry'
+
+class CheckInspec < Sensu::Plugin::Check::CLI
+  option :tests_dir,
+         short: '-d /tmp/dir',
+         long: '--tests-dir /tmp/dir',
+         required: true
+
+  # option :spec_tests,
+  #       short: '-t spec/test',
+  #       long: '--spec-tests spec/test',
+  #       default: nil
+
+  option :handler,
+         short: '-l HANDLER',
+         long: '--handler HANDLER',
+         default: 'default'
+
+  def sensu_client_socket(msg)
+    u = UDPSocket.new
+    u.send(msg + "\n", 0, '127.0.0.1', 3030)
+  end
+
+  def send_ok(check_name, msg)
+    d = { 'name' => check_name, 'status' => 0, 'output' => 'OK: ' + msg, 'handlers' => [config[:handler]] }
+    sensu_client_socket d.to_json
+  end
+
+  def send_warning(check_name, msg)
+    d = { 'name' => check_name, 'status' => 1, 'output' => 'WARNING: ' + msg, 'handlers' => [config[:handler]] }
+    sensu_client_socket d.to_json
+  end
+
+  def send_critical(check_name, msg)
+    puts "sent critical for #{check_name}"
+    d = { 'name' => check_name, 'status' => 2, 'output' => 'CRITICAL: ' + msg, 'handlers' => [config[:handler]] }
+    sensu_client_socket d.to_json
+  end
+
+  def opts
+    {
+      logger: Logger.new(nil)
+    }
+  end
+
+  def control_check_name(control)
+    file_path = control[:source_location][:ref].gsub('/', '__')
+    "#{file_path}_line#{control[:source_location][:line]}"
+  end
+
+  def run
+    runner = ::Inspec::Runner.new(opts)
+    runner.add_target(config[:tests_dir])
+    exit_code = runner.run
+    runner.report[:profiles].each do |profile|
+      profile[:controls].each do |control|
+        control[:results].each do |result|
+          check_name = control_check_name(control)
+          send_critical(check_name, result[:code_desc]) unless %w[passed].include?(result[:status])
+        end
+      end
+    end
+    # 101 is a success as well (exit with no fails but has skipped controls)
+    exit_with(:ok, 'applicable controls passed') if [0, 101].include?(exit_code)
+    exit_with(:critical, 'exit code no bueno')
+  end
+
+  def exit_with(sym, message)
+    case sym
+    when :ok
+      ok message
+    when :critical
+      critical message
+    else
+      unknown message
+    end
+  end
+end

data/lib/sensu-plugins-inspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-inspec/version'

data/lib/sensu-plugins-inspec/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsInspec
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-inspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.47'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.47'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Sensu check plugin for executing InSpec controls
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-inspec.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-inspec.rb
+- lib/sensu-plugins-inspec.rb
+- lib/sensu-plugins-inspec/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-inspec
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Sensu plugin for executing InSpec controls
+test_files: []