win32-autogui 0.2.0

data/examples/skeleton/.gitignore

@@ -0,0 +1,8 @@
+*.ddp
+*.dsk
+*.log
+*.cfIndex
+*.cfProject
+tmp/aruba
+tags
+rerun.txt

data/examples/skeleton/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 GearheadForHire, LLC
+
+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/examples/skeleton/README.markdown

@@ -0,0 +1,62 @@
+Skeleton README
+===============
+
+This is a template of the file structure needed for jump-starting
+GUI testing with the Win32-autogui RubyGem.
+
+
+Usage Example
+=============
+Create a new Win32 application testing structure for the binary quicknote.exe.  
+
+NOTE: Replace 'quicknote' with the name of your application.
+
+get the source for Win32-autogui
+
+    cd ~/workspace
+    git clone git://github.com/robertwahler/win32-autogui.git
+
+copy the skeleton example to a new folder 'quicknote'
+
+    cp -r ~/workspace/win32-autogui/examples/skeleton quicknote
+
+check it into SCM
+
+    cd quicknote
+    git init
+    git add .
+    git commit -m "initial commit"
+
+rename skeleton app to 'quicknote'
+
+    git mv lib/myapp.rb lib/quicknote.rb
+    git mv spec/myapp spec/quicknote
+
+    # MyApp => QuickNote
+    find . -name *.rb -exec sed -i 's/MyApp/QuickNote/' '{}' +
+
+    # Myapp => Quicknote
+    find . -name *.rb -exec sed -i 's/Myapp/Quicknote/' '{}' +
+
+    # myapp => quicknote
+    find . -name *.rb -exec sed -i 's/myapp/quicknote/' '{}' +
+
+customize docs
+
+    vim README.markdown LICENSE
+
+test it
+
+    rake spec
+    rake features
+
+commit it
+
+    git add .
+    git commit -m "renamed skelton app to MyApp"
+
+
+Copyright
+---------
+
+Copyright (c) 2010 GearheadForHire, LLC. See [LICENSE](LICENSE) for details.

data/examples/skeleton/Rakefile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+require 'spec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |task|
+  task.cucumber_opts = ["features"]
+end
+
+desc "Run specs and features"
+task :test => [:spec, :features]
+
+task :default => :test

data/examples/skeleton/TODO.markdown

@@ -0,0 +1,9 @@
+MyApp TODO
+==========
+
+general
+-------
+
+testing
+-------
+

data/examples/skeleton/config/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format pretty features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
+%>
+default: <%= std_opts %>
+wip: --tags @wip:3 --wip features

data/examples/skeleton/dcu/.gitignore

@@ -0,0 +1 @@
+*.dcu

data/examples/skeleton/exe/.gitignore

@@ -0,0 +1 @@
+*.exe

data/examples/skeleton/features/basic.feature

@@ -0,0 +1,6 @@
+@application
+Feature: BasicGem
+
+  This is a placeholder
+
+  Scenario: Replace or delete this file

data/examples/skeleton/features/step_definitions/application_steps.rb

@@ -0,0 +1,43 @@
+require 'myapp'
+
+include Autogui::Input
+
+After('@application') do
+  if @application
+    @application.close(:wait_for_close => true) if @application.running?
+    @application.should be_running
+  end
+end
+
+Before('@applicaton') do
+  @application = Myapp.new
+  @application.should_not be_running
+
+  # debug
+  puts "application:"
+  puts @application.inspect
+  puts "application.combined_text"
+  puts @application.combined_text
+end
+
+When /^I type in "([^"]*)"$/ do |string|
+  @application.set_focus
+  type_in(string)
+end
+
+# "the window text should match" allows regex in the partial_output, if
+# you don't need regex, use "the output should contain" instead since
+# that way, you don't have to escape regex characters that
+# appear naturally in the output
+Then /^the edit window text should match \/([^\/]*)\/$/ do |partial_output|
+  @application.edit_window.text.should =~ /#{partial_output}/
+end
+
+Then /^the edit window text should contain exactly "([^"]*)"$/ do |exact_output|
+  @application.edit_window.text.should == unescape(exact_output)
+end
+
+Then /^the edit window text should contain exactly:$/ do |exact_output|
+  @application.edit_window.text.should == exact_output
+end
+

data/examples/skeleton/features/support/env.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'win32/autogui'
+require 'aruba'
+require 'spec/expectations'

data/examples/skeleton/lib/myapp.rb

@@ -0,0 +1,73 @@
+require 'win32/autogui'
+
+APPNAME="exe\\myapp.exe"  # relative path to app using Windows style path
+
+class Myapp < Autogui::Application
+
+  def initialize(name=APPNAME, options = {:title=> "MyApp"})
+    super name, options
+  end
+
+  def edit_window
+    main_window.children.find {|w| w.window_class == 'TMemo'}
+  end
+
+  def status_bar
+    main_window.children.find {|w| w.window_class == 'TStatusBar'}
+  end
+
+  def dialog_about
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/About MyApp/) && (w.pid == pid)
+    end
+  end
+
+  def message_dialog_confirm
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/Confirm/) && (w.pid == pid)
+    end
+  end
+
+  # Title and class are the same as dialog_overwrite_confirm
+  # Use child windows to differentiate
+  def dialog_overwrite_confirm
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/^Text File Save$/) && 
+        (w.pid == pid) && 
+        (w.window_class == "#32770") &&
+        (w.combined_text.match(/already exists/))
+    end
+  end
+
+  # title and class are the same as dialog_overwrite_confirm
+  def file_save_as_dialog
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/Text File Save/) && 
+        (w.pid == pid) &&
+        (w.window_class == "#32770") &&
+        (w.combined_text.match(/Save \&in:/))
+    end
+  end
+
+  def file_open_dialog
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/Text File Open/) && (w.pid == pid)
+    end
+  end
+
+  def error_dialog
+    Autogui::EnumerateDesktopWindows.new.find do |w| 
+      w.title.match(/^MyApp$/) && (w.pid == pid) && (w.window_class == "#32770")
+    end
+  end
+
+  # menu action File, Exit
+  def file_exit
+    set_focus
+    keystroke(VK_N) if message_dialog_confirm 
+    keystroke(VK_ESCAPE) if file_open_dialog
+    keystroke(VK_MENU, VK_F, VK_X) 
+    keystroke(VK_N) if message_dialog_confirm 
+  end
+  
+end

data/examples/skeleton/spec/myapp/form_about_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Autogui::Input
+
+describe "FormAbout" do
+
+  before(:all) do
+    @application = Myapp.new
+  end
+
+  after(:all) do
+    @application.close(:wait_for_close => true) if @application.running?
+    @application.should_not be_running
+  end
+
+  before(:each) do
+    @application.dialog_about.should be_nil
+    @application.set_focus
+    keystroke(VK_MENU, VK_H, VK_A) 
+    @dialog_about = @application.dialog_about
+    @dialog_about.should_not be_nil
+    @dialog_about.is_window?.should == true
+  end
+
+  after(:each) do
+    @dialog_about.close if @dialog_about.is_window?
+    @dialog_about.is_window?.should == false
+  end
+
+  it "should open with the hotkey combination VK_MENU, VK_H, VK_A" do
+    @dialog_about.is_window?.should == true
+  end
+
+  it "should close by hitting return" do
+    @dialog_about.set_focus
+    keystroke(VK_RETURN) 
+    @application.dialog_about.should be_nil
+  end
+
+  it "should have the title 'About MyApp'" do
+    @dialog_about.title.should == "About MyApp"
+  end
+
+  it "should have an 'Ok' button" do
+    button = @dialog_about.children.find {|w| w.window_class == 'TButton'}
+    button.should_not be_nil
+    button.text.should match(/Ok/)
+  end
+
+end

data/examples/skeleton/spec/myapp/form_main_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Autogui::Input
+
+describe "FormMain" do
+  before(:all) do
+    @debug = false
+    @verbose = true
+    @application = Myapp.new
+    FileUtils.rm_rf(current_dir)
+    puts "FormMain before(:all)" if @debug
+    puts "application:\n#{@application.inspect}\n" if @debug && @verbose
+    puts "application.combined_text:\n #{@application.combined_text}\n" if @debug && @verbose
+  end
+  before(:each) do
+    @application = Myapp.new unless @application.running?
+    @application.should be_running
+    @application.set_focus
+    puts "FormMain before(:each)" if @debug
+  end
+  after(:all) do
+    if @application.running?
+      @application.file_exit 
+      # still running? force it to close
+      @application.close(:wait_for_close => true)
+      @application.should_not be_running
+    end
+    puts "FormMain after(:all)" if @debug
+  end
+  after(:each) do
+    if @application.running?
+      keystroke(VK_N) if @application.message_dialog_confirm || @application.dialog_overwrite_confirm
+      keystroke(VK_ESCAPE) if @application.error_dialog
+    end
+    puts "FormMain after(:each)" if @debug
+  end
+
+  describe "after startup" do
+    it "should have the title 'Myapp" do
+      @application.main_window.title.should match(/MyApp/)
+    end
+  end
+
+  describe "file exit (VK_MENU, VK_F, VK_X)" do
+    it "should prompt and save with modified text" do
+      type_in("anything")
+      keystroke(VK_MENU, VK_F, VK_X) 
+      @application.message_dialog_confirm.should_not be_nil
+      @application.main_window.is_window?.should == true
+      @application.should be_running
+    end
+    it "should not prompt to save with unmodified text" do
+      keystroke(VK_MENU, VK_F, VK_X) 
+      @application.message_dialog_confirm.should be_nil
+      @application.main_window.is_window?.should == false
+      @application.should_not be_running
+    end
+  end
+
+end

data/examples/skeleton/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format nested

data/examples/skeleton/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__) unless
+  $LOAD_PATH.include? File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) unless
+  $LOAD_PATH.include? File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'win32/autogui'
+require 'myapp'
+require 'spec'
+require 'spec/autorun'
+require 'aruba/api'
+
+# aruba helper, returns full path to files in the aruba tmp folder
+def fullpath(filename)
+  path = File.expand_path(File.join(current_dir, filename))
+  path = `cygpath -w #{path}`.chomp if path.match(/^\/cygdrive/)  # cygwin?
+  path
+end
+
+# return the contents of "filename" in the aruba tmp folder
+def get_file_content(filename)
+  in_current_dir do
+    IO.read(filename)
+  end
+end
+
+Spec::Runner.configure do |config|
+   config.include Aruba::Api
+end

data/examples/skeleton/spec/watchr.rb

@@ -0,0 +1,143 @@
+# Watchr: Autotest like functionality
+#
+# gem install watchr
+#
+# Run me with:
+#
+#   $ watchr spec/watchr.rb
+
+require 'term/ansicolor'
+
+$c = Term::ANSIColor
+
+def getch
+  state = `stty -g`
+  begin
+    `stty raw -echo cbreak`
+    $stdin.getc
+  ensure
+    `stty #{state}`
+  end
+end
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def all_feature_files
+  Dir['features/*.feature']
+end
+
+def all_spec_files
+  files = Dir['spec/**/*_spec\.rb']
+end
+
+def run(cmd)
+
+  pid = fork do
+    puts "\n"
+    print $c.cyan, cmd, $c.clear, "\n"
+    exec(cmd)
+  end
+  Signal.trap('INT') do
+    puts "sending KILL to pid: #{pid}"
+    Process.kill("KILL", pid)
+  end
+  Process.waitpid(pid)
+
+  prompt
+end
+
+def run_all
+  run_all_specs
+  run_default_cucumber
+end
+
+# allow cucumber rerun.txt smarts
+def run_default_cucumber
+  cmd = "cucumber"
+  run(cmd)
+end
+
+def run_all_features
+  cmd = "cucumber #{all_feature_files.join(' ')}"
+  run(cmd)
+end
+
+def run_feature(feature)
+  cmd = "cucumber #{feature}"
+  $last_feature = feature
+  run(cmd)
+end
+
+def run_last_feature
+  run_feature($last_feature) if $last_feature
+end
+
+def run_default_spec
+  cmd = "spec _1.3.1_ --color --format s ./spec"
+  run(cmd)
+end
+
+def run_all_specs
+  cmd = "spec _1.3.1_ --color --format s #{all_spec_files.join(' ')}"
+  p cmd
+  run(cmd)
+end
+
+def run_spec(spec)
+  cmd = "spec _1.3.1_ --color --format s #{spec}"
+  $last_spec = spec
+  run(cmd)
+end
+
+def run_last_spec
+  run_spec($last_spec) if $last_spec
+end
+
+def prompt
+  puts "Ctrl-\\ for menu, Ctrl-C to quit"
+end
+
+# init
+$last_feature = nil
+prompt
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch( '^features/(.*)\.feature'   )   { run_default_cucumber }
+
+#watch( '^bin/(.*)'   )   { run_default_cucumber }
+watch( '^lib/(.*)'   )   { run_default_cucumber }
+
+watch( '^features/step_definitions/(.*)\.rb' )   { run_default_cucumber }
+watch( '^features/support/(.*)\.rb' )   { run_default_cucumber }
+
+watch( '^spec/(.*)_spec\.rb'   )   { |m| run_spec(m[0]) }
+# specify just the lib files that have specs
+# TODO: This can be determined automatically from the spec file naming convention
+watch( '^lib/(.*)'   )   { run_default_spec }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+
+# Ctrl-\
+Signal.trap('QUIT') do
+
+  puts "\n\nMENU: a = all , f = features  s = specs, l = last feature (#{$last_feature ? $last_feature : 'none'}), q = quit\n\n"
+  c = getch
+  puts c.chr
+  if c.chr == "a"
+    run_all
+  elsif c.chr == "f"
+    run_default_cucumber
+  elsif c.chr == "s"
+    run_all_specs
+  elsif c.chr == "q"
+    abort("exiting\n")
+  elsif c.chr == "l"
+    run_last_feature
+  end
+
+end