Merge lp:~aacid/unity-2d/unity-2d-shell_choose_root_file into lp:~unity-2d-team/unity-2d/unity-2d-shell

[Albert Astals Cid]

[shell] Add the -rootfile option that lets the user specify the shell root qml file

[lp:~aacid/unity-2d/unity-2d-shell_choose_root_file]

921. By Albert Astals Cid on 2012-01-23

merge

922. By Albert Astals Cid on 2012-01-23

Add a test to show the file is being loaded correctly

923. By Albert Astals Cid on 2012-01-23

merge

[Michał Sawicz (saviq)]

Could you maybe rename the argument to "-rootqml", please? it's more self-explanatory then.

review: Needs Fixing

[lp:~aacid/unity-2d/unity-2d-shell_choose_root_file]

924. By Albert Astals Cid on 2012-01-24

rename param to rootqml as per Michał suggestion

[Michał Sawicz (saviq)]

Here's the result of the tests on stock unity-2d-shell:

michal@michal-vm:~/dev/canonical/desktop/unity-2d/tests/shell$ ./root_file_param.rb
Running tests on applications contained within /home/michal/dev/canonical/desktop/unity-2d
Loaded suite ./root_file_param
Started
..E
Finished in 35.574464 seconds.

  1) Error:
test_Verify_app_starts_with_a_valid_rootfile_parameter(Shell_root_file_param_test):
MobyBase::VerificationError: Verification at ./root_file_param.rb:116:in `test_Verify_app_starts_with_a_valid_rootfile_parameter' failed as an exception was thrown when the verification block was executed
=> verify{ @app.QDeclarativeText( :text => 'This is the rootfile.qml test' ) }
     end

Details:
#<MobyBase::TestObjectNotFoundError: The application (id: 1633, name: "unity-2d-shell") has no child object with type or behaviour method with name "QDeclarativeText" (attributes :text=>"This is the rootfile.qml test") on :sut_qt>
    /usr/lib/ruby/vendor_ruby/tdriver/verify/verify.rb:168:in `verify'
    ./root_file_param.rb:116:in `test_Verify_app_starts_with_a_valid_rootfile_parameter'
    /media/sf_dev/canonical/desktop/unity-2d/tests/misc/lib/testhelper.rb:39:in `run'

3 tests, 0 assertions, 0 failures, 1 errors

review: Needs Fixing

[lp:~aacid/unity-2d/unity-2d-shell_choose_root_file]

925. By Albert Astals Cid on 2012-01-24

verify_not is kind of weird, i need a 0 here so that it passes with the feature and fails without

926. By Albert Astals Cid on 2012-01-24

As discussed with Michał does not make much sense to test that the shell starts in the rootqml tests, it belongs somewhere else

[Michał Sawicz (saviq)]

Good for me, Florian please tell if that's not what you had in mind for "Add cmd line option to choose which root QML file to load".

review: Approve

[Florian Boucault (fboucault)]

That's great guys. Step 2 will be to make sure we can do:

unity-2d-shell -rootqml shell/launcher/Launcher.qml
unity-2d-shell -rootqml shell/dash/Dash.qml

[Michał Sawicz (saviq)]

Approving, then, and we will need to split the shell up into separate components. Florian, what's the priority of that?

review: Approve

=== modified file 'shell/app/shell.cpp'
--- shell/app/shell.cpp	2011-11-30 13:07:38 +0000
+++ shell/app/shell.cpp	2012-01-24 11:40:35 +0000
@@ -51,11 +51,23 @@
     Unity2dApplication::earlySetup(argc, argv);
     Unity2dApplication application(argc, argv);
 
+    QUrl rootFileUrl;
+    const QStringList arguments = application.arguments();
+    const int rootFileArgumentIndex = arguments.indexOf("-rootqml");
+    if (rootFileArgumentIndex != -1) {
+        if (rootFileArgumentIndex + 1 < arguments.count()) {
+            rootFileUrl = arguments[rootFileArgumentIndex + 1];
+        } else {
+            qCritical() << "-rootqml argument given without file";
+            return -1;
+        }
+    } else {
+        rootFileUrl = QUrl("Shell.qml");
+    }
+
     application.setApplicationName("Unity 2D Shell");
     application.setQuitOnLastWindowClosed(false);
 
-    QSet<QString> arguments = QSet<QString>::fromList(QCoreApplication::arguments());
-
     GnomeSessionClient client(INSTALL_PREFIX "/share/applications/unity-2d-shell.desktop");
     client.connectToSessionManager();
 
@@ -83,7 +95,7 @@
     /* Load the QML UI, focus and show the window */
     view.setResizeMode(QDeclarativeView::SizeViewToRootObject);
     view.rootContext()->setContextProperty("declarativeView", &view);
-    view.setSource(QUrl("Shell.qml"));
+    view.setSource(rootFileUrl);
 
     /* Unset DESKTOP_AUTOSTART_ID in order to avoid child processes (launched
        applications) to use the same client id.

=== added file 'tests/shell/root_qml_param.rb'
--- tests/shell/root_qml_param.rb	1970-01-01 00:00:00 +0000
+++ tests/shell/root_qml_param.rb	2012-01-24 11:40:35 +0000
@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * Authors:
+ * - Albert Astals Cid <[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
+
+require '../run-tests.rb' unless $INIT_COMPLETED
+require 'xdo/xwindow'
+require 'xdo/keyboard'
+require 'xdo/mouse'
+require 'tmpwindow'
+
+############################# Test Suite #############################
+context "Shell root file param test" do
+  # Run once at the beginning of this test suite
+  startup do
+    system 'killall unity-2d-shell > /dev/null 2>&1'
+    system 'killall unity-2d-shell > /dev/null 2>&1'
+
+  end
+
+  # Run once at the end of this test suite
+  shutdown do
+  end
+
+  # Run before each test case begins
+  setup do
+  end
+
+  # Run after each test case completes
+  teardown do
+    system "pkill -nf unity-2d-shell"
+  end
+
+  #####################################################################################
+  # Test cases
+
+  # Test case objectives:
+  #   * Check the app does not start with the -rootqml parameter but without path for the file
+  # Pre-conditions
+  #   * None
+  # Test steps
+  #   * Verify app does not start
+  # Post-conditions
+  #   * None
+  # References
+  #   * None
+  test "Verify app does not start without a rootqml parameter" do
+    # Execute the application 
+    @sut = TDriver.sut(:Id => "sut_qt")
+    verify_not(0) { @app = @sut.run( :name => UNITY_2D_SHELL,
+                                    :arguments => "-testability,-rootqml", 
+                                    :sleeptime => 2 ) }
+  end
+
+  # Test case objectives:
+  #   * Check the app loads the qml file specified in the -rootqml parameter
+  # Pre-conditions
+  #   * None
+  # Test steps
+  #   * Verify app starts
+  #   * Verify the contents of the qml file are loaded
+  # Post-conditions
+  #   * None
+  # References
+  #   * None
+  test "Verify app starts with a valid rootqml parameter" do
+    # Execute the application 
+    testQmlFile = File.expand_path(File.dirname(__FILE__)) + "/rootqmlparamtest.qml"
+    @sut = TDriver.sut(:Id => "sut_qt")
+    @app = @sut.run( :name => UNITY_2D_SHELL,
+                     :arguments => "-testability,-rootqml," + testQmlFile, 
+                     :sleeptime => 2 )
+    # Make certain application is ready for testing
+    verify{ @app }
+    verify{ @app.QDeclarativeText( :text => 'This is rootqmlparamtest.qml' ) }
+  end
+
+end

=== added file 'tests/shell/rootqmlparamtest.qml'
--- tests/shell/rootqmlparamtest.qml	1970-01-01 00:00:00 +0000
+++ tests/shell/rootqmlparamtest.qml	2012-01-24 11:40:35 +0000
@@ -0,0 +1,12 @@
+import QtQuick 1.1
+
+Rectangle {
+    height: 400
+    width: 400
+    color: "white"
+
+    Text {
+        text: "This is rootqmlparamtest.qml"
+    }
+    Component.onCompleted: declarativeView.show()
+}