20. Fonctions et variables ¶

La fonction Regex est utilisée pour analyser la réponse précédente (ou la valeur d'une variable) à l'aide de n'importe quelle expression régulière (fournie par l'utilisateur). La fonction renvoie la chaîne de modèle avec les valeurs variables renseignées.

Le __regexFunction peut également stocker des valeurs pour une utilisation future. Dans le sixième paramètre, vous pouvez spécifier un nom de référence. Après l'exécution de cette fonction, les mêmes valeurs peuvent être récupérées ultérieurement à l'aide de la syntaxe des valeurs définies par l'utilisateur. Par exemple, si vous saisissez " refName " comme sixième paramètre, vous pourrez utiliser :

• ${refName} pour faire référence au résultat calculé du deuxième paramètre ("Modèle pour la chaîne de remplacement") analysé par cette fonction
• ${refName_g0} pour faire référence à la correspondance entière analysée par cette fonction.
• ${refName_g1} pour faire référence au premier groupe analysé par cette fonction.
• ${refName_g#} pour faire référence au n ^ième groupe analysé par cette fonction.
• ${refName_matchNr} pour faire référence au nombre de groupes trouvés par cette fonction.

Le compteur génère un nouveau numéro à chaque appel, en commençant par 1 et en incrémentant de +1 à chaque fois. Le compteur peut être configuré pour séparer les valeurs de chaque utilisateur simulé ou pour utiliser le même compteur pour tous les utilisateurs. Si les valeurs de chaque utilisateur sont incrémentées séparément, cela revient à compter le nombre d'itérations dans le plan de test. Un compteur global revient à compter le nombre de fois que cette requête a été exécutée.

Le compteur utilise une variable entière pour contenir le décompte, qui a donc un maximum de 2 147 483 647.

Les instances de la fonction compteur sont complètement indépendantes. Le compteur global - " FALSE " - est maintenu séparément par chaque instance de compteur.

Plusieurs appels de fonction __counter dans la même itération n'incrémenteront pas davantage la valeur.
Si vous souhaitez avoir un décompte qui s'incrémente pour chaque échantillon, utilisez la fonction dans un préprocesseur tel que Paramètres utilisateur .

La fonction de numéro de thread renvoie simplement le numéro du thread en cours d'exécution. Ces numéros ne sont uniques que localement par rapport à leur groupe de threads, ce qui signifie que le thread n° 1 dans un groupe de threads est indiscernable du thread n° 1 dans un autre groupe de threads, du point de vue de cette fonction.

ctx.getThreadNum()

Il n'y a pas d'arguments pour cette fonction.

Exemple d'utilisation :

${__threadNum}

La fonction de nom de groupe de threads renvoie simplement le nom du groupe de threads en cours d'exécution.

Il n'y a pas d'arguments pour cette fonction.

Exemple d'utilisation :

${__threadGroupName}

La fonction intSum peut être utilisée pour calculer la somme de deux ou plusieurs valeurs entières.

La fonction longSum peut être utilisée pour calculer la somme de deux valeurs longues ou plus, utilisez-la au lieu de __intSum chaque fois que vous savez que vos valeurs ne seront pas dans l'intervalle -2147483648 à 2147483647.

La fonction StringFromFile peut être utilisée pour lire des chaînes à partir d'un fichier texte. Ceci est utile pour exécuter des tests qui nécessitent beaucoup de données variables. Par exemple, lors du test d'une application bancaire, des centaines ou des milliers de numéros de compte différents peuvent être nécessaires.

Voir également l' élément de test CSV Data Set Config qui peut être plus facile à utiliser. Cependant, cela ne prend actuellement pas en charge plusieurs fichiers d'entrée.

Chaque fois qu'il est appelé, il lit la ligne suivante du fichier. Tous les threads partagent la même instance, donc différents threads obtiendront des lignes différentes. Lorsque la fin du fichier est atteinte, il reprendra la lecture depuis le début, à moins que le nombre maximal de boucles n'ait été atteint. S'il existe plusieurs références à la fonction dans un script de test, chacune ouvrira le fichier indépendamment, même si les noms de fichiers sont identiques. [Si la valeur doit être réutilisée ailleurs, utilisez des noms de variable différents pour chaque appel de fonction.]

Si une erreur se produit lors de l'ouverture ou de la lecture du fichier, alors la fonction renvoie la chaîne " **ERR** "

La fonction machineName renvoie le nom d'hôte local. Ceci utilise la méthode Java InetAddress.getLocalHost() et la transmet à getHostName()

La fonction machineIP renvoie l'adresse IP locale. Ceci utilise la méthode Java InetAddress.getLocalHost() et la transmet à getHostAddress()

La fonction javaScript exécute un morceau de code JavaScript (pas Java !) et renvoie sa valeur

La fonction JMeter Javascript appelle un interpréteur JavaScript autonome. Javascript est utilisé comme langage de script, vous pouvez donc faire des calculs, etc.

Les variables suivantes sont mises à la disposition du script :

• log - le Logger pour la fonction
• ctx - Objet JMeterContext
• vars - objet JMeterVariables
• threadName - Chaîne contenant le nom du thread actuel
• sampler - objet Sampler actuel (le cas échéant)
• sampleResult - objet SampleResult précédent (le cas échéant)
• accessoires - objet JMeterProperties (classe java.util.Properties )

Rhinoscript permet l'accès aux méthodes statiques via son objet Packages. Voir la documentation sur les scripts Java . Par exemple on peut accéder aux méthodes statiques JMeterContextService ainsi : Java.type("org.apache.jmeter.threads.JMeterContextService").getTotalThreads()

La fonction random renvoie un nombre aléatoire qui se situe entre les valeurs min et max données.

La fonction RandomDate renvoie une date aléatoire comprise entre les valeurs de date de début et de date de fin données.

La fonction RandomString renvoie une chaîne aléatoire de longueur en utilisant les caractères dans les caractères à utiliser.

La fonction RandomFromMultipleVars renvoie une valeur aléatoire basée sur les valeurs de variables fournies par Source Variables .

• Extracteur de frontière
• Extracteur d'expressions régulières
• Extracteur de sélecteur CSS
• Extracteur JSON
• Extracteur XPath
• Extracteur XPath2

La fonction UUID renvoie un identifiant universel pseudo-aléatoire de type 4 (UUID).

La fonction CSVRead renvoie une chaîne depuis un fichier CSV (cf StringFromFile )

REMARQUE : JMeter prend en charge plusieurs noms de fichiers.

Dans la plupart des cas, le nouvel élément CSV Data Set Config est plus facile à utiliser.

Lorsqu'un nom de fichier est rencontré pour la première fois, le fichier est ouvert et lu dans un tableau interne. Si une ligne vide est détectée, elle est traitée comme une fin de fichier - cela permet d'utiliser des commentaires de fin.

Toutes les références ultérieures au même nom de fichier utilisent le même tableau interne. NB la casse du nom de fichier est importante pour la fonction, même si le système d'exploitation ne s'en soucie pas, donc CSVRead(abc.txt,0) et CSVRead(aBc.txt,0) feraient référence à des tableaux internes différents.

La fonction *ALIAS permet d'ouvrir plusieurs fois le même fichier et permet également des noms de fichiers plus courts.

Chaque thread a son propre pointeur interne vers sa ligne actuelle dans le tableau de fichiers. Lorsqu'un thread se réfère pour la première fois au fichier, il se verra attribuer la ligne libre suivante dans le tableau, de sorte que chaque thread accédera à une ligne différente de tous les autres threads. [Sauf s'il y a plus de threads qu'il n'y a de lignes dans le tableau.]

La fonction de propriété renvoie la valeur d'une propriété JMeter. Si la valeur de la propriété est introuvable et qu'aucune valeur par défaut n'a été fournie, elle renvoie le nom de la propriété. Lors de la fourniture d'une valeur par défaut, il n'est pas nécessaire de fournir un nom de fonction - le paramètre peut être défini sur null et il sera ignoré.

• ${__property(user.dir)} - valeur de retour de user.dir
• ${__property(user.dir,UDIR)} - renvoie la valeur de user.dir et enregistre dans UDIR
• ${__property(abcd,ABCD,atod)} - renvoie la valeur de la propriété abcd (ou " atod " si elle n'est pas définie) et l'enregistre dans ABCD
• ${__property(abcd,,atod)} - renvoie la valeur de la propriété abcd (ou " atod " si elle n'est pas définie) mais ne l'enregistre pas

Il s'agit d'une fonction de propriété simplifiée destinée à être utilisée avec des propriétés définies sur la ligne de commande. Contrairement à la fonction __property , il n'y a pas d'option pour enregistrer la valeur dans une variable, et si aucune valeur par défaut n'est fournie, elle est supposée être 1. La valeur 1 a été choisie car elle est valide pour les variables de test courantes telles que les boucles, nombre de threads, montée en puissance, etc.

Définissez la valeur de la propriété :

jmeter -Jgroup1.threads=7 -Jhostname1=www.realhost.edu

La fonction log enregistre un message et renvoie sa chaîne d'entrée

La fonction logn enregistre un message et renvoie la chaîne vide

La fonction BeanShell évalue le script qui lui est transmis et renvoie le résultat.

Pour plus de détails sur l'utilisation de BeanShell, veuillez consulter le site Web de BeanShell à l' adresse http://www.beanshell.org/

Une seule instance d'une fonction peut être appelée à partir de plusieurs threads. Cependant la méthode execute() de la fonction est synchronisée.

Si la propriété " beanshell.function.init " est définie, elle est transmise à l'interpréteur en tant que nom d'un fichier sourcé. Cela peut être utilisé pour définir des méthodes et des variables communes. Il existe un exemple de fichier init dans le répertoire bin : BeanShellFunction.bshrc .

Les variables suivantes sont définies avant l'exécution du script :

• log - le Logger pour la fonction BeanShell (*)
• ctx - Objet JMeterContext
• vars - objet JMeterVariables
• accessoires - objet JMeterProperties (classe java.util.Properties )
• threadName - le threadName (chaîne)
• Sampler - le Sampler actuel , le cas échéant
• SampleResult - le SampleResult actuel , le cas échéant

La fonction __groovy évalue les scripts Apache Groovy qui lui sont transmis et renvoie le résultat.

Si la propriété « groovy.utilities » est définie, elle sera chargée par le ScriptEngine. Cela peut être utilisé pour définir des méthodes et des variables communes. Il existe un exemple de fichier init dans le répertoire bin : utility.groovy .

Les variables suivantes sont définies avant l'exécution du script :

• log - le Logger pour la fonction groovy (*)
• ctx - Objet JMeterContext
• vars - objet JMeterVariables
• accessoires - objet JMeterProperties (classe java.util.Properties )
• threadName - le threadName (chaîne)
• sampler - le Sampler actuel , le cas échéant
• prev - le SampleResult précédent , le cas échéant
• OUT - System.out

(*) signifie que ceci est défini avant que le fichier init, le cas échéant, ne soit traité. D'autres variables varient d'une invocation à l'autre.

Par exemple , ne procédez pas comme suit :

${__groovy("${maVar}".substring(0\,2))}

Imaginez que la variable myVar change à chaque transaction, le Groovy ci-dessus ne peut pas être mis en cache car le script change à chaque fois.

À la place, procédez comme suit, qui peut être mis en cache :

${__groovy(vars.get("myVar").substring(0\,2))}

La fonction split divise la chaîne qui lui est transmise en fonction du délimiteur et renvoie la chaîne d'origine. Si des délimiteurs sont adjacents, " ? " est renvoyé comme valeur. Les chaînes fractionnées sont renvoyées dans les variables ${VAR_1} , ${VAR_2} etc. Le nombre de variables est renvoyé dans ${VAR_n} . Un délimiteur de fin est traité comme une variable manquante et " ? " est renvoyé. De plus, pour lui permettre de mieux fonctionner avec le contrôleur ForEach, __split supprime désormais la première variable inutilisée au cas où elle aurait été définie par un fractionnement précédent.

${__split(${VAR},VAR,|)}

La fonction XPath lit un fichier XML et correspond à XPath. Chaque fois que la fonction est appelée, la prochaine correspondance sera renvoyée. À la fin du fichier, il reviendra au début. Si aucun nœud ne correspond, la fonction renverra la chaîne vide et un message d'avertissement sera écrit dans le fichier journal JMeter.

${__XPath(/chemin/vers/build.xml, //cible/@nom)}

La fonction setProperty définit la valeur d'une propriété JMeter. La valeur de retour par défaut de la fonction est la chaîne vide, de sorte que l'appel de fonction peut être utilisé partout où les fonctions sont valides.

La valeur d'origine peut être renvoyée en réglant le 3ème paramètre facultatif ^sur " true ".

Les propriétés sont globales à JMeter, elles peuvent donc être utilisées pour communiquer entre les threads et les groupes de threads

La fonction time renvoie l'heure actuelle dans différents formats.

La fonction jexl renvoie le résultat de l'évaluation d'une expression Commons JEXL . Voir les liens ci-dessous pour plus d'informations sur les expressions JEXL.

La fonction __jexl2 utilise Commons JEXL 2

• Description de la syntaxe JEXL
• Exemples JEXL

La fonction jexl renvoie le résultat de l'évaluation d'une expression Commons JEXL . Voir les liens ci-dessous pour plus d'informations sur les expressions JEXL.

La fonction __jexl3 utilise Commons JEXL 3

• Description de la syntaxe JEXL
• Exemples JEXL

La fonction V (variable) renvoie le résultat de l'évaluation d'une expression de nom de variable. Cela peut être utilisé pour évaluer les références de variables imbriquées (qui ne sont actuellement pas prises en charge).

Par exemple, si l'on a les variables A1 , A2 et N = 1 :

• ${A1} - fonctionne bien
• ${A${N}} - ne fonctionne pas (référence de variable imbriquée)
• ${__V(A${N})} - fonctionne bien. A${N} devient A1 , et la fonction __V renvoie la valeur de A1

La fonction evalVar renvoie le résultat de l'évaluation d'une expression stockée dans une variable.

Cela permet de lire une chaîne à partir d'un fichier et de traiter toutes les références de variables qu'il contient. Par exemple, si la variable " requête " contient " select ${column} from ${table} " et " colonne " et " table " contiennent " nom " et " clients ", alors ${__evalVar(query)} sera évalué comme " sélectionner le nom des clients ".

La fonction eval renvoie le résultat de l'évaluation d'une expression de chaîne.

Cela permet d'interpoler les références de variable et de fonction dans une chaîne qui est stockée dans une variable. Par exemple, étant donné les variables suivantes :

• nom = Smith
• colonne = âge
• table = anniversaires
• SQL = sélectionnez ${column} à partir de ${table} où name='${name}'

Cela peut être utilisé en conjonction avec CSV Dataset, par exemple où les instructions SQL et les valeurs sont définies dans le fichier de données.

La fonction char renvoie le résultat de l'évaluation d'une liste de nombres sous forme de caractères Unicode. Voir aussi __unescape() , ci-dessous.

Cela permet d'ajouter des valeurs de caractères arbitraires dans les champs.

La fonction unescape renvoie le résultat de l'évaluation d'une chaîne Java échappée. Voir aussi __char() ci-dessus.

Cela permet d'ajouter des caractères à des champs qui sont autrement délicats (voire impossibles) à définir via l'interface graphique.

Fonction permettant de remplacer une chaîne contenant des échappements d'entités HTML par une chaîne contenant les caractères Unicode réels correspondant aux échappements. Prend en charge les entités HTML 4.0.

Par exemple, la chaîne

${__unescapeHtml(<Français>)}

Si une entité n'est pas reconnue, elle est laissée seule et insérée textuellement dans la chaîne de résultat. par exemple ${__unescapeHtml(>&zzzz;x)} renverra >&zzzz;x .

Utilise StringEscapeUtils#unescapeHtml(String) de Commons Lang.

Fonction qui échappe les caractères d'une chaîne à l'aide d'entités HTML. Prend en charge les entités HTML 4.0.

Par exemple,

${__escapeHtml("pain" & "beurre")}

Utilise StringEscapeUtils#escapeHtml(String) de Commons Lang.

Fonction pour décoder une chaîne application/x-www-form-urlencoded . Remarque : utilisez UTF-8 comme schéma de codage.

Par exemple, la chaîne

${__urldecode(Word+%22school%22+is+%22%C3%A9cole%22+in+french)}

Utilise la classe Java URLDecoder .

Fonction pour encoder une chaîne en une chaîne application/x-www-form-urlencoded .

Par exemple, la chaîne

${__urlencode(Word "school" est "école" en français)}

Utilise la classe Java URLEncoder .

La fonction FileToString peut être utilisée pour lire un fichier entier. Chaque fois qu'il est appelé, il lit le fichier entier.

Si une erreur se produit lors de l'ouverture ou de la lecture du fichier, alors la fonction renvoie la chaîne " **ERR** "

La fonction samplerName renvoie le nom (c'est-à-dire l'étiquette) de l'échantillonneur courant.

La fonction ne fonctionne pas dans les éléments Test qui n'ont pas d'échantillonneur associé. Par exemple, le plan de test. Les éléments de configuration n'ont pas non plus d'échantillonneur associé. Cependant, certains éléments de configuration sont référencés directement par les échantillonneurs, tels que le gestionnaire d'en-tête HTTP et le gestionnaire de cookies HTTP, et dans ce cas, les fonctions sont résolues dans le contexte de l'échantillonneur HTTP. Les pré-processeurs, post-processeurs et assertions ont toujours un échantillonneur associé.

Exemple:

${__samplerName()}

La fonction TestPlanName renvoie le nom du plan de test courant (peut être utilisée dans Inclure des plans pour connaître le nom du plan de test appelant).

Fonction qui échappe aux métacaractères ORO Regexp, c'est l'équivalent de \Q \E dans Java Regexp Engine.

Par exemple,

${__escapeOroRegexpChars([^"].+?,)}

Utilise Perl5Compiler#quotemeta(String) d'ORO.

Fonction qui échappe les caractères d'une chaîne à l'aide d'entités XML 1.0.

Par exemple,

${__escapeXml("pain" & 'beurre')}

Utilise StringEscapeUtils#escapeXml10(String) de Commons Lang.

La fonction timeShift renvoie une date dans le format donné avec le nombre spécifié de secondes, minutes, heures, jours ou mois ajoutés

La fonction digest renvoie une valeur cryptée dans l'algorithme de hachage spécifique avec le sel facultatif, les majuscules et le nom de la variable.

La fonction __dateTimeConvert convertit une date au format source en un format cible stockant éventuellement le résultat dans le nom de la variable.

La fonction __isPropDefined renvoie true si la propriété existe ou false sinon.

La fonction __isVarDefined renvoie true si la variable existe ou false sinon.

La fonction de changement de casse renvoie une valeur de chaîne dont la casse a été modifiée selon un mode spécifique. Le résultat peut éventuellement être enregistré dans une variable JMeter.

La fonction __StringToFile peut être utilisée pour écrire une chaîne dans un fichier. Chaque fois qu'il est appelé, il écrit une chaîne dans le fichier en l'ajoutant ou en l'écrasant.

La valeur de retour par défaut de la fonction est la chaîne vide