Improve spec test runner (mainly for windows)

Encoding was off and there was an issue with ruby sass
replacing single `\r` chars with `\n`. Also updated
cleaning functions to be more strict and friendly.

Author: mgreter

lib/sass_spec/engine_adapter.rb

@@ -1,5 +1,3 @@
-require "open3"
-
 class EngineAdapter
   def describe
     not_implemented
@@ -39,13 +37,15 @@ def describe
   end
 
   def version
-    stdout, stderr, status = Open3.capture3("#{@command} -v")
+    require 'open3'
+    stdout, stderr, status = Open3.capture3("#{@command} -v", :binmode => true)
     stdout.to_s
   end
 
 
   def compile(sass_filename, style)
-    stdout, stderr, status = Open3.capture3("#{@command} -t #{style} #{sass_filename}")
+    require 'open3'
+    stdout, stderr, status = Open3.capture3("#{@command} -t #{style} #{sass_filename}", :binmode => true)
     [stdout, stderr, status.exitstatus]
   end
 end
@@ -66,20 +66,34 @@ def version
 
   def compile(sass_filename, style)
     require 'sass'
+    # overloads STDERR
+    stderr = StringIO.new
+    # restore previous default encoding
+    encoding = Encoding.default_external
+    # Does not work as expected when tests are run in parallel
+    # It runs tests in threads, so stderr is shared across them
+    old_stderr, $stderr = $stderr, stderr
     begin
-      captured_stderr = StringIO.new
-      # Does not work as expected when tests are run in parallel
-      real_stderr, $stderr = $stderr, captured_stderr
-      begin
-        css_output = Sass.compile_file(sass_filename.to_s, :style => style.to_sym)
-        [css_output, captured_stderr.string, 0]
-      rescue Sass::SyntaxError => e
-        ["", "Error: " + e.message.to_s, 1]
-      rescue => e
-        ["", e.to_s, 2]
-      end
-    ensure
-      $stderr = real_stderr
+      Encoding.default_external = "UTF-8"
+      css_output = Sass.compile_file(sass_filename.to_s, :style => style.to_sym)
+      # strings come back as utf8 encoded
+      # internaly we only work with bytes
+      err_output = stderr.string
+      err_output.force_encoding('ASCII-8BIT')
+      css_output.force_encoding('ASCII-8BIT')
+      [css_output, err_output, 0]
+    rescue Sass::SyntaxError => e
+      # prepend the prefix to the message
+      # and indent all lines to match it
+      err_output = "Error: " + e.message.to_s
+                   .gsub(/(?:\r?\n)(?!\z)/, "\n       ")
+      err_output.force_encoding('ASCII-8BIT')
+      ["", err_output, 65]
+    rescue => e
+      ["", e.to_s, 2]
     end
+  ensure
+    $stderr = old_stderr
+    Encoding.default_external = encoding
   end
 end

lib/sass_spec/test.rb

@@ -11,7 +11,7 @@ def run_spec_test(test_case, options = {})
 
   if test_case.overwrite?
     if status != 0
-      File.open(test_case.status_path, "w+") do |f|
+      File.open(test_case.status_path, "w+", :binmode => true) do |f|
         f.write(status)
         f.close
       end
@@ -20,15 +20,15 @@ def run_spec_test(test_case, options = {})
     end
 
     if error.length > 0
-      File.open(test_case.error_path, "w+") do |f|
+      File.open(test_case.error_path, "w+", :binmode => true) do |f|
         f.write(error)
         f.close
       end
     elsif (File.file?(test_case.error_path))
       File.unlink(test_case.error_path)
     end
 
-    File.open(test_case.expected_path, "w+") do |f|
+    File.open(test_case.expected_path, "w+", :binmode => true) do |f|
       f.write(output)
       f.close
     end
@@ -83,12 +83,12 @@ def _clean_debug_path(error)
   pwd = Dir.pwd
   url = pwd.gsub(/\\/, '\/')
   error.gsub(/^.*?(input.scss:\d+ DEBUG:)/, '\1')
-       .gsub(/[ 	]+/, " ")
+       .gsub(/\/+/, "/")
        .gsub(/#{Regexp.quote(url)}\//, "/sass/sass-spec/")
        .gsub(/#{Regexp.quote(pwd)}\//, "/sass/sass-spec/")
        .gsub(/(?:\/todo_|_todo\/)/, "/")
-       .gsub(/\/libsass\-[a-z]+\-test\//, "/")
-       .gsub(/\/libsass\-[a-z]+\-issue/, "/libsass-issue")
+       .gsub(/\/libsass\-[a-z]+\-tests\//, "/")
+       .gsub(/\/libsass\-[a-z]+\-issues/, "/libsass-issues")
        .strip
 end
 

lib/sass_spec/test_case.rb

@@ -67,15 +67,24 @@ def output
     stdout, stderr, status = engine.compile(@input_path, @output_style)
 
     if @clean_test
-      cleaned = _clean_output(stdout)
+      clean_out = _clean_output(stdout)
     else
-      cleaned = _norm_output(stdout)
+      clean_out = _norm_output(stdout)
     end
-    @output ||= [stdout, cleaned, stderr, status]
+
+    stderr = _clean_error(stderr)
+    # always replace windows linefeeds
+    stdout = stdout.gsub(/(\r\n)/, "\n")
+    stderr = stderr.gsub(/(\r\n)/, "\n")
+
+    @output ||= [stdout, clean_out, stderr, status]
   end
 
   def expected
-    output = File.read(@expected_path, :encoding => "utf-8")
+    output = File.read(@expected_path, :binmode => true)
+    # we seem to get CP850 otherwise
+    # this provokes equal test to fail
+    output.force_encoding('ASCII-8BIT')
     if @clean_test
       @expected ||= _clean_output(output)
     else
@@ -84,12 +93,12 @@ def expected
   end
 
   def expected_error
-    @expected_error = _clean_error(File.read(@error_path, :encoding => "utf-8"))
+    @expected_error = _clean_error(File.read(@error_path, :binmode => true))
   end
 
   def expected_status
     if should_fail?
-      @expected_status = File.read(@status_path, :encoding => "utf-8").to_i
+      @expected_status = File.read(@status_path).to_i
     else
       @expected_status = 0
     end
@@ -99,35 +108,39 @@ def engine
     @options[:engine_adapter]
   end
 
+  # normalization happens for every test
   def _norm_output(css)
-    css = css.force_encoding('iso-8859-1').encode('utf-8')
-    css.gsub(/(?:\r?\n)+/, "\n")
-       .strip
+    # we dont want to test for linux or windows line-feeds
+    # but make sure we do not remove single cariage returns
+    css = css.gsub(/(?:\r?\n)+/, "\n")
+  end
+  def _norm_error(err)
+    # we dont want to test for linux or windows line-feeds
+    # but make sure we do not remove single cariage returns
+    err = err.gsub(/(?:\r?\n)+/, "\n")
+    # remove all newlines at the end of the file
+    err = err.sub(/(?:\r?\n)+\z/, "")
   end
 
+  # cleaning only happens when requested for test
+  # done by creating `expected.type.clean` flag file
   def _clean_output(css)
-    css = css.force_encoding('iso-8859-1').encode('utf-8')
-    css.gsub(/\s+/, " ")
-       .gsub(/ *\{/, " {\n")
+    css.gsub(/ *\{/, " {\n")
        .gsub(/([;,]) */, "\\1\n")
        .gsub(/ *\} */, " }\n")
        .gsub(/;(?:\s*;)+/m, ";")
        .gsub(/;\r?\n }/m, " }")
+       .gsub(/\r?\n/, "\n")
+       .sub(/(?:\r?\n)+\z/, "")
        .strip
   end
-
   def _clean_error(err)
-    pwd = Dir.pwd
-    url = pwd.gsub(/\\/, '/')
-    err = err.force_encoding('iso-8859-1').encode('utf-8')
-    err.gsub(/^.*?(input.scss:\d+ DEBUG:)/, '\1')
-       .gsub(/[ 	]+/, " ")
-       .gsub(/#{Regexp.quote(url)}\//, "/sass/sass-spec/")
-       .gsub(/#{Regexp.quote(pwd)}\//, "/sass/sass-spec/")
-       .gsub(/(?:\/todo_|_todo\/)/, "/")
-       .gsub(/\/libsass\-[a-z]+\-test\//, "/")
-       .gsub(/\/libsass\-[a-z]+\-issue/, "/libsass-issue")
-       .strip
+    err.gsub(/(?:\/todo_|_todo\/)/, "/") # hide todo pre/suffix
+       .gsub(/\/libsass\-[a-z]+\-tests\//, "/") # hide test directory
+       .gsub(/\/libsass\-[a-z]+\-issues\//, "/libsass-issues/") # normalize issue specs
+       .gsub(/[\w\/\-\\:]+?[\/\\]spec[\/\\]+/, "/sass/spec/") # normalize abs paths
+       .sub(/(?:\r?\n)*\z/, "\n") # make sure we have exactly one trailing linefeed
+       .sub(/\A(?:\r?[\n\s])+\z/, "") # clear the whole file if only whitespace
   end
 
 end