observed 0.1.1 → 0.2.0.rc1

data/spec/observed_spec.rb

@@ -76,4 +76,207 @@ describe Observed do
       end
     end
   end
+
+  describe 'when included' do
+    subject {
+      Module.new do
+        extend Observed
+      end
+    }
+    let(:t) {
+      Time.now
+    }
+    let(:common) {
+      'common'
+    }
+    let(:out) {
+      out = mock('out1')
+      out.expects(:write).with(tag:'t', foo:1, foo2:1, bar:2, bar2:2, baz:3, baz2:3, r3:'common', time: t)
+        .at_least_once
+      out
+    }
+    it 'can be used to define components and trigger them immediately' do
+      report_to_out = subject.report do |data, options|
+        out.write data.merge(baz2:data[:baz]).merge(r3: common).merge(options)
+      end
+      observe_then_translate_then_report = (
+        subject.observe 'foo' do |data|
+          data.merge(foo2:data[:foo],bar:2)
+        end
+      ).then(
+        subject.translate do |data, options|
+          data.merge(bar2:data[:bar],baz:3)
+        end
+      ).then(
+        report_to_out
+      )
+
+      observe_then_translate_then_report.now({foo:1}, {tag: 't', time: t})
+
+    end
+    context 'with plugins' do
+      before {
+        class TestObserver < Observed::Observer
+          plugin_name 'test1'
+          def observe(data, options)
+            data.merge({foo2:data[:foo],bar:2})
+          end
+        end
+        class TestTranslator < Observed::Translator
+          plugin_name 'test1'
+          def translate(data, options)
+            data.merge({bar2:data[:bar],baz:3})
+          end
+        end
+        class TestReporter < Observed::Reporter
+          plugin_name 'test1'
+          attribute :common
+          include Observed::Reporter::RegexpMatching
+          def report(data, options)
+            out = options[:out]
+            options = options.dup
+            options.delete :out
+            out.write data.merge({baz2:data[:baz],r3:common}.merge(options))
+          end
+        end
+      }
+      it 'can be used to define components from plugins and trigger them immediately' do
+        observe_then_translate_then_report = (subject.observe via: 'test1')
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {common: common})
+
+        observe_then_translate_then_report.now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'can be used to send and receive tagged events' do
+        require 'observed/job'
+        require 'observed/jobbed_event_bus'
+        executor = Observed::BlockingJobExecutor.new
+        job_factory = Observed::JobFactory.new(executor: executor)
+        bus = Observed::JobbedEventBus.new(job_factory: job_factory)
+
+        observe_then_send = (subject.observe via: 'test1')
+          .then(bus.pipe_to_emit 'foo')
+
+        bus.receive(/foo/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {common: common})
+
+        observe_then_send.now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'can be used to send and receive tagged events with the default event bus' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        observe_then_send = (subject.observe via: 'test1')
+          .then(subject.emit 'foo')
+
+        subject.receive(/foo/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {common: common})
+
+        observe_then_send.now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'provides the way to send the tagged events with a bit shorter code' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        observe_then_send = (subject.observe 'foo', via: 'test1')
+
+        subject.receive(/foo/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {out: out, common: common})
+
+        observe_then_send.now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'provides the way to receive the tagged events with a bit shorter code' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        observe_then_send = (subject.observe via: 'test1')
+          .then(subject.translate via: 'test1')
+          .then(subject.emit('bar'))
+
+        subject.report /bar/, via: 'test1', with: {out: out, common: common}
+
+        observe_then_send.now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'provides the way to group up observations' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        subject.group :a, [
+          (subject.observe via: 'test1')
+            .then(subject.translate via: 'test1')
+            .then(subject.emit('baz'))
+        ]
+
+        subject.report /baz/, via: 'test1', with: {out: out, common: common}
+
+        subject.group(:a).each do |observe_something|
+          observe_something.now({foo:1}, {tag: 't', time: t, out: out})
+        end
+      end
+      it 'provides the way to group up observations by their tags' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        subject.observe 'hoge', via: 'test1'
+
+        subject.receive(/hoge/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {out: out, common: common})
+
+        subject.group('hoge').each do |observe_something|
+          observe_something.now({foo:1}, {tag: 't', time: t, out: out})
+        end
+      end
+      it 'provides the way to run a group of observations in single method call' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        subject.observe 'hoge', via: 'test1'
+
+        subject.receive(/hoge/)
+        .then(subject.translate via: 'test1')
+        .then(subject.report via: 'test1', with: {out: out, common: common})
+
+        subject.run_group('hoge').now({foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'provides a short-cut for running a group of observations' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        subject.observe 'fuga', via: 'test1'
+
+        subject.receive(/fuga/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {out: out, common: common})
+
+        subject.run('fuga', {foo:1}, {tag: 't', time: t, out: out})
+      end
+      it 'provides the default values for the option `tag` and `time`' do
+        require 'observed/job'
+
+        subject.configure executor: Observed::BlockingJobExecutor.new
+
+        subject.observe 't', via: 'test1'
+
+        subject.receive(/t/)
+          .then(subject.translate via: 'test1')
+          .then(subject.report via: 'test1', with: {out: out, common: common})
+
+        ::Time.stubs(now: t)
+
+        subject.run('t', {foo:1}, {out: out})
+      end
+    end
+
+  end
 end

data/spec/observer_helpers/timer_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+require 'observed/observer'
+require 'observed/observer_helpers/timer'
+require 'observed/configurable'
+
+describe describe Observed::ObserverHelpers::Timer do
+
+  before {
+    subject.configure system: sys, logger: logger
+  }
+
+  let(:sys) {
+    sys = stub('system')
+    sys.stubs(:now).returns(before).then.returns(after)
+    sys
+  }
+
+  let(:before) { Time.now }
+
+  let(:after) { Time.now + 1 }
+
+  let(:logger) {
+    mock('logger')
+  }
+
+  context 'when included to the new Observer implementation class' do
+    subject {
+      klass = Class.new(Observed::Observer) do
+        include Observed::ObserverHelpers::Timer
+        include Observed::Configurable
+        include Observed::Logging
+
+        def observe(data)
+          [tag, data]
+        end
+      end
+      klass.new
+    }
+    it 'returns the result instead of reporting it via the system' do
+      data = ['test.success', {status: :success, result: 'the result', elapsed_time: after - before }]
+
+      expect(
+          subject.time_and_report(tag: 'test', timeout_in_seconds: 1.0) do
+            'the result'
+          end
+      ).to eq(data)
+    end
+  end
+
+  context 'when its logging enabled' do
+
+    subject {
+      klass = Class.new(Observed::Observer) do
+        include Observed::ObserverHelpers::Timer
+        include Observed::Configurable
+        include Observed::Logging
+      end
+      klass.new
+    }
+
+    describe 'its `time` method' do
+      context 'when missing :timeout_in_seconds parameter' do
+        it 'fails' do
+
+          expect {
+            subject.time({}) do
+              fail 'This block should not be called'
+            end
+          }.to raise_error(/The key `:timeout_in_seconds` must be exist in the options/)
+
+        end
+      end
+
+      context 'with correct parameters' do
+        context 'given the block which does not time out' do
+          it 'returns the result containing its status, value, elapsed time' do
+
+            expect(
+              subject.time({timeout_in_seconds: 1.0}) do
+                'test_value'
+              end
+            ).to eq(status: :success, result: 'test_value', elapsed_time: after - before)
+
+          end
+
+          context 'given the block which does time out' do
+            it 'returns the result containing its status, flag, message while logging the error' do
+
+              logger.expects(:debug).once
+              expect(
+                subject.time(timeout_in_seconds: 1.0) do
+                  raise Timeout::Error
+                end
+              ).to eq(status: :error, timed_out: true, error: {message: 'Timed out.'})
+
+            end
+          end
+
+          context 'given the block which fails' do
+            it 'returns the result containing its status, message while logging the error' do
+
+              logger.expects(:error).once
+              expect(
+                subject.time(timeout_in_seconds: 1.0) do
+                  raise RuntimeError, 'The error message'
+                end
+              ).to eq(status: :error, error: {message: 'The error message'})
+
+            end
+          end
+        end
+      end
+
+    end
+  end
+
+  context 'when its logging disabled' do
+
+    subject {
+      klass = Class.new(Observed::Observer) do
+        include Observed::ObserverHelpers::Timer
+        include Observed::Configurable
+      end
+      klass.new
+    }
+
+    describe 'its `time` method' do
+      context 'with correct parameters' do
+        context 'given the block which does time out' do
+          it 'returns the result containing its status, flag, message while not logging the error' do
+
+            logger.expects(:debug).never
+            expect(
+              subject.time(timeout_in_seconds: 1.0) do
+                raise Timeout::Error
+              end
+            ).to eq(status: :error, error: {message: 'Timed out.'}, timed_out: true)
+          end
+        end
+
+        context 'given the block which fails' do
+          it 'returns the result containing its status, message while not logging the error' do
+
+            logger.expects(:error).never
+            expect(
+              subject.time(timeout_in_seconds: 1.0) do
+                raise StandardError, 'The error message'
+              end
+            ).to eq(status: :error, error: {message: 'The error message'})
+
+          end
+        end
+      end
+    end
+
+    describe 'its `time_and_report` method' do
+      context 'when :tag parameter is not given' do
+        it 'fails' do
+
+          expect {
+            subject.time_and_report(timeout_in_seconds: 1.0) do
+              'the result'
+            end
+          }.to raise_error
+
+        end
+      end
+
+      context 'when :tag parameter is given' do
+        it 'reports the result of `time`' do
+
+          data = ['test.success', {status: :success, result: 'the result', elapsed_time: after - before }]
+
+          sys.expects(:report).with(*data).once
+
+          expect(
+            subject.time_and_report(tag: 'test', timeout_in_seconds: 1.0) do
+              'the result'
+            end
+          ).to eq(data)
+
+        end
+      end
+    end
+  end
+end

data/spec/oneshot_spec.rb

@@ -52,7 +52,12 @@ describe Observed::Application::Oneshot do
       end
     end
   end
-  context 'with configuration directories' do
-
+  describe '#parse_argv!' do
+    it 'parses ARGV like arrays and extracts Hash objects containing initialization parameters' do
+      argv = %w| -l logfile -d observed.rb foo1 |
+      params = Observed::Application::Oneshot.parse_argv! argv
+      expect(params).to eq({log_file: Pathname.new('logfile'), debug: true, config_file: 'observed.rb'})
+      expect(argv).to eq(%w| foo1 |)
+    end
   end
 end

data/spec/system_spec.rb

@@ -9,37 +9,6 @@ describe Observed::System do
     Observed::System.new(the_config)
   }
 
-  context 'with reporters configured' do
-
-    let(:the_config) {
-      s = stub('foo')
-      s.stubs(reporters: [reporter])
-      { config: s, logger: Logger.new(STDOUT, Logger::DEBUG) }
-    }
-
-    let(:reporter) {
-      s = stub('reporter')
-      s.stubs(match: true)
-      s
-    }
-
-    let(:the_time) {
-      Time.now
-    }
-
-    before {
-      Time.stubs(now: the_time)
-    }
-
-    context 'when the time of a report is omitted' do
-      it 'complements the current time' do
-        reporter.expects(:report).with('the_tag', the_time, {data:1})
-        subject.report('the_tag', {data:1})
-      end
-    end
-
-  end
-
   context 'with observers configured' do
 
     let(:observers) {
@@ -52,11 +21,15 @@ describe Observed::System do
       c
     }
 
+    let(:context) {
+      Observed::Context.new
+    }
+
     let(:the_config) {
       c = stub('config')
       c.stubs(observers: observers)
       c
-      { config: c, logger: Logger.new(STDOUT, Logger::DEBUG) }
+      { config: c, logger: Logger.new(STDOUT, Logger::DEBUG), context: context }
     }
 
     context 'when there is no matching observer for a tag' do
@@ -64,12 +37,5 @@ describe Observed::System do
         expect { subject.run('foo') }.to raise_error(/No configuration found for observation name 'foo'/)
       end
     end
-
-    context 'when there is one or more observers matches the tag' do
-      it 'runs the observer' do
-        observer.expects(:observe).once
-        expect { subject.run('bar') }.to_not raise_error
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: observed
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - KUOKA Yusuke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - examples/00readme/observed.rb
 - examples/observed.rb
 - exe/observed-oneshot
+- features/explicit_routing.feature
 - features/oneshot.feature
 - features/support/env.rb
 - features/test_in_single_ruby_source.feature
@@ -161,6 +162,17 @@ files:
 - integrations/observed-clockwork/lib/observed/clockwork.rb
 - integrations/observed-clockwork/lib/observed/clockwork/version.rb
 - integrations/observed-clockwork/observed-clockwork.gemspec
+- integrations/observed-eventmachine/.gitignore
+- integrations/observed-eventmachine/Gemfile
+- integrations/observed-eventmachine/LICENSE.txt
+- integrations/observed-eventmachine/README.md
+- integrations/observed-eventmachine/Rakefile
+- integrations/observed-eventmachine/examples/observed.rb
+- integrations/observed-eventmachine/features/integration_via_single_ruby_source.feature
+- integrations/observed-eventmachine/features/support/env.rb
+- integrations/observed-eventmachine/lib/observed/eventmachine.rb
+- integrations/observed-eventmachine/lib/observed/eventmachine/version.rb
+- integrations/observed-eventmachine/observed-eventmachine.gemspec
 - lib/observed.rb
 - lib/observed/application.rb
 - lib/observed/application/oneshot.rb
@@ -171,23 +183,39 @@ files:
 - lib/observed/config_builder.rb
 - lib/observed/config_dsl.rb
 - lib/observed/configurable.rb
+- lib/observed/context.rb
 - lib/observed/default.rb
 - lib/observed/default/observer.rb
-- lib/observed/default/reporter.rb
+- lib/observed/event_bus.rb
+- lib/observed/execution_job_factory.rb
 - lib/observed/hash.rb
 - lib/observed/hash/builder.rb
 - lib/observed/hash/fetcher.rb
 - lib/observed/hash/key_path_encoding.rb
+- lib/observed/job.rb
+- lib/observed/jobbed_event_bus.rb
+- lib/observed/logging.rb
 - lib/observed/observer.rb
 - lib/observed/observer_helpers/timer.rb
 - lib/observed/pluggable.rb
-- lib/observed/reader.rb
 - lib/observed/reporter.rb
 - lib/observed/reporter/regexp_matching.rb
+- lib/observed/reporter/report_formatting.rb
 - lib/observed/system.rb
+- lib/observed/translator.rb
 - lib/observed/version.rb
-- lib/observed/writer.rb
 - observed.gemspec
+- omnibus-observed/.gitignore
+- omnibus-observed/Berksfile
+- omnibus-observed/Berksfile.lock
+- omnibus-observed/Gemfile
+- omnibus-observed/README.md
+- omnibus-observed/Vagrantfile
+- omnibus-observed/config/projects/observed.rb
+- omnibus-observed/config/software/observed.rb
+- omnibus-observed/package-scripts/observed/makeselfinst
+- omnibus-observed/package-scripts/observed/postinst
+- omnibus-observed/package-scripts/observed/postrm
 - plugins/observed-fluentd/.gitignore
 - plugins/observed-fluentd/Gemfile
 - plugins/observed-fluentd/LICENSE.txt
@@ -212,6 +240,8 @@ files:
 - plugins/observed-gauge/observed-gauge.gemspec
 - plugins/observed-gauge/spec/gauge_spec.rb
 - plugins/observed-gauge/spec/spec_helper.rb
+- plugins/observed-growl/Gemfile
+- plugins/observed-growl/lib/observed/growl.rb
 - plugins/observed-http/.gitignore
 - plugins/observed-http/Gemfile
 - plugins/observed-http/LICENSE.txt
@@ -224,12 +254,18 @@ files:
 - plugins/observed-http/observed-http.gemspec
 - plugins/observed-http/spec/fixtures/observed.conf
 - plugins/observed-http/spec/http_spec.rb
+- plugins/observed-http/spec/integration_spec.rb
 - plugins/observed-http/spec/spec_helper.rb
+- plugins/observed-shell/Gemfile
+- plugins/observed-shell/lib/observed/shell.rb
+- run-integration-tests
 - spec/builtin_plugins/file_spec.rb
 - spec/builtin_plugins/stdout_spec.rb
 - spec/config_builder_spec.rb
 - spec/config_dsl_spec.rb
 - spec/configurable_spec.rb
+- spec/event_bus_spec.rb
+- spec/execution_job_factory_spec.rb
 - spec/fixtures/configure_by_conf/foo_plugin.rb
 - spec/fixtures/configure_by_conf/observed.conf
 - spec/fixtures/configure_by_conf_dot_d/foo_plugin.rb
@@ -239,14 +275,16 @@ files:
 - spec/hash/builder_spec.rb
 - spec/hash/fetcher_spec.rb
 - spec/input_helpers/timer_spec.rb
+- spec/job_factory_spec.rb
+- spec/job_spec.rb
+- spec/jobbed_event_bus_spec.rb
 - spec/observed_spec.rb
+- spec/observer_helpers/timer_spec.rb
 - spec/observer_spec.rb
 - spec/oneshot_spec.rb
-- spec/reader_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/system_spec.rb
-- spec/writer_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -262,16 +300,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Observed is a health-check framework for various services
 test_files:
+- features/explicit_routing.feature
 - features/oneshot.feature
 - features/support/env.rb
 - features/test_in_single_ruby_source.feature
@@ -280,6 +319,8 @@ test_files:
 - spec/config_builder_spec.rb
 - spec/config_dsl_spec.rb
 - spec/configurable_spec.rb
+- spec/event_bus_spec.rb
+- spec/execution_job_factory_spec.rb
 - spec/fixtures/configure_by_conf/foo_plugin.rb
 - spec/fixtures/configure_by_conf/observed.conf
 - spec/fixtures/configure_by_conf_dot_d/foo_plugin.rb
@@ -289,11 +330,13 @@ test_files:
 - spec/hash/builder_spec.rb
 - spec/hash/fetcher_spec.rb
 - spec/input_helpers/timer_spec.rb
+- spec/job_factory_spec.rb
+- spec/job_spec.rb
+- spec/jobbed_event_bus_spec.rb
 - spec/observed_spec.rb
+- spec/observer_helpers/timer_spec.rb
 - spec/observer_spec.rb
 - spec/oneshot_spec.rb
-- spec/reader_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/system_spec.rb
-- spec/writer_spec.rb

data/lib/observed/default/reporter.rb

@@ -1,17 +0,0 @@
-require 'observed/reporter'
-require 'observed/reporter/regexp_matching'
-
-module Observed
-  module Default
-    class Reporter < Observed::Reporter
-      include Observed::Reporter::RegexpMatching
-
-      attribute :writer
-
-      def report(tag, time, data)
-        writer.write tag, time, data
-      end
-
-    end
-  end
-end

data/lib/observed/reader.rb

@@ -1,14 +0,0 @@
-require 'observed/configurable'
-require 'observed/pluggable'
-
-module Observed
-  class Reader
-    include Observed::Configurable
-    include Observed::Pluggable
-
-    def read
-      fail 'Not Implemented'
-    end
-
-  end
-end

data/lib/observed/writer.rb

@@ -1,14 +0,0 @@
-require 'observed/configurable'
-require 'observed/pluggable'
-
-module Observed
-  class Writer
-    include Observed::Configurable
-    include Observed::Pluggable
-
-    def write(tag, time, data)
-      fail 'Not Implemented'
-    end
-
-  end
-end