sensucronic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e6fe2076af1cbc5abb22a7ba3c44f69681e48f6
+  data.tar.gz: 4ecb05e178254f4bca2db044de92bc4eff4c934e
+SHA512:
+  metadata.gz: e226aa25c316211ba25f6e2956b8f481532849db6a5993dddbe1ca542d427c3fc0609b07bd7516c93fe8e1350e74588f97a07cf62293820fad82f83af1907442
+  data.tar.gz: b369c708948112ecbe4b6f7002cf2352b07dc44faab71e1895ddfe3d67a1ab13ca57acae9cba9905f11716f891e56182bf60784ff7830a7f0fe809cc9d7b1ca4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sensucronic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 fess
+
+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,122 @@
+# Sensucronic
+
+sensucronic is a wrapper for your cron jobs to integrate with
+the sensu client input socket.
+
+it's written in ruby using mixlib::cli to fit in with the rest of the
+sensu ecosystem
+
+## Installation
+
+TODO: release gem so this works.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sensucronic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sensucronic
+
+## Usage
+
+```
+sensucronic [ OPTIONS ] [ -- ] COMMAND [ ARGS ]
+```
+```
+sensucronic [ OPTIONS ] [ -- ] 'COMMAND [ ARGS ]'
+```
+
+sensucronic runs COMMAND with ARGS it generates a json report and submits
+it to the sensu-client input socket
+
+the OPTION --dryrun causes sensucronic to issue it's report to stdout
+instead of the sensu client input socket.
+
+```
+prompt% sensucronic --dry-run true     
+{
+  "command": "true",
+  "output": "",
+  "status": 0,
+  "exitcode": 0,
+  "agent": "sensucronic"
+}
+```
+
+exitcodes are propogated to sensu's status field,  0 ok, 1 warn, 2 crit, 3
+unknown  but anything > 3 sets status to 3.  
+
+TODO: add options to configure this.
+
+```
+prompt% sensucronic --dry-run 'echo hi; exit 20'
+{
+  "command": "echo\\ hi\\;\\ exit\\ 20",
+  "output": "hi\n",
+  "status": 3,
+  "exitcode": 20,
+  "agent": "sensucronic"
+}
+```
+
+given a single quoted argument it will be parsed with a shell
+otherwise it tries to exec it as command followed by arguments
+
+```
+prompt% sensucronic --dry-run  exit 3
+{
+  "command": "exit 3",
+  "output": "Errno::ENOENT\nNo such file or directory - exit",
+  "status": 3,
+  "exitcode": 127,
+  "agent": "sensucronic"
+}
+```
+
+```
+prompt% sensucronic --dry-run  'exit 3'
+{
+  "command": "exit\\ 3",
+  "output": "",
+  "status": 3,
+  "exitcode": 3,
+  "agent": "sensucronic"
+}
+
+```
+
+use --help to view options
+```
+prompt% sensucronic --help 
+Usage: sensucronic (options)
+    -d, --dry-run                    output result to stdout only
+    -h, --help                       print this message
+    -p, --port PORT                  the port number for the sensu client input socket
+    -s, --source SOURCE              set the source attribute on the sensu result
+```
+
+## TODO
+- accept options to add extra fields to the output
+- accept options to configure the status in response to the exitcodes.  (always warn,  always crit ) 
+
+## 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/opentable/sensucronic
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sensucronic"
+
+# 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.
+
+require "pry"
+Pry.start

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/sensucronic

@@ -0,0 +1,29 @@
+#! /usr/bin/env ruby
+#
+#   sensucronic
+#
+# DESCRIPTION:
+#   a cron wrapper to integrate the result of cron execution with sensu
+#   it runs your cronjob,  capturing the output and exit code and sends
+#   the result to sensu
+# 
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   sensucronic [ OPTIONS ] [ -- ] COMMAND [ ARGS ]
+#
+# NOTES:
+#
+# LICENSE:
+#   fess <fess-sensuchronic@fess.org>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensucronic'
+
+Sensucronic.new.cli

data/lib/sensucronic/version.rb

@@ -0,0 +1,3 @@
+class Sensucronic
+  VERSION = "0.1.0"
+end

data/lib/sensucronic.rb

@@ -0,0 +1,131 @@
+require 'sensucronic/version'
+require 'mixlib/cli'
+require 'shellwords'
+require 'open3'
+require 'json'
+
+
+class Sensucronic
+  include Mixlib::CLI
+
+  option :dryrun,
+    :short       => '-d',
+    :long        => '--dry-run',
+    :boolean     => true,
+    :default     => false,
+    :description => 'output result to stdout only'
+
+  option :port,
+    :short       => '-p PORT',
+    :long        => '--port PORT',
+    :default     => 3030,
+    :description => 'the port number for the sensu client input socket'
+
+  option :source,
+    :short       => '-s SOURCE',
+    :long        => '--source SOURCE',
+    :description => 'set the source attribute on the sensu result'
+
+  option :help,
+    :short        => '-h',
+    :long         => '--help',
+    :boolean      => true,
+    :tail         => true,
+    :show_options => true,
+    :description  => 'print this message',
+    :exit         => 0
+
+  attr :stdout
+  attr :stderr
+  attr :status
+
+  def dryrun
+    config[:dryrun]
+  end
+
+  def port
+    config[:port]
+  end
+
+  def cli(argv = ARGV)
+    parse_options(argv)
+    run
+    issue_report
+  end
+
+  def issue_report
+    if dryrun
+      report_stdout
+    else
+      report_socket
+    end
+  end
+
+  def report_stdout
+    puts JSON.pretty_generate(report)
+  end
+
+  def file_socket
+    "/dev/tcp/localhost/#{port}"
+  end
+
+  def report_socket
+    # TODO if needed actually connect via tcp to the
+    # client input socket.
+    File.open(file_socket, 'w') do |sock|
+      sock.write(report.to_json)
+    end
+  rescue Errno::ENOENT => e
+    STDERR.puts "failed to submit to sensu client input socket"
+    STDERR.puts e.message
+    exit 127
+  end
+
+  def run
+    @stdout, @stderr, @status = Open3.capture3(*cli_arguments)
+  rescue Errno::ENOENT => e
+    @stdout, @stderr, @status = e.class, e.message, $?
+  end
+
+  def output_status
+    status.to_s unless status.exited?
+  end
+
+  def output
+    [stdout, stderr, output_status]
+      .select {|msg| msg && msg != "" }
+      .join("\n");
+  end
+
+  def exitsignal
+    status.termsig || status.stopsig # I think stop sig will hang?
+  end
+
+  def exitcode
+    # be like the bash on signals
+    status.exited? ? status.exitstatus : 128 + exitsignal
+  end
+
+  def sensu_status
+    case exitcode
+    when 0..2
+      exitcode
+    else
+      3
+    end
+  end
+
+  def report
+    {
+      command:  Shellwords.shelljoin(cli_arguments),
+      output:   output,
+      status:   sensu_status,
+      exitcode: exitcode,
+      agent:    self.class.to_s.downcase
+    }.tap do |r|
+      r[:exitsignal] = status.termsig  if status.termsig
+      r[:source]     = config[:source] if config[:source]
+    end
+  end
+
+end

data/sensucronic.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sensucronic/version'
+
+Gem::Specification.new do |s|
+  s.name          = "sensucronic"
+  s.version       = Sensucronic::VERSION
+  s.authors       = ["fess"]
+  s.email         = ["fess-sensucronic@fess.org"]
+
+  s.summary       = %q{report status of cronjob to sensu}
+  #s.description   = %q{}
+  #s.homepage      = "TODO: Put your gem's website or public repo URL here."
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "mixlib-cli", ">= 1.0" # optimistic
+
+  s.add_development_dependency "bundler", "~> 1.14"
+  s.add_development_dependency "rake",    "~> 10.0"
+  s.add_development_dependency "rspec",   "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sensucronic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fess
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 
+email:
+- fess-sensucronic@fess.org
+executables:
+- sensucronic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sensucronic
+- lib/sensucronic.rb
+- lib/sensucronic/version.rb
+- sensucronic.gemspec
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: report status of cronjob to sensu
+test_files: []