ciserver_formatter 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    ciserver_formatter (0.0.1)
+      rspec (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  ciserver_formatter!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Diego Alonso
+
+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/README.md

@@ -0,0 +1,29 @@
+# CiserverFormatter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ciserver_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ciserver_formatter
+
+## 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/Rakefile

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

data/ciserver_formatter.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ciserver_formatter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ciserver_formatter"
+  gem.version       = CiserverFormatter::VERSION
+  gem.authors       = ["Diego Alonso"]
+  gem.email         = ["diego.alonso@adaptfms.com"]
+  gem.description   = %q{Formatter for AdaptFMS CI server}
+  gem.summary       = %q{Formatter used when running rspec from the AdaptFMS CI server}
+  gem.homepage      = "http://www.adaptfms.com"
+
+  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"]
+
+  gem.add_dependency('rspec', ["~> 2.0"])
+end

data/lib/ciserver_formatter/ciserver_formatter.rb

@@ -0,0 +1,91 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+module CiserverFormatter
+  class CiserverFormatter <  RSpec::Core::Formatters::BaseTextFormatter
+    attr_accessor :status, :passed_count, :failed_count, :pending_count, :example_count
+
+    def initialize(output)
+      super
+      @status = :pass
+      @passed_count = 0
+      @failed_count = 0
+      @pending_count = 0
+      @group_level = 0
+    end
+
+    def start(example_count)
+      @example_count = example_count
+      StatusReporter.new(FileResolver.branch_status_file).start
+      StatusReporter.new(FileResolver.commit_status_file).start
+    end
+
+    def output
+      @ciserver_output ||= File.open(FileResolver.output_file, 'w')
+    end
+
+    def stop
+      StatusReporter.new(FileResolver.branch_status_file).finish(self)
+      StatusReporter.new(FileResolver.commit_status_file).finish(self)
+    end
+
+    def example_group_started(example_group)
+      super
+      output.puts "#{current_indentation}#{example_group.description}"
+      @group_level += 1
+    end
+
+    def example_group_finished(example_group)
+      super
+      @group_level -= 1
+    end
+
+    def example_started(example)
+      super
+    end
+
+    def example_pending(example)
+      super
+      output.puts "#{current_indentation}#{example.description}"
+      @status = :pending if @status == :pass
+      @pending_count += 1
+      update_progress
+    end
+
+    def example_failed(example)
+      super
+      output.puts "#{current_indentation}#{example.description}"
+      @status = :failed
+      @failed_count += 1
+      update_progress
+    end
+
+    def example_passed(example)
+      super
+      output.puts "#{current_indentation}#{example.description}"
+      @passed_count += 1
+      update_progress
+    end
+
+    def percentage
+      total_count * 100 / @example_count
+    end
+
+    def branch
+      FileResolver.branch
+    end
+
+    private
+    def current_indentation
+      '  ' * @group_level
+    end
+
+    def total_count
+      @failed_count + @passed_count + @pending_count
+    end
+
+    def update_progress
+      ProgressReporter.new(FileResolver.progress_output_file).report(self)
+    end
+
+  end
+end

data/lib/ciserver_formatter/file_resolver.rb

@@ -0,0 +1,40 @@
+module CiserverFormatter
+  class FileResolver
+    def self.branch
+      ENV['BRANCH']
+    end
+
+    def self.branch_path
+      File.join(build_path, branch)
+    end
+
+    def self.commit
+      ENV['COMMIT']
+    end
+
+    def self.commit_path
+      File.join(build_path, branch, commit)
+    end
+
+    def self.build_path
+      ENV['BUILD_PATH']
+    end
+
+    def self.progress_output_file
+      File.join(build_path, 'current_test_session.txt')
+    end
+
+    def self.commit_status_file
+      File.join(commit_path, 'status.txt')
+    end
+
+    def self.branch_status_file
+      File.join(branch_path, 'status.txt')
+    end
+
+    def self.output_file
+      File.join(commit_path, 'output.txt')
+    end
+
+  end
+end

data/lib/ciserver_formatter/progress_reporter.rb

@@ -0,0 +1,25 @@
+module CiserverFormatter
+  class ProgressReporter
+
+    def initialize(output_file)
+      @output_file = output_file
+    end
+
+    def report(formatter)
+      File.open(@output_file, 'w') { |f| f.write(output_for_formatter(formatter)) }
+    end
+
+    private
+    def output_for_formatter(formatter)
+      """branch:#{formatter.branch}
+test_session_status:#{formatter.status.capitalize}
+percentage_run:#{formatter.percentage}
+failed_count:#{formatter.failed_count}
+pending_count:#{formatter.pending_count}
+passed_count:#{formatter.passed_count}
+example_count:#{formatter.example_count}
+      """
+    end
+
+  end
+end

data/lib/ciserver_formatter/status_reporter.rb

@@ -0,0 +1,15 @@
+module CiserverFormatter
+  class StatusReporter
+    def initialize(file)
+      @file = file
+    end
+
+    def start
+      File.open(@file, 'w') { |f| f.write("Testing") }
+    end
+
+    def finish(formatter)
+      File.open(@file, 'w') { |f| f.write(formatter.status.capitalize) }
+    end
+  end
+end

data/lib/ciserver_formatter/version.rb

@@ -0,0 +1,3 @@
+module CiserverFormatter
+  VERSION = "0.0.1"
+end

data/lib/ciserver_formatter.rb

@@ -0,0 +1,8 @@
+require "ciserver_formatter/version"
+require "ciserver_formatter/ciserver_formatter"
+require "ciserver_formatter/status_reporter"
+require "ciserver_formatter/file_resolver"
+require "ciserver_formatter/progress_reporter"
+
+module CiserverFormatter
+end

data/spec/ciserver_formatter/ciserver_formatter_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+module CiserverFormatter
+  describe CiserverFormatter do
+    let(:output) { double(:string_io).as_null_object }
+    let(:formatter) { CiserverFormatter.new(output) }
+    let(:example) { double(:example) }
+    let(:example_group) { double(:example_group) }
+
+    before(:each) do
+      # Ignore progress report
+      FileResolver.stub(progress_output_file: nil)
+      ProgressReporter.stub(:new).with(nil).and_return(double(:reporter).as_null_object)
+    end
+
+    describe "initialize" do
+      it "should start as passed" do
+        formatter.status.should be :pass
+      end
+
+      it "should start with no examples passed" do
+        formatter.passed_count.should be 0
+      end
+
+      it "should start with no examples failed" do
+        formatter.failed_count.should be 0
+      end
+
+      it "should start with no examples pending" do
+        formatter.pending_count.should be 0
+      end
+    end
+
+    describe "example group started" do
+      it "should output the description" do
+        example_group.stub(description: "The example group description")
+        output.should_receive(:puts).with("The example group description")
+        formatter.example_group_started(example_group)
+      end
+
+      it "should increase indentation" do
+        example_group.stub(description: "")
+        formatter.example_group_started(example_group)
+
+        example.stub(description: "The example description")
+        output.should_receive(:puts).with("  The example description")
+        formatter.example_group_started(example)
+      end
+    end
+
+    describe "example group finished" do
+      it "should decrease indentation" do
+        example_group.stub(description: "")
+        formatter.example_group_started(example_group)
+        formatter.example_group_finished(example_group)
+
+        example.stub(description: "The example description")
+        output.should_receive(:puts).with("The example description")
+        formatter.example_group_started(example)
+      end
+    end
+
+    describe "example passed" do
+      it "should increase the number of passed tests" do
+        example.stub(description: "The example description")
+        formatter.example_passed(example)
+        formatter.passed_count.should be 1
+      end
+
+      it "should output the passed example description" do
+        example.stub(description: "The example description")
+        output.should_receive(:puts).with("The example description")
+        formatter.example_passed(example)
+      end
+    end
+
+    describe "example failed" do
+      it "should increase the number of failed tests" do
+        example.stub(description: "The example description")
+        formatter.example_failed(example)
+        formatter.failed_count.should be 1
+      end
+
+      it "should output the failed example description" do
+        example.stub(description: "The example description")
+        output.should_receive(:puts).with("The example description")
+        formatter.example_failed(example)
+      end
+
+      it "should change status to failed" do
+        example.stub(description: "The example description")
+        formatter.example_failed(example)
+        formatter.status.should be :failed
+      end
+    end
+
+    describe "example pending" do
+      it "should increase the number of pending tests" do
+        example.stub(description: "The example description")
+        formatter.example_pending(example)
+        formatter.pending_count.should be 1
+      end
+
+      it "should output the pending example description" do
+        example.stub(description: "The example description")
+        output.should_receive(:puts).with("The example description")
+        formatter.example_pending(example)
+      end
+
+      describe "status change" do
+        it "changes to pending if previous status was pass" do
+          example.stub(description: "The example description")
+          formatter.example_pending(example)
+          formatter.status.should be :pending
+        end
+        it "stays in failed if previous state was failed" do
+          example.stub(description: "The example description")
+          formatter.example_failed(example)
+          formatter.example_pending(example)
+          formatter.status.should be :failed
+        end
+      end
+    end
+
+    describe "percentage" do
+      before (:each) do
+        FileResolver.stub(branch_status_file: "")
+        FileResolver.stub(commit_status_file: "")
+        StatusReporter.stub_chain(:new, :start)
+        formatter.start(5)
+      end
+
+      it "percentage is 0 is no tests run" do
+        formatter.percentage.should be 0
+      end
+
+      it "calculates the right percentage" do
+        example.stub(description: "The example description")
+        formatter.example_failed(example)
+        formatter.percentage.should be 20
+      end
+    end
+
+  end
+end

data/spec/ciserver_formatter/progress_reporter_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module CiserverFormatter
+  describe ProgressReporter do
+    let(:output_file) { double(:file) }
+    let(:progress_reporter) { ProgressReporter.new(output_file) }
+
+    it "Reports the status of the formatter" do
+      expected_output = """branch:branch_name
+test_session_status:Pass
+percentage_run:35
+failed_count:0
+pending_count:0
+passed_count:35
+example_count:100
+      """
+
+      formatter = double(:formatter)
+      formatter.stub(status: :pass, percentage: 35, failed_count: 0,
+                     pending_count: 0, passed_count: 35, example_count: 100,
+                     branch: "branch_name")
+
+      opened_file = double(:opened_file)
+      File.should_receive(:open).with(output_file, 'w').and_yield(opened_file)
+      opened_file.should_receive(:write).with(expected_output)
+      progress_reporter.report(formatter)
+    end
+  end
+
+end

data/spec/ciserver_formatter/status_reporter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe CiserverFormatter::StatusReporter do
+  let(:formatter) { CiserverFormatter::CiserverFormatter.new(double(:string_io)) }
+  let(:output_file) { double(:file) }
+  let(:status_reporter) { CiserverFormatter::StatusReporter.new(output_file) }
+
+  describe "report_start" do
+    it "sets the status to testing" do
+      opened_file = double(:opened_file)
+      opened_file.should_receive(:write).with("Testing")
+      File.should_receive(:open).with(output_file, 'w').and_yield(opened_file)
+      status_reporter.start
+    end
+  end
+
+  describe "report finish" do
+    it "sets the status to the formatter status" do
+      formatter.should_receive(:status).and_return(:pass)
+      opened_file = double(:opened_file)
+      opened_file.should_receive(:write).with(:Pass)
+      File.should_receive(:open).with(output_file, 'w').and_yield(opened_file)
+      status_reporter.finish(formatter)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ciserver_formatter'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ciserver_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Diego Alonso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Formatter for AdaptFMS CI server
+email:
+- diego.alonso@adaptfms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ciserver_formatter.gemspec
+- lib/ciserver_formatter.rb
+- lib/ciserver_formatter/ciserver_formatter.rb
+- lib/ciserver_formatter/file_resolver.rb
+- lib/ciserver_formatter/progress_reporter.rb
+- lib/ciserver_formatter/status_reporter.rb
+- lib/ciserver_formatter/version.rb
+- spec/ciserver_formatter/ciserver_formatter_spec.rb
+- spec/ciserver_formatter/progress_reporter_spec.rb
+- spec/ciserver_formatter/status_reporter_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.adaptfms.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Formatter used when running rspec from the AdaptFMS CI server
+test_files:
+- spec/ciserver_formatter/ciserver_formatter_spec.rb
+- spec/ciserver_formatter/progress_reporter_spec.rb
+- spec/ciserver_formatter/status_reporter_spec.rb
+- spec/spec_helper.rb