AuditsCLI.EXE, l'outil Audits et Métriques en ligne de commande

De RAD Studio

Remonter à Utilitaires de ligne de commande - Index


AuditsCLI.EXE est l'outil Audits et Métriques en ligne de commande. Il exécute la version ligne de commande de Audits ou Métriques, selon que l'option --audits ou --metrics est spécifiée dans la ligne de commande.

Avertissement : Notez que AuditsCLI.EXE ne peut être utilisé que dans les projets Delphi.

Syntaxe de ligne de commande

Pour afficher l'aide de la ligne de commande, entrez :

C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\release.

Pour exécuter les audits, utilisez la ligne de commande :

C:\Program Files (x86)\Embarcadero\Studio\23.0\lib et C:\Program Files (x86)\Embarcadero\Studio\23.0\include.
[--config=AuditsConfigurationFile.ADT] [-o OutputFile] ProjectName.DPROJ

Pour exécuter les métriques, utilisez la ligne de commande :

C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1, spécifié par l'option de fichier projet.
[--config=MetricsConfigurationFile.MTS] [-o OutputFile] ProjectName.DPROJ

Options de la ligne de commande

Vous pouvez utiliser les options de ligne de commande suivantes :

Option Description

-h
--help

Une de ces options peut être spécifiée pour afficher l'aide courte dans la fenêtre console.

--audits
--metrics

Une de ces options doit être spécifiée.

  • audits -- Exécute l'analyse Audits.
  • metrics -- Exécute l'analyse Métriques.

--html
--xml

Une de ces options doit être spécifiée :

  • html -- Ecrit les résultats de l'analyse au format HTML.
  • xml -- Ecrit les résultats de l'analyse au format XML.

CompilerOptions

Spécifie des options associées au compilateur Delphi (voir DCC32.EXE, le compilateur en ligne de commande Delphi.) Vous pouvez utiliser les options suivantes :

  • -U<chemins> -- Cette option est obligatoire ! Elle définit les répertoires dans lesquels AuditsCLI.EXE recherchera les unités compilées. L'option a le format
-Uchemin1;chemin2.... Chaque chemin_N doit spécifier un répertoire qui peut contenir des unités compilées Delphi. Par exemple,
-U"C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\win32\debug";C:\MyUnits
  • -I<chemins> -- Définit les répertoires d'inclusion. L'option a le format
-Ichemin1;chemin2.... Chaque chemin_N doit spécifier un répertoire d'inclusion.
-Dsymbole1;symbole2.... Chaque symbole_N doit spécifier un symbole de compilation conditionnelle.
  • -A<unité>=<alias> -- Définit les alias des unités.

--config=ConfigurationFile

Spécifie le fichier stockant un ensemble d'audits ou de métriques à analyser. L'analyse activée ne traitera que les audits ou les métriques stockés dans cet ensemble.

  • Pour l'analyse Audits, l'option a le format
--config=AuditsConfigurationFile.ADT. AuditsConfigurationFile doit spécifier le fichier stockant l'ensemble d'audits à analyser. Le nom du fichier doit avoir l'extension .ADT.
  • Pour l'analyse Métriques, l'option a le format
--config=MetricsConfigurationFile.ADT. MetricsConfigurationFile doit spécifier le fichier stockant l'ensemble de métriques à analyser. Le nom du fichier doit avoir l'extension .MTS.

Les fichiers de configuration peuvent être créés depuis l'EDI. Utilisez les boîtes de dialogue Audits du contrôle qualité et Métriques du contrôle qualité pour personnaliser l'ensemble des audits actifs et l'ensemble des métriques actives. Utilisez ensuite le bouton Enregistrer l'ensemble d'audits ou Enregistrer l'ensemble de métriques de ces boîtes de dialogue pour enregistrer les ensembles personnalisés d'audits et de métriques dans les fichiers de configuration.

Si l'option config n'est pas spécifiée, l'outil Audits ou Métriques invoqué analysera des ensembles par défaut d'audits ou de métriques. Vous pouvez cocher ces ensembles par défaut dans l'EDI (voir la section Ensembles d'audits et de métriques actifs de la rubrique Fonctionnalités des audits et des métriques.)

-o OutputFile

OutputFile spécifie le dossier de sortie dans lequel AuditsCLI.EXE enregistrera les résultats d'analyse obtenus. Si vous utilisez un chemin relatif, tel que .\doc, ce chemin est relatif au répertoire racine du projet spécifié par l'option ProjectName.DPROJ. Par défaut, le nom du fichier de sortie ProjectName.[audits|metrics].[html|xml] (selon l'option spécifiée) est accepté. Vous pouvez utiliser facultativement un caractère espace entre -o et OutputFile.

ProjectName.DPROJ

Spécifie le fichier projet Delphi. Ce fichier doit avoir l'extension de nom de fichier .DPROJ. Il doit être créé depuis l'EDI.
Cette option est obligatoire !

Exemples de ligne de commande

L'exemple suivant illustre l'exécution de l'outil Métriques en ligne de commande :

AuditsCLI.exe --metrics --html^
--config="C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\MyMetrics.mts"^
-U"C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\release"^
-o "C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\QA\MyMetricsResults.html"^
"C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Ici :

  • L'option --html définit que les résultats des métriques seront générés au format HTML.
  • Le fichier MyMetrics.mts stocke l'ensemble des métriques à traiter. Ce fichier doit être créé au préalable dans la boîte de dialogue Métriques du contrôle qualité.
  • L'option -U définit que l'outil Métriques en ligne de commande recherchera les unités compilées dans le dossier
C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\release.
  • L'option -o définit que AuditsCLI.exe enregistrera les résultats de métriques générés dans le fichier MyMetricsResults.html.
  • Le fichier Project1.dproj doit être le fichier projet dont le code source est à analyser par l'outil Métriques en ligne de commande.


L'exemple suivant illustre l'exécution de l'outil Audits en ligne de commande :

AuditsCLI.exe --audits --html^
--config="C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\MyAudits.adt"^
-U"C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\release"^
-I"C:\Program Files (x86)\Embarcadero\Studio\23.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\23.0\include"^
-DDEBUG;DEVELOPERS;^
-o .\MyAuditsResults.html^
"C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Ici :

  • L'option -I définit que l'outil Audits en ligne de commande utilisera les répertoires d'inclusion
C:\Program Files (x86)\Embarcadero\Studio\23.0\lib and C:\Program Files (x86)\Embarcadero\Studio\23.0\include.
  • L'option -D définit que l'outil Audits en ligne de commande utilisera les symboles de compilation conditionnelle DEBUG et DEVELOPERS.
  • Le chemin relatif utilisé dans le fichier .\MyAuditsResults.html signifie que ce fichier doit être créé dans le répertoire racine du projet
C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1, spécifié par les options du fichier projet.

Rubriques

Voir aussi

Récupérée de « https://docwiki.embarcadero.com/RADStudio/Athens/f/index.php?title=AuditsCLI.EXE,_l%27outil_Audits_et_Métriques_en_ligne_de_commande&oldid=208976 »