2017-07-21 20:37:57 +11:00
|
|
|
# Aide memoire pour l'écriture de scripts avec le socle bash
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 20:02:19 +11:00
|
|
|
* Sommaire
|
2017-07-21 20:03:11 +11:00
|
|
|
* I - Arborescence du socle
|
2017-07-21 20:18:48 +11:00
|
|
|
* II - Variables d'environement
|
2017-07-21 20:11:47 +11:00
|
|
|
* 1 - Variables globales
|
2017-07-21 20:37:57 +11:00
|
|
|
* 2 - Variables de session
|
2017-07-21 20:05:21 +11:00
|
|
|
* III - Utilisation du socle bash
|
2017-07-21 20:18:48 +11:00
|
|
|
* 1 - Cartouche
|
|
|
|
|
* 1.1 Élements du cartouche
|
|
|
|
|
* 1.2 Versionnement sémantique
|
|
|
|
|
* 1.2.1 Usage
|
|
|
|
|
* 1.2.2 Format
|
|
|
|
|
* 1.2.3 Sémantique
|
2017-07-21 20:08:37 +11:00
|
|
|
* 2 - Initialisation du socle
|
2017-07-21 20:18:48 +11:00
|
|
|
* 3 - Structure d'un script
|
|
|
|
|
* 4 - Actions realisées au lancement d'un script
|
|
|
|
|
* IV - Nomenclature
|
|
|
|
|
* 1 - Fichiers temporaires
|
|
|
|
|
* 2 - Nom des exécutables
|
|
|
|
|
* V - Description et usage des bibliothèques
|
2017-07-21 21:14:27 +11:00
|
|
|
* 1 - fct\_message
|
|
|
|
|
* 2 - fct\_affiche\_ligne
|
|
|
|
|
* 3 - fct\_erreur
|
|
|
|
|
* 4 - fct\_unique\_exec
|
|
|
|
|
* 5 - fct\_libere\_exec
|
|
|
|
|
* 6 - fct\_usage
|
|
|
|
|
* 7 - fct\_rotation
|
2017-07-21 20:18:48 +11:00
|
|
|
* 8 - fctpath
|
2017-07-21 21:14:27 +11:00
|
|
|
* 9 - fct\_params
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
|
2017-07-21 20:25:09 +11:00
|
|
|
## I - Arborescence du socle
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
La racine des dossiers utilisée par le Socle Bash est définie par la variable d'environement NC\_EXPL\_ROOT.
|
2017-07-21 20:18:48 +11:00
|
|
|
Cette dernière est initialisée à la connexion par l'appel au script /etc/profile.d/tetalab.sh
|
|
|
|
|
Cette arborescence est utilisée pour tous scripts Bash ainsi que les variables d'environement qui
|
|
|
|
|
en découlent.
|
|
|
|
|
|
2017-07-21 21:06:31 +11:00
|
|
|
Sous l'arborescence ${NC\_EXPL\_ROOT} on trouve les dossiers suivants :
|
2017-07-21 20:37:57 +11:00
|
|
|
|
2017-07-21 21:00:45 +11:00
|
|
|
+-----------------+-----------------------------------------------------------------------------------------------+
|
|
|
|
|
| Dossier | Description |
|
|
|
|
|
+-----------------+-----------------------------------------------------------------------------------------------+
|
|
|
|
|
| {Racine}/bin | Contient les binaires (scripts Bash) |
|
|
|
|
|
| {Racine}/conf | Contient les fichiers de configuration des scripts, ainsi que du socle |
|
|
|
|
|
| {Racine}/cpt | Contient les fichiers de comtpe-rendus génerés par les script (purge auto, 8 jours par défaut)|
|
|
|
|
|
| {Racine}/dat | Contient les fichiers de données gérés par les scripts |
|
|
|
|
|
| {Racine}/hist | Contient l'historique d'exécution des scripts (pas de purge) |
|
|
|
|
|
| {Racine}/lib | Contient les bibliothèques chargées par le socle |
|
|
|
|
|
| {Racine}/log | Contient les fichiers de logs d exécution des scripts (purge auto , 8 jours par défaut ) |
|
|
|
|
|
| {Racine}/man | Contient les fichiers d'aide des scripts pour l'utilitaire "man" |
|
|
|
|
|
| {Racine}/mod | Contient les fichiers modèles (templates) à usage des scripts |
|
|
|
|
|
| {Racine}/msg | Contient les fichiers de messages des scripts utilisés par la bibliothèque "fct_erreur" |
|
|
|
|
|
| {Racine}/tmp | Contient les fichiers temporaires des scripts |
|
|
|
|
|
+-----------------+-----------------------------------------------------------------------------------------------+
|
2017-07-21 20:37:57 +11:00
|
|
|
|
|
|
|
|
Note : Sous chaque dossier vous trouverez un fichier texte lisezmoi.txt decrivant l'usage du répertoire.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## II - Variables d'environement
|
|
|
|
|
|
|
|
|
|
Le socle utilise deux groupes de variables. Le premier dit "global" le second "de session".
|
|
|
|
|
Sauf si explicite, les variables globales sont définies et exportées à la connexion. Elles sont donc utilisables
|
|
|
|
|
par tous les scripts, mais elles ne sont pas modifiables.
|
|
|
|
|
|
|
|
|
|
Les variables de session sont définies à l'execution d'un script et lui sont propres.
|
|
|
|
|
Cependent certaines d'entre elles sont transmises aux scripts enfants:
|
2017-07-21 21:14:27 +11:00
|
|
|
- SH\_SESSION\_ID, SH\_FICLOG, SH\_FICCPT, SH\_RETENTION\_CPT, SH\_RETENTION\_LOG, SH\_NIV\_DEBUG, SH\_SILENCE, SH\_AFF\_SID
|
2017-07-21 20:37:57 +11:00
|
|
|
|
|
|
|
|
Les variables de session sont modifiable à 2 niveaux. De facon global dans le fichier "init.conf" ou pour un script
|
2017-07-21 21:14:27 +11:00
|
|
|
particulier dans le fichier ${NC\_EXPL\_CFG}/<Nom\_du\_script>.conf.
|
2017-07-21 20:37:57 +11:00
|
|
|
|
|
|
|
|
La valeur définie dans "init.conf" sera utlisée sauf si elle a été surchargée dans le fichier de configuration du
|
|
|
|
|
script.
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Il y a cependant une spécificite pour SH\_RETENTION\_CPT et SH\_RETENTION\_LOG:
|
2017-07-21 20:37:57 +11:00
|
|
|
- ces variables sont definies une et une seule fois lors de la première initialisation. Ce qui signinfie qu'un
|
|
|
|
|
script qui aurait surchargé ces variables, ignorera l'initialisation de ces variable si il est appelé par un
|
|
|
|
|
autre script.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 1 - Variables globales générales
|
|
|
|
|
|
2017-07-21 20:42:19 +11:00
|
|
|
+-------------------+----------------------------+
|
|
|
|
|
| Nom | Usage |
|
|
|
|
|
+-------------------+----------------------------+
|
|
|
|
|
| NC_EXPL_ROOT | Racine /opt/expl |
|
|
|
|
|
| EXPL_ROOT | Alias pour NC_EXPL_ROOT |
|
|
|
|
|
| NC_EXPL_BIN | Pointe vers {Racine}/bin |
|
|
|
|
|
| NC_EXPL_CFG | Pointe vers {Racine}/conf |
|
|
|
|
|
| NC_EXPL_CPT | Pointe vers {Racine}/cpt |
|
|
|
|
|
| NC_EXPL_DAT | Pointe vers {Racine}/dat |
|
|
|
|
|
| NC_EXPL_HST | Pointe vers {Racine}/hist |
|
|
|
|
|
| NC_EXPL_LIB | Pointe vers {Racine}/lib |
|
|
|
|
|
| NC_EXPL_LOG | Pointe vers {Racine}/log |
|
|
|
|
|
| NC_EXPL_MAN | Pointe vers {Racine}/man |
|
|
|
|
|
| NC_EXPL_MOD | Pointe vers {Racine}/mod |
|
|
|
|
|
| NC_EXPL_MSG | Pointe vers {Racine}/msg |
|
|
|
|
|
| NC_EXPL_TMP | Pointe vers {Racine}/tmp |
|
|
|
|
|
| RUBYLIB | vaut ${NC_EXPL_LIB} |
|
|
|
|
|
| NC_EXPL_SRVBATCH | Nom du serveur Batch |
|
|
|
|
|
+-------------------+----------------------------+
|
2017-07-21 20:37:57 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Les variables NC\_EXPL\_ROOT, EXPL\_ROOT et NC\_EXPL\_SRVBATCH sont définies dans le fichier "tetalab.sh"
|
|
|
|
|
Les autres variables NC\_* sont définies dans le fichier "profile\_init.env"
|
2017-07-21 20:37:57 +11:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### 2 - Variables de session
|
|
|
|
|
|
|
|
|
|
Cette liste n'est pas exhaustive, seules les principales variables sont citées.
|
|
|
|
|
|
2017-07-21 20:42:19 +11:00
|
|
|
+--------------------+-------------------------------------------------------------------------------+
|
|
|
|
|
| Nom | Usage |
|
|
|
|
|
+--------------------+-------------------------------------------------------------------------------+
|
|
|
|
|
| SH_SESSION_ID | Numero unique d'exécution : <TimeStamp>_<PID> |
|
|
|
|
|
| SH_SILENCE | Active ou non l'affichage des messages via fct_message. Par defaut vaut "non" |
|
|
|
|
|
| SH_PROG | Nom du script |
|
|
|
|
|
| SH_LOGUSER | Compte initial de connexion au serveur |
|
|
|
|
|
| SH_EXECUSER | Compte courant exécutant le script |
|
|
|
|
|
| SH_DIR | Dossier hébergeant le script |
|
|
|
|
|
| SH_PROG_VERSION | Version du script |
|
|
|
|
|
| SH_FICTRC | Pointe vers le fichier ${NC_EXPL_HST}/<Nom_du_script>.hist |
|
|
|
|
|
| SH_FICMSG | Pointe vers le fichier ${NC_EXPL_MSG}/<Nom_du_script>.msg |
|
|
|
|
|
| SH_FICCFG | Pointe vers le fichier ${NC_EXPL_CFG}/<Nom_du_script>.conf |
|
|
|
|
|
| SH_FICSEM | Pointe vers le fichier /dev/shm/<Nom_du_script>.sem |
|
|
|
|
|
| SH_FICLOG | Pointe vers le fichier ${NC_EXPL_LOG}/<Nom_du_script>.log |
|
|
|
|
|
| SH_FICCPT | Pointe vers le fichier ${NC_EXPL_CPT}/<Nom_du_script>.cpt |
|
|
|
|
|
| SH_NIV_DEBUG | Vaut 0 par défaut. Niveau d'affichage dans les fichiers de traces |
|
|
|
|
|
| SH_RETENTION_CPT | Vaut 8 par défaut. Duree de rétention en jours des fichiers de compte-rendus |
|
|
|
|
|
| SH_RETENTION_LOG | Vaut 8 par défaut. Duree de rétention en jours des fichiers de traces |
|
|
|
|
|
+--------------------+-------------------------------------------------------------------------------+
|
2017-07-21 20:37:57 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Remarque : Les variables SH\_SILENCE et SH\_NIV\_DEBUG sont controlées par les options "-s" et "-dbg"
|
2017-07-21 20:37:57 +11:00
|
|
|
si la gestion des options a été activée.
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
|
2017-07-21 21:00:45 +11:00
|
|
|
## III - Utilisation du socle bash
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Cette partie décrit sommairement les quelques règles d'usage pour écrire un script Bash avec le socle.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
### 1 - Cartouche
|
|
|
|
|
|
|
|
|
|
Les scripts doivent commencer par le cartouche ci-dessous :
|
|
|
|
|
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
|
|
|
|
| |
|
|
|
|
|
| #!/bin/bash |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| ## Script : <Nom_du_script> |
|
|
|
|
|
| ## Module Puppet : <Nom_du_module_hebergeant_le_script> |
|
|
|
|
|
| ## Auteur : <Auteur ayant cree le script> |
|
|
|
|
|
| ## Date : <Derniere_date_d_actualisation_au_format_JJ-MM-AAAA> |
|
|
|
|
|
| ## Version : <Version> |
|
|
|
|
|
| ## Objet : <Resume de la fonction> |
|
|
|
|
|
| ## |
|
|
|
|
|
| # ---------------------------------------------------------------------------- |
|
|
|
|
|
| # Mise a jour : |
|
|
|
|
|
| # <Version> <Date> - <Auteur> - <Action> : <Description> |
|
|
|
|
|
| # 0.0.1 08-06-2016 - Toto Laricot - Cre : Creation |
|
|
|
|
|
| # 0.0.2 08-09-2016 - Titi Alapeti - Ano : Ce truc est faux |
|
|
|
|
|
| # ---------------------------------------------------------------------------- |
|
|
|
|
|
| # Dependance : |
|
|
|
|
|
| # @DEP: <Nom_du_script>:<Version[-|+]> |
|
|
|
|
|
| # ---------------------------------------------------------------------------- |
|
|
|
|
|
| # Liste des options et arguments |
|
|
|
|
|
| # @OPT: <type>:<nom>:<var>:<nb_arg>:<def_val>:<OptE>:<OptI>:<ctl_val> # <Commentaire> |
|
|
|
|
|
| # @OPT: <type>:... # <Commentaire> |
|
|
|
|
|
| # @ARG: <type>:<var>:<nb_arg>:<def_val>:<ctl_val> # <Commentaire> |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| ## |
|
|
|
|
|
| ## Syntaxes : |
|
|
|
|
|
| ## -------- |
|
|
|
|
|
| ## |
|
|
|
|
|
| ## prompt> <Nom_du_script> <Liste_des_arguments_et_options> |
|
|
|
|
|
| ## |
|
|
|
|
|
| ## <Opt1> : <Description> |
|
|
|
|
|
| ## |
|
|
|
|
|
| ## Fonctionnement : |
|
|
|
|
|
| ## -------------- |
|
|
|
|
|
| ## |
|
|
|
|
|
| ## <Que fait le script dans les details et comment ca marche......> |
|
|
|
|
|
| ## |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| . |
|
|
|
|
|
| . |
|
|
|
|
|
| . |
|
|
|
|
|
| |
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Note : Les lignes commençant par 2 "#" sont utilisées pour générer l'aide, leur maintient est donc nécéssaire
|
2017-07-21 21:00:45 +11:00
|
|
|
pour garantir la fiabilité de l'information. Ce sont ces lignes, qui sont lues lors de l'utilisation de
|
|
|
|
|
l'option par defaut "-h".
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:00:45 +11:00
|
|
|
### 1.1 Elements du cartouche
|
|
|
|
|
|
|
|
|
|
#### 1.1.1 Meta-données
|
|
|
|
|
|
|
|
|
|
<Action> : peut prendre les valeurs suivantes -> cre, ano, evo, typo
|
|
|
|
|
* cre : Création du script.
|
|
|
|
|
* evo : Évolution du script -> Ajout de nouvelles fonctionnalités, Amélioration du code.
|
|
|
|
|
* ano : Correction du code suite à un comportement inattendu.
|
|
|
|
|
* typo : Ajout de commentaires, de texte ou corrections gramaticales sans influence sur le code.
|
|
|
|
|
|
|
|
|
|
<Auteur> : <Prenom> <Nom>
|
|
|
|
|
|
|
|
|
|
<Version> : Format x.y.z
|
|
|
|
|
Pour le suivi des versions on utilisera le versionnement sémantique (voir paragraphe III-1.2).
|
|
|
|
|
|
|
|
|
|
#### 1.1.2 Paragraphe
|
|
|
|
|
|
|
|
|
|
* Mise a jour : Ce paragraphe est utilisé pour suivre l'evolution des versions. La dernière version en
|
|
|
|
|
vigueur doit être reportée dans le premier paragraphe.
|
|
|
|
|
|
|
|
|
|
* Dependance : Permêt de définir la liste ainsi que la version des scripts qui sont appelés.
|
|
|
|
|
Dans le cas d'un changement cela permêt de connaître les scripts qui sont impactés.
|
|
|
|
|
Pour le moment aucun script n'exploite cette méta-donnée qui est presente pour un future usage.
|
|
|
|
|
|
|
|
|
|
* Liste des options : La déclaration des options n'est pas obligatoire.
|
|
|
|
|
|
|
|
|
|
Si aucune déclaration n'est présente alors la bibliothèque params.lib ne fait aucune action.
|
|
|
|
|
Dans ce cas les options par défaut -h, -log, -hist, -cpt, -s et -dbg ne seront pas disponible.
|
|
|
|
|
|
|
|
|
|
Si le script ne nécessite pas d'option mais que l'on souhaite disposer des options par défaut, il
|
|
|
|
|
faudra déclarer une option bidon. ex: "# @OPT: f:bidon::::::"
|
|
|
|
|
|
|
|
|
|
Si la déclaration existe alors le socle gèrera les paramètres en entrée du script, ainsi que
|
|
|
|
|
les options par défaut -h, -log, -hist, -cpt, -s et -dbg. Ces mots clé sont reservés et ne
|
|
|
|
|
peuvent pas être utilisé par le script.
|
|
|
|
|
|
|
|
|
|
La déclaration est réalisée dans le paragraphe "Liste des options et arguments". Chaque
|
|
|
|
|
option est identifiée par l'entête de ligne "# @OPT:" suivi de la description.
|
|
|
|
|
|
|
|
|
|
La description consiste en une liste de paramètres séparés par ":"
|
2017-07-21 21:14:27 +11:00
|
|
|
<type>:<nom>:<var>:<nb\_arg>:<def\_val>:<OptE>:<OptI>:<ctl\_val>
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
L'ordre des paramètre est figé et tous doivent etre présents.
|
|
|
|
|
|
|
|
|
|
8 champs sont obligatoires, soit 7 caracteres ":" (on ne compte pas le caracatere ":" suivant @OPT).
|
|
|
|
|
Exemple de déclaration valide :
|
2017-07-21 21:14:27 +11:00
|
|
|
|
2017-07-21 21:00:45 +11:00
|
|
|
# @OPT: fb:h::0:::
|
|
|
|
|
# @OPT: fb:s::0:::
|
|
|
|
|
# @OPT: f:dbg:SH_NIV_DEBUG:0/1:::
|
|
|
|
|
# @OPT: fb:log::0:::
|
|
|
|
|
# @OPT: f:hist:SH_ARG_HIST:0/1:10::
|
|
|
|
|
# @OPT: oM:i:G_INSTANCE:1/1:ALL:dbid:
|
|
|
|
|
# @OPT: oM:pr:G_PR_NOM:1/1:sq,t,l:
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <type> : Propriété de l'attribu défini par l'aggrégation des lettres suivantes:
|
|
|
|
|
* f -> Option falcultative
|
|
|
|
|
* b -> Booléen
|
|
|
|
|
* o -> Option obligatoire
|
|
|
|
|
* M -> Argument transformé en majuscule
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <nom> : nom de l'option (sans le tiret). Attention le nom de l'option est sensible à la casse.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <var> : nom de la variable dans laquelle sera stockée le(s) argument(s)
|
2017-07-21 21:00:45 +11:00
|
|
|
si plusieurs arguments alors un tableau sera initialisé <var[n]>
|
|
|
|
|
L'index [n] commence à zero.
|
|
|
|
|
Le nombre d'arguments éffectivement passés a la commande est "${#<var>[*]}".
|
|
|
|
|
La valeur max de l'index [n] est "${#<var>[*]} - 1".
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <nb\_arg> : nombre d'arguments attendus de la forme "min/max", "min/", "max" ou ""
|
2017-07-21 21:00:45 +11:00
|
|
|
si vide ou "0" alors l'option est booléene.
|
|
|
|
|
la forme "min/" considere le nombre max non determiné (infini)
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <def\_val> : Valeur par défaut assignée à <var>
|
|
|
|
|
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <OptE> : Liste des options mutellement exclusives séparées par une virgule.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* <OptI> : Liste des options inclusives séparées par une virgule.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
Lors de l'initialisation les marqueurs "@OPT" sont lues et analysées.
|
|
|
|
|
Le résultat est comparé aux arguments et options sousmis au script
|
|
|
|
|
et les variables suivantes son initialisées ...
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* SH\_OPTION\_<nom> : Initialisée à "1" (Vrai) ou "0" (Faux) selon que l'option est respectivement utilisée ou non.
|
2017-07-21 21:00:45 +11:00
|
|
|
Il existe toujours une variable par option déclarée. Ceci concerne aussi les options par défaut géré par la bibliothèque params.lib
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* SH\_ARG\_<nom> : Cette variable existe uniquement si le champ <var> est null et si le type n'est pas booléen.
|
|
|
|
|
Par défaut elle est initialisée à null ou avec la valeur <def\_val>
|
|
|
|
|
Si le champ <var> est renseigné, alors SH\_ARG\_<nom> est remplacée pas <var>.
|
|
|
|
|
Si l'option associée peut prendre plusieurs arguments, alors les variables SH\_ARG\_<nom> ou <var> sont des tableaux dont l'index commence a zéro.
|
|
|
|
|
La taille du tableau peut etre récuperée via ${#SH\_ARG\_<nom>[*]} ou ${#<var>[*]}.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Les options -h, -s, -log [id], -hist [N] et -dbg N sont prises en charge automatiquement. Ces noms sont donc reservées.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
Les options par défaut réalisent les actions suivantes :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
-h : Affiche l'aide du script (Ligne du cartouche qui commence par "##")
|
2017-07-21 21:00:45 +11:00
|
|
|
-s : Mode silence. Plus d'affichage sur le terminal.
|
|
|
|
|
Initialise la variable SH_SILENCE a "oui"
|
2017-07-21 21:14:27 +11:00
|
|
|
-log [id] : Affiche le dernier journal ou le journal "id" (identifiant de session d'exécution).
|
2017-07-21 21:00:45 +11:00
|
|
|
-cpt [id] : Affiche le dernier compte-rendu ou le Compte-rendu "id" (identifiant de session d'execution).
|
2017-07-21 21:14:27 +11:00
|
|
|
-hist [N] : Affiche l'historique des "N" dernières executions (N=10 par défaut)
|
|
|
|
|
-dbg N : Activation du mode debug au niveau "N". Active les messages gérés par la librairie fct_message
|
|
|
|
|
dont l'option -debug est utilisée.
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
* Arguments : La declaration des argument du script n'est pas obligatoire
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
Attention : Si aucune option "@OPT:" n est declaree alors il n y auras pas de prise en charge des arguments.
|
|
|
|
|
Si votre script ne necessite pas d option, mais qu il presente des arguments, alors il faudras declarer
|
|
|
|
|
une option bidon :"# @OPT: f:bidon::::::"
|
|
|
|
|
|
|
|
|
|
La declaration est realise dans le paragraphe "Liste des options et arguments".
|
|
|
|
|
Elle est identifiee par l entete de ligne "# @ARG:" suivi de la description.
|
|
|
|
|
Il ne peut y avoir qu une ligne de description pour les arguments.
|
|
|
|
|
(Si plusieurs lignes avec le marqueur @ARG existe, alors seul la premiere et prise en compte)
|
|
|
|
|
|
|
|
|
|
La description consiste en une liste de parametres separes par ":"
|
2017-07-21 21:14:27 +11:00
|
|
|
<type>:<var>:<nb\_arg>:<def\_val>:<ctl\_val>
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
L ordre des parametres est fige et tous doivent etre presents.
|
|
|
|
|
|
|
|
|
|
<type> : Propriete de l attribu defini par l agregation des lettres suivantes
|
|
|
|
|
f -> Argument falcultative
|
|
|
|
|
o -> Argument obligatoire
|
|
|
|
|
M -> Argument transforme en majuscule
|
|
|
|
|
|
|
|
|
|
<var> : nom de la variable dans laquelle sera stockee le(s) argument(s)
|
|
|
|
|
si plusieurs arguments alors un tableau sera initialise <var[n]>
|
|
|
|
|
L index [n] commence a zero.
|
|
|
|
|
Le nombre d arguments effectivement passes a la commande est "${#<var>[*]}".
|
|
|
|
|
L valeur max de l index [n] est "${#<var>[*]} - 1".
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Si <var> n est pas renseigne alors la variable SH\_ARGS[] est initialisee
|
2017-07-21 21:00:45 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
<nb\_arg> : nombre d arguments attendus de la forme "min/max", "min/", "max" ou "".
|
2017-07-21 21:00:45 +11:00
|
|
|
si vide alors on considere que le nombre d arguments est a minima de 1.
|
|
|
|
|
la forme "min/" considere le nombre est a minima de "min".
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
<def\_val>: Valeur par defaut assignee a <var>
|
|
|
|
|
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
2017-07-21 21:00:45 +11:00
|
|
|
|
|
|
|
|
ATTENTION
|
|
|
|
|
Si le caractere "&" est present dans la valeur d un argument, alors cette valeur doit etre encadree
|
|
|
|
|
par une simple cote et le caractere "&" doit etre proteger par un anti-slash "\".
|
|
|
|
|
|
|
|
|
|
Le cas echeans le shell generera un fils qui tentera l execution d'un script portant le nom de la valeur de l argument.
|
|
|
|
|
|
|
|
|
|
1.2 Versionnement semantique
|
|
|
|
|
1.2.1 Usage
|
|
|
|
|
L idee de l utilisation du versionnement semantique est de definir clairement les intentions
|
|
|
|
|
d un changement dans un code pour les clients de ce dernier. Ceci permet de fiabiliser la mise en
|
|
|
|
|
place de dependances et de determiner les impacts d un changement.
|
|
|
|
|
|
|
|
|
|
1.2.2 Format
|
|
|
|
|
Le format utilise est le suivant x.y.z
|
|
|
|
|
x est l identifiant de version majeure.
|
|
|
|
|
y est l identifiant de version mineure.
|
|
|
|
|
z est l identifiant de version de correction.
|
|
|
|
|
|
|
|
|
|
1.2.3 Semantique
|
|
|
|
|
- Version majeure X : Il vaut "0" lors du developpement, le script est considere non valide et ne
|
|
|
|
|
devrait pas etre appele par d autre script. Une fois le script valide la version
|
|
|
|
|
doit etre 1.0.0 (premiere version stable).
|
|
|
|
|
Il doit etre incremente si des changements dans le code n assure plus la compatibilite
|
|
|
|
|
ascendante. Les identifiants de version mineure et de correction doivent etre remis
|
|
|
|
|
a zero quand l identifiant de version majeure est incremente.
|
|
|
|
|
|
|
|
|
|
- Version mineur y : Doit etre incremente lors de l ajout de nouvelle fonctionnalite ou d amelioration
|
|
|
|
|
du code qui n on t pas d impact sur la compatibilite ascendante. L identifiant de
|
|
|
|
|
version de correction doit être remis a zero lorsque l identifiant de version mineure
|
|
|
|
|
est incremente.
|
|
|
|
|
|
|
|
|
|
- Version de correction z : Doit être incremente si seules des corrections retro-compatibles sont introduites.
|
|
|
|
|
Une correction est definie comme un changement interne qui corrige un comportement incorrect.
|
|
|
|
|
Il peut etre incremente lors de correction typographique ou grammaticale.
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
|
|
|
|
|
2 - Initialisation du socle.
|
|
|
|
|
Par defaut les librairies du socle sont chargees a la connexion. Mais pour qu elles puissent etre operationnelles
|
|
|
|
|
il faut initialiser les variables de session.
|
2017-07-21 21:14:27 +11:00
|
|
|
Ceci est realise en sourcant le fichier "${NC\_EXPL\_CFG}/init.conf" au debut du script :
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Rem : L analyse des options et arguments est aussi realise par "${NC\_EXPL\_CFG}/init.conf".
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
|
|
|
|
| |
|
|
|
|
|
| #!/bin/bash |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| . |
|
|
|
|
|
| <CARTOUCHE> |
|
|
|
|
|
| . |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # Initialisation de l environement |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
2017-07-21 21:14:27 +11:00
|
|
|
| if [ ! -f ${NC\_EXPL\_CFG}/init.conf ] |
|
2017-07-21 18:44:49 +11:00
|
|
|
| then |
|
2017-07-21 21:14:27 +11:00
|
|
|
| echo "Fichier d initialisation du socle \${NC\_EXPL\_CFG}/init.conf n existe pas !" |
|
2017-07-21 18:44:49 +11:00
|
|
|
| echo "Arret du script par securite" |
|
|
|
|
|
| exit 250 |
|
|
|
|
|
| else |
|
2017-07-21 21:14:27 +11:00
|
|
|
| . ${NC\_EXPL\_CFG}/init.conf |
|
2017-07-21 18:44:49 +11:00
|
|
|
| fi |
|
|
|
|
|
| . |
|
|
|
|
|
| . |
|
|
|
|
|
| |
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
|
|
|
|
3 - Structure d un script
|
|
|
|
|
Voici les elements qui devraient etre present a minima dans les script Bash. Ceci est recommande pour
|
|
|
|
|
assurer une homogeneite dans l ensemble du socle.
|
|
|
|
|
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
|
|
|
|
| |
|
|
|
|
|
| #!/bin/bash |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| . |
|
|
|
|
|
| <CARTOUCHE> |
|
|
|
|
|
| . |
|
|
|
|
|
| ##---------------------------------------------------------------------------- |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # Initialisation de l environement |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
2017-07-21 21:14:27 +11:00
|
|
|
| if [ ! -f ${NC\_EXPL\_CFG}/init.conf ] |
|
2017-07-21 18:44:49 +11:00
|
|
|
| then |
|
2017-07-21 21:14:27 +11:00
|
|
|
| echo "Fichier d initialisation du socle \${NC\_EXPL\_CFG}/init.conf n existe pas !" |
|
2017-07-21 18:44:49 +11:00
|
|
|
| echo "Arret du script par securite" |
|
|
|
|
|
| exit 250 |
|
|
|
|
|
| else |
|
2017-07-21 21:14:27 +11:00
|
|
|
| . ${NC\_EXPL\_CFG}/init.conf |
|
2017-07-21 18:44:49 +11:00
|
|
|
| fi |
|
|
|
|
|
| |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # Definition des fonctions |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # |
|
2017-07-21 21:14:27 +11:00
|
|
|
| function fct\_un |
|
2017-07-21 18:44:49 +11:00
|
|
|
| { ... <Code fonction> |
|
|
|
|
|
| } |
|
|
|
|
|
| |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
2017-07-21 21:14:27 +11:00
|
|
|
| function fct\_deux |
|
2017-07-21 18:44:49 +11:00
|
|
|
| { ... |
|
|
|
|
|
| } |
|
|
|
|
|
| |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # Programme principal MAIN |
|
|
|
|
|
| #----------------------------------------------------------------------------- |
|
|
|
|
|
| # |
|
2017-07-21 21:14:27 +11:00
|
|
|
| fct\_message "${SH\_PROG}" |
|
|
|
|
|
| fct\_message "version ${SH\_PROG\_VERSION}" |
|
2017-07-21 18:44:49 +11:00
|
|
|
| |
|
|
|
|
|
| # -- Initialisation des variables par defaut |
|
|
|
|
|
| # -- --------------------------------------- |
|
2017-07-21 21:14:27 +11:00
|
|
|
| G\_VAR1=${G\_AVR1:="Valeur par defaut"} # <Comentaire> |
|
2017-07-21 18:44:49 +11:00
|
|
|
| ... |
|
|
|
|
|
| |
|
|
|
|
|
| # -- Control de coherence des options |
|
|
|
|
|
| # -- -------------------------------- |
|
|
|
|
|
| |
|
|
|
|
|
| # -- Traitement |
|
|
|
|
|
| # -- ---------- |
|
|
|
|
|
| |
|
|
|
|
|
| < ... Code du script ...> |
|
|
|
|
|
| |
|
2017-07-21 21:14:27 +11:00
|
|
|
| fct\_erreur 0 |
|
2017-07-21 18:44:49 +11:00
|
|
|
| |
|
|
|
|
|
+----------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Note : La construction /G\_VAR1=${G\_AVR1:="Valeur par defaut"}/ permet de definir une variable avec une
|
|
|
|
|
valeur par defaut, qui peut etre surchargee dans le fichier de configuration {NC\_EXPL\_CFG}/<Nom\_du\_script>.conf
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Concernant les fonctions /fct\_message/ et /fct\_erreur/ voir le chapitre V.
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
4 - Actions realisees au lancement d un script
|
2017-07-21 21:14:27 +11:00
|
|
|
Le script commence par le chargement de la configuration ". ${NC\_EXPL\_CFG}/init.conf"
|
2017-07-21 18:44:49 +11:00
|
|
|
un certain nombre d action sont effectuees par defaut en plus de l initialisation des variables de session.
|
|
|
|
|
|
|
|
|
|
- Initialisation des variables de session (Cf. II.3)
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Generation d'un numero de session unique sous la varable ${SH\_SESSION\_ID}
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Chargement du fichier ${SH\_FICCFG}
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Rotation des fichiers ${SH\_FICLOG} et ${SH\_FICCPT} selon les retentions respective ${SH\_RETENTION\_LOG} et ${SH\_RETENTION\_CPT}
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Purge des fichiers temporaires (${NC\_EXP\_ROOT}/tmp) anterieurs selon la retentions ${SH\_RETENTION\_LOG}
|
|
|
|
|
et suppression des fichiers generes par le script utilsant le socle dans ${NC\_EXP\_ROOT}/log et ${NC\_EXP\_ROOT}/cpt
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Ecriture dans le fichier ${SH\_FICTRC} de la date de debut execution, ainsi que des arguments passes au script
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
- Initialisation du fichier ${SH\_FICLOG} a vide
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
- Analyse des parametres passes au script
|
|
|
|
|
Cette analyse ne fonctionne que si les options ont ete declarees dans l entete du script (Cf. III.1.1.2)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
IV - Nomenclature
|
|
|
|
|
------------
|
|
|
|
|
1 - Fichier temporaire
|
2017-07-21 21:14:27 +11:00
|
|
|
Les fichiers temporaires doivent etre ecrits dans le repertoire ${NC\_EXPL\_TMP}.
|
|
|
|
|
Les noms des fichiers temporaires sont de le forme : <Libre>\_${SH\_SESSION\_ID}.tmp
|
2017-07-21 18:44:49 +11:00
|
|
|
De cette facon il seront geres par le socle (Suppresion automatique)
|
|
|
|
|
|
|
|
|
|
2 - Nom des executables ( fichiers du dossier {racine}/bin )
|
|
|
|
|
Les noms des fichiers doit etre de la forme :
|
2017-07-21 21:14:27 +11:00
|
|
|
<pre>\_<descr>
|
|
|
|
|
<pre>\_<descr>.<language>
|
|
|
|
|
<pre>\_<app\_source>\_<app\_dest>[\_<libre>].<language>
|
|
|
|
|
<app>\_<descr>.<language>
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
<pre> est une des valeurs suivantes : "sys", "dba", "exp", "ctl", "aud", "int"
|
|
|
|
|
|
|
|
|
|
- "sys" : Scrit d administration systeme.
|
|
|
|
|
- "dba" : Script d administration base de donnees
|
|
|
|
|
Ces scripts peuvent presenter des risques et doivent faire
|
|
|
|
|
l objet d une attention particuliere lors de leurs execution.
|
|
|
|
|
|
|
|
|
|
- "exp" : Script d exploitation devolue principalement au traitement reccurent
|
|
|
|
|
Ces scripts sont reserves a l'exploitation courante. Il peuvent
|
|
|
|
|
modifier le systeme dans le cadres de traitements reccurents.
|
|
|
|
|
Leurs execution est de risque modere, comme respecter une date d execution.
|
|
|
|
|
Il sont reserves a l exploitation systeme uniquement. Dans le cas d un traitement
|
2017-07-21 21:14:27 +11:00
|
|
|
reccurrent pour le compte d une application le nom doit etre de la forme <app>\_<descr>.<language>
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
- "int" : Script dedier aux interfaces entre applications
|
|
|
|
|
Ces script doivent fair l objet d une attention particuliere car il peuvent modifier
|
|
|
|
|
les donnees applicative et peuvent etre contraint par des conditions d execution.
|
|
|
|
|
|
|
|
|
|
- "ctl" : Script de controle (devolu principalement a icinga)
|
|
|
|
|
- "aud" : Script d audit ne modifiant pas le systeme.
|
|
|
|
|
Ces scripts peuvent etre executes sans aucun risque.
|
|
|
|
|
|
|
|
|
|
<descr> est libre, doit refleter si possible la fonction du script.
|
|
|
|
|
|
|
|
|
|
<language> est une des valeurs suivantes :
|
|
|
|
|
- "rb" : Script Ruby.
|
|
|
|
|
- "sh" : Script Bash.
|
|
|
|
|
- Pas d extention : Script C
|
|
|
|
|
|
|
|
|
|
<app> est le nom de application a laquelle le script est dedie.
|
|
|
|
|
Ces scripts sont reserves a une application particuliere,
|
|
|
|
|
dans le cadres de l exploitation reccurente de l'application.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
V - Description et usage des Librairies
|
|
|
|
|
-----------------------------------
|
2017-07-21 21:14:27 +11:00
|
|
|
1 - fct\_message
|
2017-07-21 18:44:49 +11:00
|
|
|
--- -----------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_message [-cpt] [-hist] [-nolog] [-debug N] [-color Couleur] "<Message a ecrire>"
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Cette fonction est a utiliser en remplacement de la commande "echo".
|
|
|
|
|
Elle ajoute l horadatage au message et gere la ventilation des ecritures dans les differents fichiers de traces.
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Fonction : Par defaut le message est affiche sur le terminal et est ecrit dans le fichier journal ${NC\_EXPL\_LOG}/<nom\_du\_script>.log
|
2017-07-21 18:44:49 +11:00
|
|
|
Les options modifient la destination de l ecriture :
|
2017-07-21 21:14:27 +11:00
|
|
|
- cpt : Ecrit en plus du journal dans le fichier de compte-rendu ${NC\_EXPL\_CPT}/<nom\_du\_script>.cpt
|
|
|
|
|
- hist : Ecrit uniquement dans le fichier d historique des executions ${NC\_EXPL\_TRC}/<nom\_du\_script>.hist
|
2017-07-21 18:44:49 +11:00
|
|
|
- nolog : inhibe l ecritutre dans le fichier journal
|
|
|
|
|
- debug N : N'affiche pas le message sur le terminal mais uniquement dans le fichier journal, a condition
|
|
|
|
|
que le script soit execute en mode debug de niveau equivalent a "N" via l'option "-dbg N".
|
|
|
|
|
Par defaut le niveau de debug est 0, ainsi si "N" vaut zero alors le message est ecrit
|
|
|
|
|
uniquement dans le fichier journal.
|
|
|
|
|
- color : Affiche le message en couleur. Les couleurs reconues sont : vert,rouge,bleu,cyan,jaune,orange,blanc et noir
|
|
|
|
|
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
2 - fct\_affiche\_ligne
|
2017-07-21 18:44:49 +11:00
|
|
|
--- -----------------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_affiche\_ligne [entete|pied] <elements>
|
|
|
|
|
Usage : Affiche un tableau sur la sortie standard et dans le fichier compte-rendu ${NC\_EXPL\_ROOT}/<script>.cpt
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
Fonction : 3 etapes sont necessaires pour creer un tableau :
|
|
|
|
|
- Definition du tableau
|
|
|
|
|
- Affichage des elements
|
|
|
|
|
- Fermeture du tableau
|
|
|
|
|
|
|
|
|
|
Ces etapes doivent imperativement etre suivies et dans cet ordre.
|
|
|
|
|
Il n est pas possible d imbriquer des tableaux.
|
|
|
|
|
|
|
|
|
|
- Definition
|
2017-07-21 21:14:27 +11:00
|
|
|
Elle realise par l appel de la fonction fct\_affiche\_ligne avec l argument entete la forme est alors la suivante :
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
fct\_affiche\_ligne entete "{Titre}" "{Colonne\_1},{Taille\_1}" "{Colonne\_2},{Taille\_2}" "{Colonne\_3},{Taille\_3}" "{Colonne\_4},{Taille\_4}" ...
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
ou bien
|
2017-07-21 21:14:27 +11:00
|
|
|
fct\_affiche\_ligne entete "{Titre}" "Groupe1({Colonne\_1},{Taille\_1}:{Colonne\_2},{Taille\_2})" "{Colonne\_3},{Taille\_3}" "{Colonne\_4},{Taille\_4}" "Groupe2({Colonne\_4},{Taille\_4}:...)"
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
- Affichage des elements
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
fct\_affiche\_ligne "<Element1>" "<Element2>" ...
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
- Fermeture du tableau
|
|
|
|
|
Cette action permet de liberer les variables de session qui ont ete crees
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
fct\_affiche\_ligne pied
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
Exemple ...
|
|
|
|
|
|
|
|
|
|
+
|
2017-07-21 21:14:27 +11:00
|
|
|
| fct\_affiche\_ligne entete "Un tableau" "C1,10" "C2,10" "c3,10"
|
|
|
|
|
| fct\_affiche\_ligne A B C
|
|
|
|
|
| fct\_affiche\_ligne 1 "" 3
|
|
|
|
|
| fct\_affiche\_ligne pied
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
|
+
|
|
|
|
|
| --------------------------------------
|
|
|
|
|
| Un tableau
|
|
|
|
|
| --------------------------------------
|
|
|
|
|
| C1 | C2 | c3
|
|
|
|
|
| --------------------------------------
|
|
|
|
|
| A |B |C
|
|
|
|
|
| 1 | |3
|
|
|
|
|
| --------------------------------------
|
|
|
|
|
+
|
|
|
|
|
|
|
|
|
|
+
|
2017-07-21 21:14:27 +11:00
|
|
|
| fct\_affiche\_ligne entete "Un Autre tableau" "C1,10" "G1(C2,20:C3,10:C4,3)" "C5,15"
|
|
|
|
|
| fct\_affiche\_ligne A B C D E
|
|
|
|
|
| fct\_affiche\_ligne 1 "" 3 3 4
|
|
|
|
|
| fct\_affiche\_ligne pied
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
|
+
|
|
|
|
|
| ------------------------------------------------------------------------
|
|
|
|
|
| Un Autre tableau
|
|
|
|
|
| ------------------------------------------------------------------------
|
|
|
|
|
| | G1 |
|
|
|
|
|
| C1 |-----------------------------------------| C5
|
|
|
|
|
| | C2 | C3 | C4 |
|
|
|
|
|
| ------------------------------------------------------------------------
|
|
|
|
|
| A |B |C |D |E
|
|
|
|
|
| 1 | |3 |3 |4
|
|
|
|
|
| ------------------------------------------------------------------------
|
|
|
|
|
+
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
3 - fct\_erreur
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ----------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_erreur <N>
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Gestion des erreurs d un script
|
|
|
|
|
|
|
|
|
|
Fonction : Cette fonction doit etre appelee pour sortir d un script du socle.
|
2017-07-21 21:14:27 +11:00
|
|
|
Elle affiche le message d erreur associe au code qui est lu dans le fichier ${NC\_EXPL\_MSG}/<script>.msg
|
2017-07-21 18:44:49 +11:00
|
|
|
Elle execute eventuellement une fonction rattachee, specifiee dans ce meme fichier.
|
|
|
|
|
Elle ferme les fichiers de traces, supprime les fichiers temporaires, libere les semaphores et
|
|
|
|
|
renvoi un code retour au script appelant.
|
|
|
|
|
|
|
|
|
|
N est un entier positif dont les valeurs suivantes sont reservees :
|
|
|
|
|
|
|
|
|
|
0 : Fin normale du script
|
2017-07-21 21:14:27 +11:00
|
|
|
250 : <lib:fct\_erreur> Appel de la librairie sans le numero d erreur (<N> non renseigne !)
|
|
|
|
|
251 : <lib:fct\_erreur> La description de l erreur <N> n existe pas dans le fichier <script>.msg
|
|
|
|
|
252 : <lib:fct\_erreur> Le fichier <script>.msg n existe pas
|
|
|
|
|
253 : <lib:fct\_erreur> La description de l erreur dans le fichier <script>.msg est incorrecte
|
|
|
|
|
254 : <lib:fct\_params> Erreur a ete remontee par la librairie
|
|
|
|
|
255 : <lib:fct\_erreur> Appel de la librairie avec un numero d erreur >= 250
|
2017-07-21 18:44:49 +11:00
|
|
|
256 : reserve pur un futur usage
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Le fichier <script>.msg contient les descriptions des codes erreur.
|
|
|
|
|
Un code par ligne de la forme :
|
|
|
|
|
<NumErreur> | <type> | <action> | <message> ou <fonction>
|
|
|
|
|
|
|
|
|
|
<NumErreur> : Entier positif identifiant l erreur
|
|
|
|
|
|
|
|
|
|
<type> : prend les valeurs erreur, alert ou info
|
|
|
|
|
colorise le message en fonction du type respectivement
|
|
|
|
|
rouge, orange et bleu
|
|
|
|
|
|
|
|
|
|
<action> : Action a realiser (continu,stop,exec)
|
|
|
|
|
- continu : Affiche le message puis rend la main au script
|
|
|
|
|
- stop : Affiche le message puis sort en erreur
|
|
|
|
|
- exec : execute la fonction puis rend la main au script
|
|
|
|
|
|
|
|
|
|
<fonction> : Fonction a executer
|
|
|
|
|
Ce champs peut contenir des variables qui seront valorisees.
|
|
|
|
|
|
|
|
|
|
<message> : Message a afficher (dans les traces et sur la sortie standard)
|
|
|
|
|
Ce champs peut contenir des variables qui seront valorisees.
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
4 - fct\_unique\_exec
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ---------------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_unique\_exec [<nom>] [<Occurences>]
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Empeche l execution multiple d un code par la l'acquisition de semaphore
|
|
|
|
|
|
|
|
|
|
Fonction :
|
|
|
|
|
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
5 - fct\_libere\_exec
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ---------------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_libere\_exec [<nom>]
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Libere les semaphores
|
|
|
|
|
|
|
|
|
|
Fonction :
|
|
|
|
|
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
6 - fct\_usage
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ---------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_usage
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Affiche l aide du script.
|
|
|
|
|
Ce sont les lignes du cartouche commencant par "##"
|
|
|
|
|
|
|
|
|
|
Fonction : Cette fonction est uniquement a usage interne du socle.
|
2017-07-21 21:14:27 +11:00
|
|
|
Elle est integree a la fonction fct\_params.
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
7 - fct\_rotation
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ------------
|
|
|
|
|
|
|
|
|
|
Syntaxe :
|
|
|
|
|
Usage :
|
|
|
|
|
|
|
|
|
|
Fonction :
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
8 - fctpath
|
|
|
|
|
--- -------
|
|
|
|
|
|
|
|
|
|
Syntaxe :
|
|
|
|
|
Usage :
|
|
|
|
|
|
|
|
|
|
Fonction :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
9 - fct\_params
|
2017-07-21 18:44:49 +11:00
|
|
|
--- ----------
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
Syntaxe : fct\_params
|
2017-07-21 18:44:49 +11:00
|
|
|
Usage : Gestion des options et arguments du script
|
|
|
|
|
|
|
|
|
|
Fonction : Cette fonction est uniquement a usage interne du socle.
|
2017-07-21 21:14:27 +11:00
|
|
|
Elle est appelee a l initialisation des variables de session lors du chargement du fichier ${NC\_EXPL\_CFG}/init.conf
|
2017-07-21 18:44:49 +11:00
|
|
|
Cette fonction extrait les lignes de declaration "# OPT:" et les compare au arguments sousmis au script
|
|
|
|
|
Pour plus d information voir le paragraphe III-1.1.2
|
|
|
|
|
|
|
|
|
|
V - Deploiement via puppet
|
|
|
|
|
-----------------------------------
|
|
|
|
|
1 - Script avec Hiera
|
|
|
|
|
--- -----------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::file\_bin\_bash:
|
|
|
|
|
'aud\_process\_swap.sh':
|
|
|
|
|
source: 'puppet:///modules/script\_core\_dtsi/bin/aud\_process\_swap.sh'
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
2 - Fichier de conf avec Hiera
|
|
|
|
|
--- --------------------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::file\_conf\_bash:
|
|
|
|
|
aud\_process\_swap.conf:
|
|
|
|
|
source: 'puppet:///modules/script\_core\_dtsi/conf/aud\_process\_swap.conf'
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
3 - Fichier de conf construit depuis un script avec Hiera
|
|
|
|
|
--- -----------------------------------------------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::file\_conf\_hiera::aud\_process\_swap:
|
2017-07-21 18:44:49 +11:00
|
|
|
directives1: "conf1"
|
|
|
|
|
|
|
|
|
|
4 - fichier de message avec Hiera
|
|
|
|
|
--- ------------------------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::msg\_errors\_hiera::aud\_process\_swap:
|
2017-07-21 18:44:49 +11:00
|
|
|
1: 'erreur | stop | message N 1'
|
|
|
|
|
2: 'alert | continu | message N 2'
|
|
|
|
|
|
|
|
|
|
5 - Fichier modele avec Hiera
|
|
|
|
|
--- --------------------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::file\_mod:
|
|
|
|
|
aud\_process\_swap.mod:
|
|
|
|
|
source: 'puppet:///modules/script\_core\_dtsi/mod/aud\_process\_swap.mod'
|
2017-07-21 18:44:49 +11:00
|
|
|
|
|
|
|
|
6 - Fichier SQL avec Hiera
|
|
|
|
|
--- ----------------------
|
|
|
|
|
Exemple :
|
|
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::is\_bdd: true
|
2017-07-21 18:44:49 +11:00
|
|
|
|
2017-07-21 21:14:27 +11:00
|
|
|
script\_core\_dtsi::file\_sql:
|
|
|
|
|
aud\_process\_swap.sql:
|
|
|
|
|
source: 'puppet:///modules/script\_core\_dtsi/sql/aud\_process\_swap.sql'
|
