~gerboland/unity-2d/dash-test

#!/usr/bin/env ruby1.8
=begin
/*
 * This file is part of unity-2d
 *
 * Copyright 2011 Canonical Ltd.
 *
 * Authors:
 * - Gerry Boland <gerry.boland@canonical.com>
 *
 * 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 'xdo/xwindow'
require 'xdo/keyboard'

require 'timeout'

############################# Test Suite #############################
context "Dash Show and Hide Tests" do

  # Run once at the beginning of this test suite
  startup do
    system 'killall unity-2d-places > /dev/null 2>&1'

    # Need launcher running to summon dash
    @@sut = TDriver.sut(:Id => "sut_qt")
    @@launcher = @@sut.run( :name => UNITY_2D_LAUNCHER, 
    		          :arguments => "-testability" )
  end
  
  # Run once at the end of this test suite
  shutdown do
    #Need to kill Launcher as it does not shutdown when politely asked
    system "pkill -nf unity-2d-launcher"
  end

  # Run before each test case begins
  setup do
    # Execute the Dash
    @app = @@sut.run( :name => UNITY_2D_PLACES, 
    		     :arguments => "-testability" )
  end

  # Run after each test case completes
  teardown do
    @app.close
  end

  #####################################################################################
  # Test cases


  # Test case objectives:
  #   * Check the Dash is hidden at launch
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  # Post-conditions
  #   * None
  # References
  #   * None
  test "Hidden at Startup" do
    verify_not(10, 'Dash should be hidden at startup') {
      #this should throw an exception, as the DeclarativeView does not exist when Dash hidden
      @app.DashDeclarativeView()
    }
  end


  # Test case objectives:
  #   * Check the Dash is summoned and hidden by the Super key
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  #   * Tap the Super key and check Dash is visible
  #   * Tap the Super key again and check Dash is hidden
  # Post-conditions
  #   * None
  # References
  #   * None
  test "Show and hide with Super key" do
    verify_not(10, 'Dash should be hidden at startup') {
      @app.DashDeclarativeView()
    }
    XDo::Keyboard.super
    verify_equal('true', 10, 'Super key hit, Dash should be visible but is not') {
      @app.DashDeclarativeView()['visible']
    }
    XDo::Keyboard.super
    verify_not(10, 'Super key should hide visible Dash') {
      @app.DashDeclarativeView()
    }
  end


  # Test case objectives:
  #   * Check the Dash is hidden by the Escape key
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  #   * Tap the Super key and check Dash is visible
  #   * Tap the Escape key and check Dash is hidden
  # Post-conditions
  #   * None
  # References
  #   * None
  test "Show with Super key, hide with Escape" do
    verify_not(10, 'Dash should be hidden at startup') {
      @app.DashDeclarativeView()
    }
    XDo::Keyboard.super
    verify_equal('true', 10, 'Super key hit, Dash should be visible but is not') {
      @app.DashDeclarativeView()['visible']
    }
    XDo::Keyboard.escape
    verify_not(10, 'Escape key should hide visible Dash') {
      @app.DashDeclarativeView()
    }
  end


  # Test case objectives:
  #   * Check the Dash is summoned and hidden by the BFB of the Launcher
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  #   * Click the BFB and check Dash is visible
  #   * Click the BFB again and check Dash is hidden
  # Post-conditions
  #   * None
  # References
  #   * None
  test "Show and hide using BFB" do
    verify_not(10, 'Dash should be hidden at startup') {
      @app.DashDeclarativeView()
    }

    #Click the BFB
    @@launcher.LauncherList( :name => 'main' ).LauncherList( :isBfb => 'true' ).tap
    verify_equal('true', 10, 'BFB clicked, Dash should be visible but is not') {
      @app.DashDeclarativeView()['visible']
    }

    @@launcher.LauncherList( :name => 'main' ).LauncherList( :isBfb => 'true' ).tap
    verify_not(10, 'BFB should hide visible Dash') {
      @app.DashDeclarativeView()
    }
  end


  # Test case objectives:
  #   * Check the Dash Console lens is summoned by Alt+F2
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  #   * Press Alt+F2 and check Dash is visible
  #   * Check the Console lens is visible by looking for a 'History' header
  #   * Tap the Escape key and check Dash is hidden
  # Post-conditions
  #   * None
  # References
  #   * None  
  test "Show and hide using Alt+F2" do
    verify_not(10, 'Dash should be hidden at startup') {
      @app.DashDeclarativeView()
    }

    XDo::Keyboard.alt_F2 #need function key with uppercase F
    verify_equal('true', 10, 'Alt+F2 pressed, Dash should be visible but is not') {
      @app.DashDeclarativeView()['visible']
    }
=begin #FIXME: how to identify console lens is active?
    #Check that Console lens is open
    verify(10) {
      @app.QDeclarativeItem( :name => 'content' ) \
          .QDeclarativeFocusScope( :name => 'History' ) #FIXME
    }
=end
    XDo::Keyboard.escape
    verify_not(10, 'Escape should hide visible Dash') {
      @app.DashDeclarativeView()
    }
  end


  # Test case objectives:
  #   * Check the Dash hides when you click on an file/application
  # Pre-conditions
  #   * Launcher running
  # Test steps
  #   * Verify Dash starts hidden
  #   * Click the BFB button on the Launcher and check Dash is visible
  #   * Type in the string "calc"
  #   * Verify Search box contains the string "calc"
  #   * Search through the list of returned applications for one with the name "Calculator"
  #   * Click the "Calculator" application
  #   * Verify the Dash hides
  # Post-conditions
  #   * "Calculator" application running
  # References
  #   * None  
  test "Dash hides when you click on application" do
    verify_not(10, 'Dash should be hidden at startup') {
      @app.DashDeclarativeView()
    }

    #Click the BFB
    @@launcher.LauncherList( :name => 'main' ).LauncherList( :isBfb => 'true' ).tap
    verify_equal('true', 10, 'BFB clicked, Dash should be visible but is not') {
      @app.DashDeclarativeView()['visible']
    }

    #Lets search for a hopefully international name: Mahjongg
    desired_app = 'Mahjongg'
    search_string = desired_app.slice(0,3).downcase #search for first few chars: 'mah'
    XDo::Keyboard.type(search_string)

    #Verify text box contains this string
    verify_equal(search_string, 10, "Dash search box does not contain typed text '#{search_string}'") {
      @app.DashDeclarativeView() \
          .QDeclarativeItem( :name => 'content' ) \
          .QDeclarativeTextInput()['displayText']
    }

    #Search through results for Mahjongg and click it
    verify(10, "Failed to find #{desired_app}") {
      @app.DashDeclarativeView \
          .QDeclarativeItem( :name => 'content' ) \
          .QDeclarativeFocusScope( :name => 'Applications' ) \
          .QDeclarativeLoader( :name => 'body' ) \
          .child( :text => desired_app ) \
          .tap 
    } 

    #Dash should now be hidden
    verify_not(10, 'Dash failed to hide after application was clicked') {
      @app.DashDeclarativeView()
    }
    #Check Mahjongg appears
    window_id = -1
    Timeout.timeout(20){window_id = XDo::XWindow.wait_for_window(desired_app, :onlyvisible)}
    verify_true(0, "#{desired_app} window not found") { window_id != -1 }

    #Close it
    XDo::XWindow.new(window_id).close!
  end
end