observed 0.1.1

data/plugins/observed-gauge/spec/gauge_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+require 'observed/gauge'
+
+shared_examples_for 'the observed-gauge plugin' do
+
+  subject {
+    described_class.new
+  }
+
+  before {
+    File.delete(rrd) if File.exist?(rrd)
+
+    subject.configure rrd: rrd, key_path: key_path
+  }
+
+  it 'matches against the tag using a pattern described in regular expression' do
+    expect(subject.match('test.foo')).to be_true
+  end
+
+  it 'reports data with averaged values' do
+    subject.prepare_rrd(start: t - 120, rrd: rrd)
+    system.expects(:report).with(tag, expected_data.freeze).once
+    expect { subject.report('test.foo', t - 120, data) }.to_not raise_error
+    expect { subject.report('test.foo', t - 60, data) }.to_not raise_error
+    expect { subject.report('test.foo', t, data) }.to_not raise_error
+  end
+
+  it 'creates rrd files automatically on first report' do
+    expect { subject.report('test.foo', t, data) }.to_not raise_error
+
+    expect { File.exist? rrd }.to be_true
+  end
+end
+
+describe Observed::Plugins::Gauge do
+  subject {
+    Observed::Plugins::Gauge.new
+  }
+
+  it 'has a name' do
+    expect(described_class.plugin_name).to eq('gauge')
+  end
+
+  context 'with configuration' do
+
+    before {
+
+      subject.configure(
+          system: system,
+          tag_pattern: tag_pattern,
+          tag: tag,
+          step: step,
+          period: period
+      )
+    }
+
+    after {
+      File.delete(rrd) if File.exist?(rrd)
+    }
+
+    let(:t) {
+      Time.now
+    }
+
+    let(:system) {
+      sys = mock('system')
+
+      sys.stubs(:now).returns(t)
+
+      sys
+    }
+
+    let(:tag_pattern) {
+      /test.\.*/
+    }
+
+    let(:tag) {
+      'test.out'
+    }
+
+    let(:step) {
+      10
+    }
+
+    let(:period) {
+      60
+    }
+
+    before {
+      subject.configure(
+          system: system,
+          tag_pattern: tag_pattern,
+          tag: tag,
+          step: step,
+          period: period,
+          key_path: key_path
+      )
+    }
+
+    context 'with an incorrect key path' do
+
+      let(:key_path) {
+        123
+      }
+
+      let(:rrd) {
+        'gauge_incorrect_key_path.rrd'
+      }
+
+      let(:data) {
+        { response: { time: 10 }}
+      }
+
+      let(:t) {
+        Time.now
+      }
+
+      it 'raise an error' do
+        expect { subject.report('test.foo', t, data) }.to raise_error(/Unexpected type of key_path met/)
+      end
+    end
+
+    context 'with a correct key path' do
+
+      let(:key_path) {
+        'response.time'
+      }
+
+      let(:data_source) {
+        'response_time'
+      }
+
+      context 'with the default coercer' do
+
+        context 'with data whose keys are symbols' do
+          let(:rrd) {
+            'gauge_spec_symbols.rrd'
+          }
+
+          let(:data) {
+            { response: { time: 10 }}
+          }
+
+          let(:expected_data) {
+            { response: { time: 10 }}
+          }
+
+          it_behaves_like 'the observed-gauge plugin'
+        end
+
+        context 'with data whose keys are strings' do
+          let(:rrd) {
+            'gauge_spec_strings.rrd'
+          }
+
+          let(:data) {
+            {'response' => {'time' => 10}}
+          }
+
+          let(:expected_data) {
+            { 'response' => { 'time' => 10 }}
+          }
+
+          it_behaves_like 'the observed-gauge plugin'
+        end
+
+      end
+
+      context 'with a string-to-integer coercer for values' do
+
+        before {
+          subject.configure coercer: ->(v){ t.to_i }
+        }
+
+        let(:rrd) {
+          'gauge_spec_coercer.rrd'
+        }
+
+        let(:data) {
+          {'response' => {'time' => '10'}}
+        }
+
+        let(:expected_data) {
+          { 'response' => { 'time' => 10 }}
+        }
+
+        it_behaves_like 'the observed-gauge plugin'
+      end
+
+    end
+
+  end
+
+end

data/plugins/observed-gauge/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'fakefs/spec_helpers'
+require 'rspec'
+
+Dir["#{File.expand_path('..',  __FILE__)}/support/**/*.rb"].each { |f| require f }
+
+puts "Please do not update/create files while tests are running."
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.order = :random
+  config.filter_run :focus => true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    @fixture_path = Pathname.new(File.expand_path('../fixtures/',  __FILE__))
+  end
+
+  config.mock_framework = :mocha
+end
+
+if RUBY_VERSION =~ /^1.9/
+  require 'simplecov'
+  SimpleCov.start
+end

data/plugins/observed-http/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/plugins/observed-http/Gemfile

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

data/plugins/observed-http/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 GREE, 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/plugins/observed-http/README.md

@@ -0,0 +1,37 @@
+# Observed::Http
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'observed-http'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install observed-http
+
+## Test
+
+    $ gem build observed.gemspec
+    $ gem install observed
+    $ cd plugins/observed-http
+    $ bundle install
+    $ bundle exec rspec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/plugins/observed-http/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/plugins/observed-http/features/observe_web_services_via_http.feature

@@ -0,0 +1,32 @@
+Feature: Observe Web services via HTTP
+
+  In order to observe Web services using Observed,
+  I want to the observed-http plugin to send HTTP request and report the result via reporters
+
+  Scenario: Create a .rb file containing Observed code and run it with the ruby command
+    Given a file named "test.rb" with:
+    """
+    require 'observed'
+    require 'observed/http'
+
+    include Observed
+
+    observe 'foo_1', via: 'http', with: {
+      method: 'get',
+      url: 'http://google.com',
+      timeout_in_milliseconds: 1000
+    }
+
+    report /foo_\d+/, via: 'stdout'
+
+    run 'foo_1'
+    """
+    When I run `ruby test.rb`
+    Then the output should contain:
+    """
+    foo_1.success
+    """
+    Then the output should contain:
+    """
+    Get http://google.com
+    """

data/plugins/observed-http/features/support/env.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'aruba/cucumber'
+
+World(Aruba::Api)
+
+Before do
+  @aruba_timeout_seconds = 20
+end

data/plugins/observed-http/lib/observed/http/version.rb

@@ -0,0 +1,5 @@
+module Observed
+  module Http
+    VERSION = "0.1.0"
+  end
+end

data/plugins/observed-http/lib/observed/http.rb

@@ -0,0 +1,60 @@
+require 'observed/http/version'
+require 'observed/observer_helpers/timer'
+require 'timeout'
+require 'net/http'
+
+module Observed
+  module Plugins
+    class HTTP < Observed::Observer
+
+      include Observed::ObserverHelpers::Timer
+
+      attribute :timeout_in_milliseconds, default: 5000
+
+      attribute :method
+      attribute :url
+
+      def observe
+        logger.debug "method: #{method}, url: #{url}"
+
+        uri = URI.parse(url)
+
+        logger.debug "uri: #{uri}, uri.host: #{uri.host}, uri.port:#{uri.port}, uri.path: #{uri.path}"
+
+        http_method = method.capitalize
+        path = if uri.path.size == 0
+                 '/'
+               else
+                 uri.path
+               end
+        req = Net::HTTP::const_get(http_method.intern).new(path)
+
+        timeout_in_seconds = timeout_in_milliseconds / 1000.0
+        if timeout_in_seconds.nan?
+          fail "Invalid configuration on timeout: `timeout` must be a number but it was not(=#{timeout_in_seconds})"
+        end
+
+        time_and_report(tag: self.tag, timeout_in_seconds: timeout_in_seconds) do
+
+          logger.debug "Sending a HTTP request with the timeout of #{timeout_in_seconds} seconds"
+
+          body = Net::HTTP.start(uri.host, uri.port) {|http|
+            http.request(req)
+          }.body
+
+          logger.debug "Response body: #{body}"
+
+          "#{http_method} #{uri}"
+        end
+
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      plugin_name 'http'
+
+    end
+  end
+end

data/plugins/observed-http/observed-http.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'observed/http/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "observed-http"
+  spec.version       = Observed::Http::VERSION
+  spec.authors       = ["KUOKA Yusuke"]
+  spec.email         = ["yusuke.kuoka@gree.net"]
+  spec.description   = %q{observed-http}
+  spec.summary       = %q{observed-http is a plugin for Observed to run health-check against Web services talking HTTP.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "observed", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+end

data/plugins/observed-http/spec/fixtures/observed.conf

@@ -0,0 +1,10 @@
+require 'observed/builtin_plugins'
+require 'observed/http'
+
+observe 'foo_1', via: 'http', with: {
+  method: 'get',
+  url: 'http://google.com',
+  timeout_in_milliseconds: 1000
+}
+
+report /foo_\d+/, via: 'stdout'

data/plugins/observed-http/spec/http_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+require 'observed/application/oneshot'
+
+describe Observed::Application::Oneshot do
+  subject {
+    Observed::Application::Oneshot.create(
+        config_file: 'spec/fixtures/observed.conf'
+    )
+  }
+  it 'initializes' do
+    expect(subject.run.size).not_to eq(0)
+  end
+end

data/plugins/observed-http/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'fakefs/spec_helpers'
+require 'rspec'
+
+Dir["#{File.expand_path('..',  __FILE__)}/support/**/*.rb"].each { |f| require f }
+
+puts "Please do not update/create files while tests are running."
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.order = :random
+  config.filter_run :focus => true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    @fixture_path = Pathname.new(File.expand_path('../fixtures/',  __FILE__))
+  end
+
+  config.mock_framework = :mocha
+end
+
+if RUBY_VERSION =~ /^1.9/
+  require 'simplecov'
+  SimpleCov.start
+end

data/spec/builtin_plugins/file_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+require 'observed/builtin_plugins/file'
+
+describe Observed::BuiltinPlugins::File do
+
+  include FakeFS::SpecHelpers
+
+  subject {
+    reporter = Observed::BuiltinPlugins::File.new
+    reporter.configure config
+    reporter
+  }
+
+  let(:config) {
+    { tag_pattern: /foo\..+/, format: formatter, path: path }
+  }
+
+  let(:path) {
+    'test.txt'
+  }
+
+  before(:each) {
+    File.open(path, 'w') do |f|
+      f.write("default content\n")
+    end
+  }
+
+  shared_examples_for 'the plugin in the appending mode' do
+
+    context 'with a specific formatter' do
+
+      let(:formatter) {
+        -> tag, time, data, fetcher { "foo #{time.to_i} #{data[:foo]} #{fetcher['bar.baz']}" }
+      }
+
+      it 'reports the formatted data to the file' do
+        time = Time.now
+
+        expect { subject.report('foo', time, {foo: 1, bar: {baz: 2}}) }.to_not raise_error
+
+        expect(File.read(path)).to eq("default content\nfoo #{time.to_i} 1 2\n")
+      end
+
+    end
+
+    context 'without a specific formatter' do
+
+      let(:formatter) {
+        nil
+      }
+
+      it 'reports the data formatted by the default formatter to the stdout' do
+        time = Time.now
+
+        expect { subject.report('foo', time, {foo: 1}) }.to_not raise_error
+
+        expect(File.read(path)).to eq("default content\n#{time.to_s} foo {:foo=>1}\n")
+      end
+
+    end
+  end
+
+  shared_examples_for 'the plugin in the overwriting mode' do
+
+    context 'with a specific formatter' do
+
+      let(:formatter) {
+        -> tag, time, data, fetcher { "foo #{time.to_i} #{data[:foo]} #{fetcher['bar.baz']}" }
+      }
+
+      it 'reports the formatted data to the file' do
+        time = Time.now
+
+        expect { subject.report('foo', time, {foo: 1, bar: {baz: 2}}) }.to_not raise_error
+
+        expect(File.read(path)).to eq("foo #{time.to_i} 1 2\n")
+      end
+
+    end
+
+    context 'without a specific formatter' do
+
+      let(:formatter) {
+        nil
+      }
+
+      it 'reports the data formatted by the default formatter to the stdout' do
+        time = Time.now
+
+        expect { subject.report('foo', time, {foo: 1}) }.to_not raise_error
+
+        expect(File.read(path)).to eq("#{time.to_s} foo {:foo=>1}\n")
+      end
+
+    end
+
+  end
+
+  context 'with the default mode' do
+
+    it_behaves_like 'the plugin in the appending mode'
+
+    context 'with the formatter whose number of parameters is not 3 nor 4' do
+
+      let(:formatter) {
+        -> a, b {}
+      }
+
+      it 'fails while reporting' do
+        pattern = /Number of parameters for the function for the key :format must be 3 or 4, but was 2/
+        expect { subject.report('foo', Time.now, {}) }.to raise_error(pattern)
+      end
+    end
+
+  end
+
+  context 'with the mode :append' do
+    before {
+      subject.configure mode: :append
+    }
+    it_behaves_like 'the plugin in the appending mode'
+  end
+
+  context 'with the mode \'a\'' do
+    before {
+      subject.configure mode: 'a'
+    }
+    it_behaves_like 'the plugin in the appending mode'
+  end
+
+  context 'with the mode :overwrite' do
+    before {
+      subject.configure mode: :overwrite
+    }
+    it_behaves_like 'the plugin in the overwriting mode'
+  end
+
+  context 'with the mode \'w\'' do
+    before {
+      subject.configure mode: 'w'
+    }
+    it_behaves_like 'the plugin in the overwriting mode'
+  end
+end