alerty 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f1c92b7d3ec37c17af10d78fba346435c7be67e
-  data.tar.gz: 84616ba361045f8b94e544eea7626734077f212a
+  metadata.gz: 37200c7df937b8b93002b2ef0e988b49f0704482
+  data.tar.gz: 02a87bf6ae0a11ad405f2a9e9c518cdaa3b613d8
 SHA512:
-  metadata.gz: 0479571dc19db4fb6c52f5fa1dca7cf023c15ce6947a68207ba41770027bda7fece31b4580ea11236f82e7a6ce84d3b04256026cce205956c2013a7d19e78d2c
-  data.tar.gz: 2547fee4e93f27d12acc0bc7eceb78ba376e329bc65850d35ae013875a2ef5032b5a1ead04571384343392fc2cd9ec3cfc839b7f3131e2609f200f09ab97d2bb
+  metadata.gz: 3970c46b9de3142aa6d459de8657a8ffc86c3d1e5bd9219d47700e8918e27b1b3252a5ade20b149217b047fb81ea3fea5d2f15eb5ae75a18ec625c7ef0e688f3
+  data.tar.gz: 6c90bdd66aa9714bfbc48cc80c7d54750e7666b4d2df64942225aa6600e15664db6e29dde59f34149e9ed9f25732f4afb05f4da929f060092b3f6d9b2d46a411

data/.gitignore

@@ -16,3 +16,4 @@ vendor
 pkg/
 .env
 log/alerty.log
+spec/cli_spec.out

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.0.3 (2015/08/14)
+
+Enchancements:
+
+* Add exec plugin
+* Pass `hostname` to plugins
+
+# 0.0.3 (2015/08/14)
+
+Enchancements:
+
+* Pass more information to plugins
+  * command
+  * exitstatus
+  * output
+  * started_at
+  * duration
+
 # 0.0.2 (2015/08/13)
 
 Enchancements:

data/README.md

@@ -1,10 +1,14 @@
 # alerty
 
-Send an alert if a given command failed. 
+A CLI utility to send an alert if a given command failed. 
 
 ## How Useful?
 
-I use `alerty` to run commands in cron. With `alerty`, we can send an alert if a cron command fails.
+I use `alerty` to run commands in cron to send alerts if cron commands fail.
+
+```
+0 * * * * alerty -c /etc/sysconfig/alerty -- /path/to/script --foo FOO --bar
+```
 
 ## Installation
 
@@ -48,16 +52,15 @@ $ bin/alerty -h
 
 Following plugins are available:
 
+* [stdout](./lib/alerty/plugin/stdout.rb)
+* [file](./lib/alerty/plugin/file.rb)
+* [exec](./lib/alerty/plugin/exec.rb)
 * [alerty-plugin-ikachan](https://github.com/sonots/alerty-plugin-ikachan)
 
 ## ChangeLog
 
 See [CHANGELOG.md](CHANGELOG.md) for details.
 
-### ToDo
-
-* Add tests
-
 ### Licenses
 
 See [LICENSE](LICENSE)

data/alerty.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "alerty"
-  gem.version       = '0.0.2'
+  gem.version       = '0.0.4'
   gem.author        = ['Naotoshi Seo']
   gem.email         = ['sonots@gmail.com']
   gem.homepage      = 'https://github.com/sonots/alerty'

data/bin/alerty

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/alerty/cli'
-Alerty.new.run
+Alerty::CLI.new.run

data/example.yml

@@ -1,8 +1,10 @@
-log_path: log/alerty.log
+log_path: STDOUT
 log_level: debug
 timeout: 10
 lock_path: log/lock
 plugins:
   - type: stdout
   - type: file
-    path: log/failure.log
+    path: log/file.log
+  - type: exec
+    command: cat > log/exec.log

data/lib/alerty/cli.rb

@@ -2,54 +2,57 @@ require 'optparse'
 require_relative '../alerty'
 
 class Alerty
-  def parse_options(argv = ARGV)
-    op = OptionParser.new
-    op.banner += ' -- command'
-
-    (class<<self;self;end).module_eval do
-      define_method(:usage) do |msg|
-        puts op.to_s
-        puts "error: #{msg}" if msg
-        exit 1
+  class CLI
+    def parse_options(argv = ARGV)
+      op = OptionParser.new
+      op.banner += ' -- command'
+
+      (class<<self;self;end).module_eval do
+        define_method(:usage) do |msg|
+          puts op.to_s
+          puts "error: #{msg}" if msg
+          exit 1
+        end
       end
-    end
 
-    opts = {}
-    op.on('-c', '--config CONFIG_FILE', "config file path (default: /etc/sysconfig/alerty)") {|v|
-      opts[:config_path] = v
-    }
-    op.on('--log LOG_FILE', "log file path (default: STDOUT)") {|v|
-      opts[:log_path] = v
-    }
-    op.on('--log-level LOG_LEVEL', "log level (default: warn)") {|v|
-      opts[:log_level] = v
-    }
-    op.on('-t', '--timeout SECONDS', "timeout the command (default: no timeout)") {|v|
-      opts[:timeout] = v.to_i
-    }
-    op.on('-l', '--lock LOCK_FILE', "exclusive lock file to prevent running a command duplicatedly (default: no lock)") {|v|
-      opts[:lock_path] = v
-    }
-
-    op.parse!(argv)
-    opts[:command] = argv.join(' ')
+      opts = {}
+      op.on('-c', '--config CONFIG_FILE', "config file path (default: /etc/sysconfig/alerty)") {|v|
+        opts[:config_path] = v
+      }
+      op.on('--log LOG_FILE', "log file path (default: STDOUT)") {|v|
+        opts[:log_path] = v
+      }
+      op.on('--log-level LOG_LEVEL', "log level (default: warn)") {|v|
+        opts[:log_level] = v
+      }
+      op.on('-t', '--timeout SECONDS', "timeout the command (default: no timeout)") {|v|
+        opts[:timeout] = v.to_i
+      }
+      op.on('-l', '--lock LOCK_FILE', "exclusive lock file to prevent running a command duplicatedly (default: no lock)") {|v|
+        opts[:lock_path] = v
+      }
+
+      op.parse!(argv)
+      opts[:command] = argv.join(' ')
+
+      if opts[:command].empty?
+        raise OptionParser::InvalidOption.new("No command is given")
+      end
 
-    if opts[:command].empty?
-      usage "No command is given"
+      opts
     end
 
-    opts
-  end
-
-  def run
-    begin
-      opts = parse_options
-    rescue OptionParser::InvalidOption => e
-      usage e.message
+    def run
+      begin
+        opts = parse_options
+      rescue OptionParser::InvalidOption => e
+        usage e.message
+      end
+  
+      Config.configure(opts)
+      Config.plugins # load plugins in early stage
+      command = Command.new(command: opts[:command])
+      command.run!
     end
-
-    Config.configure(opts)
-    Config.plugins # load plugins in early stage
-    Command.new(command: opts[:command]).run!
   end
 end

data/lib/alerty/command.rb

@@ -1,20 +1,31 @@
 require 'frontkick'
+require 'socket'
 
 class Alerty
   class Command
     def initialize(command:)
       @command = command
       @opts = { timeout: Config.timeout, exclusive: Config.lock_path }
+      @hostname = Socket.gethostname
     end
 
     def run!
+      started_at = Time.now
       result = Frontkick.exec("#{@command} 2>&1", @opts)
       if result.success?
         exit 0
       else
+        record = {
+          hostname:   @hostname,
+          command:    @command,
+          exitstatus: result.exitstatus,
+          output:     result.stdout,
+          started_at: started_at.to_f,
+          duration:   result.duration,
+        }
         Config.plugins.each do |plugin|
           begin
-            plugin.alert(result.stdout)
+            plugin.alert(record)
           rescue => e
             Alerty.logger.warn "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
           end

data/lib/alerty/config.rb

@@ -41,6 +41,13 @@ class Alerty
           Object.const_get(class_name).new(plugin)
         end
       end
+
+      # for debug
+      def reset
+        @config_path = nil
+        @config = nil
+        @plugins = nil
+      end
     end
   end
 end

data/lib/alerty/plugin/exec.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'frontkick'
+require 'shellwords'
+
+class Alerty
+  class Plugin
+    class Exec
+      def initialize(config)
+        raise ConfigError.new("exec: command is not configured") unless config.command
+        @command = config.command
+      end
+
+      def alert(record)
+        Alerty.logger.info "exec: echo #{record.to_json.shellescape} | #{@command}"
+        Frontkick.exec("echo #{record.to_json.shellescape} | #{@command}")
+      end
+    end
+  end
+end

data/lib/alerty/plugin/file.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 class Alerty
   class Plugin
     class File
@@ -6,9 +8,9 @@ class Alerty
         @path = config.path
       end
 
-      def alert(msg)
+      def alert(record)
         ::File.open(@path, 'a') do |io|
-          io.puts msg
+          io.puts record.to_json
         end
       end
     end

data/lib/alerty/plugin/stdout.rb

@@ -1,11 +1,13 @@
+require 'json'
+
 class Alerty
   class Plugin
     class Stdout
       def initialize(config)
       end
 
-      def alert(msg)
-        $stdout.puts msg
+      def alert(record)
+        $stdout.puts record.to_json
       end
     end
   end

data/lib/alerty.rb

@@ -3,6 +3,7 @@ require_relative 'alerty/error'
 require_relative 'alerty/config'
 require_relative 'alerty/command'
 require_relative 'alerty/logger'
+require_relative 'alerty/cli'
 
 class Alerty
   def self.logger

data/spec/cli_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe Alerty::CLI do
+  CONFIG_PATH = File.join(File.dirname(__FILE__), 'cli_spec.yml')
+  BIN_DIR = File.join(ROOT, 'bin')
+  OUTPUT_FILE = File.join(File.dirname(__FILE__), 'cli_spec.out')
+
+  describe '#parse_options' do
+    it 'incorrect' do
+      expect { Alerty::CLI.new.parse_options([]) }.to raise_error(OptionParser::InvalidOption)
+    end
+
+    it 'command' do
+      expect(Alerty::CLI.new.parse_options(['--', 'ls', '-l'])[:command]).to eql('ls -l')
+    end
+
+    it 'config' do
+      expect(Alerty::CLI.new.parse_options(['-c', 'config.yml', '--', 'ls'])[:config_path]).to eql('config.yml')
+    end
+  end
+
+  describe '#run' do
+    context 'with success' do
+      before :all do
+        FileUtils.rm(OUTPUT_FILE, force: true)
+        system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- echo foo")
+        sleep 0.1
+      end
+
+      it 'should not output' do
+        expect(File.size?(OUTPUT_FILE)).to be_falsey
+      end
+    end
+
+    context 'with failure' do
+      before :all do
+        FileUtils.rm(OUTPUT_FILE, force: true)
+        system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- [ a = b ]")
+        sleep 0.1
+      end
+
+      it 'should output' do
+        expect(File.size?(OUTPUT_FILE)).to be_truthy
+      end
+    end
+  end
+end

data/spec/cli_spec.yml

@@ -0,0 +1,6 @@
+log_path: STDOUT
+log_level: debug
+timeout: 10
+plugins:
+  - type: file
+    path: spec/cli_spec.out

data/spec/command_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Alerty::Command do
+  describe 'run!' do
+    context 'Frontkick.exec' do
+      before do
+        Alerty::Config.configure(
+          log_path: '/tmp/foo',
+          log_level: 'fatal',
+          timeout: 20,
+          lock_path: '/tmp/lock',
+        )
+      end
+
+      let(:command) { Alerty::Command.new(command: 'ls') }
+
+      it do
+        expect(Frontkick).to receive(:exec).with("ls 2>&1", {
+          timeout: 20,
+          exclusive: '/tmp/lock',
+        }).and_return(Frontkick::Result.new(exit_code: 0))
+        expect { command.run! }.to raise_error(SystemExit)
+      end
+    end
+
+    context 'plugins.alert' do
+      before do
+        Alerty::Config.instance_variable_set(:@config, Hashie::Mash.new(
+          plugins: [{
+            type: 'stdout',
+          }]
+        ))
+        Alerty::Config.configure(
+          log_path: '/tmp/foo',
+          log_level: 'fatal',
+          timeout: nil,
+          lock_path: nil,
+        )
+      end
+
+      let(:command) { Alerty::Command.new(command: 'echo foo') }
+
+      it do
+        expect(Frontkick).to receive(:exec).with("echo foo 2>&1", {
+          timeout: nil,
+          exclusive: nil,
+        }).and_return(Frontkick::Result.new(stdout: 'foo', exit_code: 1))
+        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
+        expect(JSON.parse(stdout)["output"]).to eql("foo")
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Alerty::Config do
+  describe 'configure' do
+    before do
+      Alerty::Config.configure(
+        log_path: '/tmp/foo',
+        log_level: 'fatal',
+        timeout: 20,
+        lock_path: '/tmp/lock',
+      )
+    end
+
+    it { expect(Alerty::Config.log_path).to eql('/tmp/foo') }
+    it { expect(Alerty::Config.log_level).to eql('fatal') }
+    it { expect(Alerty::Config.timeout).to eql(20) }
+    it { expect(Alerty::Config.lock_path).to eql('/tmp/lock') }
+  end
+
+  describe 'config' do
+    before do
+      Alerty::Config.instance_variable_set(:@config, Hashie::Mash.new(
+        log_path: '/tmp/foo',
+        log_level: 'fatal',
+        timeout: 20,
+        lock_path: '/tmp/lock',
+      ))
+    end
+
+    it { expect(Alerty::Config.log_path).to eql('/tmp/foo') }
+    it { expect(Alerty::Config.log_level).to eql('fatal') }
+    it { expect(Alerty::Config.timeout).to eql(20) }
+    it { expect(Alerty::Config.lock_path).to eql('/tmp/lock') }
+  end
+
+  describe 'plugins' do
+    before do
+      Alerty::Config.reset
+      Alerty::Config.instance_variable_set(:@config, Hashie::Mash.new(
+        log_path: '/tmp/foo',
+        log_level: 'fatal',
+        timeout: 20,
+        lock_path: '/tmp/lock',
+        plugins: [
+          {
+            type: 'stdout',
+          },
+          {
+            type: 'file',
+            path: 'STDOUT',
+          }
+        ]
+      ))
+    end
+
+    it do
+      expect(Alerty::Config.plugins[0]).to be_a(Alerty::Plugin::Stdout)
+      expect(Alerty::Config.plugins[1]).to be_a(Alerty::Plugin::File)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,5 +6,15 @@ require 'alerty'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+ROOT = File.dirname(File.dirname(__FILE__))
+def capture_stdout
+  out = StringIO.new
+  $stdout = out
+  yield
+  return out.string
+ensure
+  $stdout = STDOUT
+end
+
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alerty
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -145,10 +145,15 @@ files:
 - lib/alerty/config.rb
 - lib/alerty/error.rb
 - lib/alerty/logger.rb
+- lib/alerty/plugin/exec.rb
 - lib/alerty/plugin/file.rb
 - lib/alerty/plugin/stdout.rb
 - lib/alerty/string_util.rb
 - log/.gitkeep
+- spec/cli_spec.rb
+- spec/cli_spec.yml
+- spec/command_spec.rb
+- spec/config_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sonots/alerty
 licenses:
@@ -175,4 +180,8 @@ signing_key:
 specification_version: 4
 summary: Send an alert if a given command failed
 test_files:
+- spec/cli_spec.rb
+- spec/cli_spec.yml
+- spec/command_spec.rb
+- spec/config_spec.rb
 - spec/spec_helper.rb