API elemzés Ant feladat

Cél

Ez a feladat egy teljes API elemzést futtat egy API profilon egy adott alapsorhoz képest - az elemzés része az API használat, a bináris kompatibilitás és a köteg verziószámának érvényesítése. A profil egy fejlesztés alatt álló termék aktuális állapota. A profil bináris kompatibilitás összehasonlítása egy API alapsorral (általában a termék előző kiadásával) történik.

Az elemzés nem foglalja magában a @since címkék érvényesítését, mivel az összes ellenőrzés bináris osztályfájlokon kerül végrehajtásra (a forrás elemzése nélkül).

Használat

Leírás

Az Ant feladat neve: apitooling.analysis. A használatához az apitooling-ant.jar fájlnak szerepelnie kell az Ant osztályútvonalon.

<apitooling.analysis
	baseline="..."
	profile="..."
	report="..."
	filters="..."
	excludelist="..."
	includelist="..."
	preferences="..."
	debug="..."
	eefile="..."
/>

Paraméterek

Attribútum Leírás Kötelező
baseline Ez az attribútum adja meg a referencia alapsor helyét.

Ez lehet egy .zip, .jar, .tgz, .tar.gz fájl, vagy egy könyvtár, amely megfelel az Eclipse telepítési könyvtárnak. Ez az a könyvtár, ahol az Eclipse végrehajtható fájl található.

A helyet abszolút útvonalként kell megadni.
Igen
profile Ez az attribútum adja meg az aktuális termék vagy profil helyét, amelyet össze kíván hasonlítani a referencia alapsorral.

Ez lehet egy .zip, .jar, .tgz, .tar.gz fájl, vagy egy könyvtár, amely megfelel az Eclipse telepítési könyvtárnak. Ez az a könyvtár, ahol az Eclipse végrehajtható fájl található.

A helyet abszolút útvonalként kell megadni.
Igen
report Itt állíthatja be a kimeneti helyet, ahová a jelentések elő lesznek állítva.

A feladat befejeződése után a jelentések ebben a könyvtárban érhetők el, a szűrő gyökéréhez hasonló szerkezetben. Minden olyan komponenshez létrehozásra kerül egy almappa, amelynek jelentett problémái vannak. Minden almappa tartalmaz egy "report.xml" nevű fájlt.

A mappában létrejön egy "allNonApiBundles" nevű speciális mappa is, amely ugyancsak tartalmaz egy "report.xml" fájlt. A fájl felsorolja az összes olyan köteget, amelyek nem használják az API eszközök jelleget.

A jelentéskönyvtárban létrehozásra kerül egy "counts.xml" nevű fájl is, amely a talált problémák összegzését tartalmazza.

A helyet abszolút útvonalként kell megadni.
Igen
filters Itt állíthatja be az API szűrők elemzés során használandó gyökérkönyvtárát.

Az argumentum az .api_filters fájlok gyökérkönyvtára, amely az API eszközkészlet elemzése által létrehozott lehetséges problémák szűréséhez használható.
A gyökérkönyvtárat abszolút útvonalként kell megadni.
A gyökér a következő szerkezetet tartalmazza:
 root
  |
  +-- komponens neve (például org.eclipse.jface)
         |
         +--- .api_filters
Nem
excludelist Itt állíthatja be a kizárási lista helyét.

A kizárási lista helye egy szövegfájlt ad meg, amely az elemzésből kizárandó kötegek listáját tartalmazza. Alapértelmezésben a profilban lévő összes köteg elemezve lesz. A tartalmazási és kizárási lista attribútumok használatával egyenként megadhatja a tartalmazni és kizárni kívánt kötegeket. A tartalmazási lista adja meg az elemezni kívánt kötegek alap készletét (ha nincs megadva, akkor az összes köteg), és ezután kerül alkalmazásra a kizárási lista. A fájl minden sora a következők egyikét adja meg:
  • egy adott köteg neve
  • egy reguláris kifejezés a kötegnevek egyeztetéséhez (az "R:" kifejezéssel kezdődő sorok)
  • egy megjegyzés (a '#' karakterrel kezdődő sorok)

A helyet abszolút útvonalként kell megadni.
Íme egy példa a kizárási listára:
 # DOC CSOMAGOK
 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
 # NEM-ECLIPSE CSOMAGOK
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Nem
includelist Itt állíthatja be a tartalmazási lista helyét.

A tartalmazási lista helye egy szövegfájlt ad meg, amely az elemzésbe belefoglalni kívánt kötegek listáját tartalmazza. Alapértelmezésben a profilban lévő összes köteg elemezve lesz. A tartalmazási és kizárási lista attribútumok használatával egyenként megadhatja a tartalmazni és kizárni kívánt kötegeket. A tartalmazási lista adja meg az elemezni kívánt kötegek alap készletét (ha nincs megadva, akkor az összes köteg), és ezután kerül alkalmazásra a kizárási lista. A fájl minden sora a következők egyikét adja meg:
  • egy adott köteg neve
  • egy reguláris kifejezés a kötegnevek egyeztetéséhez (az "R:" kifejezéssel kezdődő sorok)
  • egy megjegyzés (a '#' karakterrel kezdődő sorok)

A helyet abszolút útvonalként kell megadni.
Íme egy példa a tartalmazási listára:
 # DOC CSOMAGOK
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # NEM-ECLIPSE CSOMAGOK
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Nem
preferences Itt adhatja meg a feladat beállításait.

A beállítások segítségével konfigurálható a problémák súlyossága. A problémák súlyossága három értéket vehet fel: Ignore (figyelmen kívül hagyás), Warning (figyelmeztetés) vagy Error (hiba). Az észlelt problémák meghatározása az API eszközökben lévő probléma beállítási kulcsoknak megfelelően történik.
A helyet abszolút útvonalként kell megadni. Ha a megadott hely nem létezik, akkor a beállítások nem lesznek konfigurálva.
A '#' karakterrel kezdődő sorok figyelmen kívül maradnak. A beállítási fájl formátuma az alábbihoz hasonló:
 #Thu Nov 20 17:35:06 EST 2008
 ANNOTATION_ELEMENT_TYPE_ADDED_METHOD_WITHOUT_DEFAULT_VALUE=Ignore
 ANNOTATION_ELEMENT_TYPE_CHANGED_TYPE_CONVERSION=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_FIELD=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_METHOD=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_TYPE_MEMBER=Warning
 API_COMPONENT_ELEMENT_TYPE_REMOVED_API_TYPE=Ignore
 API_COMPONENT_ELEMENT_TYPE_REMOVED_TYPE=Ignore
 CLASS_ELEMENT_TYPE_ADDED_METHOD=Error
 CLASS_ELEMENT_TYPE_ADDED_RESTRICTIONS=Ignore
 CLASS_ELEMENT_TYPE_ADDED_TYPE_PARAMETER=Ignore
 CLASS_ELEMENT_TYPE_CHANGED_CONTRACTED_SUPERINTERFACES_SET=Ignore
 ...
A kulcsok az org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes helyen találhatók.
Nem
debug Itt állíthatja be a hibakeresési értéket.

Lehetséges értékek: true vagy false
Az alapértelmezett érték a false.
Nem
eefile Beállíthatja a használandó végrehajtási környezet fájlt.

Alapértelmezésben a JavaSE-1.6 végrehajtási környezetnek megfelelő végrehajtási környezet fájl kerül felhasználásra.

A fájl formátumának leírását ez a wiki oldal tartalmazza.

A fájlt abszolút útvonallal kell megadni.
Nem

Példák

	<apitooling.analysis
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\reports\xml"
		filters="D:\filters"
		excludelist="D:\exclude_list_external.txt"
		preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs"
		debug="true"
	/>

Ez lefuttatja a feladatot és létrehozza a report.xml fájlokat a D:\reports\xml mappában. A jelentendő problémák számának csökkentése érdekében felhasználja a kizárási listát és az .api_filter fájlokat, amelyek a D:\exclude_list_external.txt és D:\filters helyeken találhatók.

A problémák súlyossága a D:\tests_api\org.eclipse.pde.api.tools.prefs helyen megadottaknak megfelelően lesz előállítva.

Mivel engedélyezve van a hibakeresés, az Ant konzolon hibakeresési nyomkövetési információk is megjelennek.

Kapcsolódó leírások

API befagyasztás Ant feladat
Fájl előállítása Ant feladat
API használat Ant feladat
Elemzési jelentés átalakítása Ant feladat
API befagyasztási jelentés átalakítása Ant feladat
API használat jelentés átalakítása Ant feladat
API elavulás Ant feladat
API elavulás jelentés átalakítása Ant feladat