right_develop 1.1.0

data/lib/right_develop/ci/rake_task.rb

@@ -0,0 +1,127 @@
+#
+# Copyright (c) 2009-2011 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.
+
+# Once this file is required, the Rake DSL is loaded - don't do this except inside Rake!!
+require 'rake/tasklib'
+
+# Make sure the rest of RightDevelop & CI is required, since this file can be
+# required directly.
+require 'right_develop'
+require 'right_develop/ci'
+
+# Try to load RSpec 2.x - 1.x Rake tasks
+['rspec/core/rake_task', 'spec/rake/spectask'].each do |f|
+  begin
+    require f
+  rescue LoadError
+    # no-op, we will raise later
+  end
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+module RightDevelop::CI
+  # A Rake task definition that creates a CI namespace with appropriate
+  # tests.
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    # The namespace in which to define the continuous integration tasks.
+    #
+    # Default :ci
+    attr_accessor :ci_namespace
+
+    # File glob to select which specs will be run with the spec task.
+    #
+    # Default nil (let RSpec choose pattern)
+    attr_accessor :rspec_pattern
+
+    # Filename (without directory!) to which RSpec XML results should be written.
+    # The CI task will take output_path, append "rspec" as a subdir and finally
+    # append this file name, to come up with a relative path for output. For example:
+    #
+    # Default "rspec.xml"
+    #
+    #   output_path = "my_cool_ci"
+    #   rspec_output = "my_awesome_rspec.xml"
+    #
+    # Given the options above, the CI harness would write RSpec results to:
+    #   my_cool_ci/rspec/my_awesome_rspec.xml
+    attr_accessor :rspec_output
+
+    # The base directory for all output files.
+    #
+    # Default 'measurement'
+    attr_accessor :output_path
+
+    def initialize(*args)
+      @ci_namespace = args.shift || :ci
+
+      yield self if block_given?
+
+      @output_path ||= 'measurement'
+      @rspec_output ||= 'rspec.xml'
+
+      namespace @ci_namespace do
+        task :prep do
+          FileUtils.mkdir_p(@output_path)
+          FileUtils.mkdir_p(File.join(@output_path, 'rspec'))
+          FileUtils.mkdir_p(File.join(@output_path, 'cucumber'))
+        end
+
+        if defined?(::RSpec::Core::RakeTask)
+          # RSpec 2
+          desc "Run RSpec examples"
+          RSpec::Core::RakeTask.new(:spec => :prep) do |t|
+            t.rspec_opts = ['-r', 'right_develop/ci',
+                            '-f', JavaSpecFormatter.name,
+                            '-o', File.join(@output_path, 'rspec', @rspec_output)]
+            unless self.rspec_pattern.nil?
+              t.pattern = self.rspec_pattern
+            end
+          end
+        elsif defined?(::Spec::Rake::SpecTask)
+          # RSpec 1
+          Spec::Rake::SpecTask.new(:spec => :prep) do |t|
+            desc "Run RSpec Examples"
+            t.spec_opts = ['-r', 'right_develop/ci',
+                           '-f', JavaSpecFormatter.name + ":" + File.join(@output_path, 'rspec', @rspec_output)]
+            unless self.rspec_pattern.nil?
+              t.spec_files = FileList[self.rspec_pattern]
+            end
+          end
+        else
+          raise LoadError, "Cannot define CI rake task: unsupported RSpec version"
+        end
+
+        desc "Run Cucumber features"
+        Cucumber::Rake::Task.new do |t|
+          t.cucumber_opts = ['--no-color',
+                             '--format', JavaCucumberFormatter.name,
+                             '--out', File.join(@output_path, 'cucumber')]
+        end
+        task :cucumber => [:prep]
+      end
+    end
+  end
+end

data/lib/right_develop/net.rb

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2009-2011 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.
+
+# Try to load RSpec 2.x - 1.x
+['rspec', 'spec'].each do |f|
+  begin
+    require f
+  rescue LoadError
+    # no-op, we will raise later
+  end
+end
+
+module RightDevelop::Net
+  # Extra fatal exceptions to add to RightSupport::Net::RequestBalancer
+  FATAL_TEST_EXCEPTIONS = []
+
+  spec_namespaces = []
+
+  if defined?(::RSpec::Mocks)
+    # RSpec 2.x
+    spec_namespaces += [::RSpec::Mocks, ::RSpec::Expectations]
+  elsif defined?(::Spec::Expectations)
+    # RSpec 1.x
+    spec_namespaces += [::Spec::Expectations]
+  end
+
+  # Use some reflection to locate all RSpec and Test::Unit exceptions
+  spec_namespaces.each do |namespace|
+    namespace.constants.each do |konst|
+      konst = namespace.const_get(konst)
+      if konst.is_a?(Class) && konst.ancestors.include?(Exception)
+        FATAL_TEST_EXCEPTIONS << konst
+      end
+    end
+  end
+
+  dfe = RightSupport::Net::RequestBalancer::DEFAULT_FATAL_EXCEPTIONS
+  FATAL_TEST_EXCEPTIONS.each do |e|
+    dfe << e unless dfe.include?(e)
+  end
+end

data/lib/right_develop/parsers.rb

@@ -0,0 +1,10 @@
+# Ensure the main gem is required, since this module might be loaded using ruby -r
+require 'right_develop'
+
+module RightDevelop
+  module Parsers
+  end
+end
+
+# Explicitly require everything else to avoid overreliance on autoload (1-module-deep rule)
+require 'right_develop/parsers/sax_parser.rb'

data/lib/right_develop/parsers/sax_parser.rb

@@ -0,0 +1,139 @@
+require 'xml/libxml'
+require 'active_support/inflector'
+require 'right_develop/parsers/xml_post_parser.rb'
+
+module RightDevelop::Parsers
+  class SaxParser
+    extend XmlPostParser
+
+    # Parses XML into a ruby hash
+    #
+    # @param [String] text The XML string to convert into a ruby hash
+    # @param [Hash] opts
+    # @opts [Lambda or Proc] :post_parser A lambda function to run against
+    #   the return content of the initial xml parser.
+    # @return [Array or Hash] returns rubified XML in Hash and Array format
+    def self.parse(text, opts = {})
+      # Parse the xml text
+      # http://libxml.rubyforge.org/rdoc/
+      xml           = ::XML::SaxParser::string(text)
+      xml.callbacks = new
+      xml.parse
+
+      if opts[:post_parser]
+        if opts[:post_parser].kind_of?(Proc)
+          return opts[:post_parser].call(xml.callbacks.result)
+        else
+          raise ArgumentError.new(":post_parser parameter must be a lambda/proc")
+        end
+      else
+        return xml.callbacks.result
+      end
+    end
+
+    def initialize
+      @tag  = {}
+      @path = []
+    end
+
+    def result
+      @tag
+    end
+
+    # Callbacks
+
+    def on_error(msg)
+      raise msg
+    end
+
+    def on_start_element_ns(name, attr_hash, prefix, uri, namespaces)
+      # Push parent tag
+      @path << @tag
+      # Create a new tag
+      if @tag[name]
+        @tag[name] = [ @tag[name] ] unless @tag[name].is_a?(Array)
+        @tag[name] << {}
+        @tag = @tag[name].last
+      else
+        @tag[name] = {}
+        @tag = @tag[name]
+      end
+      # Put attributes
+      attr_hash.each do |key, value|
+        @tag["#{key}"] = value
+      end
+      # Put name spaces
+      namespaces.each do |key, value|
+        @tag["@xmlns#{key ? ':'+key.to_s : ''}"] = value
+      end
+    end
+
+    def on_characters(chars)
+      # Ignore lines that contains white spaces only
+      return if chars[/\A\s*\z/m]
+      # Put Text
+      (@tag['@@text'] ||= '') << chars
+    end
+
+    def on_comment(msg)
+      # Put Comments
+      (@tag['@@comment'] ||= '') << msg
+    end
+
+    def on_end_element_ns(name, prefix, uri)
+      # Special handling of empty text fields
+      if @tag.is_a?(Hash) && @tag.empty? && @tag['@@text'].nil?
+        @tag['@@text'] = nil
+      end
+
+      # Finalize tag's text
+      if @tag.keys.count == 0
+        # Set tag value to nil then the tag is blank
+        name.pluralize == name ? @tag = [] : {}
+      elsif @tag.keys == ['@@text']
+        # Set tag value to string if it has no any other data
+        @tag = @tag['@@text']
+      end
+      # Make sure we saved the changes
+      if @path.last[name].is_a?(Array)
+        # If it is an Array then update the very last item
+        @path.last[name][-1] = @tag
+      else
+        # Otherwise just replace the tag
+        @path.last[name] = @tag
+      end
+      # Pop parent tag
+      @tag = @path.pop
+    end
+
+    def on_start_document
+    end
+
+    def on_reference (name)
+    end
+
+    def on_processing_instruction(target, data)
+    end
+
+    def on_cdata_block(cdata)
+    end
+
+    def on_has_internal_subset()
+    end
+
+    def on_internal_subset (name, external_id, system_id)
+    end
+
+    def on_is_standalone ()
+    end
+
+    def on_has_external_subset ()
+    end
+
+    def on_external_subset (name, external_id, system_id)
+    end
+
+    def on_end_document
+    end
+  end
+end

data/lib/right_develop/parsers/xml_post_parser.rb

@@ -0,0 +1,113 @@
+require 'active_support/inflector'
+
+module RightDevelop::Parsers
+  module XmlPostParser
+
+    # Parses a rubified XML hash/array, removing the top level xml tag, along with
+    # any arrays encoded with singular/plural for parent/child nodes.
+    # Intended to allow for one set of code for validating JSON or XML responses.
+    #
+    # @example
+    #   Initial XML:
+    #   <top_level>
+    #    <arrays>
+    #      <array item1="one" item2="two"/>
+    #      <array item3="three" item4="four"/>
+    #    </arrays>
+    #   </top_level>
+    #
+    #   Before removing nesting, after initial parsing:
+    #   {
+    #     'top_level' => {
+    #       'arrays' => {
+    #        'array' => [
+    #          {'item1' => 'one', 'item2' => 'two'},
+    #          {'item3' => 'three', 'item4' => 'four'}
+    #        ]
+    #       }
+    #     }
+    #   }
+    #
+    #   After removing nesting:
+    #   {
+    #     'arrays' => [
+    #       {'item1' => 'one', 'item2' => 'two'},
+    #       {'item3' => 'three', 'item4' => 'four'}
+    #     ]
+    #   }
+    #
+    # @param [Array or Hash] xml_object parsed XML object, such as from Parser::Sax.parse.
+    # @return [Array or Hash] returns a ruby Array or Hash with top level xml tags removed,
+    #   as well as any extra XML encoded array tags.
+    def self.remove_nesting(xml_object)
+      if xml_object.length != 1 || (!xml_object.is_a?(Hash) && !xml_object.is_a?(Array))
+        raise ArgumentError, "xml_object format doesn't have a single top level entry"
+      end
+      if !xml_object.is_a?(Hash)
+        raise TypeError, "xml_object object doesn't seem to be a Hash or an Array"
+      end
+      xml_object = deep_clone(xml_object)
+
+      #if root & children are the same base word, get rid of both layers
+      root_key       = xml_object.keys[0]
+      root_child     = xml_object[xml_object.first[0]]
+      if root_child.respond_to?(:keys)
+        root_child_key = root_child.keys[0]
+      else
+        root_child_key = nil
+      end
+
+      #remove root key
+      xml_object = xml_object[xml_object.first[0]]
+
+      #remove extra root child key
+      if root_key.singularize == root_child_key
+        # Ensure object is an array (like JSON responses)
+        xml_object = [xml_object[xml_object.first[0]]].flatten
+      elsif !xml_object
+         # Degenerate case where nothing was contained by parent node
+         # (i.e. no resources were actually returned)
+        xml_object = []
+      end
+
+      remove_nesting_node(xml_object)
+      return xml_object
+    end
+
+    private
+
+    # Does a deep clone of the passed ruby object. Intended for Arrays / Hashes
+    #
+    # @param [Object] object to deep clone
+    # @return [Object] returns an exact deep copy of the passed in object
+    #
+    # @example BaseHelpers.deep_clone([{:a=>1},{:b=>2}])
+    def self.deep_clone(object)
+      Marshal.load(Marshal.dump(object))
+    end
+
+    def self.remove_nesting_node(xml_object_node)
+      if xml_object_node.is_a?(Array)
+        xml_object_node.each_with_index do |node,index|
+          remove_nesting_node(node)
+        end
+      elsif xml_object_node.is_a?(Hash)
+        # If child is singular version of parent, remove extra child pointer
+        xml_object_node.each do |parent_key, parent_value|
+          if parent_value.is_a?(Hash) && parent_value.length == 1
+            child_key = parent_value.keys[0]
+            if parent_key.singularize == child_key
+              # Wrap xml object in an array so it matches JSON format
+              child_node = xml_object_node[parent_key][child_key]
+              if child_node.is_a?(Hash)
+                child_node = [child_node]
+              end
+              xml_object_node[parent_key] = child_node
+            end
+          end
+          remove_nesting_node(parent_value)
+        end
+      end
+    end
+  end
+end