gecko/testing/mozmill/tests/firefox/testSearch/testOpenSearchAutodiscovery.js

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is MozMill Test code.
 *
 * The Initial Developer of the Original Code is Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Henrik Skupin <hskupin@mozilla.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

// Include necessary modules
var RELATIVE_ROOT = '../../shared-modules';
var MODULE_REQUIRES = ['SearchAPI'];

const gDelay = 0;
const gTimeout = 5000;

const searchEngine = {name: "YouTube Video Search",
                      url : "http://www.youtube.com/"};

var setupModule = function(module)
{
  controller = mozmill.getBrowserController();

  search = new SearchAPI.searchBar(controller);
}

var teardownModule = function(module)
{
  search.removeEngine(searchEngine.name);
  search.restoreDefaultEngines();
}

/**
 * Autodiscovery of OpenSearch search engines
 */
var testOpenSearchAutodiscovery = function()
{
  // Open the web page with the test OpenSearch plugin
  controller.open(searchEngine.url);
  controller.waitForPageLoad();

  // Check that the drop down icon glows
  var engineButton = search.getElement({type: "searchBar_dropDown"});
  controller.assertJS("subject.dropDownGlows == 'true'",
                      {dropDownGlows: engineButton.getNode().getAttribute('addengines')});

  // Open search engine drop down and check for installable engines
  search.enginesDropDownOpen = true;
  var addEngines = search.installableEngines;
  controller.assertJS("subject.installableEngines.length == 1",
                      {installableEngines: addEngines});

  // Install the new search engine which gets automatically selected
  var engine = search.getElement({type: "engine", subtype: "title", value: addEngines[0].name});
  controller.waitThenClick(engine);

  controller.waitForEval("subject.search.selectedEngine == subject.newEngine", gTimeout, 100,
                         {search: search, newEngine: searchEngine.name});

  // Check if a search redirects to the YouTube website
  search.search({text: "Firefox", action: "goButton"});

  // Clear search term and check the empty text
  var inputField = search.getElement({type: "searchBar_input"});
  search.clear();
  controller.assertValue(inputField, searchEngine.name);
}

/**
 * Map test functions to litmus tests
 */
// testOpenSearchAutodiscovery.meta = {litmusids : [8237]};