Syntaxe de base : la magie des espaces et des commentaires

Découvrez la syntaxe épurée de Robot Framework, où les espaces structurent le code et les commentaires améliorent la lisibilité pour des tests automatisés clairs.

La clarté par la structure : les fondations de la syntaxe Robot Framework

L'une des caractéristiques les plus appréciées de Robot Framework est sa syntaxe simple et lisible, qui se rapproche du langage naturel. Cette accessibilité est en grande partie due à des conventions claires concernant l'utilisation des espaces et des commentaires. Contrairement à de nombreux langages de programmation qui s'appuient sur des points-virgules, des accolades ou une indentation stricte pour définir la structure du code, Robot Framework utilise principalement les espaces comme délimiteurs. Cette approche, bien que potentiellement déroutante au premier abord pour les développeurs habitués à d'autres syntaxes, se révèle rapidement être un atout majeur pour la lisibilité et la collaboration.

Les commentaires, quant à eux, jouent un rôle crucial dans la documentation et la compréhension des scripts de test. Ils permettent d'ajouter des explications, de clarifier des intentions ou de désactiver temporairement des portions de code sans les supprimer. Ensemble, une utilisation judicieuse des espaces et des commentaires transforme vos scripts Robot Framework en documents clairs, faciles à comprendre et à maintenir, même pour des personnes n'ayant pas une connaissance approfondie du framework.

Ce sous-chapitre va explorer en détail ces deux piliers de la syntaxe de Robot Framework. Nous verrons comment les espaces sont utilisés pour séparer les keywords de leurs arguments, et comment les commentaires peuvent être employés efficacement pour enrichir vos tests.

La règle des deux espaces (ou plus) : structurer avec l'espacement

Dans Robot Framework, la séparation entre les différentes parties d'une instruction (comme un keyword et ses arguments, ou les arguments entre eux) est réalisée en utilisant deux espaces ou plus. Une tabulation est généralement équivalente à plusieurs espaces et peut également être utilisée, bien que la consistance avec les espaces soit souvent préférée pour éviter les problèmes d'alignement visuel entre différents éditeurs.

Prenons un exemple simple. Si vous voulez utiliser le keyword `Log` (de la librairie `BuiltIn`) pour afficher un message, vous écrirez :

*** Test Cases ***
Exemple d'utilisation d'espace
    Log    Ceci est un message de log.

Ici, `Log` est le keyword. Il est séparé de son argument `Ceci est un message de log.` par au moins deux espaces (ici, nous en avons utilisé quatre pour l'alignement, mais deux suffiraient). Si un keyword prend plusieurs arguments, chaque argument est également séparé du précédent par deux espaces ou plus :

*** Test Cases ***
Exemple avec plusieurs arguments
    Create File    mon_fichier.txt    Contenu initial du fichier    encoding=UTF-8

Dans cet exemple, `Create File` est le keyword. `mon_fichier.txt` est le premier argument, `Contenu initial du fichier` est le deuxième, et `encoding=UTF-8` est le troisième (un argument nommé). Chacun est séparé par plusieurs espaces. Cette convention s'applique partout : dans la section `*** Settings ***` pour séparer `Library` de son nom, dans `*** Variables ***` pour séparer le nom de la variable de sa valeur, et bien sûr dans `*** Test Cases ***` et `*** Keywords ***`.

Pourquoi cette règle ? Elle contribue énormément à la lisibilité. Les scripts ne sont pas encombrés de caractères de ponctuation syntaxique, et la structure tabulaire qui en résulte souvent rend le code facile à scanner visuellement. Un seul espace n'est généralement pas suffisant et peut être interprété comme faisant partie du nom du keyword ou d'un argument, menant à des erreurs du type "Keyword not found".

L'indentation des lignes sous un nom de cas de test ou un nom de keyword utilisateur est également importante, bien qu'elle soit plus une convention pour la lisibilité qu'une règle syntaxique stricte pour la séparation (qui reste gérée par les deux espaces). Typiquement, on indente avec quatre espaces :

*** Keywords ***
Mon Keyword Utilisateur
    [Arguments]    ${arg1}    ${arg2}
    Log    Argument 1: ${arg1}
    Log    Argument 2: ${arg2}

Il est crucial d'être cohérent avec l'utilisation des espaces. Des outils comme l'extension "Robot Framework Language Server" pour VS Code peuvent aider à formater correctement le code et à signaler les problèmes d'espacement.

Le pouvoir des commentaires (`#`) : documenter et clarifier

Les commentaires sont un outil indispensable dans tout langage de script ou de programmation, et Robot Framework ne fait pas exception. Ils permettent d'ajouter des notes explicatives, des rappels, ou de désactiver temporairement des lignes de code sans avoir à les supprimer. Dans Robot Framework, tout ce qui suit le caractère dièse (`#`) sur une ligne est considéré comme un commentaire et est ignoré par l'interpréteur lors de l'exécution du test.

Vous pouvez utiliser les commentaires de plusieurs manières :

Commentaire sur une ligne entière : Utile pour introduire une section de code ou donner une explication générale.

*** Test Cases ***
Test de fonctionnalité critique
    # Phase d'initialisation : préparation des données de test
    ${donnee_test}    Generer Donnee Aleatoire
    # ... reste du test

Commentaire en fin de ligne : Pratique pour ajouter une courte note ou clarifier une étape spécifique sans alourdir le script.

*** Test Cases ***
Test avec commentaire en fin de ligne
    Open Browser    https://certiquizz.com    chrome    # Ouvre le site cible dans Chrome
    Input Text      id:username    mon_nom_utilisateur   # Saisie du nom d'utilisateur

Désactiver du code : En plaçant un `#` au début d'une ligne, vous pouvez "commenter" cette ligne, ce qui signifie qu'elle ne sera pas exécutée. C'est une technique très courante pour le débogage ou pour mettre de côté temporairement une partie d'un test.
```
*** Keywords ***
Mon Keyword en développement
    Log    Etape 1 exécutée
    # Log    Etape 2 temporairement désactivée pour test
    # Click Element    id:bouton_obsolete
    Log    Etape 3 exécutée
```

Il est important de noter que le caractère `#` doit être le premier caractère non blanc de la partie commentaire. S'il est à l'intérieur d'une chaîne de caractères ou d'une valeur de variable, il sera traité littéralement.

*** Variables ***
${URL_AVEC_DIESE}    https://example.com/page#section1    # Le # fait partie de l'URL ici

De bonnes pratiques pour les commentaires incluent :

Expliquer le "pourquoi" plutôt que le "comment" : Le code Robot Framework est souvent auto-descriptif sur ce qu'il fait (`Click Button`). Les commentaires devraient clarifier la raison d'être d'une action ou d'une vérification si elle n'est pas évidente.
Maintenir les commentaires à jour : Un commentaire obsolète ou incorrect est pire que pas de commentaire du tout.
Ne pas sur-commenter : Un code clair et bien structuré avec des noms de keywords et de variables explicites nécessite moins de commentaires.

En résumé, la syntaxe de Robot Framework, avec sa dépendance aux espaces pour la structure et l'utilisation du `#` pour les commentaires, vise avant tout la création de tests lisibles par l'homme. Cette philosophie facilite la collaboration entre testeurs, développeurs et même les parties prenantes non techniques, rendant les tests automatisés plus accessibles et plus maintenables sur le long terme.

◄ Précédent Suivant ►

く