Sommaire

Appium est un outil libre d’automatisation d’applications native, hybride ou Web, utilisant le protocole WebDriver pour le rendre compatible iOS, Android et Windows.

Cette procédure couvre l’installation et la configuraiton d'Appium v1.6.2+.

Installation du serveur Appium

Android

Installer le Android SDK v.1.7+. Se référer à la documentation officielle ici et ici pour plus d’informations.

IOS
Installation
  1. Installer Xcode 8.1+

  2. Installer les Apple Developer Tools via cette documentation externe (en)

  3. Suivre la procédure décrite au sein de cette documentation externe (en) et y ajouter les commandes et corrections suivantes:

    1. Carthage ne peut pas être installé via npm mais via brew. Ainsi, pour installer Carthage, executer:

      brew install carthage
    2. Executer les commandes supplémentaires suivantes:

      npm install -g ios-deploy --unsafe-perm=true
      npm install -g deviceconsole
      brew uninstall ideviceinstaller
      brew uninstall libimobiledevice
      brew install --HEAD libimobiledevice
      brew unlink libimobiledevice && brew link libimobiledevice
      brew install ideviceinstaller
      brew unlink ideviceinstaller && brew link ideviceinstaller
      Caution
      A propos de la version actuelle d’Appium via npm

      A l’heure de l’écriture de ce document, la version installée du serveur Appium via npm (1.6.2) ne fonctionnait pas correctement avec Cerberus. Seule la version de développment, à savoir 1.6.3-SNAPSHOT, permettait de lancer correctement des tests mobiles. Ci-dessous la liste des commandes à exécuter afin d’intaller la version de développement du serveur d’Appium (extrait de la documentation officielle (en)):

      git clone https://github.com/appium/appium.git
      cd appium
      npm install -g mocha
      npm install -g gulp
      npm install -g gulp-cli
      npm install
      gulp transpile
Signature des applications

La dernière version d’Appium utilise appium-xcuitest-driver, lui même dépendant de Web Driver Agent qui a besoin d’être déployé sur le mobile a tester. Ainsi, le poste hébergeant le serveur Appium a besoin d’être configuré pour être autoriser à déployer une applciation sur le mobile à tester.

Le poste hébergeant le serveur Appium doit :

  1. avoir le compte Apple associé enregistré auprès d’une Equie de Développement Apple

  2. avoir téléchargé le certificat iOS Development au niveau des Signing identities Xcode associées à l’Equipe de Développement Apple

  3. avoir téléchargé le profile de provisionnement associé à l’Equipe de Développement Apple qui autorise :

    • au moins l’appliation Web Driver Agent (identifiée par le bundle id com.facebook.WebDriverAgentLib)

    • le mobile de test à installer application Web Driver Agent

Une fois ces prérequis réalisé, créer un fichier appium.xcconfig et y renseigner (où <Team ID> est l’identifiant de votre Equipe de Développement Apple) :

DEVELOPMENT_TEAM = <Team ID>
CODE_SIGN_IDENTITY = iPhone Developer

Ce fichier sera utilisé plus loin lors de l’exécution. Voir la section Exécution pour plus de détails.

Exécutions

L’exécution du serveur Appium peut différée selon son mode d’installation:

Installation via npm

Si le serveur Appium a été installé via npm, exécuter simplement :

appium
Installation à partir du code source

Si le serveur Appium a été installé à partir de son code source, nous encourageons à créer un fichier exécutable contenant les commandes à exécuter pour démarrer le serveur. De fait, la maintenance et l’utilisation en sera simplifiée. Ainsi :

  1. Créer un fichier appium file avec le contenu suivant :

    #!/bin/bash
    cd /chemin/vers/le/code/source/appium && node . "$@"
  2. Rendre ce fichier exécutable

    chmod +x /chemin/vers/le/fichier/créé
  3. Localiser le dossier de ce fichier et le renseigner au sein de votre variable PATH, en éditant votre fichier ~/.bash_profile (ou tout autre fichier de démarrage de session) :

    export PATH=/chemin/vers/le/dossier/du/fichier/créé:$PATH
  4. Redémarrer la session du Terminal

  5. Démarrer le serveur Appium en exécutant

    appium
Note pour le test d’applications IOS

Comme vu lors de la section précédente, Appium doit pouvoir accéder aux informations lui permettant de signer une application. Ceci peut être réalisé en fournissant la capabilité xcodeConfigFile au démarrage du serveur Appium.

Vous pourriez souhaiter (ce qui est même préférable) de fournir cette valeur à chaque requête cliente. Notamment car il s’agit souvent de la même Equipe de Développement Apple au sein d’une même organisation. Cette réflexion peut également être apportée pour la capabilité obligatoire realDeviceLogger qui sera toujours pointée vers l’installation de deviceconsole.

Dans ce cas, il vous est possible d’utiliser l’option de démarrage --default-capabilities, permettant de fournir les capabilités par défaut qui seront prises en compte à chauqe requête cliente. Pour facilité son utilisation, nous optons sur l’utilisation d’un fichier JSON dédié. Pour cela :

  1. Créer un fichier nommé common.caps (par exemple) contenant les lignes suivantes :

    {
        "xcodeConfigFile": "/chemin/vers/le/fichier/appium.xcconfig",
    	"realDeviceLogger": "/usr/local/lib/node_modules/deviceconsole/deviceconsole"
    }
  2. Puis démarrer le serveur Appium en lui précisant les capabilités par défaut :

    appium --default-capabilities /chemin/vers/le/fichier/common.caps

Utilisations clientes

La section suivante présente différents cas d’utilisation pour l’utilisation du serveur Appium.

Exécuter un cas de test mobile avec Cerberus

Une fois le cas de test écrit, Cerberus peut exécuter ce cas de test sur le mobile souhaité en configurant au préalable un Robot associé.

Au sein de Cerberus, ouvrir la page des Robots (Exécuter → Robot), et, en fonction du type d’application à tester :

Android

Robot definition

Robot capabilities

Note
Ces valeurs sont données à titre d’exemple. N’hésitez pas à les modifier à votre guise.
IOS

Robot definition

Robot capabilities

Note

Ces valeurs sont données à titre d’exemple. N’hésitez pas à les modifier à votre guise.

Les deux dernieres capabilités xcodeConfigFile and realDeviceLogger ne sont pas nécessaires si elles sont déjà déclarées au démarrage du serveur Appium. Voir la section précédente pour plus de détails.

Inspection

L’inspection est utilisée pour localiser les éléments d’une application. Elle fournit alors les identificateurs (id, XPath, etc.) permettant d’alimenter les cas de tests Cerberus pour localiser les éléments.

L’inspection peut être réalisée grâce à l’application cliente Appium.

Installation

Installer la dernière version de l’application cliente Appium disponible sur la page officielle.

Configuration

L’application cliente Appium doit être configurée pour n’être utilisée que pour l’inspection. Ainsi,

Au sein du menu General settings :

  • Renseigner le champ Server address avec l’adresse du serveur Appium

  • Renseigner le champ Port avec le numéro du port sur serveur Appium

  • Cocher la case Use Remote Server

General settings

Pour une inspection Android, ouvrir le menu Android et :

  • Renseigner App Path avec le chemin absolu (ou l’URL) de l’APK de application

  • Renseigner Platform Name par Android

  • Renseigner Automation Name par Appium

  • Renseigner Platform Version avec la version Android du mobile testé

  • Renseigner Device Name avec le nom du mobile testé

Android settings

Pour une inspection IOS, ouvrir le menu IOS et :

  • Renseigner App Path avec le chemin absolu (ou l’URL) de l’IPA de l’application

  • Renseigner Force device avec le nom du mobile testé

  • Renseigner Platform version avec la version IOS du mobile testé. Cette version doit être inférieure ou égale à la version disponible au sein du poste hébergeant le serveur Appium (e.g., 10.1 avec Xcode 8).

  • Renseigner UDID avec l’UDID du mobilé testé

IOS settings

Exécution

Une fois l’application client Appium correctement configurée, sélectionner le bouton radio correspondant au type de l’application à tester (Android ou IOS) et cliquer sur le bouton d’Inspection.

Appium Inspector

Titre Lien

Liste des capabilités de serveur Appium (en)

https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md