Tâche Ant Problème détecté par une analyse d'utilisation d'API

Objectif

Cette tâche résout les analyses d'utilisation d'API dans un profil relatif à une ligne de base. Elle signale les références aux types, méthodes et zones qui sont manquantes dans le profil.

Syntaxe

Description

Le nom de la tâche Ant est le suivant : apitooling.apiusescanproblems. Pour qu'il puisse être utilisé, le fichier jar apitooling-ant.jar doit figurer dans le chemin d'accès aux classes Ant.

<apitooling.apiusescanproblems
	profile="..."
	report="..."
	apiusescans="..."
	excludelist="..."
	includelist="..."
	preferences="..."
	debug="..."
/>

Paramètres

Attribut Description Obligatoire
profile Cet attribut définit l'emplacement du produit ou le profil par rapport auquel les analyses d'utilisation d'API doivent être résolues.

Il peut s'agir d'un fichier .zip, .jar, .tgz, .tar.gz ou d'un répertoire qui correspond au dossier d'installation Eclipse. Il s'agit du répertoire dans lequel se trouve l'exécutable Eclipse.

L'emplacement est défini en utilisant un chemin absolu.
Oui
report Définit l'emplacement dans lequel les rapports sont générés.

Une fois la tâche exécutée, les rapports sont disponibles dans ce répertoire. Un sous-dossier est créé pour chaque composant pour lequel des incidents doivent être signalés. Chaque sous-dossier contient un fichier "report.xml".

L'emplacement est spécifié en utilisant un chemin absolu.
Oui
apiusescans Cet attribut indique la liste séparée par des virgules des emplacements des analyses d'utilisation d'API dont vous souhaitez contrôler le profil.

Il peut s'agir d'un fichier .zip ou d'un répertoire qui correspond au rapport d'analyse d'utilisation d'API. Il s'agit du répertoire dans lequel se trouve le dossier XML dans l'analyse d'utilisation.
Oui
excludelist Définit l'emplacement de la liste d'exclusion.

L'emplacement de la liste d'exclusion indique les regroupements de fichier texte devant être exclus de l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'exclusion :
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Non
includelist Définit l'emplacement de la liste d'inclusion.

L'emplacement de la liste d'inclusion indique un fichier texte répertoriant les regroupements à inclure dans l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'inclusion :
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Non
preferences Définit les préférences de la tâche.

Les préférences permettent de configurer la gravité des incidents. Les incidents peuvent avoir les niveaux de gravité Ignorer, Avertissement ou Erreur. Le groupe d'incidents détectés est défini par les clés de référence d'incident correspondantes dans les utilitaires d'API.
L'emplacement est défini en utilisant un chemin absolu. Si l'emplacement fourni n'existe pas, les préférences ne sont pas définies.
Les lignes commençant par '#' sont ignorées. Le format du fichier des préférences se présente comme suit :
 #Thu Nov 20 17:35:06 EST 2008
 API_USE_SCAN_TYPE_SEVERITY=Error
 API_USE_SCAN_METHOD_SEVERITY=Error
 API_USE_SCAN_FIELD_SEVERITY=Error
Les clés se trouvent dans org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes.
Non
debug Définit la valeur de débogage.

Les valeurs possibles sont true et false
La valeur par défaut est false.
Non

Exemples

	<apitooling.apiusescanproblems
		profile="D:\eclipse\3.7\eclipse"
		report="D:\reports\xml"
		apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo"
		excludelist="D:\exclude_list_external.txt"
		preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs"
		debug="true"
	/>

Cet exemple permet d'exécuter la tâche en créant des fichiers report.xml dans le dossier D:\reports\xml. Les types, méthodes et zones issus des analyses d'utilisation seront résolus dans le profil dans le dossier D:\eclipse\3.7\eclipse et ceux qui manquent seront signalés. Il utilise la liste d'exclusion du fichier D:\exclude_list_external.txt pour réduire le nombre de regroupements pour lesquels des problèmes doivent être signalés.

La gravité des incidents est générée en fonction de ce qui est spécifié par D:\tests_api\org.eclipse.pde.api.tools.prefs.

Etant donné que le débogage est activé, un traçage de débogage apparaît dans la console Ant.

Référence connexe

Tâche Ant d'analyse d'API
Tâche Ant de gel d'API
Tâche Ant de génération de fichier
Tâche Ant d'utilisation d'API
Tâche Ant de conversion de rapport d'analyse
Tâche Ant de conversion de rapport de gel d'API
Tâche Ant de conversion de rapport d'utilisation d'API
Tâche Ant de dépréciation d'API
Tâche Ant de conversion de rapport de dépréciation d'API