gnome_app_driver 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10a3a958d03c4ebc90fe78e4159eed230a79e5fa
+  data.tar.gz: c8c36cb4b8b50fae9835d632851453577cfa2c35
+SHA512:
+  metadata.gz: ff10a7761fc4455f2b6279a0c4db3f40b51c615d058f3e072061d67db7f732c74c91ee17a3ddec8d238724ce2ba60fb26e1e66af4a86a7b1306651b18ed6c123
+  data.tar.gz: 694fe0e0cfdd318feddfa1138d294bbed7b37545f943dabfca38d12b80447331a1a5179f4e1fb103300cd2feb207f80fcfaf4da86073327946a2af64b6cf7a54

data/Changelog.md

@@ -0,0 +1,39 @@
+# Change log
+
+## 0.1.1 / 2017-11-05
+
+* Release Ruby-GNOME2 version under a new name: gnome_app_driver
+
+## 0.1.0 / 2017-04-25
+
+* Use Ruby-GNOME2 instead of GirFFI to provide GLib bindings
+
+## 0.0.7 / 2016-10-16
+
+* Depend on GirFFI 0.11.x
+
+## 0.0.6 / 2016-03-23
+
+* Depend on GirFFI 0.10.x
+
+## 0.0.5 / 2016-02-04
+
+* Depend on GirFFI 0.9.x
+* Fix boot failure handling
+
+## 0.0.4 / 2015-12-12
+
+* Loosen dependencies
+
+## 0.0.3 / 2015-10-29
+
+* Ensure frame is focused by waiting for it to be :active
+
+## 0.0.2 / 2015-09-20
+
+* Print self during recursive inspect
+* Update dependencies
+
+## 0.0.1 / 2015-05-29
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 Matijs van Zuijlen
+
+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.md

@@ -0,0 +1,92 @@
+# Ruby-GNOME2 App Driver
+
+Test driver for Ruby-GNOME2 applications using Atspi. Takes care of boot and
+shutdown, and provides a handle on the GUI's main UI frame.
+
+## Usage
+
+This driver assumes your application lives in `bin/` and uses additional ruby
+code in `lib/`.
+
+Say, your application is called `foo`. Then, in your tests, do something like this:
+
+    require 'gnome_app_driver'
+
+    describe 'The application' do
+      before do
+        @driver = GnomeAppDriver.new('foo')
+
+        # This will boot `ruby -Ilib bin/foo`, wait for its main window to appear,
+        # and focus it.
+        @driver.boot
+      end
+
+      it 'does stuff' do
+        # Fetch the main window's atspi object
+        frame = @driver.frame
+
+        # You can now interact with the window's objects
+
+        # Select item matching /bar/ from combo box:
+        box = frame.find_role :combo_box
+        item = box.find_role :menu_item, /bar/
+        box.get_action_name(0).must_equal 'press'
+        box.do_action 0
+        item.get_action_name(0).must_equal 'click'
+        item.do_action 0
+
+        # Fetch contents of a text box
+        textbox = frame.find_role :text
+        textbox.get_text(0, 100).must_equal 'Foo bar baz'
+
+        # Quit application
+        @driver.press_ctrl_q
+
+        # Check exit status
+        status = @driver.cleanup
+        status.exitstatus.must_equal 0
+      end
+
+      after do
+        # Ensure application is cleaned up
+        @driver.cleanup
+      end
+    end
+
+## Installation
+
+    gem install gnome_app_driver
+
+## Dependencies
+
+Ruby-GNOME2 App Driver needs atspi's GIR data, and needs to be able to interact with
+the application via atspi and atk. The below are suggested packages to install.
+Corrections are welcome, of course.
+
+### Debian
+
+This should work on Debian unstable.
+
+    sudo apt-get install dbus
+    sudo apt-get install libgirepository1.0-dev gobject-introspection
+    sudo apt-get install gir1.2-atspi-2.0 libatk-adaptor
+
+### Ubuntu
+
+Please try the instructions for Debian. This will probably not work on Ubuntu
+12.04. Again, corrections and additions are welcome.
+
+### Other OS
+
+To be determined. Please contribute back your experience in getting Ruby-GNOME2 App
+Driver working on your favorite operation system.
+
+## Contributing
+
+Contributions are welcome! Please feel free to create issues or pull requests
+on GitHub.
+
+## License
+
+Copyright © 2015-2017 [Matijs van Zuijlen](http://www.matijs.net).
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake/clean'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:end_to_end) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/end_to_end/*_test.rb']
+    t.warning = true
+  end
+
+  task all: [:end_to_end]
+end
+
+task test: 'test:all'
+
+task default: 'test'

data/lib/gnome_app_driver.rb

@@ -0,0 +1,159 @@
+require 'gobject-introspection'
+
+# Namespace for Atspi classes. Autoloading with GObjectIntrospection is set up
+# here.
+module Atspi
+  class << self
+    def const_missing(name)
+      init
+      if const_defined?(name)
+        const_get(name)
+      else
+        super
+      end
+    end
+
+    def init
+      class << self
+        remove_method(:init)
+        remove_method(:const_missing)
+      end
+      loader = GObjectIntrospection::Loader.new(self)
+      loader.load('Atspi')
+    end
+  end
+end
+
+# Utility monkey-patches for the Atspi::Accessible class
+module AtspiAccessiblePatches
+  def each_child
+    child_count.times do |i|
+      child = get_child_at_index i
+      yield child if child
+    end
+  end
+
+  def find_role(role, regex = //)
+    return self if role == self.role && name =~ regex
+    each_child do |child|
+      result = child.find_role role, regex
+      return result if result
+    end
+    nil
+  end
+
+  def inspect_recursive(level = 0, maxlevel = 5)
+    puts "#{'  ' * level} > name: #{name}; role: #{role}"
+    each_child do |child|
+      child.inspect_recursive(level + 1) unless level >= maxlevel
+    end
+  end
+end
+
+Atspi::Accessible.include AtspiAccessiblePatches
+
+# Test driver for the Atspi-enabled applications. Takes care of boot and
+# shutdown, and provides a handle on the GUI's main UI frame.
+class GnomeAppDriver
+  def initialize(app_name, app_file: nil, verbose: false)
+    @app_file = app_file || "bin/#{app_name}"
+    @lib_dir = 'lib'
+    @app_name = app_name
+    @pid = nil
+    @verbose = verbose
+    @frame = nil
+    @thread = nil
+  end
+
+  attr_reader :frame
+
+  def boot(test_timeout: 30, exit_timeout: 10, arguments: [])
+    raise 'Already booted' if @pid
+
+    spawn_process(arguments)
+
+    @cleanup = false
+
+    @frame = find_and_focus_frame
+
+    @thread = Thread.new do
+      wait_for('test to be done', test_timeout) { @cleanup }
+      wait_for('pid to go away', exit_timeout) { !@pid }
+      kill_process if @pid
+    end
+  end
+
+  def spawn_process(arguments)
+    command = "ruby -I#{@lib_dir} #{@app_file} #{arguments.join(' ')}"
+    log "About to spawn: `#{command}`"
+    @pid = Process.spawn command
+  end
+
+  def press_ctrl_q
+    Atspi.generate_keyboard_event(37, nil, :press)
+    Atspi.generate_keyboard_event(24, nil, :pressrelease)
+    Atspi.generate_keyboard_event(37, nil, :release)
+  end
+
+  def cleanup
+    status = exit_status
+    @pid = nil
+    @thread.join if @thread
+    status
+  end
+
+  private
+
+  def find_and_focus_frame
+    acc = wait_for('app to appear', 10) { find_app }
+    raise 'App not found' unless acc
+
+    frame = acc.get_child_at_index 0
+    role = frame.role
+    raise "Frame has unexpected role #{role.inspect}" unless role == :frame
+
+    wait_for('frame to be focused', 10) do
+      frame.state_set.contains(Atspi::StateType::ACTIVE)
+    end
+
+    frame
+  end
+
+  def kill_process
+    log "About to kill child process #{@pid}"
+    Process.kill 'KILL', @pid
+  end
+
+  def log(message)
+    warn message if @verbose
+  end
+
+  def find_app
+    desktop = Atspi.get_desktop(0)
+    desktop.each_child do |child|
+      return child if child.name == @app_name
+    end
+    nil
+  end
+
+  # TODO: Use timeout
+  def wait_for(description, _timeout)
+    start = Time.now
+    result = nil
+    # Try for 0.01 * 50 * (50 + 1) / 2 = 12.75 seconds
+    50.times do |num|
+      result = yield
+      break if result
+      sleep 0.01 * (num + 1)
+    end
+    log "Waited #{Time.now - start} seconds for #{description}"
+    result
+  end
+
+  def exit_status
+    return unless @pid
+    @cleanup = true
+    _, status = Process.wait2 @pid
+    status
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: gnome_app_driver
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matijs van Zuijlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gobject-introspection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gtk3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- matijs@matijs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/gnome_app_driver.rb
+homepage: http://www.github.com/mvz/ruby-gnome2_app_driver
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Test Ruby-GNOME2 applications using Atspi
+test_files: []