sensu-push 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4580b15946280939052b174118be33ac004d3d4b24545226188fec0f1cbdc87b
+  data.tar.gz: 07b280cb2f099c825d9e115c6afa7fbadd61c829d9f5d74655c9b13c8f78e160
+SHA512:
+  metadata.gz: 5bf53680c77961b9d239d252c3b5a577da0a1b80b09635ecef835336693be9843f48301271bbbd88f72cf9528fcacde8eaaa99812fb47ab46af1fc7de3358a50
+  data.tar.gz: 929513f8b53417543f7a085231a8ff537fac9484601d90b0b2aebc52ea28b12fe78d4aeb81401098c40f0b528716d8c0c1344118decc8ec58b9781c7b37ec932

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic
+Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 2020-01-10
+
+### Fixed
+- Entity creation no longer throws a method missing exception
+
+### Added
+- TLS support
+
+## [0.2.0] - 2020-01-10
+
+### Added
+- Create proxy Entity if missing
+- Check TTL
+
+## [0.1.0] - 2020-01-10
+
+### Added
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sensu-push.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sensu Inc.
+
+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,53 @@
+# Sensu Push
+
+Sensu Push is a utility for executing Sensu Go checks on systems that
+cannot run the Sensu Go Agent. Sensu Push wraps the check command
+execution, constructs a Sensu Go Entity and Event, and communicates
+with the Sensu Go Backend API to create the Entity (if missing) and
+submit the Event for processing. This utility is written in Ruby
+(1.8+) and only uses stdlib in hopes it can run on the vast majority
+of systems.
+
+## Installation
+
+```
+gem install sensu-push
+```
+
+## Usage
+
+```
+$ sensu-push -h
+Usage: sensu-push [options]
+    -h, --help                       Display this message
+    -V, --version                    Display version
+    -n, --namespace NAME             Sensu Go namespace
+    -c, --check-name NAME            Sensu Go check name
+    -e, --entity-name NAME           Sensu Go entity name
+    -t, --check-timeout SECONDS      Sensu Go check execution timeout
+    -T, --check-ttl SECONDS          Sensu Go check TTL
+    -H, --handlers NAME[,NAME]       Sensu Go event handlers
+    -b, --backends URL[,URL]         URL or comma-delimited list of Sensu Go Backend API URLs
+    -k, --api-key KEY                Sensu Go Backend API key
+    -s, --insecure-skip-tls-verify   Skip TLS verify peer when using HTTPS
+```
+
+Example:
+
+```
+$ sensu-push -c true -e laptop -b http://localhost:8080 -k '46691493-dee5-46d8-8d2b-f37a18424afc' -- true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sensu/sensu-push.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sensu/push"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sensu-push

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+unless $:.include?(File.dirname(__FILE__) + "/../lib/")
+  $: << File.dirname(__FILE__) + "/../lib"
+end
+
+require "sensu/push"
+
+options = Sensu::Push.read_cli_opts
+
+entity = Sensu::Push::Entity.new(options)
+check = Sensu::Push::Check.new(options)
+check.exec!
+event = Sensu::Push::Event.new(entity, check)
+
+api = Sensu::Push::APIClient.new(options)
+api.create_entity_if_missing(entity)
+api.create_event(event)

data/lib/sensu/push.rb

@@ -0,0 +1,57 @@
+require "optparse"
+require "sensu/push/version"
+require "sensu/push/entity"
+require "sensu/push/check"
+require "sensu/push/event"
+require "sensu/push/api_client"
+
+module Sensu
+  module Push
+    def self.read_cli_opts(arguments=ARGV)
+      options = {}
+
+      optparse = OptionParser.new do |opts|
+        opts.on("-h", "--help", "Display this message") do
+          puts opts
+          exit
+        end
+        opts.on("-V", "--version", "Display version") do
+          puts VERSION
+          exit
+        end
+        opts.on("-n", "--namespace NAME", "Sensu Go namespace") do |name|
+          options[:namespace] = name
+        end
+        opts.on("-c", "--check-name NAME", "Sensu Go check name") do |name|
+          options[:check_name] = name
+        end
+        opts.on("-e", "--entity-name NAME", "Sensu Go entity name") do |name|
+          options[:entity_name] = name
+        end
+        opts.on("-t", "--check-timeout SECONDS", "Sensu Go check execution timeout") do |timeout|
+          options[:timeout] = timeout.to_i
+        end
+        opts.on("-T", "--check-ttl SECONDS", "Sensu Go check TTL") do |ttl|
+          options[:ttl] = ttl.to_i
+        end
+        opts.on("-H", "--handlers NAME[,NAME]", "Sensu Go event handlers") do |handlers|
+          options[:handlers] = handlers.split(",")
+        end
+        opts.on("-b", "--backends URL[,URL]", "URL or comma-delimited list of Sensu Go Backend API URLs") do |backends|
+          options[:backends] = backends.split(",")
+        end
+        opts.on("-k", "--api-key KEY", "Sensu Go Backend API key") do |key|
+          options[:api_key] = key
+        end
+        opts.on("-s", "--insecure-skip-tls-verify", "Skip TLS verify peer when using HTTPS") do |key|
+          options[:skip_tls_verify_peer] = true
+        end
+      end
+
+      optparse.parse!(arguments)
+      options[:command] = arguments.join(" ")
+
+      options
+    end
+  end
+end

data/lib/sensu/push/api_client.rb

@@ -0,0 +1,67 @@
+require "uri"
+require "json"
+
+begin
+  require "net/https"
+rescue LoadError
+  require "net/http"
+end
+
+module Sensu
+  module Push
+    class APIClient
+      def initialize(options={})
+        @options = options
+        uri = URI.parse(select_backend)
+        @http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == "https"
+          @http.use_ssl = true
+          @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          if options[:skip_tls_verify_peer]
+            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+        end
+      end
+
+      def select_backend
+        @backends ||= []
+        if @backends.empty?
+          @backends = @options[:backends].shuffle
+        end
+        @backends.shift
+      end
+
+      def entity_exists?(entity)
+        request = Net::HTTP::Get.new("/api/core/v2/namespaces/#{entity.namespace}/entities/#{entity.name}")
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Key #{@options[:api_key]}"
+        response = @http.request(request)
+        response.code == "200"
+      end
+
+      def create_entity(entity)
+        request = Net::HTTP::Post.new("/api/core/v2/namespaces/#{entity.namespace}/entities")
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Key #{@options[:api_key]}"
+        request.body = JSON.dump(entity.to_hash)
+        response = @http.request(request)
+        puts response.inspect
+      end
+
+      def create_entity_if_missing(entity)
+        unless entity_exists?(entity)
+          create_entity(entity)
+        end
+      end
+
+      def create_event(event)
+        request = Net::HTTP::Post.new("/api/core/v2/namespaces/#{event.entity.namespace}/events")
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Key #{@options[:api_key]}"
+        request.body = JSON.dump(event.to_hash)
+        response = @http.request(request)
+        puts response.inspect
+      end
+    end
+  end
+end

data/lib/sensu/push/check.rb

@@ -0,0 +1,35 @@
+require "open3"
+
+module Sensu
+  module Push
+    class Check
+      attr_reader :name, :namespace, :output, :status
+
+      def initialize(options={})
+        @options = options
+        @name = @options[:check_name]
+        @namespace = @options.fetch(:namespace, "default")
+      end
+
+      def exec!
+        stdin, stdout, stderr, wait = Open3.popen3(@options[:command])
+        @output = "#{stdout.read}\n#{stderr.read}"
+        @status = wait.value.exitstatus
+        [@output, @status]
+      end
+
+      def to_hash
+        {
+          :metadata => {
+            :name => @name,
+            :namespace => @namespace
+          },
+          :command => @options[:command],
+          :output => @output,
+          :status => @status,
+          :ttl => @options.fetch(:ttl, 0)
+        }
+      end
+    end
+  end
+end

data/lib/sensu/push/entity.rb

@@ -0,0 +1,23 @@
+module Sensu
+  module Push
+    class Entity
+      attr_reader :name, :namespace
+
+      def initialize(options={})
+        @options = options
+        @name = options[:entity_name]
+        @namespace = options.fetch(:namespace, "default")
+      end
+
+      def to_hash
+        {
+          :metadata => {
+            :name => @name,
+            :namespace => @namespace
+          },
+          :entity_class => "proxy"
+        }
+      end
+    end
+  end
+end

data/lib/sensu/push/event.rb

@@ -0,0 +1,19 @@
+module Sensu
+  module Push
+    class Event
+      attr_reader :entity, :check
+
+      def initialize(entity, check)
+        @entity = entity
+        @check = check
+      end
+
+      def to_hash
+        {
+          :entity => @entity.to_hash,
+          :check => @check.to_hash
+        }
+      end
+    end
+  end
+end

data/lib/sensu/push/version.rb

@@ -0,0 +1,5 @@
+module Sensu
+  module Push
+    VERSION = "0.3.0"
+  end
+end

data/sensu-push.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sensu/push/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-push"
+  spec.version       = Sensu::Push::VERSION
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com", "engineering@sensu.io"]
+
+  spec.summary       = "A utility for executing Sensu Go checks on systems that cannot run the Sensu Go Agent"
+  spec.description   = "A utility for executing Sensu Go checks on systems that cannot run the Sensu Go Agent"
+  spec.homepage      = "https://github.com/sensu/sensu-push"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sensu-push
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A utility for executing Sensu Go checks on systems that cannot run the
+  Sensu Go Agent
+email:
+- portertech@gmail.com
+- engineering@sensu.io
+executables:
+- sensu-push
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sensu-push
+- lib/sensu/push.rb
+- lib/sensu/push/api_client.rb
+- lib/sensu/push/check.rb
+- lib/sensu/push/entity.rb
+- lib/sensu/push/event.rb
+- lib/sensu/push/version.rb
+- sensu-push.gemspec
+homepage: https://github.com/sensu/sensu-push
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A utility for executing Sensu Go checks on systems that cannot run the Sensu
+  Go Agent
+test_files: []