right_scraper 1.0.0

data/lib/right_scraper/scrapers/svn_scraper.rb

@@ -0,0 +1,77 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+module RightScale
+
+  class SvnScraper < ScraperBase
+
+    # Check whether it is possible to perform an incremental update of the repo
+    #
+    # === Return
+    # true:: Scrape directory contains files belonging to the scraped repo and protocol supports
+    #        incremental updates
+    # false:: Otherwise
+    def incremental_update?
+      return false unless File.directory?(@repo_dir)
+      Dir.chdir(@repo_dir) do
+        info = `svn info`
+        $?.success? && info =~ (/^URL: (.*)$/) && $1 == @repo.url
+      end
+    end
+
+    # Scrape SVN repository, see RightScale::Scraper#scrape
+    #
+    # === Return
+    # true:: Always return true
+    def scrape_imp
+      msg = @incremental ? "Updating " : "Checking out "
+      msg += "SVN repository '#{@repo.display_name}'"
+      @callback.call(msg, is_step=true) if @callback
+      if @incremental
+        svn_cmd = "svn update --non-interactive --quiet" +
+        (@repo.first_credential ? " --username #{@repo.first_credential}" : '') +
+        (@repo.second_credential ? " --password #{@repo.second_credential}" : '') +
+        ' 2>&1'
+        Dir.chdir(@repo_dir) do
+          res = `#{svn_cmd}`
+          if $? != 0
+            @callback.call("Failed to update repo: #{res}, falling back to checkout", is_step=false) if @callback
+            FileUtils.rm_rf(@repo_dir)
+            @incremental = false
+          end
+        end
+      end
+      if !@incremental
+        svn_cmd = "svn checkout #{@repo.url} #{@repo_dir} --non-interactive --quiet" +
+        (!@repo.tag.nil? && !@repo.tag.empty? ? " --revision #{@repo.tag}" : '') +
+        (@repo.first_credential ? " --username #{@repo.first_credential}" : '') +
+        (@repo.second_credential ? " --password #{@repo.second_credential}" : '') +
+        ' 2>&1'
+        res = `#{svn_cmd}`
+        @errors << res if $? != 0
+      end
+      true
+    end
+
+  end
+end

data/lib/right_scraper.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+# Explicitely list required files to make IDEs happy
+require 'fileutils'
+require File.join(File.dirname(__FILE__), 'right_scraper', 'scraper_base')
+require File.join(File.dirname(__FILE__), 'right_scraper', 'scrapers', 'download_scraper')
+require File.join(File.dirname(__FILE__), 'right_scraper', 'scrapers', 'git_scraper')
+require File.join(File.dirname(__FILE__), 'right_scraper', 'scrapers', 'svn_scraper')
+require File.join(File.dirname(__FILE__), 'right_scraper', 'repository')
+require File.join(File.dirname(__FILE__), 'right_scraper', 'scraper')

data/right_scraper.gemspec

@@ -0,0 +1,55 @@
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+
+require 'rubygems'
+
+spec = Gem::Specification.new do |spec|
+  spec.name      = 'right_scraper'
+  spec.version   = '1.0.0'
+  spec.authors   = ['Raphael Simon']
+  spec.email     = 'raphael@rightscale.com'
+  spec.homepage  = 'https://github.com/rightscale/right_scraper'
+  spec.platform  = Gem::Platform::RUBY
+  spec.summary   = 'Download and update remote repositories'
+  spec.has_rdoc = true
+  spec.rdoc_options = ["--main", "README.rdoc", "--title", "RightScraper"]
+  spec.extra_rdoc_files = ["README.rdoc"]
+  spec.required_ruby_version = '>= 1.8.6'
+  spec.rubyforge_project = %q{right_scraper}
+  spec.require_path = 'lib'
+
+  spec.description = <<-EOF
+  RightScraper provides a simple interface to download and keep local copies of remote
+  repositories up-to-date using the following protocols:
+    * git: RightScraper will clone then pull repos from git
+    * SVN: RightScraper will checkout then update SVN repositories
+    * tarballs: RightScraper will download, optionally uncompress and expand a given tar file
+EOF
+
+  candidates = Dir.glob("{lib,spec}/**/*") +
+               ["LICENSE", "README.rdoc", "Rakefile", "right_scraper.gemspec"]
+  spec.files = candidates.sort
+end
+
+if $PROGRAM_NAME == __FILE__
+   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
+   Gem::Builder.new(spec).build
+end

data/spec/download_scraper_spec.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'scraper_base'
+require 'repository'
+require File.join('scrapers', 'download_scraper')
+
+describe RightScale::DownloadScraper do
+
+  include RightScale::SpecHelpers
+
+  # Create download repository following given layout
+  # Update @repo_path with path to repository
+  # Delete any previously created repo
+  def setup_download_repo
+    @download_repo_path = File.expand_path(File.join(File.dirname(__FILE__), '__download_repo'))
+    @repo_path = File.join(File.dirname(__FILE__), '__repo')
+    @repo_content = [ 'file1', { 'folder1' => [ 'file2', 'file3' ] }, { 'folder2' => [ { 'folder3' => [ 'file4' ] } ] } ]
+    FileUtils.rm_rf(@download_repo_path)
+    create_file_layout(@download_repo_path, @repo_content)
+    @download_file = File.expand_path(File.join(File.dirname(__FILE__), '__download_file.tar'))
+    Dir.chdir(@download_repo_path) do
+      res, status = exec("tar cf #{@download_file} *")
+      raise "Failed to create tarball: #{res}" unless status.success?
+    end
+  end
+
+  # Cleanup after ourselves
+  def delete_download_repo
+    FileUtils.rm_rf(@download_repo_path) if @download_repo_path
+    @download_repo_path = nil
+    FileUtils.rm_rf(@repo_path) if @repo_path
+    @repo_path = nil
+    File.delete(@download_file) if File.exist?(@download_file)
+  end
+
+  context 'given a download repository' do
+
+    before(:all) do
+      setup_download_repo
+    end
+
+    before(:each) do
+      @scraper = RightScale::DownloadScraper.new(@repo_path)
+      @repo = RightScale::Repository.from_hash(:display_name => 'test repo',
+                                               :repo_type    => :download,
+                                               :url          => "file://#{@download_file}")
+    end
+
+    after(:all) do
+      delete_download_repo
+    end
+
+    it 'should scrape' do
+      messages = []
+      @scraper.scrape(@repo) { |m, progress| messages << m if progress }
+      puts "\n **ERRORS: #{@scraper.error_message}\n" unless @scraper.succeeded?
+      @scraper.succeeded?.should be_true
+      messages.size.should == 1
+      File.directory?(@scraper.repo_dir.should be_true)
+      extract_file_layout(@scraper.repo_dir).should == @repo_content
+    end
+
+  end
+
+end

data/spec/git_scraper_spec.rb

@@ -0,0 +1,108 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'scraper_base'
+require 'repository'
+require File.join('scrapers', 'git_scraper')
+
+describe RightScale::GitScraper do
+  
+  include RightScale::SpecHelpers
+  
+  # Create git repository following given layout
+  # Update @repo_path with path to repository
+  # Delete any previously created repo
+  def setup_git_repo
+    @origin_path = File.expand_path(File.join(File.dirname(__FILE__), '__origin'))
+    @repo_path = File.join(File.dirname(__FILE__), '__repo')
+    @repo_content = [ 'file1', { 'folder1' => [ 'file2', 'file3' ] }, { 'folder2' => [ { 'folder3' => [ 'file4' ] } ] } ]
+    FileUtils.rm_rf(@origin_path)
+    FileUtils.mkdir_p(@origin_path)
+    Dir.chdir(@origin_path) do
+      res, status = exec("git init --bare")
+      raise "Failed to initialize remote git repository: #{res}" unless status.success?
+    end
+    FileUtils.rm_rf(@repo_path)
+    res, status = exec("git clone --quiet #{@origin_path} #{@repo_path}")
+    raise "Failed to initialize git repository: #{res}" unless status.success?
+    create_file_layout(@repo_path, @repo_content)
+    Dir.chdir(@repo_path) do
+      res, status = exec("git add .")
+      res, status = exec("git commit --quiet -am 'Initial Commit'") if status.success?
+      res, status = exec("git push origin master") if status.success?
+      raise "Failed to setup git repository: #{res}" unless status.success?
+    end
+  end
+
+  # Cleanup after ourselves
+  def delete_git_repo
+    FileUtils.rm_rf(@origin_path) if @origin_path
+    @origin_path = nil
+    FileUtils.rm_rf(@repo_path) if @repo_path
+    @repo_path = nil
+  end
+
+  context 'given a git repository' do
+
+    before(:all) do
+      setup_git_repo
+    end
+
+    before(:each) do
+      @scraper = RightScale::GitScraper.new(@repo_path)      
+      @repo = RightScale::Repository.from_hash(:display_name => 'test repo',
+                                               :repo_type    => :git,
+                                               :url          => @origin_path)
+    end
+    
+    after(:all) do
+      delete_git_repo
+    end
+
+    it 'should scrape' do
+      messages = []
+      @scraper.scrape(@repo) { |m, progress| messages << m if progress }
+      puts "\n **ERRORS: #{@scraper.error_message}\n" unless @scraper.succeeded?
+      @scraper.succeeded?.should be_true
+      messages.size.should == 1
+      File.directory?(@scraper.repo_dir.should be_true)
+      extract_file_layout(@scraper.repo_dir, [ '.git', '.ssh' ]).should == @repo_content
+    end
+    
+    it 'should scrape incrementally' do
+      @scraper.scrape(@repo)
+      puts "\n **ERRORS: #{@scraper.error_message}\n" unless @scraper.succeeded?
+      @scraper.incremental_update?.should be_true
+      messages = []
+      @scraper.scrape(@repo) { |m, progress| messages << m if progress }
+      puts "\n **ERRORS: #{@scraper.error_message}\n" unless @scraper.succeeded?
+      @scraper.succeeded?.should be_true
+      messages.size.should == 1
+      File.directory?(@scraper.repo_dir.should be_true)
+      extract_file_layout(@scraper.repo_dir, [ '.git', '.ssh' ]).should == @repo_content
+    end
+
+  end
+
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*"~

data/spec/repository_spec.rb

@@ -0,0 +1,45 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'repository'
+
+describe RightScale::Repository do
+
+  it 'should be initializable from a hash' do
+    repo = RightScale::Repository.from_hash(:display_name      => 'display_name',
+                                            :repo_type         => 'repo_type',
+                                            :url               => 'url',
+                                            :tag               => 'tag',
+                                            :first_credential  => 'first_credential',
+                                            :second_credential => 'second_credential')
+    repo.should be_kind_of(RightScale::Repository)
+    repo.display_name.should      == 'display_name'
+    repo.repo_type.should         == 'repo_type'
+    repo.url.should               == 'url'
+    repo.tag.should               == 'tag'
+    repo.first_credential.should  == 'first_credential'
+    repo.second_credential.should == 'second_credential'
+  end
+    
+end

data/spec/scraper_base_spec.rb

@@ -0,0 +1,41 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'scraper_base'
+
+describe RightScale::ScraperBase do
+
+  before(:each) do
+    @base = RightScale::ScraperBase.new('/tmp')
+  end
+  
+  it 'should initialize the scrape directory' do
+    @base.root_dir.should == '/tmp'
+  end
+  
+  it 'should default to non incremental updates' do
+    @base.send(:incremental_update?).should be_false
+  end
+    
+end

data/spec/scraper_spec.rb

@@ -0,0 +1,67 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join('scrapers', 'git_scraper')
+require File.join('scrapers', 'svn_scraper')
+require File.join('scrapers', 'download_scraper')
+require 'scraper'
+
+describe RightScale::Scraper do
+
+  before(:each) do
+    @scraper = RightScale::Scraper.new('/tmp')
+    @mock_scraper = flexmock('MockScraper')
+    mock_scraper_klass = flexmock('MockScraperClass', :new => @mock_scraper)
+    RightScale::SCRAPERS.merge!(:mock => mock_scraper_klass)
+  end
+  
+  after(:all) do
+    RightScale::SCRAPERS.delete(:mock)
+  end
+  
+  it 'should scrape' do
+    repo = RightScale::Repository.new
+    repo.repo_type = :mock
+    @mock_scraper.should_receive(:scrape).with(repo, Proc).and_return(true)
+    @mock_scraper.should_receive(:succeeded?).and_return(true)
+    @mock_scraper.should_receive(:repo_dir).and_return('42')
+    @scraper.scrape(repo) { }.should be_true
+    @scraper.repo_dir.should == '42'
+  end
+  
+  it 'should scrape from a hash' do
+    @mock_scraper.should_receive(:scrape).with(RightScale::Repository, Proc).and_return(true)
+    @mock_scraper.should_receive(:succeeded?).and_return(true)
+    @mock_scraper.should_receive(:repo_dir).and_return('42')
+    @scraper.scrape({:repo_type => :mock}) { }.should be_true
+  end
+  
+  it 'should report failures' do
+    @mock_scraper.should_receive(:scrape).with(RightScale::Repository, Proc).and_return(true)
+    @mock_scraper.should_receive(:succeeded?).and_return(false)
+    @mock_scraper.should_receive(:repo_dir).and_return('42')
+    @scraper.scrape({:repo_type => :mock}) { }.should be_false
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+#--
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# 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.
+#++
+
+require 'rubygems'
+require 'flexmock'
+require 'spec'
+require 'find'
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'right_scraper')))
+
+Spec::Runner.configuration.mock_with :flexmock
+
+# Helper module
+module RightScale
+  
+  module SpecHelpers
+
+    # Set the 'verbose' environment variable for debugging a failing spec
+    VERBOSE='verbose'
+
+    # Execute given shell command and return output and exit code
+    # Allows centralizing logging/output
+    #
+    # === Parameters
+    # cmd(String):: Command to be run
+    #
+    # === Return
+    # res, process status(Array):: Pair whose first element is the output of the command
+    #                              and second element is the process exit status
+    def exec(cmd)
+      puts "+ [#{Dir.pwd}] #{cmd}" if ENV[VERBOSE]
+      res = `#{cmd} 2>&1`
+      puts res unless res.empty? if ENV[VERBOSE]
+      return res, $?
+    end
+
+    # Create file layout from given array
+    # Strings in array correspond to files while Hashes correspond to folders
+    # File content is equal to filename
+    #
+    # === Parameters
+    # Path(String):: Path where layout should be created
+    # layout(Array):: Describe the file layout to be created
+    #
+    # === Return
+    # true:: Always return true
+    def create_file_layout(path, layout)
+      FileUtils.mkdir_p(path)
+      layout.each do |elem|
+        if elem.is_a?(Hash)
+          elem.each do |k, v|
+            full_path = File.join(path, k)
+            FileUtils.mkdir_p(full_path)
+            create_file_layout(full_path, v)
+          end
+        else
+          File.open(File.join(path, elem.to_s), 'w') { |f| f.puts elem.to_s }
+        end  
+      end
+      true
+    end
+    
+    # Extract array representing file layout for given directory
+    #
+    # === Parameters
+    # path(String):: Path to directory whose layout is to be retrieved
+    # layout(Array):: Array being updated with layout, same as return value, empty array by default
+    # ignore(Array):: Optional: Name of files or directories that should be ignored
+    #
+    # === Return
+    # layout(Array):: Corresponding layout as used by 'create_file_layout'
+    def extract_file_layout(path, ignore=[])
+      return [] unless File.directory?(path)
+      layout = []
+      ignore += [ '.', '..' ]
+      Dir.foreach(path) do |f|
+        next if ignore.include?(f)
+        full_path = File.join(path, f)
+        if File.directory?(full_path)
+          layout << { f => extract_file_layout(full_path, ignore) }
+        else
+          layout << f
+        end
+      end
+      layout   
+    end
+           
+ 
+  end
+  
+end