cucumber-wordpress 1.0

data/LICENCE

@@ -0,0 +1,13 @@
+Copyright © 2009, The Dextrous Web
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -0,0 +1,38 @@
+= cucumber-wordpress
+
+Environment setup and step definitions for testing WordPress with Cucumber.
+
+== Getting started
+
+Install the gem:
+  gem install cucumber-wordpress --source http://gemcutter.org
+
+Copy the examples/features/ directory into an existing WordPress installation:
+  cd wordpress-installation
+  cp /usr/lib/ruby/gems/1.8/gems/cucumber-wordpress-1.0/examples/features .
+
+Configure wp-config variables:
+  vim features/support/config.yml
+
+Run cucumber:
+  cucumber
+
+== Caveats
+
+* The WordPress installation you're testing must be being served over HTTP
+  somehow (see WEBHOST in config.yml). Eventually I want to be able to start a
+  Web server from within cucumber.
+* wp-config.php gets copied elsewhere and overwritten, so you can't be running
+  this in a production environment.
+
+== Patches
+ 
+* Send me a pull request via GitHub or an email at tom@thedextrousweb.com.
+
+== Author
+
+* Tom Adams <tom@thedextrousweb.com>
+
+== Copyright
+
+Copyright (c) 2009 The Dextrous Web. See LICENCE for details.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = "1.0"
+    gem.name = "cucumber-wordpress"
+    gem.summary = %Q{Environment setup and step definitions for testing WordPress with Cucumber}
+    gem.email = "tom@thedextrousweb.com"
+    gem.homepage = "http://github.com/dxw/cucumber-wordpress"
+    gem.authors = ["Tom Adams"]
+    gem.add_dependency "cucumber"
+    gem.add_dependency "webrat"
+    gem.add_dependency "mysql"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/examples/features/step_definitions/webrat_steps.rb

@@ -0,0 +1,159 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent|
+  click_link_within(parent, link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^I fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time
+When /^I select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it.
+When /^I select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^I select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field)
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response.should contain(text)
+end
+
+Then /^I should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response.should contain(regexp)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response.should_not contain(text)
+end
+
+Then /^I should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response.should_not contain(regexp)
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should_not =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  field_labeled(label).should be_checked
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  field_labeled(label).should_not be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  uri = URI.parse(current_url)
+  if uri.query.blank?
+    uri.path.should == path_to(page_name)
+  else
+    "#{uri.path}?#{uri.query}".should include(path_to(page_name))
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/examples/features/support/config.yml

@@ -0,0 +1,9 @@
+--- 
+WEBHOST: localhost
+DB_NAME: wordpress_test
+DB_USER: root
+DB_PASSWORD:
+DB_HOST: localhost
+DB_CHARSET: utf8
+DB_COLLATE:
+TABLE_PREFIX: wp_

data/examples/features/support/env.rb

@@ -0,0 +1,96 @@
+#
+# All the standard stuff
+#
+
+require 'spec/mocks'
+require 'webrat'
+Webrat.configure do |config|
+  config.mode = :mechanize
+end
+World do
+  session = Webrat::Session.new
+  session.extend(Webrat::Methods)
+  session.extend(Webrat::Matchers)
+  session
+end
+
+#
+# WordPress stuff
+#
+
+require 'cucumber-wordpress'
+require 'cucumber-wordpress/steps'
+
+# Get the WordPress configuration for this site
+WordPress.configure(YAML::load(open(File.join(File.dirname(__FILE__),'config.yml'))))
+
+# Hide the original wp-config.php, and write our own
+WordPress.write_config
+WordPress.create_db
+
+at_exit do
+  # Replace the original wp-config.php (if it existed)
+  WordPress.reset_config
+  WordPress.drop_db
+end
+
+# Before every scenario, reset the DB to how it was when it was first installed
+Before do |scenario|
+  WordPress.reset_db
+end
+
+#
+# And we're done!
+# Apart from a couple of patches we need to apply to webrat...
+#
+
+# For some reason the MechanizeAdapter uses response_body instead of response.body.
+# This is needed
+module Webrat
+  class Session
+    include Spec::Mocks::ExampleMethods
+    def response
+      m = mock
+      m.should_receive(:body).any_number_of_times.and_return(response_body)
+      m
+    end
+  end
+end
+
+# Use XPath in click_link_within, etc.
+# This is needed too
+module Webrat
+  class Scope
+    protected
+
+    def xpath_scoped_dom
+      Webrat::XML.xpath_at(@scope.dom, @selector)
+    end
+
+    def scoped_dom
+      begin
+        Webrat::XML.css_at(@scope.dom, @selector)
+      rescue Nokogiri::CSS::SyntaxError, Nokogiri::XML::XPath::SyntaxError => e
+        begin
+          # That was not a css selector, mayby it's an xpath selector?
+          xpath_scoped_dom
+        rescue
+          # Raise original css syntax error if selector is not xpath either
+          raise e
+        end
+      end
+    end
+  end
+end
+
+# Fix attach_file so it works with mechanize
+# Thanks: https://webrat.lighthouseapp.com/projects/10503/tickets/303-tiny-patch-for-attach_file-to-work-with-mechanize
+# This is not needed for cucumber-wordpress (yet)
+module Webrat
+  class FileField < Field
+  protected
+    def test_uploaded_file
+      open(@value)
+    end
+  end
+end

data/examples/features/support/paths.rb

@@ -0,0 +1,21 @@
+require 'cucumber-wordpress'
+
+module NavigationHelpers
+  def path_to(page_name)
+
+    # Default WordPress paths
+    path = WordPress.path_to(page_name)
+    return path unless path.nil?
+
+    # Our own paths
+    partial = case page_name
+    when /^my special page$/
+      '/my-special-page.php'
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n"
+    end
+    URI::join("http://#{WordPress.WEBHOST}/", partial)
+  end
+end
+
+World(NavigationHelpers)

data/examples/features/wordpress.feature

@@ -0,0 +1,18 @@
+Feature: WordPress example
+  WordPress should be as easy to test as Rails.
+
+  Background:
+    Given WordPress is installed
+
+  Scenario: Submitting a post
+    Given I am logged in as "admin"
+    And I am on admin dashboard
+    When I follow "Add New" within "#menu-posts"
+    Then I should see "Add New Post"
+    When I fill in "title" with "hullo thar"
+    And I fill in "content" with "I <3 cucumber"
+    And I press "publish"
+    Then there should be 1 post
+    Given I am on homepage
+    Then I should see "hullo thar"
+    And I should see "I <3 cucumber"

data/lib/cucumber-wordpress/steps.rb

@@ -0,0 +1,71 @@
+Given /^WordPress is installed$/ do
+  visit path_to 'homepage'
+  title = 'A Very Boring Test Title'
+  if response.body.include? '<title>WordPress &rsaquo; Installation</title>'
+    fill_in('Blog Title', :with => title)
+    fill_in('Your E-mail', :with => 'test@wordpress.org')
+    click_button('Install WordPress')
+    WordPress.passwords = {'admin' => response.body.match(%r[<td><code>(.+)</code><br />])[1]}
+  end
+  visit path_to 'homepage'
+  unless response.body.include? "<title> #{title}</title>"
+    raise Exception
+  end
+
+  # Take this so we can reset the DB before each scenario
+  WordPress.original_contents = {}
+  %w[comments
+   links
+   options
+   postmeta
+   posts
+   term_relationships
+   term_taxonomy
+   terms
+   usermeta
+   users].each do |table|
+    WordPress.original_contents[table] = WordPress.mysql.query("select * from #{WordPress.TABLE_PREFIX}#{table}").map{|row|row}
+   end
+end
+
+Given /^I am logged in as "([^\"]*)"$/ do |user|
+  visit path_to 'login page'
+  fill_in('Username', :with => user)
+  fill_in('Password', :with => WordPress.passwords[user])
+  click_button('Log In')
+end
+
+Given /^plugin "([^\"]*)" is (enabled|disabled)$/ do |plugin,able|
+  Given 'I am logged in as "admin"'
+  visit path_to 'admin dashboard'
+  click_link('Plugins')
+  link = %Q&//a[contains(@href,"#{plugin}")]&
+  if dom.xpath("#{link}/child::text()").any?{|t|t.to_s == 'Activate'}
+    if able == 'enabled'
+      click_link_within("#{link}/..",'Activate')
+    else
+      click_link_within("#{link}/..",'Deactivate')
+    end
+  end
+end
+
+Then /^there should be (\d+) posts?$/ do |count|
+  WordPress.mysql.query("select count(*) from #{WordPress.TABLE_PREFIX}posts where ID != 1 and post_type = 'post'").fetch_row.first.to_i.should == count.to_i
+end
+
+Then /^there should be (\d+) categories?$/ do |count|
+  # Two initial categories, which we won't count: Uncategorized and Blogroll
+  WordPress.mysql.query("select count(*) from #{WordPress.TABLE_PREFIX}terms where term_id > 2").fetch_row.first.to_i.should == count.to_i
+end
+
+Then /^there should be a category called "([^\"]*)"$/ do |category|
+  WordPress.mysql.query("select count(*) > 0 from #{WordPress.TABLE_PREFIX}terms where name = '#{Mysql.escape_string(category)}' or slug = '#{Mysql.escape_string(category)}'").fetch_row.first.to_i.should == 1
+end
+
+Then /^there should be a post called "([^\"]*)"$/ do |post|
+  WordPress.mysql.query("select count(*) > 0 from #{WordPress.TABLE_PREFIX}posts where post_title = '#{Mysql.escape_string(post)}' or post_name = '#{Mysql.escape_string(post)}'").fetch_row.first.to_i.should == 1
+end
+
+Then /^there should be a post called "([^\"]*)" in the "([^\"]*)" category$/ do |post, category|
+  WordPress.mysql.query("select count(*) > 0 from #{WordPress.TABLE_PREFIX}terms join #{WordPress.TABLE_PREFIX}term_relationships join #{WordPress.TABLE_PREFIX}posts where (post_title = '#{Mysql.escape_string(post)}' or post_name = '#{Mysql.escape_string(post)}') and (name = '#{Mysql.escape_string(category)}' or slug = '#{Mysql.escape_string(category)}')").fetch_row.first.to_i.should == 1
+end

data/lib/cucumber-wordpress.rb

@@ -0,0 +1,90 @@
+require 'singleton'
+require 'mysql'
+Mysql::Result.send(:include, Enumerable)
+
+class WordPress
+  include Singleton
+
+  def self.method_missing(method, *args)
+    self.instance.send(method, *args)
+  end
+
+  attr_accessor :passwords, :mysql, :original_contents
+  attr_accessor :WEBHOST, :DB_NAME, :DB_USER, :DB_PASSWORD, :DB_HOST, :DB_CHARSET, :DB_COLLATE, :TABLE_PREFIX
+
+  def configure(data)
+    @WEBHOST = data['WEBHOST'].to_s
+    @DB_NAME = data['DB_NAME'].to_s
+    @DB_USER = data['DB_USER'].to_s
+    @DB_PASSWORD = data['DB_PASSWORD'].to_s
+    @DB_HOST = data['DB_HOST'].to_s
+    @DB_CHARSET = data['DB_CHARSET'].to_s
+    @DB_COLLATE = data['DB_COLLATE'].to_s
+    @TABLE_PREFIX = data['TABLE_PREFIX'].to_s
+  end
+
+  def create_db
+    @mysql = Mysql::new(@DB_HOST, @DB_USER, @DB_PASSWORD)
+    @mysql.query("create database if not exists #{@DB_NAME} character set = #{@DB_CHARSET}#{@DB_COLLATE.present? ? " collate = #{@DB_COLLATE}" : ''}")
+    @mysql.query("use #{@DB_NAME}")
+  end
+
+  def drop_db
+    @mysql.query("drop database if exists #{@DB_NAME}")
+  end
+
+  def write_config
+    # Copy production DB elsewhere
+    @has_config = File.exist? 'wp-config.php'
+    FileUtils.cp 'wp-config.php', '.wp-config.php' if @has_config
+
+    # Write our own
+    open('wp-config.php','w+') do |f|
+      f.write <<HERE
+<?php
+define('DB_NAME', '#{@DB_NAME}');
+define('DB_USER', '#{@DB_USER}');
+define('DB_PASSWORD', '#{@DB_PASSWORD}');
+define('DB_HOST', '#{@DB_HOST}');
+define('DB_CHARSET', '#{@DB_CHARSET}');
+define('DB_COLLATE', '#{@DB_COLLATE}');
+$table_prefix  = '#{@TABLE_PREFIX}';
+if ( !defined('ABSPATH') ) define('ABSPATH', dirname(__FILE__) . '/');
+require_once(ABSPATH . 'wp-settings.php');
+HERE
+    end
+  end
+
+  def reset_config
+    FileUtils.rm 'wp-config.php'
+    FileUtils.mv '.wp-config.php', 'wp-config.php' if @has_config
+  end
+
+  def reset_db
+    @original_contents.nil? ? nil : @original_contents.each_pair do |table,contents|
+      @mysql.query("delete from #{@TABLE_PREFIX}#{table}")
+      contents.each do |row|
+        values = row.map{|v|"#{v.nil? ? 'null' : "'"+Mysql.escape_string(v)+"'"}"}.join(', ')
+        @mysql.query("insert into #{@TABLE_PREFIX}#{table} values (#{values})")
+      end
+    end
+  end
+
+  def path_to(page_name)
+    partial = case page_name
+    when /^homepage$/
+      '/'
+    when /^login page$/
+      '/wp-login.php'
+    when /^admin dashboard$/
+      '/wp-admin/'
+    when /^upload new consultation$/
+      '/wp-admin/consultation-new.php'
+    when /^media library$/
+      "/wp-admin/upload.php"
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n"
+    end
+    URI::join("http://#{@WEBHOST}/", partial)
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: cucumber-wordpress
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Tom Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: tom@thedextrousweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENCE
+- README.rdoc
+- Rakefile
+- examples/features/step_definitions/webrat_steps.rb
+- examples/features/support/config.yml
+- examples/features/support/env.rb
+- examples/features/support/paths.rb
+- examples/features/wordpress.feature
+- lib/cucumber-wordpress.rb
+- lib/cucumber-wordpress/steps.rb
+has_rdoc: true
+homepage: http://github.com/dxw/cucumber-wordpress
+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: Environment setup and step definitions for testing WordPress with Cucumber
+test_files: 
+- examples/features/support/paths.rb
+- examples/features/support/env.rb
+- examples/features/step_definitions/webrat_steps.rb