Úloha Ant problémů skenování API use scan

Účel

Tato úloha vyřeší skenování API use scan v profilu vzhledem k úrovni baseline. Hlásí odkazy na typy, metody a pole, které nyní v profilu chybějí.

Použití

Popis

Název úlohy Ant je: apitooling.apiusescanproblems. Chcete-li ji použít, soubor JAR apitooling-ant.jar musí být v cestě ke třídě nástroje Ant.

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

Parametry

Atribut Popis Nezbytné
profile Tento atribut určuje umístění aktuálního produktu nebo profilu, pro který chcete vyřešit skenování API use scan.

Může to být soubor .zip, .jar, .tgz, .tar.gz nebo adresář, který odpovídá instalačnímu adresáři Eclipse. To je adresář, v němž se nachází spustitelný soubor Eclipse.

Umístění se zadává pomocí absolutní cesty.
Ano
report Nastavte umístění výstupu, kam se vygenerují sestavy.

Po dokončení úlohy jsou v tomto adresáři k dispozici sestavy. Pro každou komponentu s problémy, které se mají hlásit, se vytvoří podsložka. Každá podsložka obsahuje soubor s názvem "report.xml".

Umístění se zadává pomocí absolutní cesty.
Ano
apiusescans Tento atribut určuje seznam umístění skenování API use scan oddělený čárkami, s jehož použitím chcete profil kontrolovat.

Může to být soubor .zip nebo adresář, který odpovídá sestavě skenování API use scan. To je adresář, v němž se nachází složka XML v procházení použití.
Ano
excludelist Nastavte umístění vylučovacího seznamu.

Umístění vylučovacího seznamu určuje textový soubor obsahující seznam balíků, které se mají vyloučit z analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Seznam zahrnutí naplní sadu balíků, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
  • Specifický název balíku.
  • Regulární výraz k porovnání s názvy balíků (řádky s "R:").
  • Komentář (řádky s '#').

Umístění se zadává pomocí absolutní cesty.
Následuje příklad vylučovacího seznamu:
 # 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\..*
 ...
Ne
includelist Nastavte umístění seznamu zahrnutí.

Umístění seznamu zahrnutí určuje textový soubor obsahující seznam balíků, které se mají zahrnout do analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Seznam zahrnutí naplní sadu balíků, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
  • Specifický název balíku.
  • Regulární výraz k porovnání s názvy balíků (řádky s "R:").
  • Komentář (řádky s '#').

Umístění se zadává pomocí absolutní cesty.
Následuje příklad seznamu zahrnutí:
 # 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\..*
 ...
Ne
preferences Nastavte předvolby úlohy.

Předvolby se používají k nakonfigurování závažností problémů. Závažnosti problémů mají tři možné hodnoty: ignorovat (Ignore), varování (Warning) nebo chyba (Error). Sada zjištěných problémů se definuje pomocí příslušných klíčů předvoleb problémů v nástrojích API.
Umístění se zadává pomocí absolutní cesty. Pokud zadané umístění neexistuje, předvolby se nenastaví.
Řádky začínající znakem '#' se ignorují. Formát souboru předvoleb vypadá takto:
 #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
Klíče se nacházejí v org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes.
Ne
debug Nastavte hodnotu ladění.

Možné hodnoty jsou: true, false
Výchozí hodnota je false.
Ne

Příklady

	<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"
	/>

Tím se spustí úloha, která vytvoří soubory report.xml ve složce D:\reports\xml. Typy, metody a pole z procházení použití budou vyřešeny v profilu v umístění D:\eclipse\3.7\eclipse, a ty které chybí, budou ohlášeny. Ke snížení počtu balíků, u kterých mají být hlášeny problémy, se použije vylučovací seznam ze souboru D:\exclude_list_external.txt.

Závažnosti problémů se budou generovat podle specifikace v D:\tests_api\org.eclipse.pde.api.tools.prefs.

Vzhledem k tomu, že je povoleno ladění, na konzole Ant se zobrazí určitá ladicí trasování.

Související odkazy

Úloha ANT analýzy API
Úloha Ant zmrazení API
Úloha Ant generování souboru
Úloha Ant použití API
Úloha Ant převodu sestavy analýzy
Úloha Ant převodu sestavy zmrazení API
Úloha Ant převodu sestavy využití API
Úloha Ant nepřípustnosti rozhraní API
Úloha Ant převodu sestavy nepřípustnosti rozhraní API