taza 0.5.0 → 0.8.0

data/History.txt

@@ -1,3 +1,36 @@
+=== 0.8.0 / 2008-11-23
+
+Taza is a web application testing framework meant to be used with browsed-based testing libraries like WATIR or Selenium
+
+Not all web applications can be written in Ruby, unfortunately. When you aren't testing an application that was written with testing in mind Taza can provide a structured and opionated way to do browser-based testing.
+
+* Sites have Pages
+* Sites have Flows that move through Pages
+* Pages have elements and filters to define simple ways of interacting with them
+* Pages have tests/specs that help chip away at the dreaded 0% Coverage Beast™
+
+* Features
+  * Generate a Taza project easily
+  * Generate Sites, Pages, and Flows using a familiar format(./script/generate)
+  * Automatically generate specs when generating a site to push you
+  * Easily switch browser and/or driver
+  * Automatic opening and cleanup of browser
+  * Included rake spec commands generated for sites and pages
+  * Rake spec commands will create an RSpec HTML report by default
+  * Easily tie-in special functionality like getting a DOM dump of each browser before it closes
+
+* Todo
+  0.8.x
+    * Add a taza_example to easily generate a fully-functional example of how a taza project might look
+    * Provide more documentation
+  0.9
+    * Add more thorough Selenium support
+    * Easily allow overwriting of spec options for included rake tasks
+    * Provide better conventions around cross-site testing
+  1.0
+    * Using Selenium with WATIR syntax(Easily switch between Selenium and WATIR without having to change any Page code)
+    * Provide more advanced documentation
+
 === 0.5.0 / 2008-10-03
 
 * 1 major enhancement

data/Manifest.txt

@@ -3,15 +3,45 @@ Manifest.txt
 README.txt
 Rakefile
 bin/taza
-lib/taza/generators/site.rb
-lib/taza/generators/project.rb
-lib/taza/generators/base.rb
-lib/taza/generators/page.rb
-lib/taza/generators.rb
-lib/taza/generators/templates/rakefile.rb.erb
-lib/taza/generators/templates/page.rb.erb
-lib/taza/generators/templates/site.rb.erb
+generators/flow/flow_generator.rb
+generators/flow/templates/flow.rb.erb
+generators/page/page_generator.rb
+generators/page/templates/functional_page_spec.rb.erb
+generators/page/templates/page.rb.erb
+generators/site/site_generator.rb
+generators/site/templates/site.rb.erb
+generators/site/templates/site.yml.erb
+lib/app_generators/taza/taza_generator.rb
+lib/app_generators/taza/templates/config.yml.erb
+lib/app_generators/taza/templates/rakefile.rb.erb
+lib/app_generators/taza/templates/spec_helper.rb.erb
+lib/taza.rb
+lib/taza/browser.rb
+lib/taza/browsers/ie_watir.rb
+lib/taza/browsers/safari_watir.rb
+lib/taza/flow.rb
 lib/taza/page.rb
+lib/taza/settings.rb
 lib/taza/site.rb
 lib/taza/tasks.rb
-lib/taza.rb
+spec/browser_spec.rb
+spec/flow_generator_spec.rb
+spec/page_generator_spec.rb
+spec/page_spec.rb
+spec/platform/osx/browser_spec.rb
+spec/platform/windows/browser_spec.rb
+spec/project_generator_spec.rb
+spec/sandbox/config.yml
+spec/sandbox/config/config.yml
+spec/sandbox/config/site_name.yml
+spec/sandbox/flows/batman.rb
+spec/sandbox/flows/robin.rb
+spec/sandbox/pages/foo/bar.rb
+spec/settings_spec.rb
+spec/site_generator_spec.rb
+spec/site_spec.rb
+spec/spec_helper.rb
+spec/taza_bin_spec.rb
+spec/taza_spec.rb
+spec/taza_tasks_spec.rb
+spec/unit_helper_spec.rb

data/README.txt

@@ -6,21 +6,43 @@
 
 Taza is meant to make acceptance testing more sane for developers(or QA where applicable) and customers.
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
-* Generate a project for application testing
+* Generate a project for browser-based testing
 * Generate pages and sites for different applications
+* Create flows that move through a site
+* Use filters to control which elements are accessible on a page depending on its state
+* Taza automatically creates and cleans up the browser for each site just like a File block
 * Manage tests by tags
 * Cross-site testing
 
+== ISSUES:
+
+* Taza has only been used in the wild with WATIR(Safari/Firefox/IE), but Selenium support is built-in
+* Taza's generators currently generate RSpec specs, Test::Unit and other test framework support is planned
+
 == SYNOPSIS:
 
-To generate a new skeleton for acceptance testing
- $ taza foo
+Taza is meant to be a refreshing way to look at browser testing. Taza provides a few ways to abstract browser-based testing into three simple ideas.
+  * Sites
+  * Pages
+  * Flows
+
+Sites have Pages.
+Pages have elements and filters.
+Flows are common actions on a site such as logging in or performing a search.
+
+Here's an example for starting a project around the Google sites
+
+  $ taza google
+  $ cd google/
+  $ ./script/generate site google
+  $ ./script/generate page home_page google
+  $ ./script/generate flow search google
+  $ rake spec:functional:google
+
+That will generate an RSpec HTML report at artifacts/functional/google/index.html
 
-Inside your new skeleton you'll have a few rake tasks available to help you get started
- $ rake generate:site name=google
- $ rake generate:page site=google name=home_page
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -2,65 +2,124 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'rubygems'
+require 'config/vendorized_gems'
 require 'hoe'
 require 'taza'
 require 'rbconfig'
 require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+require 'rake/rdoctask'
 
 private
-def windows?
-  Config::CONFIG['host_os'].include?("mswin")  
+def spec_files
+  return FileList['spec/**/*_spec.rb'].exclude(/spec\/platform\/(?!osx)/) if Taza.osx?
+  return FileList['spec/**/*_spec.rb'].exclude(/spec\/platform\/(?!windows)/) if Taza.windows?
+  return FileList['spec/**/*_spec.rb'].exclude('spec/platform/*')
 end
-
 public
 
 Hoe.new('taza', Taza::VERSION) do |p|
   p.rubyforge_name = 'taza' # if different than lowercase project name
   p.developer('Adam Anderson', 'adamandersonis@gmail.com')
   p.remote_rdoc_dir = ''
+  p.extra_deps << ['taglob','>= 1.0.0']
+  p.extra_deps << ['rake']
+  p.extra_deps << ['hoe']
+  p.extra_deps << ['mocha','>= 0.9.0']
+  p.extra_deps << ['rspec']
+  p.extra_deps << ['rubigen']
+end
+
+Rake::RDocTask.new do |rdoc|
+  files = ['README.txt', 'History.txt',
+           'lib/**/*.rb', 'doc/**/*.rdoc']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = 'README.txt'
+  rdoc.title = 'Taza RDoc'
+  rdoc.template = './vendor/gems/gems/allison-2.0.3/lib/allison.rb'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--line-numbers' << '--inline-source'
 end
 
 Spec::Rake::SpecTask.new do |t|
   t.libs << File.join(File.dirname(__FILE__), 'lib')
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end 
+  t.spec_files = spec_files
+end
 
 desc "Run all examples with RCov"
 Spec::Rake::SpecTask.new('rcov') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_files = spec_files
+  t.libs << File.join(File.dirname(__FILE__), 'lib')
   t.rcov = true
   t.rcov_dir = 'artifacts'
-  t.rcov_opts = ['--exclude', 'spec']
- 
+  if Taza.windows?
+    t.rcov_opts = ['--exclude', 'spec,lib/taza/browsers/ie_watir.rb']
+  elsif Taza.osx?
+    t.rcov_opts = ['--exclude', 'spec,lib/taza/browsers/safari_watir.rb']
+  else
+    t.rcov_opts = ['--exclude', 'spec,lib/taza/browsers']
+  end
+end
+
+desc "Generate html reports for specs"
+Spec::Rake::SpecTask.new(:reports) do |t|
+  t.spec_files=FileList['spec/**/*_spec.rb']
+  FileUtils.mkdir('artifacts') unless File.directory?('artifacts')
+  t.spec_opts=["--format html:artifacts/rspec.html"]
+end
+
+desc "Verify Code Coverage is at 99.4%"
+RCov::VerifyTask.new(:verify_rcov => :rcov) do |t|
+  t.threshold = 99.6
+  t.index_html = 'artifacts/index.html'
 end
 
 desc "Run flog against all the files in the lib"
-task :flog do  
+task :flog do
   require "flog"
   flogger = Flog.new
   flogger.flog_files Dir["lib/**/*.rb"]
+  FileUtils.mkdir('artifacts') unless File.directory?('artifacts')
   File.open("artifacts/flogreport.txt","w") do |file|
     flogger.report file
   end
 end
-  
+ 
+desc "Verify Flog Score is under threshold"
+task :verify_flog => :flog do |t|
+  flog_score_threshold = 40.0
+  messages = []
+  File.readlines("artifacts/flogreport.txt").each do |line|
+    line =~ /^(.*): \((\d+\.\d+)\)/
+    if $2.to_f > flog_score_threshold
+      messages << "Flog score is too high for #{$1}(#{$2})"
+    end
+  end
+  unless messages.empty?
+    puts messages
+    raise "Your Flog score is too high and you ought to think about the children who will have to maintain your code."
+  end
+end
+
 desc "Run saikuro cyclo complexity against the lib"
 task :saikuro do
   #we can specify options like ignore filters and set warning or error thresholds
   system "ruby vendor/gems/gems/Saikuro-1.1.0/bin/saikuro -c -t -i lib -y 0 -o artifacts"
 end
- 
+
 namespace :gem do
   desc "install a gem into vendor/gems"
   task :install do
     if ENV["name"].nil?
       STDERR.puts "Usage: rake gem:install name=the_gem_name"; exit 1
     end
-    gem = windows? ? "gem.bat" : "gem"
+    gem = Taza.windows? ? "gem.bat" : "gem"
     system "#{gem} install #{ENV['name']} --install-dir=vendor/gems  --no-rdoc --no-ri -p ""http://10.8.77.100:8080"""
   end
 end
 
+desc "Should you check-in?"
+task :quick_build => [:verify_rcov, :verify_flog]
+
 #define a task which uses flog
 # vim: syntax=ruby
-

data/bin/taza

@@ -1,4 +1,17 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
-require 'taza/generators'
-Taza::Generators::Project.new(ARGV[0]).generate
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'taza'
+  puts "#{File.basename($0)} #{Taza::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../lib/app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'taza')

data/generators/flow/flow_generator.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rubigen'
+require 'activesupport'
+
+class FlowGenerator < RubiGen::Base
+  default_options :author => nil
+  attr_reader :site_name,:name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.size != 2
+    @name = args.shift
+    @site_name=args.shift
+    check_if_site_exists
+    extract_options
+  end
+
+  def check_if_site_exists
+    unless File.directory?(File.join(destination_root,'lib','sites',site_name.underscore))
+      $stderr.puts "******No such site #{site_name} exists.******"
+      usage
+    end
+  end
+
+  def manifest
+    record do |m|
+      m.template "flow.rb.erb", File.join('lib','sites', site_name.underscore, "flows",  "#{name.underscore}.rb")
+    end
+  end
+
+  protected
+  def banner
+    <<-EOS
+    Creates a taza flow for a given taza site, site you are making a flow for must exist first.
+
+    USAGE: #{$0} #{spec.name} flow_name site_name
+    EOS
+  end
+
+  def add_options!(opts)
+    # opts.separator ''
+    # opts.separator 'Options:'
+    # For each option below, place the default
+    # at the top of the file next to "default_options"
+    # opts.on("-a", "--author=\"Your Name\"", String,
+    #         "Some comment about this option",
+    #         "Default: none") { |options[:author]| }
+    # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+  end
+
+  def extract_options
+    # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+    # Templates can access these value via the attr_reader-generated methods, but not the
+    # raw instance variable value.
+    # @author = options[:author]
+  end
+end

data/generators/flow/templates/flow.rb.erb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'taza/flow'
+
+module <%= site_name.camelize %>
+  class <%= name.camelize %> < ::Taza::Flow
+    alias :<%= site_name.underscore %> :site
+
+    def run(params={})
+      
+    end
+  end
+end

data/generators/page/page_generator.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rubigen'
+require 'activesupport'
+
+class PageGenerator < RubiGen::Base
+  default_options :author => nil
+  attr_reader :site_name,:name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.size != 2
+    @name = args.shift
+    @site_name=args.shift
+    check_if_site_exists
+    extract_options
+  end
+
+  def check_if_site_exists
+    unless File.directory?(File.join(destination_root,'lib','sites',site_name.underscore))
+      $stderr.puts "******No such site #{site_name} exists.******"
+      usage
+    end
+  end
+
+  def manifest
+    record do |m|
+      m.template "page.rb.erb", File.join('lib','sites', site_name.underscore, "pages",  "#{name.underscore}_page.rb")
+      m.template "functional_page_spec.rb.erb", File.join('spec','functional',site_name.underscore,"#{name.underscore}_page_spec.rb")
+    end
+  end
+
+  protected
+  def banner
+    <<-EOS
+    Creates a taza page for a given taza site, site you are making a page for must exist first.
+
+    USAGE: #{$0} #{spec.name} page_name site_name
+    EOS
+  end
+
+  def add_options!(opts)
+    # opts.separator ''
+    # opts.separator 'Options:'
+    # For each option below, place the default
+    # at the top of the file next to "default_options"
+    # opts.on("-a", "--author=\"Your Name\"", String,
+    #         "Some comment about this option",
+    #         "Default: none") { |options[:author]| }
+    # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+  end
+
+  def extract_options
+    # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+    # Templates can access these value via the attr_reader-generated methods, but not the
+    # raw instance variable value.
+    # @author = options[:author]
+  end
+end

data/generators/page/templates/functional_page_spec.rb.erb

@@ -0,0 +1,8 @@
+require 'spec/spec_helper'
+require '<%= site_name.underscore %>'
+
+describe "<%= name.camelize %>" do
+  it "should fail because you haven't written any tests yet" do
+    false.should be_true
+  end
+end

data/generators/page/templates/page.rb.erb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'taza/page'
+
+module <%= site_name.camelize %>
+  class <%= name.camelize %>Page < ::Taza::Page
+
+  end
+end