CreoleLint et CreoleCat

CreoleLint et CreoleCat sont des utilitaires permettant de faciliter les tests sur les dictionnaires et les templates :

  • CreoleLint permet de valider la syntaxe des dictionnaires et des templates ;

  • CreoleCat permet d'instancier un seul template indépendamment des commandes instance et reconfigure.

Vérifier les dictionnaires et templates avec CreoleLint

La commande CreoleLint permet de valider la syntaxe des dictionnaires et des templates.

L'outil effectue une série de tests dans le but de détecter des erreurs dans la déclaration et l'utilisation des variables.

Sur un module installé, il est possible de lancer l'application sans option particulière :

# CreoleLint

Cette commande permet également :

  • de valider un seul template avec l'option -t  : CreoleLint -t hostname

  • de ne lancer qu'un seul des tests lint avec l'option -n nomDuTest : CreoleLint -n valid_dtd

  • de ne lancer que la validation des dictionnaires avec l'option -d : CreoleLint -d

Les tests lint disponibles sont les suivants :

  • valid_dtd : validation syntaxique des dictionnaires ;

  • tabs_in_dicos : recherche de tabulation dans les dictionnaires ;

  • hidden_if_in_dicos : recherche des conditions, sont dépréciées hidden_if_in et hidden_if_not_in ;

  • obligatoire_in_dicos : recherche du validateur déprécié obligatoire ;

  • wrong_dicos_name : validation du nom des dictionnaires ;

  • valid_var_label : vérification des libellés des variables ;

  • valid_separator_label : vérification des libellés des séparateurs ;

  • valid_help_label : vérification des libellés de l'aide en ligne ;

  • old_fw_file : recherche des anciens fichiers eole-firewall ;

  • duplicate_in_dicos : recherche des variables en double dans les dictionnaires ;

  • valid_parse_tmpl : validation de tous les templates.

Truc & astuce

L'option -l permet de choisir le niveau des messages (info, warning ou error).

La commande CreoleLint suivie du paramètre -h permet d'obtenir de l'aide. Un manuel est également disponible :

# man CreoleLint

Instancier un template avec CreoleCat

La commande CreoleCat permet d'instancier un seul template indépendamment des commandes instance et reconfigure.

Cette commande permet :

  • d'instancier un seule template existant sur le module en utilisant la ou les destinations déclarées dans le dictionnaire :

    # CreoleCat -t hostname

  • d'instancier un template existant sur le module en redirigeant le résultat dans un fichier spécifique :

    # CreoleCat -t hostname -o /tmp/hostname.txt

  • d'instancier un fichier template avec un chemin spécifique :

    # CreoleCat -s /tmp/test.tmpl -o /tmp/test.txt

Truc & astuce

L'option -l permet de choisir le niveau des messages (info, warning ou error).

Les options -v (--verbose) ou -d (--debug) permettent de connaître le détail des opérations réalisées par le programme.

La commande CreoleCat suivie du paramètre -h permet d'obtenir de l'aide.

Exemple

root@scribe:~# CreoleCat -d -t sympa.auth.conf

Instanciation du fichier '/etc/sympa/auth.conf' depuis '/var/lib/creole/sympa.auth.conf'

Copy template: '/usr/share/eole/creole/distrib/sympa.auth.conf' -> '/var/lib/creole'

Cheetah processing: '/var/lib/creole/sympa.auth.conf' -> '/etc/sympa/auth.conf'

Changing properties: chown sympa:sympa /etc/sympa/auth.conf

Changing properties: chmod 0644 /etc/sympa/auth.conf

Remarque

Dans le cas d'un template renommé, c'est le nom du template (défini dans l'attribut source) qu'il faut utiliser.