selenium-logo.png PHP

PHPWebDriver (https://github.com/Element-34/php-w...) est un fork de projet Facebook php-webdriver (https://github.com/facebook/php-web...) avec quelques différences:

  • distribution via PEAR
  • ajoute de la classe WebDriverWait
  • ajout de ActionChains
  • interface nettoyée pour réduire le couplage avec l'implémentation de WebDriver

Ce fork résulte de l'insatisfaction de son auteur avec les autres implémentations PHP. Pour mémoire, aucune de ces implémentations n'est officiellement soutenue par Selenium. Évidemment, c'est libre et distribué sous la licence Apache 2 (comme le reste de la suite Selenium). L'auteur offre un support commercial et une correction prioritaire des bugs (http://element34.ca/blog).

Ce qui suit est la traduction de la documentation actuellement fournie....

Description

Ce client se veut aussi léger que possible en tirant partie de la nature dynamique de PHP pour permettre à presque tous les appels d'API d'être une transformation directe de ce qui est défini dans le protocole WebDriver lui-même.

La plupart des clients nécessitent d'abord de lire le protocole pour voir ce qui est possible, puis d'étudier le client lui-même pour voir comment l'appeler. Ce client-ci essaie de rendre inutile cette seconde étape, au lieu de quoi vous pouvez vous reposer exclusivement sur http://code.google.com/p/selenium/w....

Chaque commande correspond simplement au nom de l'appel de fonction et chaque chemin additionnel un autre appel de fonction chaîné. Le paramètre de la fonction est soit un array() si la commande prend des paramètres JSON, soit une primitive individuelle si elle attend une URL.

La valeur de retour de la fonction est exactement ce que le serveur renvoie comme partie de la définition du protocole. Si une erreur est renvoyée, la fonction va lancer l'instance appropriée de WebDriverException.

Pour débuter

Pour démarrer avec PHPWebDriver, il faut avoir PEAR d'installé, puis:

  $ sudo pear channel-discover element-34.github.com/pear
  $ sudo pear install -f element-34/PHPWebDriver

Comme serveur, tout ce dont vous avez besoin est le fichier selenium-server-standalone-#.jar fourni ici: http://code.google.com/p/selenium/d...

Téléchargez et lancer ce fichier en remplaçant # par la version actuelle du serveur.

  $ java -jar selenium-server-standalone-#.jar

Puis, quand la session est créée, assurez-vous de passer l'URL correspondant à l'endroit où le serveur s'excute.

  // Ceci doit être l'URL de la machine exécutant server-standalone.jar
  $wd_host = 'http://localhost:4444/wd/hub';
  $web_driver = new PHPWebDriver_WebDriver($wd_host);
  
  // Le premier paramètre de session() est le 'browserName' (default = 'firefox')
  // Le second paramètre est un objet JSON contenant les 'desiredCapabilities' additionnelles
  
  // POST /session
  $session = $web_driver->session('firefox');

Exemples simples

Notez qu'ils suivent tous exactement le protocole.

  • Se placer à un endroit précis de l'écran
  // POST /session/:sessionId/moveto
  $session->moveto(array('xoffset' => 3, 'yoffset' => 300));
  • Récupérer l'URL actuelle
  // GET /session/:sessionId/url
  $session->url();
  • Changer le focus sur une autre frame
  // POST /session/:sessionId/frame
  $session->frame(array('id' => 'some_frame_id'));
  • Obtenir la liste des gestionnaires de fenêtre de toutes les fenêtres ouvertes
  // GET /session/:sessionId/window_handles
  $session->window_handles();
  • Acquitter la boîte d'avertissement (alert) actuellement affichée
  // POST /session/:sessionId/accept_alert
  $session->accept_alert();
  • Modifier le délai d'expiration du script asynchrone
  // POST /session/:sessionId/timeouts/async_script
  $session->timeouts()->async_script(array('ms' => 2000));
  • Double cliquer sur un élément sur un écran tactile
  // POST session/:sessionId/touch/doubleclick
  $session->touch()->doubleclick(array('element' => $element->getID())
  • Vérifier si 2 élements sont égaux
  // GET /session/:sessionId/element/:id/equals/:other
  $element->equals($other_element->getID()))
  • Obtenir la valeur d'un propriété CSS d'un élément
  // GET /session/:sessionId/element/:id/css/:propertyName
  $element->css($property_name)

GET, POST ou DELETE pour les mêmes exemples de commande

Quand vous pouvez utiliser plusieurs méthodes HTTP pour la même commance, appelez la commande directement pour GET ou ajoutez la méthode HTTP pour POST ou DELETE.

  • Choisir l'orientation paysage avec POST
  // POST /session/:sessionId/orientation
  $session->postOrientation(array('orientation' => 'LANDSCAPE'));
  • Récupérer l'orientation avec le GET normal
  // GET /session/:sessionId/orientation
  $session->orientation();
  • Régler la taille de la fenêtre attachée à $window_handle avec POST
  // Si omis, $window_handle est mis par défaut à 'current'
  // POST /session/:sessionId/window/:windowHandle/size
  $session
     ->window($window_handle)
     ->postSize(array('width' => 10, 'height' => 10));
  • Obtenir la taille actuelle de la fenêtre avec GET
  // GET /session/:sessionId/window/:windowHandle/size
  $session->window()->size();

Quelques exceptions inévitables à la traduction directe du protocole

  • Ouvrir une page
  // POST /session/:sessionId/url
  $session->open('http://philippe.poumaroux.free.fr');
  • Interagir avec la session
  // DELETE /session/:sessionId
  $session->close();
  // GET /session/:sessionId
  $session->capabilities();
  • Trouver des éléments
  // POST /session/:sessionId/element
  $element = $session->element($using, $value);
  // POST /session/:sessionId/elements
  $session->elements($using, $value);
  // POST /session/:sessionId/element/:id/element
  $element->element($using, $value);
  // POST /session/:sessionId/element/:id/elements
  $element->elements($using, $value);
  • Obtenir l'élément actif
  // POST /session/:sessionId/element/active
  $session->activeElement();
  • Manipuler des cookies
  // GET /session/:sessionId/cookie
  $session->getAllCookies();
       
  // GET /session/:sessionId/cookie
  $session->getCookie($name);
  // POST /session/:sessionId/cookie
  //
  // champs obligatoires de $cookie_array
       // - nom: string
       // - valeur: string
       //
       // champs facultatifs $cookie_array 
       // - chemin: string
       // - domaine: string
       // - sécurisé: boolean
       // - expiration: nombre (secondes depuis epoch)
       $session->setCookie($cookie_array);
  // DELETE /session/:sessionId/cookie
  $session->deleteAllCookies()
  // DELETE /session/:sessionId/cookie/:name
  $session->deleteCookie($name)
  • Manipuler des fenêtres
  // POST /session/:sessionId/window
  $session->focusWindow($window_handle);
  // DELETE /session/:sessionId/window
  $session->deleteWindow();

Attendre

  • Attendre un élément
  $w = new PHPWebDriver_WebDriverWait($session);
  $w->until(function($session) {$session->element("id", "overlayPanelProfileovolp-pad");});

Interagir avec des éléments

  • Envoyer des caractères via le protocole (beurk)
  $e1 = $this->session->element("id", "un id");
  $e1->value(array("value" => array("pumpkins")));
  • Envoyer des carctères un peu plus élégamment
  $e2 = $this->session->element("id", "some id");
  $e2->sendKeys("turtles");
  $e3 = $this->session->element("id", "un id");
  $e3->sendKeys(PHPWebDriver_WebDriverKeys::SpaceKey());
  • Faire défiler la page en utilisant la touche espace
  $e4 = $this->session->element("tag name", "body");
  $e4->sendKeys(PHPWebDriver_WebDriverKeys::SpaceKey());