bbc-a11y 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1a5f15fb23bfa023b502767ac8667ef7b3f27ce
-  data.tar.gz: 48b3be883a67e39d68fd2c383c38b5e49af2d444
+  metadata.gz: 8697bc18c43d39bd843b0dfe9fda7a20ea761fc4
+  data.tar.gz: 4e709fc1f14853e37d2d00ed0453de4db887829a
 SHA512:
-  metadata.gz: 8f936fb98eef71751d1730c3b7736352b38e4822a75dc8b97a1efadfc81b63caf1d352b8c41697a1a8d4b3492f2e319a99ccc30520de3e9d498edb1c05700c85
-  data.tar.gz: f6452c73fd7f27d46a390be8d6054ffda5bc21af07b540c49fa60038a51d0491f459dc168b2e21f48dbc0847590fc040be5e647a7e03e71e1ff75246a26780cb
+  metadata.gz: 29063edb07ab6454f23b5a0b797e911e278b74ecb7bf4299e64700c8ab16f6c86508829727343fe7f35ded04f354ee9f1a61e4bce18d5ebdada70316c3f30541
+  data.tar.gz: a0da88c1f3e550ac193b7d9b87a15c00b8135d42dda11e76a809d0750831d28f32f969c147bf5c43e3ddc3b207399d57af21b589c13e0e22edf1f6dda8c09dfc

data/CONTRIBUTING.md

@@ -1,18 +1,14 @@
 # BBC A11y Contributing guidelines
 
-The standards are all stored in the `features` directory.
+The standards are all stored in the `standards` directory.
 
 You can run a manual test of your development copy of a11y at any time just by running:
 
     bundle exec ./bin/a11y <url>
 
-You can also pick out a specific feature to run:
+You can also use cucumber to run one specific test:
 
-    bundle exec ./bin/a11y <url> -- features/04_language.feature
-
-Or you can short-cut a11y's command-line interface and just run Cucumber directly:
-
-    URL=<url> bundle exec cucumber features/04_language.feature
+    A11Y_URL=<url> bundle exec cucumber features/04_language.feature
 
 The step definitions behind these features are shallow wrappers that delegate to objects in `lib/bbc/a11y/`. Those objects are unit-tested to ensure they'll behave as expected when tests pass or fail.
 

data/README.md

@@ -1,3 +1,7 @@
+# WARNING - PROTOTYPE SOFTWARE
+
+This project is still at an experimental / proof-of-concept stage. Please set your expectations appropriately, but *do* [give us as much feedback](https://github.com/cucumber-ltd/bbc-a11y/issues) as you can.
+
 #BBC Accessiblity Standards
 
 This tool runs a set of tests against a set of URLs to verify whether each one meets the [BBC accessibility standards](http://www.bbc.co.uk/guidelines/futuremedia/accessibility/).
@@ -41,7 +45,7 @@ Nobody's perfect. Use `skip_scenario` in the configuration to opt-out of certain
 ```
 BBC::A11y.configure do
   page "http://bbc.co.uk" do
-    skip_scenario "W3C"
+    skip_scenario /W3C/
   end
 
   page "http://bbc.co.uk/news"
@@ -52,9 +56,9 @@ A11y will skip any scenarios from the specifications whose name contains that st
 
 ## Running it
 
-Once you're configured, you can run the tests using the `a11y` command:
+Once you're configured, you can run the tests using the `a11y` command, from the directory where your `.a11y.rb` configuration file is stored:
 
     bundle exec a11y
 
-This will pick up your `.a11y.rb` configuration file and run the a11y features on each page specified in your configuration. 
+This will pick up your `.a11y.rb` configuration file and run the a11y features on each page specified in your configuration.
 Output is printed to the console.

data/Rakefile

@@ -8,6 +8,5 @@ task :unit do
 end
 
 task :acceptance do
-  sh "cd examples/local-web-app && rake"
-  sh "cd examples/bbc-pages && rake"
+  sh "cucumber"
 end

data/bin/a11y

@@ -2,4 +2,5 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
 
 require 'bbc/a11y/cli'
-BBC::A11y::CLI.new($stdin, $stdout, $stderr, ARGV.dup).call
+require 'bbc/a11y/cucumber_runner'
+BBC::A11y::CLI.new($stdin, $stdout, $stderr, ARGV.dup).call(BBC::A11y::CucumberRunner)

data/features/README.md

@@ -0,0 +1,4 @@
+These are the acceptance tests for the a11y tool itself.
+
+To read the accessibility standards checks that this tool will run against your app,
+you need to look in the `standards` directory.

data/features/exit_status.feature

@@ -0,0 +1,14 @@
+@wip
+Feature: Exit status
+
+  For CI, we need to make sure the process exits with a non-zero
+  status when there's been a failure.
+
+  Scenario: Passing tests
+    When all the tests pass
+    Then the exit status should be 0
+
+  Scenario: Failing test
+    Given a standards-compliant website running at http://localhost:54321
+    When I run `a11y http://localhost:54321/missing_header.html`
+    Then the exit status should be 1

data/features/specify_url_via_cli.feature

@@ -0,0 +1,10 @@
+Feature: Specify URL via the CLI
+
+  Scenario: No config, just pass page URL on command-line
+    Given a standards-compliant website running at http://localhost:54321
+    When I run `a11y http://localhost:54321/perfect.html`
+    Then it should pass with:
+      """
+      BBC Accesibility: http://localhost:54321/perfect.html
+      -----------------------------------------------------
+      """

data/features/specify_url_via_config.feature

@@ -0,0 +1,16 @@
+Feature: Specify URL via config
+
+  Scenario: Specify a single page
+    Given a standards-compliant website running at http://localhost:54321
+    And a file named ".a11y.rb" with:
+      """
+      BBC::A11y.configure do
+        page "http://localhost:54321/perfect.html"
+      end
+      """
+    When I run `a11y`
+    Then it should pass with:
+      """
+      BBC Accesibility: http://localhost:54321/perfect.html
+      -----------------------------------------------------
+      """

data/features/step_definitions/steps.rb

@@ -0,0 +1,13 @@
+Given(/^a standards-compliant website running at http:\/\/localhost:(\d+)$/) do |port|
+  WebServer.ensure_running_on(port)
+end
+
+Given(/^all the tests pass$/) do
+  WebServer.ensure_running_on(54321)
+  step "I run `a11y http://localhost:54321/perfect.html`"
+end
+
+Given(/^one test fails$/) do
+  WebServer.ensure_running_on(54321)
+  step "I run `a11y http://localhost:54321/missing_header.html`"
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/features/support/web_server.rb

@@ -0,0 +1,30 @@
+require 'webrick'
+
+class WebServer
+  DOCUMENT_ROOT = File.expand_path File.dirname(__FILE__) + '/web_server'
+  class << self
+    def ensure_running_on(port)
+      return if @running
+      server = WEBrick::HTTPServer.new options(port)
+      Thread.new { server.start }
+      at_exit { server.shutdown }
+      @running = true
+    end
+
+    def options(port)
+      default = {
+        :Port => port.to_i, 
+        :DocumentRoot => DOCUMENT_ROOT, 
+      }
+      disable_logging = {
+        :AccessLog => [], 
+        :Logger => WEBrick::Log::new("/dev/null", 7)
+      }
+      unless ENV['DEBUG']
+        default.merge disable_logging
+      else
+        default
+      end
+    end
+  end
+end

data/features/support/web_server/missing_header.html

@@ -0,0 +1,13 @@
+<html lang="en-gb">
+  <head>
+    <title>Missing header</title>
+  </head>
+
+  <body>
+    <p role="main">
+    Here is some text in British English. This is needed so that we can verify that
+    the lang attribute in the html element at the top, which specified en-gb, is
+    correct.
+    </p>
+  </body>
+</html>

data/features/support/web_server/perfect.html

@@ -0,0 +1,14 @@
+<html lang="en-gb">
+  <head>
+    <title>Perfect page - Main heading</title>
+  </head>
+
+  <body>
+    <h1>Main heading</h1>
+    <p role="main">
+    Here is some text in British English. This is needed so that we can verify that
+    the lang attribute in the html element at the top, which specified en-gb, is
+    correct.
+    </p>
+  </body>
+</html>

data/lib/bbc/a11y.rb

@@ -1,4 +1,5 @@
 module BBC
   module A11y
+    TestsFailed = Class.new(StandardError)
   end
 end

data/lib/bbc/a11y/cli.rb

@@ -1,5 +1,5 @@
-require 'bbc/a11y/cucumber_runner'
 require 'bbc/a11y/configuration'
+require 'bbc/a11y'
 
 module BBC
   module A11y
@@ -14,9 +14,11 @@ module BBC
         @stdin, @stdout, @stderr, @args = stdin, stdout, stderr, args
       end
 
-      def call
+      def call(runner)
         trap_interrupt
-        CucumberRunner.new(settings, cucumber_args).call
+        runner.new(settings, cucumber_args).call
+      rescue TestsFailed
+        exit 1
       rescue MissingArgument => error
         stderr.puts "You missed an argument: #{error.message}"
         stderr.puts HELP
@@ -26,12 +28,24 @@ module BBC
       private
 
       def settings
-        Configuration.parse(File.expand_path(".a11y.rb"))
+        if a11y_args.any?
+          Configuration.for_urls(a11y_args)
+        else
+          Configuration.parse(File.expand_path(".a11y.rb"))
+        end
+      end
+
+      def a11y_args
+        if args.find_index('--')
+          args[0..(args.find_index('--') - 1)]
+        else
+          args
+        end
       end
 
       def cucumber_args
         return [] unless args.include?('--')
-        args[args.find_index('--')+1..-1]
+        args[(args.find_index('--') + 1)..-1]
       end
 
       def trap_interrupt

data/lib/bbc/a11y/configuration.rb

@@ -16,6 +16,11 @@ module BBC
         BBC::A11y.configuration
       end
 
+      def self.for_urls(urls)
+        page_settings = urls.map { |url| PageSettings.new(url) }
+        Settings.new.with_pages(page_settings)
+      end
+
       class Settings
         attr_reader :before_all_hooks,
           :after_all_hooks,
@@ -44,7 +49,7 @@ module BBC
         end
 
         def skip_test_case?(test_case)
-          @scenarios_to_skip.any? { |pattern| pattern.match test_case.name }
+          @scenarios_to_skip.any? { |pattern| test_case.name.match pattern }
         end
 
         def merge(other)

data/lib/bbc/a11y/cucumber_runner.rb

@@ -51,6 +51,9 @@ module BBC
           end
         end
         puts
+        if result.failed?
+          CucumberRunner.test_case_failed
+        end
       end
 
       private
@@ -135,6 +138,21 @@ module BBC
 
     class CucumberRunner
       include ConsoleWriter
+      FEATURES_PATH = File.expand_path(File.dirname(__FILE__) + "/../../../standards")
+
+      class << self
+        # need to use a global stash-point for the formatter to talk back to use
+        # until Cucumber gives us a way to add formatter instances that we can
+        # share.
+        def failed_count
+          @failed_count ||= 0
+        end
+
+        def test_case_failed
+          @failed_count ||= 0
+          @failed_count += 1
+        end
+      end
 
       def initialize(settings, cucumber_args)
         @settings = settings
@@ -152,19 +170,21 @@ module BBC
         end
       ensure
         run_after_all_hooks
+        raise BBC::A11y::TestsFailed if self.class.failed_count > 0
       end
 
       private
 
       def configuration
         return @configuration if @configuration
-        features_path = File.expand_path(File.dirname(__FILE__) + "/../../../features")
         @configuration = Cucumber::Cli::Configuration.new
+        if !@cucumber_args.any?
+          @cucumber_args = [FEATURES_PATH, "--require", FEATURES_PATH]
+        end
         # This is ugly, but until Cucumber offers a better API, we have to pass in our settings as though
         # they were CLI arguments
-        @configuration.parse!(@cucumber_args + [
-                              features_path,
-                              "--format", "BBC::A11y::CucumberFormatter"])
+        @configuration.parse!(@cucumber_args +
+                              ["--format", "BBC::A11y::CucumberFormatter"])
         @configuration
       end
 
@@ -179,7 +199,7 @@ module BBC
       def print_page_header(page_settings)
         puts
         puts
-        underline("BBC Accesibility: #{page_settings.url}")
+        puts underline("BBC Accesibility: #{page_settings.url}")
       end
 
     end

data/lib/bbc/a11y/cucumber_support.rb

@@ -1,7 +1,10 @@
+require 'bbc/a11y/cucumber_support/disabled_w3c'
 require 'bbc/a11y/cucumber_support/language_detector'
+require 'bbc/a11y/cucumber_support/matchers'
 require 'bbc/a11y/cucumber_support/page'
-require 'bbc/a11y/cucumber_support/w3c'
 require 'bbc/a11y/cucumber_support/per_page_checks'
+require 'bbc/a11y/cucumber_support/w3c'
+require 'bbc/a11y/configuration'
 
 module BBC
   module A11y
@@ -17,7 +20,7 @@ module BBC
 
       # Returns an object that can validate URLs
       def w3c
-        @w3c ||= W3C.new
+        @w3c ||= DisabledW3C.new
       end
 
       # An object that represents the current page being viewed in the browser
@@ -43,7 +46,11 @@ module BBC
       end
 
     end
+
+    CucumberSupport.current_page_settings ||= 
+      Configuration::PageSettings.new(ENV['A11Y_URL'])
   end
 
 end
 
+

data/lib/bbc/a11y/cucumber_support/disabled_w3c.rb

@@ -0,0 +1,37 @@
+module BBC
+  module A11y
+    module CucumberSupport
+
+      class DisabledW3C
+
+        def validate(url)
+          raise Cucumber::Core::Test::Result::Skipped.new <<-MESSAGE
+W3C validation is disabled by default as it makes off-netowrk calls
+to the W3C web service and can be slow and unreliable.
+
+To enable these checks, include the following code in your .a11y.rb
+config file:
+
+    BBC::A11y.configure do
+      page "my_page.html" do
+
+        customize_world do
+          def w3c
+            @w3c ||= BBC::A11y::CucumberSupport::W3C.new
+          end
+        end
+
+      end
+    end
+          MESSAGE
+        end
+
+        def errors
+          []
+        end
+
+      end
+
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_support/matchers.rb

@@ -0,0 +1,21 @@
+require 'rspec/matchers'
+module BBC
+  module A11y
+    module CucumberSupport
+      RSpec::Matchers.define :have_title_attribute_or_associated_label_tag do
+        match do |element|
+          if !element['title'].nil?
+            return true
+          end
+          if id = element['id']
+            return true if element.find_xpath("//*[for=#{id}]")
+          end
+          if element.find_xpath("..")[0].name == "label"
+            return true
+          end
+          false
+        end
+      end
+    end
+  end
+end