Merge lp:~elopio/ubuntuone-testing/testability into lp:ubuntuone-testing

[Leo Arias]

Added the first Qt testability tests for the control panel: connect and disconnect.

First testability branch.
Includes the disconnect and connect tests.

[Rick McBride (rmcbride)]

Woohoo! Ruby

review: Approve

=== added directory 'ubuntuone/client'
=== added directory 'ubuntuone/client/qt'
=== added directory 'ubuntuone/client/qt/tests'
=== added directory 'ubuntuone/client/qt/tests/testabilitydriver'
=== added directory 'ubuntuone/client/qt/tests/testabilitydriver/controlpanel'
=== added file 'ubuntuone/client/qt/tests/testabilitydriver/controlpanel/header-tests.rb'
--- ubuntuone/client/qt/tests/testabilitydriver/controlpanel/header-tests.rb	1970-01-01 00:00:00 +0000
+++ ubuntuone/client/qt/tests/testabilitydriver/controlpanel/header-tests.rb	2012-04-17 21:50:23 +0000
@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+require '../run-tests.rb' unless $INIT_COMPLETED
+require $actions_path + '/controlpanel.rb'
+
+############################# Test Suite #############################
+context "Header tests" do
+
+  # Run once at the beginning of this test suite
+  startup do
+    $SUT.execute_shell_command 'killall ubuntuone-control-panel-qt'
+  end
+
+  # Run once at the end of this test suite
+  teardown do
+    $SUT.execute_shell_command 'killall ubuntuone-control-panel-qt'
+  end
+
+  # Run before each test case begins
+  setup do
+    # Execute the application 
+    @controlpanel = $SUT.run(:name=>'python',
+                      :start_command=>'ubuntuone-control-panel-qt ' +
+                                      '-testability')
+  end
+
+  # Run after each test case completes
+  teardown do
+    $SUT.execute_shell_command 'pkill -nf ubuntuone-control-panel-qt'
+  end
+
+  # Test cases
+
+  test "Disconnect from service" do
+    connect_and_wait_for_file_sync_update
+    disconnect
+    verify_true(3, 'test disconnected') {
+      is_disconnected?
+    } 
+  end
+
+  test "Connect to service" do
+    disconnect
+    connect_and_wait_for_file_sync_update
+  end
+
+end

=== added directory 'ubuntuone/client/qt/tests/testabilitydriver/misc'
=== added directory 'ubuntuone/client/qt/tests/testabilitydriver/misc/lib'
=== added file 'ubuntuone/client/qt/tests/testabilitydriver/misc/lib/testhelper.rb'
--- ubuntuone/client/qt/tests/testabilitydriver/misc/lib/testhelper.rb	1970-01-01 00:00:00 +0000
+++ ubuntuone/client/qt/tests/testabilitydriver/misc/lib/testhelper.rb	2012-04-17 21:50:23 +0000
@@ -0,0 +1,191 @@
+require 'test/unit'
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift File.expand_path(dir + '/../lib')
+$TEST_DIR = File.dirname(File.expand_path(__FILE__))
+
+# Enable a startup and shutdown method for each test case 
+# From https://github.com/freerange/test_startup
+module TestStartupAndShutdown
+  def startup(&block)
+    install_global_startup
+    @__startup_blocks ||= []
+    @__startup_blocks << block if block_given?
+    @__startup_blocks
+  end
+  
+  def shutdown(&block)
+    install_global_startup
+    @__shutdown_blocks ||= []
+    @__shutdown_blocks << block if block_given?
+    @__shutdown_blocks
+  end
+  
+  attr_reader :__startup_blocks, :__shutdown_blocks
+  
+  def install_global_startup
+    extend(TestSuiteWithGlobalStartup)
+  end
+  
+  module TestSuiteWithGlobalStartup
+    def suite(*args)
+      mysuite = super
+      these_startup_blocks = __startup_blocks
+      these_shutdown_blocks = __shutdown_blocks
+      mysuite.instance_eval { @__startup_blocks = these_startup_blocks }
+      mysuite.instance_eval { @__shutdown_blocks = these_shutdown_blocks }
+      def mysuite.run(*args)
+        (@__startup_blocks || []).each { |block| block.call }
+        super
+        (@__shutdown_blocks || []).each { |block| block.call }
+      end
+      mysuite
+    end
+  end
+end
+
+Test::Unit::TestCase.extend(TestStartupAndShutdown)
+
+##
+# Test::Unit runs test in alphabetical order. This class instead runs them
+# sequentially. Can specify ordering with the line
+# execute :sequentially:
+# Taken from http://wiki.openqa.org/download/attachments/804/testcase.rb
+# Copyright: Bret Pettichord
+
+class TestCase < Test::Unit::TestCase
+  @@order = :sequentially
+  def initialize name
+    throw :invalid_test if name == :default_test && self.class == TestCase
+    super
+  end        
+  class << self
+    attr_accessor :test_methods, :order
+    def test_methods
+      @test_methods ||= []
+    end
+    def order
+      @order || @@order
+    end
+    def default_order= order
+      @@order = order
+    end
+    def sorted_test_methods
+      case order
+      when :alphabetically:          test_methods.sort
+      when :sequentially:            test_methods
+      when :reversed_sequentially:   test_methods.reverse
+      when :reversed_alphabetically: test_methods.sort.reverse
+      else raise ArgumentError, "Execute option not supported: #{@order}"
+      end
+    end
+    def suite
+      suite = Test::Unit::TestSuite.new(name)
+      sorted_test_methods.each do |test|
+        catch :invalid_test do
+          suite << new(test)
+        end
+      end
+      if (suite.empty?)
+        catch :invalid_test do
+          suite << new(:default_test)
+        end
+      end
+      return suite
+    end
+    def method_added id
+      name = id.id2name
+      test_methods << name if name =~ /^test./
+    end
+    def execute order
+      @order = order
+    end
+  end
+
+  # Runs the individual test method represented by this
+  # instance of the fixture, collecting statistics, failures
+  # and errors in result. Also catches MobyBase::VerificationError
+  # and considers them fails, not errors.
+  def run(result)
+    yield(STARTED, name)
+    @_result = result
+    begin
+      setup
+      __send__(@method_name)
+    rescue Test::Unit::AssertionFailedError, MobyBase::VerificationError => e
+      add_failure(e.message, e.backtrace)
+    rescue Exception
+      raise if PASSTHROUGH_EXCEPTIONS.include? $!.class
+      add_error($!)
+    ensure
+      begin
+        teardown
+      rescue Test::Unit::AssertionFailedError, MobyBase::VerificationError => e
+        add_failure(e.message, e.backtrace)
+      rescue Exception
+        raise if PASSTHROUGH_EXCEPTIONS.include? $!.class
+        add_error($!)
+      end
+    end
+    result.add_run
+    yield(FINISHED, name)
+  end
+end
+
+
+##
+# Snippit from test/spec/mini 5
+# Allows syntatic sugar for tests in the following form:
+#
+#context "It's test/spec/mini!" do
+#  setup do
+#    @name = "Chris"
+#  end
+#
+#  teardown do
+#    @name = nil
+#  end
+#
+#  test "with Test::Unit" do
+#    assert (self.class < Test::Unit::TestCase)
+#  end
+#
+#  test "body-less test cases"
+#
+#  test :symbol_test_names do
+#    assert true
+#  end
+#
+#  xtest "disabled tests" do
+#    assert disabled!
+#  end
+#
+#  context "and of course" do
+#    test "nested contexts!" do
+#      assert_equal "Chris", @name
+#    end
+#  end
+#end
+#
+# http://gist.github.com/307649 ([e-mail])
+#
+
+def context(*args, &block)
+  return super unless (name = args.first) && block
+
+  klass = Class.new(TestCase) do
+    def self.test(name, &block)
+      define_method("test_#{name.to_s.gsub(/\W/,'_')}", &block) if block
+    end
+    def self.xtest(*args) end
+    def self.context(*args, &block) instance_eval(&block) end
+    def self.setup(&block)
+      define_method(:setup) { self.class.setups.each { |s| instance_eval(&s) } }
+      setups << block
+    end
+    def self.setups; @setups ||= [] end
+    def self.teardown(&block) define_method(:teardown, &block) end
+  end
+  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
+  klass.class_eval &block
+end

=== added file 'ubuntuone/client/qt/tests/testabilitydriver/run-tests.rb'
--- ubuntuone/client/qt/tests/testabilitydriver/run-tests.rb	1970-01-01 00:00:00 +0000
+++ ubuntuone/client/qt/tests/testabilitydriver/run-tests.rb	2012-04-17 21:50:23 +0000
@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * Copyright 2011, 2012 Canonical Ltd.
+ *
+ * Original author:
+ * - Gerry Boland <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+# Testability test suite execution script
+# 
+# Run all tests with
+#   $ ruby run-tests.rb
+
+# Check script being run by Ruby 1.8.x, later versions not supported by TDriver
+abort("Aborted! Ruby 1.9 not supported, use 1.8") unless RUBY_VERSION < '1.9'
+
+# Time verify_* assertions should wait until they throw exception 
+TIMEOUT = 10
+
+# Add ./misc/lib to the list of library locations - need to calculate absolute path
+require 'pathname'
+$library_path = File.expand_path(File.dirname(__FILE__)) + '/misc/lib'
+$actions_path = File.expand_path(File.dirname(__FILE__)) + '/shared/actions'
+$LOAD_PATH.unshift $library_path
+
+# The following line includes the complete tdriver environment 
+require 'tdriver'
+include TDriverVerify
+
+# Require unit test framework: This enables execution of test cases and also includes assertions (Test::Unit::Assertions)
+require 'testhelper'
+
+# Establish connection to qttasserver
+$SUT = TDriver.sut(:Id => "sut_qt")
+
+# Enable reports only with -report switch
+include TDriverReportTestUnit if ARGV.delete('-report')
+
+# List of directories in which to search for test cases
+test_directories = ['controlpanel']
+
+# Only run scan for tests if this script is directly called
+if __FILE__ == $0
+    $INIT_COMPLETED = true # Prevent this file being included by test cases
+
+     # Scan through the above directories and execute test cases contained.
+    test_directories.each do | directory |
+         Dir["#{directory}/*.rb"].each { |testCase| require testCase }
+    end
+end

=== added directory 'ubuntuone/client/qt/tests/testabilitydriver/shared'
=== added directory 'ubuntuone/client/qt/tests/testabilitydriver/shared/actions'
=== added file 'ubuntuone/client/qt/tests/testabilitydriver/shared/actions/controlpanel.rb'
--- ubuntuone/client/qt/tests/testabilitydriver/shared/actions/controlpanel.rb	1970-01-01 00:00:00 +0000
+++ ubuntuone/client/qt/tests/testabilitydriver/shared/actions/controlpanel.rb	2012-04-17 21:50:23 +0000
@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+def disconnect
+    if is_connected?
+        click_sync_status_button
+    end
+end
+
+def is_connected?
+    return get_sync_status_button_text == 'Disconnect'
+end
+
+private
+def get_sync_status_button_text
+    return get_sync_status_button.attribute('text')
+end
+
+private
+def get_sync_status_button
+    return @controlpanel.QPushButton(:name=>'sync_status_button')
+end
+
+private
+def click_sync_status_button
+    get_sync_status_button.tap
+end
+
+def is_disconnected?
+    return get_sync_status_button_text == 'Connect' &&
+        get_sync_status_label_text == 'File Sync is disconnected.'
+end
+
+private
+def get_sync_status_label_text
+    return get_sync_status_label.attribute('text')
+end
+
+private
+def get_sync_status_label
+    return @controlpanel.QLabel(:name=>'sync_status_label')
+end
+
+def connect_and_wait_for_file_sync_update
+    if is_disconnected?
+        click_sync_status_button
+    end
+    wait_for_file_sync_update
+end
+
+private
+def wait_for_file_sync_update
+    # TODO define a timeout.
+    verify_true(360, 'test connected') {
+        is_connected? && is_file_sync_up_to_date?
+    }
+end
+
+private
+def is_file_sync_up_to_date?
+    return get_sync_status_label_text == 'File Sync is up-to-date.'
+end