Intégrer une fonction dans chaque script

**JulesP** · 28/11/2019, 14h24

Bonjour alors voilà je m'explique j'ai ce début de code dans tout mes scripts

Code PowerShell :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$printlog1 ="\\s.....\d$\opcon\logs\printlog1.txt"
 
$CurrentScript = "$PSCommandPath".Substring($PSScriptRoot.Length+1) 
$CS = $CurrentScript.PadRight(20)
 
$CST = $CS + " " + (get-date -Format G) + " " + $MSGLOG01
 
 
Function Add-PrintLog
    (
    [PARAMETER(Mandatory=$true, HelpMessage='My First Argument')][string]$MSGLOG01
    )
    {
 
$CST = (get-date -Format G) + "  " + $CS + " " + $MSGLOG01
Write-host $MSGLOG01 -ForegroundColor black -BackgroundColor darkgray
Add-Content $printlog1 $CST
    }

Celui-ci me permet d’intégrer dans une log tout les éléments que je désire avec la commande

Code PowerShell :

Sélectionner tout - Visualiser dans une fenêtre à part

 Add-PrintLog -MSGLOG01

et ceci pour tous mes scripts (tout va dans la même LOG exigence de la direction).

Je voudrai en faire une fonction ou un module pour que je n'ai pas à le mettre a chaque début de mes scripts.
Pourriez-vous m'aider?

Merci d'avance,

**Laurent Dardenne** · 28/11/2019, 19h22

Salut,
tu peux copier tout ton code dans un fichier .pms1 et puis faire un import-module dans chaque script (modifier chaque script).
Ou charger le module AVANT d'appeler le moindre script (le chargement du module étant une sorte d'initialisation du contexte) puis utiliser simplement Add-PrintLog.

Premier soucis, ton module est lié à ton traitement (path du log), pas grave pour changer le chemin pour d'autres traitement on crée un autre module qui fait la même chose mais avec un autre nom ( je déconne

).
L'autre déjà plus gênant est de connaitre l'appelant (le nom du producteur du log) soit tu le passes à chaque appel soit tu lis la pile d'appel (get-pscallstack).
En passant comme on ne connait pas les usages, le write-host peut poser pb dans certains contexte d'exécution, ensuite si tu utilises ton traitement sur un serveur Citrix le nom de ton fichier sera identique pour chaque session

Je ne pense pas que ma réponse t'aidera, perso j'utilise ceci quand je le peux, il en existe d'autres sur Github.

Et je ne comprend pas ceci :

Code powershell :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
 
$CST = $CS + " " + (get-date -Format G) + " " + $MSGLOG01

Car $MSGLOG01 est déclaré comme paramètre de ta fonction.

**Laurent Dardenne** · 28/11/2019, 19h30

Envoyé par JulesP

j'ai ce début de code dans tout mes scripts

Tu peux aussi utiliser le dotsource pour charger un script externe et ainsi ne pas recopier le code. Mais là ceci dépend de la structure de tes répertories de scripts.

**JulesP** · 29/11/2019, 08h38

Merci pour ces réponses, maintenant un petit tuto pour la création d'un module, parce que la je suis un peu perdu....

**Laurent Dardenne** · 29/11/2019, 19h35

Un tuto, rédigé avec la version 2 de Powershell. Depuis il y a eu qq améliorations/corrections. Mnt les modules prérequis sont chargés

Un exemple rapido à partir de ton code :

Code powershell :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
@'
$Script:LogFileName ="C:\temp\LogFileName.txt"
 
#$CurrentScript = "$PSCommandPath".Substring($PSScriptRoot.Length+1) 
#$Script:CS = $CurrentScript.PadRight(20)
#$CST = $CS + " " + (get-date -Format G) + " " + $MSGLOG01
 
 
Function Add-Log {
    [cmdletBinding()]
 Param(
    [PARAMETER(Mandatory=$true, HelpMessage='My First Argument')]
   [string] $MSGLOG01
 )
 
   $CallerScript=$PSCmdlet.SessionState.PSVariable.GetValue('PSCommandPath')
   Write-Debug  $CallerScript
 
   $CallerScriptRoot=$PSCmdlet.SessionState.PSVariable.GetValue('PSScriptRoot')
   Write-Debug $CallerScriptRoot
 
   $Caller=$CallerScript.Substring($CallerScriptRoot.Length+1)
 
   $Header = (get-date -Format G) + '  ' + $($Caller.PadRight(20)) +' '
 
   $CST = $Header + $MSGLOG01
   Write-host $MSGLOG01 -ForegroundColor black -BackgroundColor darkgray
   Add-Content $LogFileName $CST
 
   $CallStack="Call Stack`r`n$(Get-PSCallStack|Out-String)"
   Write-Debug $CallStack
 
   Add-Content $LogFileName $CallStack
 
   Add-Content $LogFileName 'La suite'
}
 
Function Get-LogFileName{
    param()
 return  $Script:LogFileName
}
 
Export-ModuleMember -Function 'Add-Log','Get-LogFileName'
'@ > c:\temp\Log.psm1
 
@'
Import-Module C:\temp\Log.psm1 -force
"Fait qq chose"
Add-Log 'Message 1'
'@ > c:\temp\CallLog.ps1
 
cd c:\temp
.\CallLog.ps1
$F=get-LogFileName
type $F

Je te laisse regarder ça et peiner un peu

**JulesP** · 11/12/2019, 11h12

Re bonjour,

Bon j'avoue la je galère j'ai essayé différente méthode, mais je n'y arrive vraiment pas.
quand je crée le module pas de soucis, mais soit il garde le nom du module sois il ne fait rien,
Il me fraudait vraiment un exemple pour comprendre.

Merci d'avance,

**Laurent Dardenne** · 11/12/2019, 16h34

Salut,

Envoyé par JulesP

Bon j'avoue la je galère

Je veux bien te croire :-)

Envoyé par JulesP

Il me fraudait vraiment un exemple pour comprendre.

Je t'en ai fournis un à partir de ton script et je l'ai testé rapido sous PS v5.1
L'inverse est peut être préférable communique nous ce que tu as fait et avec ça on verra ce qu'il manque ou ce qu'il y en trop

**JulesP** · 11/12/2019, 16h43

j'avoue j'ai essayé ton script mais j'ai rien compris pourquoi y a t'il des @
bon jusqu'à la ligne 42 ça va aussi
Mais alors en dessous je pige plus rien??
JE SUIS MAUVAIS

**Laurent Dardenne** · 11/12/2019, 16h51

Les @ sont là pour déclarer des herestring, on garde le format de la chaîne.

Envoyé par JulesP

Mais alors en dessous je pige plus rien??

C'est à dire la syntaxe? l'usage ?
Je crée un fichier module, puis un fichier script et je les teste.

Envoyé par JulesP

JE SUIS MAUVAIS

Je ne pense pas, tu débutes, nuance

**JulesP** · 12/12/2019, 08h34

Oui je début très fortement,
Oui la syntaxe.
Quand je copie-colle ton exemple dans powershell c'est rouge de partout,
donc je copie que les lignes 1 à 42 et je corrige les erreurs mais ça ne fonctionne pas du tout

**Laurent Dardenne** · 12/12/2019, 08h49

Envoyé par JulesP

Oui je début très fortement,
Oui la syntaxe.
Quand je copie-colle ton exemple dans powershell c'est rouge de partout,

Je n'ai pas ce comportement sous Windows 10 ps 5.1

Il ne doit pas y avoir d'espace devant le signe '@ qui clôt la herestring.

Tu peux créer les deux fichiers c:\temp\Log.psm1 et c:\temp\CallLog.ps1 dans un éditeur

**JulesP** · 12/12/2019, 09h17

Un grand merci j'avance et je comprends un peu mieux,
La jusqu’à l'export module ça va mieux,
maintenant comment je l’intègre a mes scripts ? grâce au 2ème bloc d'instruction c'est ça ?

**Laurent Dardenne** · 12/12/2019, 17h34

Envoyé par JulesP

maintenant comment je l’intègre a mes scripts ?

Tu procèdes comme avec ton script d'origine :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
Add-PrintLog -MSGLOG01

Seul change le nom de la fonction et le chargement du module en tant que prérequis.
Lit le code d'exemple proposé, le second script.

Mais si tu poses la question c'est que tu n'as pas trop compris mon code d'exemple. Je me trompe ?

**JulesP** · 17/12/2019, 10h43

Bonjour,

Oui c'est vrai je suis un peu pommé,
J'ai créée le module,
J'ai chargé le module dans un de mes scripts et voici le résultat :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Exception lors de l'appel de «*Substring*» avec «*1*» argument(s)*: «*startIndex ne peut pas être supérieur à la longueur de la chaîne.
Nom du paramètre*: startIndex*»
Au caractère C:\Users\....\Documents\WindowsPowerShell\Modules\LOG01\LOG01.psm1:21 : 4
+    $Caller=$CallerScript.Substring($CallerScriptRoot.Length+1)
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [], MethodInvocationException
    + FullyQualifiedErrorId : ArgumentOutOfRangeException
 
Impossible d’appeler une méthode dans une expression Null.
Au caractère C:\Users\.....\Documents\WindowsPowerShell\Modules\LOG01\LOG01.psm1:23 : 46
+ ...  $Header = (get-date -Format G) + '  ' + $($Caller.PadRight(20)) +' '
+                                                ~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation : (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Quand j'utilisé mon code mise au début voici le résultat que j'avais :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
17/12/2019 10:30:33  GEDINT01.ps1         Durée Totale : 00:00:24 7/12/2019 10:37:02   Démarrage du traitement d'intégration des documents V***** dans la GRA

Donc la date, l'heure, le nom du script et le "Add-PrintLog -MSGLOG01".
maintenant avec le module je n'ai plus du tout cela,

DONC OUI JE SUIS PERDU............. :'( :'(

**Laurent Dardenne** · 17/12/2019, 18h44

Envoyé par JulesP

DONC OUI JE SUIS PERDU

Ce que je t'ai proposé c'était un exemple pour démarrer, toi tu veux tout suite le mettre en prod sans savoir comment le debugger.
Là le mardi tu te prépares tes problèmes du vendredi

.

J'ai placé des traces, déclare $debugpreference='continue' tu devrais avoir un résultat, mais pour le moment c'est ceci qui pose pb :

Code PowerShell :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
$CallerScriptRoot=$PSCmdlet.SessionState.PSVariable.GetValue('PSScriptRoot')
  Write-Debug $CallerScriptRoot

Quelle version de powershell utilises-tu (cf. $PSVersionTable ) ?
Tu peux aussi insérer des valeur par défaut dans les variables $caller et $callerXXX.

**JulesP** · 18/12/2019, 10h37

Bonjour,

HA non non je veux pas mettre en prod tout de suite, je fais des tests pour essayer de comprendre, c'est pas simple...
La version est : PSVersion 5.1.14409.1018.

je n'ai rien avec la commande :
$debugpreference='continue'

Merci pour tout

**Laurent Dardenne** · 18/12/2019, 18h46

Envoyé par JulesP

HA non non je veux pas mettre en prod tout de suite,

Ok, au temps pour moi.

Envoyé par JulesP

je n'ai rien avec la commande :
$debugpreference='continue'

Après qq test la variable PSCommandPath n'est pas tjr renseigné.
Elle l'est dans un script, mais pas dans un scriptblock, normal :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
 $sb={Add-Log 'Message 2'}
 &$sb

Peux-tu me communiquer le code que tu utilises ?
Et qu'as-tu comme résultat si tu modifes, dans le code du module, la fonction Add-Log comme ceci:

Code powershell :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
Function Add-Log {
    [cmdletBinding()]
 Param(
    [PARAMETER(Mandatory=$true, HelpMessage='My First Argument')]
   [string] $MSGLOG01
 )
 
   $CallStack="Call Stack`r`n$(Get-PSCallStack|Out-String)"
   Write-Debug $CallStack
 
   Add-Content $LogFileName $CallStack
 
   Add-Content $LogFileName 'La suite'
}

Intégrer une fonction dans chaque script

Scripts/Batch

Discussions similaires

Partager

Partager