assert_valid_markup 0.5.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Conway
+
+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.rdoc

@@ -0,0 +1,71 @@
+= assert_valid_markup plugin for Rails
+
+
+Validate your (X)HTML from within your functional tests. If anything changes to invalidate
+your markup, you'll know pronto.
+
+If xmllint/xmlcatalog are available in your PATH, this plugin will use them to validate your xml.
+When doing so, it will automatically fetch and cache all DTDs locally so that you don't incur a
+network hit on future runs.
+
+Otherwise, validations will be done using the W3C Validator web service (http://validator.w3.org/).
+Responses from the web service are cached, so your tests aren't slowed down unless something has changed.
+
+== Installation
+
+Install as a gem:
+
+    gem install assert_valid_markup
+
+and edit config/environments/test.rb:
+
+    config.gem 'assert_valid_markup'
+
+or install as a plugin:
+
+    ./script/plugin install http://github.com/wr0ngway/assert_valid_markup
+
+
+== Usage
+
+Calling the assertion with no parameters validates whatever is in @request.body,
+which is automatically set by the existing get/post/etc helpers. For example:
+
+    class FooControllerTest < Test::Unit::TestCase
+      def test_bar_markup
+        get :bar
+        assert_valid_markup
+      end
+    end
+
+Add a string parameter to the assertion to validate any random fragment. Por ejemplo:
+
+    class FooControllerTest < Test::Unit::TestCase
+      def test_bar_markup
+        assert_valid_markup "<div>Hello, world.</div>"
+      end
+    end
+
+For the ultimate in convenience, use the class-level methods to validate a slew of
+actions in one line. Par exemple:
+
+    class FooControllerTest < Test::Unit::TestCase
+      assert_valid_markup :bar, :baz, :qux
+    end
+
+    # automatically validate all GETs in BarControllerTest
+    class BarControllerTest < Test::Unit::TestCase
+      assert_all_valid_markup
+    end
+
+    # Add this to test_helper to automatically validate the responses for ALL GETs in ALL controllers
+    class ActionController::TestCase < ActiveSupport::TestCase
+      assert_all_valid_markup
+    end
+
+
+== Credits
+
+Scott Raymond <sco@scottraymond.net>. Released under the MIT license.
+Matt Conway <matt@conwaysplace.com> (xmllint additions)
+Latest version: http://github.com/wr0ngway/assert_valid_markup

data/VERSION

@@ -0,0 +1,2 @@
+0.5.0
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/assert_valid_markup.rb

@@ -0,0 +1,149 @@
+require 'test/unit'
+require 'net/http'
+require 'digest/md5'
+require 'open-uri'
+require 'fileutils'
+require 'tempfile'
+require 'xmlsimple'
+require 'cgi'
+
+class Test::Unit::TestCase
+
+  @@default_avm_options = {
+      :catalog_path => File.expand_path("~/.xml-catalogs"),
+      :validation_service => system("xmllint --version > /dev/null 2>&1") ? :local : :w3c,
+      :dtd_validate => true
+  }
+
+  # Assert that markup (html/xhtml) is valid according the W3C validator web service.
+  # By default, it validates the contents of @response.body, which is set after calling
+  # one of the get/post/etc helper methods. You can also pass it a string to be validated.
+  # Validation errors, if any, will be included in the output. The response from the validator
+  # service will be cached in the system temp directory to minimize duplicate calls.
+  #
+  # For example, if you have a FooController with an action Bar, put this in foo_controller_test.rb:
+  #
+  #   def test_bar_valid_markup
+  #     get :bar
+  #     assert_valid_markup
+  #   end
+  #
+  def assert_valid_markup(fragment=@response.body, options={})
+    opts = @@default_avm_options.merge(options)
+    result = ''
+    if opts[:validation_service] == :local
+      result = local_validate(fragment, opts[:dtd_validate], opts[:catalog_path])
+    else
+      result = w3c_validate(fragment, opts[:dtd_validate])
+    end
+    assert result.empty?, result
+  end
+  
+  # Class-level method to quickly create validation tests for a bunch of actions at once.
+  # For example, if you have a FooController with three actions, just add one line to foo_controller_test.rb:
+  #
+  #   assert_valid_markup :bar, :baz, :qux
+  #
+  # If you pass :but_first => :something, #something will be called at the beginning of each test case
+  def self.assert_valid_markup(*actions)
+    options = actions.find { |i| i.kind_of? Hash }
+    actions.delete_if { |i| i.kind_of? Hash }
+    actions.each do |action|
+      toeval = "def test_#{action}_valid_markup\n"
+      toeval << "#{options[:but_first].id2name}\n" if options and options[:but_first]
+      toeval << "get :#{action}\n"
+      toeval << "assert_valid_markup\n"
+      toeval << "end\n"
+      class_eval toeval
+    end
+  end
+
+  # Class-level method to to turn on validation for the response from any successful html request via "get"
+  def self.assert_all_valid_markup
+    self.class_eval do
+      # automatically check markup for all successfull GETs
+      def get_with_assert_valid_markup(*args)
+        get_without_assert_valid_markup(*args)
+        assert_valid_markup if ! @@skip_validation && @request.format.html? && @response.success?
+      end
+      alias_method_chain :get, :assert_valid_markup
+    end
+  end
+
+  @@skip_validation = false
+
+  # Allows one to skip validation for the given block - useful when you use assert_all_valid_markup and need to only
+  # skip validation for a handful of tests
+  def skip_markup_validation
+    begin
+      @@skip_validation = true
+      yield
+    ensure
+      @@skip_validation = false
+    end
+  end
+  
+  def local_validate(xmldata, dtd_validate, catalog_path)
+    catalog_file = "#{catalog_path}/catalog"
+    if ! File.exists? catalog_path
+      puts "Creating xml catalog at: #{catalog_path}"
+      FileUtils.mkdir_p(catalog_path)
+      out = `xmlcatalog --noout --create '#{catalog_file}' 2>&1`
+      if $? != 0
+        puts out
+        exit 1
+      end
+    end
+    
+    ENV["XML_DEBUG_CATALOG"] = ""
+    ENV["SGML_CATALOG_FILES"] = catalog_file
+    tmpfile = Tempfile.new('xmllint')
+    tmpfile.write(xmldata)
+    tmpfile.close
+    validation_output = `xmllint --catalogs --memory --noout #{dtd_validate ? '--valid' : ''} #{tmpfile.path} 2>&1`
+    ENV.delete("XML_DEBUG_CATALOG")
+
+    validation_output.each do |line|
+      line.chomp!
+      if match = line.match(/Resolve: pubID (.*) sysID (.*)/)
+        pubid = match[1]
+        sysid = match[2]
+        localdtd = "#{catalog_path}/#{sysid.split('/').last}"
+        if ! File.exists? localdtd
+          puts "Adding xml catalog resource\n\tpublic id: '#{pubid}'\n\turi: '#{sysid}'\n\tfile: '#{localdtd}'"
+          open(localdtd, "w") {|f| f.write(open(sysid).read())}
+          out = `xmlcatalog --noout --add 'public' '#{pubid}' 'file://#{localdtd}' '#{catalog_file}' 2>&1`
+          if $? != 0
+            puts out
+            exit 1
+          end
+        end
+      end
+    end
+    validation_failed = validation_output.grep(/^#{Regexp.escape(tmpfile.path)}:/)
+    return validation_failed.collect {|l| l.gsub(/^[^:]*:/, "Invalid markup: line ")}.join("\n")
+  end
+
+  def w3c_validate(fragment, dtd_validate)
+    validation_result = ''
+    begin
+      filename = File.join Dir::tmpdir, 'markup.' + Digest::MD5.hexdigest(fragment).to_s
+      if ! ENV['NO_CACHE_VALIDATION']
+        response = File.open filename {|f| Marshal.load(f) } unless ENV['NO_CACHE_VALIDATION'] rescue nil
+      end
+      if ! response
+        response = Net::HTTP.start('validator.w3.org').post2('/check', "fragment=#{CGI.escape(fragment)}&output=xml")
+        File.open filename, 'w+' do |f| Marshal.dump response, f end
+      end
+      markup_is_valid = response['x-w3c-validator-status']=='Valid'
+      if ! markup_is_valid
+        doc = XmlSimple.xml_in(response.body)
+        validation_result = doc['messages'][0]['msg'].collect{ |m| "Invalid markup: line #{m['line']}: #{CGI.unescapeHTML(m['content'])}" }.join("\n")
+      end
+    rescue SocketError
+      # if we can't reach the validator service, just let the test pass
+      puts "WARNING: Could not reach w3c validator service"
+    end
+    return validation_result
+  end
+end

data/rails/init.rb

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

data/test/assert_valid_markup_test.rb

@@ -0,0 +1,178 @@
+require 'test_helper'
+require "active_support/core_ext/module"
+
+class DummyControllerTestCase < Test::Unit::TestCase
+  def get(body, html, success)
+    @request = stub(:format => stub(:html? => html))
+    @response = stub(:body => "#{body}", :success? => success)
+  end
+end
+
+class AssertValidMarkupTest < Test::Unit::TestCase
+
+  VALID = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><title></title></head><body></body></html>'
+  INVALID = '<foo>'
+
+  def teardown
+    Object.constants.grep(/^DummyMarkup/).each do |c|
+      Object.send(:remove_const, c)
+    end
+  end
+
+
+  should "validate markup on simple test" do
+
+    eval <<-CLAZZ
+      class ::DummyMarkupTest < Test::Unit::TestCase
+        def test_foo
+          assert_valid_markup('#{VALID}', :validation_service => :local)
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    DummyMarkupTest.new('test_foo').run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert_equal 1, result.assertion_count
+    assert result.passed?
+  end
+
+  should "fail to validate for bad markup" do
+
+    eval <<-CLAZZ
+      class ::DummyMarkupTest < Test::Unit::TestCase
+        def test_foo
+          assert_valid_markup('#{INVALID}', :validation_service => :local)
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    DummyMarkupTest.new('test_foo').run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert_equal 1, result.assertion_count
+    assert ! result.passed?
+  end
+
+  should "validate for action controller response" do
+    eval <<-CLAZZ
+      class ::DummyMarkupTest < Test::Unit::TestCase
+        def test_foo
+          @response = mock(:body => '#{VALID}')
+          assert_valid_markup
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    DummyMarkupTest.new('test_foo').run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert result.passed?
+  end
+
+  should "validate with web service if no xmllint" do
+
+    eval <<-CLAZZ
+      class ::DummyMarkupTest < Test::Unit::TestCase
+        def test_foo
+          assert_valid_markup('#{VALID}', :validation_service => :w3c)
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    DummyMarkupTest.new('test_foo').run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert_equal 1, result.assertion_count
+    assert result.passed?
+  end
+
+  should "fail validation with web service if no xmllint" do
+
+    eval <<-CLAZZ
+      class ::DummyMarkupTest < Test::Unit::TestCase
+        def test_foo
+          assert_valid_markup('#{INVALID}', :validation_service => :w3c)
+         end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    DummyMarkupTest.new('test_foo').run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert_equal 1, result.assertion_count
+    assert ! result.passed?
+  end
+
+  should "validate action controller tests that call get" do
+    eval <<-CLAZZ
+      class ::DummyMarkupControllerTest < DummyControllerTestCase
+        assert_all_valid_markup
+
+        def test_foo
+          get(VALID, true, true)
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    tc = DummyMarkupControllerTest.new('test_foo')
+    tc.run(result, &lambda {} )
+    assert_equal 1, result.run_count
+    assert result.passed?
+  end
+
+  should "validate all action controller tests that call get" do
+    eval <<-CLAZZ
+      class ::DummyMarkupControllerTest < DummyControllerTestCase
+        assert_all_valid_markup
+
+        def test_foo
+          get(INVALID, true, true)
+        end
+
+        def test_bar
+          get(INVALID, true, true)
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    tc = DummyMarkupControllerTest.suite
+    tc.run(result, &lambda {} )
+    assert_equal 2, result.run_count
+    assert_equal 2, result.failure_count
+    assert ! result.passed?
+  end
+
+  should "not validate action controller tests that call get with failure or non-html or skip" do
+    eval <<-CLAZZ
+      class ::DummyMarkupControllerTest < DummyControllerTestCase
+        assert_all_valid_markup
+
+        def test_foo
+          get(INVALID, true, false)
+        end
+
+        def test_bar
+          get(INVALID, false, true)
+        end
+
+        def test_baz
+          skip_markup_validation do
+            get(INVALID, true, true)
+          end
+        end
+      end
+    CLAZZ
+
+    result = Test::Unit::TestResult.new
+    tc = DummyMarkupControllerTest.suite
+    tc.run(result, &lambda {} )
+    p result
+    assert_equal 3, result.run_count
+    assert_equal 0, result.failure_count
+    assert result.passed?
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'assert_valid_markup'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: assert_valid_markup
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Matt Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Also contains some conveniences such as a flag to clear w3c cache at runtime, and some other cleanups
+email: wr0ngway@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- init.rb
+- lib/assert_valid_markup.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/wr0ngway/assert_valid_markup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fork of assert_valid_markup, sped up by using xmllint locally rather than hitting w3c service
+test_files: 
+- test/assert_valid_markup_test.rb
+- test/test_helper.rb