Εργασία Ant για τα προβλήματα ανίχνευσης χρήσης API

Σκοπός

Αυτή η εργασία αναλύει τις ανιχνεύσεις χρήσης ΑΡΙ σε ένα προφίλ που σχετίζεται με τη γραμμή βάσης. Αναφέρει τις παραπομπές προς είδη, μεθόδους και πεδία τα οποία λείπουν από το προφίλ.

Χρήση

Περιγραφή

Το όνομα της εργασίας Ant είναι: apitooling.apiusescanproblems Προκειμένου να χρησιμοποιηθεί, το αρχείο jar apitooling-ant.jar πρέπει να βρίσκεται στην ίδια διαδρομή κλάσεων Ant.

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

Παράμετροι

Γνώρισμα Περιγραφή Απαιτείται
profile Αυτό το γνώρισμα καθορίζει τη θέση του τρέχοντος προϊόντος ή προφίλ με βάση το οποίο θα γίνει η ανάλυση των ανιχνεύσεων χρήσης ΑΡΙ.

Μπορεί να είναι αρχείο .zip, .jar, .tgz, .tar.gz ή ένας κατάλογος που αντιστοιχεί στο φάκελο εγκατάστασης του Eclipse. Αυτός είναι ο κατάλογος στον οποίο υπάρχει το Eclipse ως εκτελέσιμο αρχείο.

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ναι
report Ορίστε τη θέση εξόδου όπου θα δημιουργηθούν οι αναφορές.

Μετά την ολοκλήρωση της εργασίας, οι αναφορές είναι διαθέσιμες σε αυτόν τον κατάλογο. Δημιουργείται ένας υποφάκελος για κάθε στοιχείο που παρουσιάζει προβλήματα προς αναφορά. Κάθε υποφάκελος περιέχει ένα αρχείο με το όνομα "report.xml".

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ναι
apiusescans Αυτό το γνώρισμα καθορίζει τη λίστα θέσεων (διαχωρισμένων με κόμματα) των ανιχνεύσεων χρήσης ΑΡΙ που θέλετε να ελεγχθούν με βάση το προφίλ.

Μπορεί να είναι ένα αρχείο .zip ή ένας κατάλογος που αντιστοιχεί στην αναφορά ανίχνευσης χρήσης API. Αυτός είναι ο κατάλογος στον οποίο υπάρχει ο φάκελος XML της ανίχνευσης χρήσης.
Ναι
excludelist Ορίστε τη θέση της λίστας εξαιρέσεων.

Η θέση της λίστας εξαιρέσεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα εξαιρεθούν από την ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
  • ένα όνομα δέσμης
  • μια κανονική έκφραση για την αναζήτηση ονομάτων δεσμών (γραμμές που αρχίζουν με "R:")
  • ένα σχόλιο (γραμμές που αρχίζουν με '#')

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας εξαιρέσεων:
 # ΔΕΣΜΕΣ DOC
 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
 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Όχι
includelist Ορίζει τη θέση της λίστας συμπεριλήψεων.

Η θέση της λίστας συμπεριλήψεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα συμπεριληφθούν στην ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
  • ένα όνομα δέσμης
  • μια κανονική έκφραση για την αναζήτηση ονομάτων δεσμών (γραμμές που αρχίζουν με "R:")
  • ένα σχόλιο (γραμμές που αρχίζουν με '#')

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας συμπεριλήψεων:
 # ΔΕΣΜΕΣ DOC
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Όχι
preferences Ορίστε τις προτιμήσεις για την εργασία.

Οι προτιμήσεις χρησιμοποιούνται για τη ρύθμιση της σοβαρότητας των προβλημάτων. Στη σοβαρότητα των προβλημάτων μπορούν να αποδοθούν τρεις πιθανές τιμές: Παράβλεψη, Προειδοποίηση ή Σφάλμα. Το σύνολο των προβλημάτων που έχει εντοπιστεί, καθορίζεται από τα αντίστοιχα κλειδιά προτιμήσεων προβλημάτων στα εργαλεία API.
Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής. Εάν η συγκεκριμένη θέση δεν υπάρχει, δεν θα γίνει ορισμός των προτιμήσεων.
Οι γραμμές που ξεκινούν με το χαρακτήρα '#' παραβλέπονται. Το αρχείο προτιμήσεων έχει την ακόλουθη μορφή:
 #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
Τα κλειδιά βρίσκονται στο αρχείο org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes.
Όχι
debug Ορίστε την τιμή για τον εντοπισμό και τη διόρθωση σφαλμάτων.

Οι πιθανές τιμές είναι: true, false
Η προεπιλεγμένη τιμή είναι false.
Όχι

Παραδείγματα

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

Εκτελεί την εργασία που δημιουργεί τα αρχεία report.xml στο φάκελο D:\reports\xml. Τα είδη, οι μέθοδοι και τα πεδία από τις ανιχνεύσεις χρήσης θα αναλυθούν στο προφίλ στη θέση D:\eclipse\3.7\eclipse ενώ θα αναφερθούν τα στοιχεία που λείπουν. Θα χρησιμοποιήσει η λίστα εξαιρέσεων από το αρχείο D:\exclude_list_external.txt για τη μείωση του αριθμού δεσμών για τις οποίες θα γίνεται αναφορά προβλημάτων.

Η σοβαρότητα των προβλημάτων θα δημιουργηθεί όπως ορίζεται από το αρχείο D:\tests_api\org.eclipse.pde.api.tools.prefs.

Εφόσον έχει ενεργοποιηθεί ο εντοπισμός και η διόρθωση σφαλμάτων, θα εμφανιστεί κάποια ρουτίνα ιχνηλασίας εντοπισμού και διόρθωσης σφαλμάτων στην κονσόλα Ant.

Σχετικές παραπομπές

Εργασία Ant ανάλυσης API
Εργασία Ant αναστολής API
Εργασία Ant δημιουργίας αρχείων
Εργασία Ant χρήσης API
Εργασία Ant μετατροπής αναφορών ανάλυσης
Εργασία Ant μετατροπής αναφορών αναστολής API
Εργασία Ant μετατροπής αναφορών χρήσης API
Εργασία Ant κατάργησης ΑΡΙ
Εργασία Ant μετατροπής αναφορών κατάργησης API