right_develop 2.1.3 → 2.1.5

data/README.rdoc

@@ -14,6 +14,27 @@ To use our CI harness, just add the following to your Rakefile (or into lib/task
   require 'right_develop'
   RightDevelop::CI::RakeTask.new
 
+==== Integrating CI with Rails
+
+For stateful apps, it is generally necessary to run some sort of database setup step prior to running tests.
+Rails accomplishes this with the reusable "db:test:prepare" task which is declared as a dependency to the "spec"
+task, ensuring that the DB is prepared before running tests.
+
+RightDevelop has a similar hook; the ci:prep task is executed before running any ci:* task. If you need to perform
+app-specific CI setup, you can hook into it like this:
+
+  task 'ci:prep' => ['db:my_special_setup_task']
+
+Unfortunately, db:test:prepare does some things that aren't so useful in the CI environment, such as verifying
+that the development DB exists and is fully migrated. The development DB is irrelevant when running tests, and if someone
+has failed to commit changes to schema.rb then we _want_ the tests to break. Therefore, to setup a Rails app properly,
+use the following dependency:
+
+  # Make sure we run the Rails DB-setup stuff before any CI run. Avoid using db:test:prepare
+  # because it also checks for pending migrations in the dev database, which is not useful to us.
+  task 'ci:prep' => ['db:test:purge', 'db:test:load', 'db:schema:load']
+
+
 ==== Customizing your CI Harness
 
 You can override various aspects of the CI harness' behavior by passing a block to the constructor which

data/VERSION

@@ -1 +1 @@
-2.1.3
+2.1.5

data/lib/right_develop/ci/java_spec_formatter.rb

@@ -60,7 +60,7 @@ module RightDevelop::CI
       end
 
       def classname_for(example)
-        klass = example.example_group.described_class || example.example_group.top_level_description
+        klass = example.example_group.top_level_description || example.example_group.described_class
         klass = RightDevelop::CI::Util.pseudo_java_class_name(klass.to_s)
         "rspec.#{klass}"
       end
@@ -71,8 +71,8 @@ module RightDevelop::CI
         builder.testsuite :errors => 0, :failures => failure_count, :skipped => pending_count, :tests => example_count, :time => duration, :timestamp => Time.now.iso8601 do
           builder.properties
           @test_results.each do |test|
-            classname        = classname_for(test)
-            full_description = test.full_description
+            classname        = purify(classname_for(test))
+            full_description = purify(test.full_description)
             time             = test.metadata[:execution_result][:run_time]
 
             # The full description always begins with the classname, but this is useless info when
@@ -85,7 +85,7 @@ module RightDevelop::CI
               case test.metadata[:execution_result][:status]
               when "failed"
                 builder.failure :message => "failed #{full_description}", :type => "failed" do
-                  builder.cdata! failure_details_for test
+                  builder.cdata! purify(failure_details_for(test))
                 end
               when "pending" then
                 builder.skipped
@@ -95,6 +95,10 @@ module RightDevelop::CI
         end
         output.puts builder.target!
       end
+
+      def purify(untrusted)
+        RightDevelop::CI::Util.purify(untrusted)
+      end
     end
   elsif defined?(::Spec::Runner)
     # RSpec 1.x
@@ -142,8 +146,8 @@ module RightDevelop::CI
         builder.testsuite :errors => 0, :failures => failure_count, :skipped => pending_count, :tests => example_count, :time => duration, :timestamp => Time.now.iso8601 do
           builder.properties
           @test_results.each_pair do |test, result|
-            classname        = classname_for(test)
-            full_description = test.description
+            classname        = purify(classname_for(test))
+            full_description = purify(test.description)
 
             # The full description always begins with the classname, but this is useless info when
             # generating the XML report.
@@ -155,7 +159,7 @@ module RightDevelop::CI
               case result
               when "failed"
                 builder.failure :message => "failed #{full_description}", :type => "failed" do
-                  builder.cdata! failure_details_for(test)
+                  builder.cdata! purify(failure_details_for(test))
                 end
               when "pending" then
                 builder.skipped
@@ -189,6 +193,10 @@ module RightDevelop::CI
         klass = RightDevelop::CI::Util.pseudo_java_class_name(klass)
         "rspec.#{klass}"
       end
+
+      def purify(untrusted)
+        RightDevelop::CI::Util.purify(untrusted)
+      end
     end
   else
     raise LoadError, "Cannot define RightDevelop::CI::JavaSpecFormatter: unsupported RSpec version"

data/lib/right_develop/ci/util.rb

@@ -1,3 +1,7 @@
+if RUBY_VERSION =~ /^1\.8/
+  require 'iconv'
+end
+
 module RightDevelop::CI
   module Util
     module_function
@@ -14,6 +18,11 @@ module RightDevelop::CI
     # Replacement codepoint that looks a bit like a period
     JAVE_PACKAGE_SEPARATOR_HOMOGLYPH = '·'
 
+    # Regular expression that matches characters that need to be escaped inside CDATA
+    # c.f. http://www.w3.org/TR/xml11/#charsets
+    # RestrictedChar ::= [#x1-#x8] | [#xB-#xC] | [#xE-#x1F] | [#x7F-#x84] | [#x86-#x9F]
+    INVALID_CDATA_CHARACTER = Regexp.new '[\x01-\x08\x0b-\x0c\x0e-\x1f\x7f-\x84\x86-\x9f]', nil, 'n' # Ruby 1.8-2.1 compatible
+
     # Make a string suitable for parsing by Jenkins JUnit display plugin by escaping any non-valid
     # Java class name characters as an XML entity. This prevents Jenkins from interpreting "hi1.2"
     # as a package-and-class name.
@@ -36,5 +45,27 @@ module RightDevelop::CI
 
       result
     end
+
+    # Strip invalid UTF-8 sequences from a string and entity-escape any character that can't legally
+    # appear inside XML CDATA. If test output contains weird data, we could end up generating
+    # invalid JUnit XML which will choke Java. Preserve the purity of essence of our precious XML
+    # fluids!
+    #
+    # @return [String] the input with all invalid UTF-8 replaced by the empty string
+    # @param [String] untrusted a string (of any encoding) that might contain invalid UTF-8 sequences
+    def purify(untrusted)
+      # First pass: strip bad UTF-8 characters
+      if RUBY_VERSION =~ /^1\.8/
+        iconv = Iconv.new('UTF-8//IGNORE', 'UTF-8')
+        result = iconv.iconv(untrusted)
+      else
+        result = untrusted.force_encoding(Encoding::BINARY).encode('UTF-8', :undef=>:replace, :replace=>'')
+      end
+
+      # Second pass: entity escape characters that can't appear in XML CDATA.
+      result.gsub(INVALID_CDATA_CHARACTER) do |ch|
+        "&#x%s;" % [ch.unpack('H*').first]
+      end
+    end
   end
 end

data/lib/right_develop/parsers/xml_post_parser.rb

@@ -113,6 +113,9 @@ module RightDevelop::Parsers
               end
               xml_object_node[parent_key] = child_node
             end
+          elsif parent_value.nil? && parent_key.pluralize == parent_key
+            #Wrap xml object in an array so it matches JSON format in cases where nothing is contained in parent node
+            xml_object_node[parent_key] = []
           end
           remove_nesting_node(parent_value)
         end

data/right_develop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{right_develop}
-  s.version = "2.1.3"
+  s.version = "2.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tony Spataro"]
-  s.date = %q{2014-03-25}
+  s.date = %q{2014-04-14}
   s.default_executable = %q{right_develop}
   s.description = %q{A toolkit of development tools created by RightScale.}
   s.email = %q{support@rightscale.com}

data/right_develop.rconf

@@ -10,5 +10,5 @@ ruby do
 end
 
 bundler do
-  version '1.3.5'
+  version '1.5.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_develop
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 1
   prerelease: false
   segments: 
   - 2
   - 1
-  - 3
-  version: 2.1.3
+  - 5
+  version: 2.1.5
 platform: ruby
 authors: 
 - Tony Spataro
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-03-25 00:00:00 -07:00
+date: 2014-04-14 00:00:00 -07:00
 default_executable: right_develop
 dependencies: 
 - !ruby/object:Gem::Dependency