torkify 0.0.1

data/spec/conductor_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'torkify/conductor'
+require 'torkify/observer_set'
+
+module Torkify
+  describe Conductor do
+    before do
+      @reader = double
+      @observers = Torkify::ObserverSet.new
+      @conductor = Conductor.new @observers
+    end
+
+    subject { @conductor }
+
+    it { should respond_to :observers }
+    it { should respond_to :start }
+
+    its(:observers) { should equal @observers }
+
+    context "when an observer is added" do
+      before do
+        @observer = Object.new
+        @conductor.observers.add @observer
+      end
+
+      subject { @conductor.observers.first }
+
+      it { should equal @observer }
+    end
+
+    context "when start is called" do
+      before do
+        @conductor.observers += [double, double]
+        @conductor.observers.each do |o|
+          o.should_receive(:on_startup)
+          o.should_receive(:on_shutdown)
+        end
+      end
+
+      it "should call startup and shutdown on each observer and each_line on reader" do
+        @reader.should_receive(:each_line)
+        @conductor.start @reader
+      end
+    end
+
+    context "when start is called with dummy input" do
+      before do
+        line = '["test","spec/status_change_event_spec.rb",[],"spec/status_change_event_spec.rb.log",0]'
+        @reader.should_receive(:each_line).and_yield(line)
+        @conductor.observers += [double, double]
+      end
+
+      it "should notify each observer about the test event" do
+        @conductor.observers.each do |o|
+          o.should_receive(:on_startup)
+          o.should_receive(:on_test)
+          o.should_receive(:on_shutdown)
+        end
+        @conductor.start @reader
+      end
+    end
+  end
+end

data/spec/event_parser_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'torkify/event_parser'
+
+module Torkify
+  describe EventParser do
+    before { @parser = EventParser.new }
+
+    context "when calling parse on a test event line with no numbers" do
+      before do
+        line = '["test","spec/reader_spec.rb",[],"spec/reader_spec.rb.log",3]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a TestEvent }
+
+      its(:file)     { should == 'spec/reader_spec.rb' }
+      its(:lines)    { should == [] }
+      its(:log_file) { should == 'spec/reader_spec.rb.log' }
+      its(:worker)   { should == 3 }
+    end
+
+    context "when calling parse on a test event line with numbers" do
+      before do
+        line = '["test","spec/another_spec.rb",[20, 32, 41],"spec/another_spec.rb.log",6]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a TestEvent }
+
+      its(:file)     { should == 'spec/another_spec.rb' }
+      its(:lines)    { should == [20, 32, 41] }
+      its(:log_file) { should == 'spec/another_spec.rb.log' }
+      its(:worker)   { should == 6 }
+    end
+
+    context "when calling parse on a pass event line" do
+      before do
+        line = '["pass","spec/pass_spec.rb",[27],"spec/pass_spec.rb.log",1,0,"#<Process::Status: pid 27490 exit 0>"]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a PassOrFailEvent }
+      its(:type)      { should == 'pass' }
+      its(:file)      { should == 'spec/pass_spec.rb' }
+      its(:lines)     { should == [27] }
+      its(:log_file)  { should == 'spec/pass_spec.rb.log' }
+      its(:worker)    { should == 1 }
+      its(:exit_code) { should == 0 }
+      its(:pid)       { should == 27490 }
+    end
+
+    context "when calling parse on a fail event line" do
+      before do
+
+        line = '["fail","spec/fail_spec.rb",[],"spec/fail_spec.rb.log",1,256,"#<Process::Status: pid 23318 exit 1>"]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a PassOrFailEvent }
+      its(:type)      { should == 'fail' }
+      its(:file)      { should == 'spec/fail_spec.rb' }
+      its(:lines)     { should == [] }
+      its(:log_file)  { should == 'spec/fail_spec.rb.log' }
+      its(:worker)    { should == 1 }
+      its(:exit_code) { should == 256 }
+      its(:pid)       { should == 23318 }
+    end
+
+    context "when calling parse on an absorb event line" do
+      before do
+        line = '["absorb"]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_an Event }
+      its(:type) { should == 'absorb' }
+    end
+
+    context "when calling parse on an unknown event type" do
+      before do
+        line = '["random"]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_an Event }
+      its(:type) { should == 'random' }
+    end
+
+    context "when calling parse on a pass now fail event line" do
+      before do
+        line = '["pass_now_fail","spec/status_change_spec.rb",["fail","spec/status_change_spec.rb",[68],"spec/status_change_spec.rb.log",2,256,"#<Process::Status: pid 23819 exit 1>"]]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a StatusChangeEvent }
+      its(:type)      { should == 'pass_now_fail' }
+      its(:file)      { should == 'spec/status_change_spec.rb' }
+      its(:event)     { should be_a PassOrFailEvent }
+
+      context "and getting the inner event" do
+        subject { @event.event }
+
+        its(:type)      { should == 'fail' }
+        its(:file)      { should == 'spec/status_change_spec.rb' }
+        its(:log_file)  { should == 'spec/status_change_spec.rb.log' }
+        its(:lines)     { should == [68] }
+        its(:worker)    { should == 2 }
+        its(:exit_code) { should == 256 }
+        its(:pid)       { should == 23819 }
+      end
+    end
+
+    context "when calling parse on a fail now pass event line" do
+      before do
+        line = '["fail_now_pass","spec/status_change_spec.rb",["pass","spec/status_change_spec.rb",[],"spec/status_change_spec.rb.log",1,0,"#<Process::Status: pid 677 exit 0>"]]'
+        @event = @parser.parse line
+      end
+
+      subject { @event }
+
+      it { should be_a StatusChangeEvent }
+      its(:type)      { should == 'fail_now_pass' }
+      its(:file)      { should == 'spec/status_change_spec.rb' }
+      its(:event)     { should be_a PassOrFailEvent }
+
+      context "and getting the inner event" do
+        subject { @event.event }
+
+        its(:type)      { should == 'pass' }
+        its(:file)      { should == 'spec/status_change_spec.rb' }
+        its(:log_file)  { should == 'spec/status_change_spec.rb.log' }
+        its(:lines)     { should == [] }
+        its(:worker)    { should == 1 }
+        its(:exit_code) { should == 0 }
+        its(:pid)       { should == 677 }
+      end
+    end
+
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'torkify/events/event'
+
+module Torkify
+  describe Event do
+    context "when type is absorb" do
+      before do
+        @event = Event.new('absorb')
+      end
+
+      subject { @event }
+
+      its(:type) { should == 'absorb' }
+      its(:to_s) { should == 'absorb' }
+      its(:message) { should == :on_absorb }
+    end
+  end
+end

data/spec/listener_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'torkify/listener'
+
+module Torkify
+  describe Listener do
+    before do
+      Torkify::Reader.stub(:new)
+      Torkify::Conductor.any_instance.stub(:start)
+    end
+
+    context "with default command and directory" do
+      before do
+        @command = 'tork-remote tork-engine'
+        @dir = Dir.pwd
+      end
+      subject { Listener.new @command, @dir }
+
+      it "should create a reader with those defaults" do
+        Torkify::Reader.should_receive(:new).with @command, @dir
+        subject.start
+      end
+    end
+
+    context "with alternative command and directory" do
+      before do
+        @command = 'the command'
+        @dir = 'the dir'
+      end
+
+      subject { Listener.new @command, @dir }
+
+      it "should create a reader with the given parameters" do
+        Torkify::Reader.should_receive(:new).with @command, @dir
+        subject.start
+      end
+    end
+
+    it { should respond_to :add_observer }
+
+    context "after adding an observer" do
+      before do
+        @listener = Listener.new
+      end
+
+      subject { @listener.add_observer double }
+
+      it { should be @listener }
+    end
+  end
+end

data/spec/observer_set_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'torkify/observer_set'
+require 'torkify/events/test_event'
+require 'torkify/events/pass_or_fail_event'
+
+module Torkify
+  describe ObserverSet do
+    before { @set = ObserverSet.new }
+    subject { @set }
+
+    it { should respond_to :length }
+    it { should respond_to :add }
+    it { should respond_to :<< }
+    it { should respond_to :| }
+
+    context "when empty" do
+      its(:length) { should == 0 }
+    end
+
+    context "when calling union with an array" do
+      before { @set |= [1, 3] }
+
+      it           { should be_a ObserverSet }
+      its(:length) { should == 2 }
+      its(:to_a)   { should == [1, 3] }
+    end
+
+    context "when adding an array" do
+      before { @set += [1, 3, 10] }
+
+      it           { should be_a ObserverSet }
+      its(:length) { should == 3 }
+    end
+
+    context "when it contains one observer" do
+      before do
+        @observer = Object.new
+        @set.add @observer
+      end
+
+      its(:length) { should == 1 }
+
+      context "with a pass event" do
+        before { @event = Torkify::PassOrFailEvent.new 'pass', 1, [], 3, 4, 5, 6 }
+        it "should call the pass method on the observer with dispatch" do
+          @observer.should_receive(:on_pass).with(@event)
+          @set.dispatch(@event)
+        end
+      end
+
+      context "with a fail event" do
+        before do
+          @event = Torkify::PassOrFailEvent.new 'fail', 1, [], 3, 4, 5, 6
+        end
+
+        it "should call the fail method on the observer with dispatch" do
+          @observer.should_receive(:on_fail).with(@event)
+          @set.dispatch(@event)
+        end
+
+        it "should not raise an error on dispatch with unknown method" do
+          expect { @set.dispatch(@event) }.not_to raise_error
+        end
+
+        it "should not raise an error on dispatch to method with wrong number of parameters" do
+          def @observer.on_fail; end
+          expect { @set.dispatch(@event) }.not_to raise_error
+        end
+
+        it "should not raise an error on dispatch to method that raises an exception" do
+          @observer.should_receive(:on_fail).and_raise(RuntimeError)
+          expect { @set.dispatch(@event) }.not_to raise_error
+        end
+      end
+    end
+
+    context "when it contains multiple observers" do
+      before { @set += [double, double, double] }
+
+      its(:length) { should == 3 }
+
+      it "should call the pass method on every observer with dispatch" do
+        event = Torkify::PassOrFailEvent.new 'pass', 1, [], 3, 4, 5, 6
+        @set.each { |o| o.should_receive(:on_pass).with(event) }
+        @set.dispatch(event)
+      end
+
+    end
+
+    context "when trying to add the same object twice" do
+      before do
+        object = double
+        @set.add object
+        @set.add object
+      end
+
+      its(:length) { should == 1 }
+    end
+  end
+end

data/spec/pass_or_fail_event_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'torkify/events/pass_or_fail_event'
+
+module Torkify
+  describe PassOrFailEvent do
+
+    context "with pass data" do
+      before do
+        @type = 'pass'
+        @file = 'file'
+        @lines = []
+        @log_file = 'log_file'
+        @worker = 1
+        @exit_code = 0
+        @exit_info = 'exit info'
+      end
+
+      subject { @event = PassOrFailEvent.new @type,
+                                             @file,
+                                             @lines,
+                                             @log_file,
+                                             @worker,
+                                             @exit_code,
+                                             @exit_info }
+
+      its(:type)      { should == @type }
+      its(:file)      { should == @file }
+      its(:lines)     { should == @lines }
+      its(:log_file)  { should == @log_file }
+      its(:worker)    { should == @worker }
+      its(:exit_code) { should == @exit_code }
+      its(:exit_info) { should == @exit_info }
+      its(:to_s)      { should == "PASS file" }
+      its(:message)   { should == :on_pass }
+
+      context "and line numbers" do
+        before do
+          @lines = [1, 14, 23]
+        end
+
+        its(:to_s)      { should == "PASS file (lines 1, 14, 23)" }
+      end
+    end
+
+    context "with fail data" do
+      before do
+        @type = 'fail'
+        @file = 'file'
+        @lines = []
+        @log_file = 'log_file'
+        @worker = 0
+        @exit_code = 1
+        @exit_info = 'exit info'
+      end
+
+      subject { @event = PassOrFailEvent.new @type,
+                                             @file,
+                                             @lines,
+                                             @log_file,
+                                             @worker,
+                                             @exit_code,
+                                             @exit_info }
+
+      its(:type)      { should == @type }
+      its(:file)      { should == @file }
+      its(:lines)     { should == @lines }
+      its(:log_file)  { should == @log_file }
+      its(:worker)    { should == @worker }
+      its(:exit_code) { should == @exit_code }
+      its(:exit_info) { should == @exit_info }
+      its(:to_s)      { should == "FAIL file" }
+      its(:message)   { should == :on_fail }
+
+      context "and line numbers" do
+        before do
+          @lines = [1, 14, 23]
+        end
+
+        its(:to_s)      { should == "FAIL file (lines 1, 14, 23)" }
+      end
+    end
+
+    context "with a process status string" do
+      before do
+        @event = PassOrFailEvent.new(*(1..6),
+                                     '#<Process::Status: pid 18228 exit 0>')
+      end
+
+      subject { @event.pid }
+
+      it { should == 18228 }
+    end
+  end
+end

data/spec/reader_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'torkify/reader'
+
+module Torkify
+  describe Reader do
+    context "with dummy command" do
+      before { @reader = Reader.new 'echo' }
+      subject { @reader}
+
+      it { should respond_to :readline  }
+      it { should respond_to :each_line }
+      it { should respond_to :pos       }
+    end
+
+    context "with echo command" do
+      before { @reader = Reader.new 'echo "Line 1\nLine 2"' }
+
+      context "first line" do
+        subject { @reader.readline.strip }
+        it { should == "Line 1" }
+      end
+
+      context "second line" do
+        before { @reader.readline }
+        subject { @reader.readline.strip }
+
+        it { should == "Line 2" }
+      end
+
+      context "each over line" do
+        before do
+          @output = []
+          @reader.each_line { |line| @output << line.strip }
+        end
+
+        subject { @output }
+
+        it { should == ["Line 1", "Line 2"] }
+      end
+    end
+
+    context "with command that writes to standard error" do
+      it "should raise TorkError" do
+        err = 'Command error'
+        expect { Reader.new "echo '#{err}' >&2" }.to raise_exception(TorkError, err)
+      end
+    end
+
+    context "with a working directory" do
+      before do
+        @reader = Reader.new 'echo $PWD', '/usr'
+      end
+      subject { @reader.read.strip }
+
+      it { should == '/usr' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'torkify'
+Torkify.logger.level = Log4r::FATAL

data/spec/status_change_event_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'torkify/events/status_change_event'
+require 'torkify/events/pass_or_fail_event'
+
+module Torkify
+  describe StatusChangeEvent do
+
+    context "with a pass_now_fail event" do
+      before do
+        @type = 'pass_now_fail'
+        @file = 'file'
+        @inner_event = PassOrFailEvent.new(*(1..7))
+        @event = StatusChangeEvent.new(@type, @file, @inner_event)
+      end
+
+      subject { @event }
+
+      its(:type)  { should == @type }
+      its(:file)  { should == @file }
+      its(:event) { should == @inner_event }
+      its(:to_s)  { should == 'PASS NOW FAIL file' }
+      its(:message)  { should == :on_pass_now_fail }
+    end
+
+    context "with a fail_now_pass event" do
+      before do
+        @type = 'fail_now_pass'
+        @file = 'file'
+        @inner_event = PassOrFailEvent.new(*(1..7))
+        @event = StatusChangeEvent.new(@type, @file, @inner_event)
+      end
+
+      subject { @event }
+
+      its(:type)  { should == @type }
+      its(:file)  { should == @file }
+      its(:event) { should == @inner_event }
+      its(:to_s)  { should == 'FAIL NOW PASS file' }
+      its(:message)  { should == :on_fail_now_pass }
+    end
+  end
+end

data/spec/test_event_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'torkify/events/test_event'
+
+module Torkify
+  describe TestEvent do
+
+    context "with typical seed data" do
+      before do
+        @type = 'test'
+        @file = 'file'
+        @lines = []
+        @log_file = 'log_file'
+        @worker = 1
+      end
+
+      subject { TestEvent.new(@type, @file, @lines, @log_file, @worker) }
+
+      its(:type)     { should == @type }
+      its(:file)     { should == @file }
+      its(:lines)    { should == @lines }
+      its(:log_file) { should == @log_file }
+      its(:worker)   { should == @worker }
+      its(:to_s)     { should == 'TEST file' }
+      its(:message)  { should == :on_test }
+
+      context "with line numbers" do
+        before { @lines = [1, 5, 12] }
+        its(:to_s)   { should == 'TEST file (lines 1, 5, 12)' }
+      end
+    end
+  end
+end

data/torkify.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'torkify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "torkify"
+  gem.version       = Torkify::VERSION
+  gem.authors       = ["Jon Cairns"]
+  gem.email         = ["jon@joncairns.com"]
+  gem.description   = %q{Easily create callbacks for automated testing with tork}
+  gem.summary       = %q{Torkify allows you to execute code after tests run, when using the tork gem for automated testing. You can create listeners which are called when tests are run, and when they fail or pass. This allows you to easily execute code and call system programs.}
+  gem.homepage      = "https://github.com/joonty/torkify"
+
+  gem.add_dependency 'json', '~> 1.7.7'
+  gem.add_dependency 'log4r', '~> 1.1.10'
+  gem.add_dependency 'tork', '~> 19.2.1'
+
+  gem.add_development_dependency 'rspec', '~> 2.13.0'
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end