Integration von Bugtracking- und Versionsverwaltungssystem

Transkript

1 Integration von Bugtracking- und Versionsverwaltungssystem Handbuch fuer Entwickler 1

2 Inhaltverzeichnis 1. Ausgangslage Ziel Design Model Architektur Pakete von Subclipse Plugins Datenbank Schema Neue Java Dateien in der zugehoerigen Paketen hinzufuegen Fragment bei der Integration zu veraendern Verpackung der Plugins Angaben

3 1. Ausgangslage 1.1 Einfuehrung : Versionsverwaltungssystem : Eine Versionsverwaltung (en. Version Control) ist eine Kombination verschiedener Technologien und Verfahren um Änderung an den Dateien eines Projekts, insbesondere Quellcode, Dokumentation und Webseiten, zu verfolgen und verwalten. Besonders im Vordergrund steht dabei der Mehrbenutzerbetrieb, be idem mehrere Benutzer gleichzeitig an den selben Quelltexten arbeiten koennen. Das Versionsverwaltungssystem bietet dabei Techniken, um parallel erfolgte Aenderungen zusammenzufuehren, oder die Arbeit durch sogenannte Sperren zu koordinieren. z.b: CVS, Subversion, usw. Subclipse v

4 Bug-Tracking-System : Ein Bug-Tracking-System wird verwendet, um Programmfehler und Veraenderungswuesche zentral zu erfassen und deren Behebung zu koordinieren. Die gesammelten Fehler und deren Bearbeitung koennen von jedem eingesehen werden. Beispielsweise entdecket ein Benutzer beim ausfuehren eines Programms einen Fehler. Daraufhin kann er einen Eintrag im Bug-Tracking-System anlagern. Die Programmentwickler koennen nun entscheiden wie Sie mit dieser Meldung umgehen. z.b: Bugzilla, Trac, TestTrack,usw. Trac v0.9.3 Heutezutag fast bei aller Softwareentwicklungen benutzt man den Versionsverwaltungssystem und Bugtrackingsystem gleichzeitig zusammen. Es gibt Abhaengigkeit zwichen einem Versionsverwaltungssystem und Bug-Tracking-System. Typischerweise,wenn man eine Fehler in der Quelldatei behoben hat, die unter der Versionsverwaltungssystem steht, muss man noch einen Eintrag ueber dieser bestimmte Fehler ins Bug-Tracking-System hinzufuegen. Jedes Mal muss eine synchronisation von Status unter beiden System bleiben. 4

5 2. Ziel Bei userer Entwicklung benutzen wir Trac als voreingestellte Bug-Tracking-System und Subclipse (eine subversion Plugins von Eclipse) als einen Cleint Software zur Kommunikation mit Versionsverwaltungssystem Wie vorher erwaeht, aber manchmal aus welchem Grund hat man in der Praxis die information der Quelltextaenderung verloren. Oder manchmal wenn die Veraenderungen im Trac nicht rechtzeitig aktuellisiert, wird die Einheitlichkeit zwischen der beiden Systeme abbrechen. Es bewirkt Selbstverstaendlich Irrtums. Bild 2.1 Schnittstellen von integriete Plugins aus Subclipse und Trac Nach der Integration kann man sowohl durch Subclipse GUI mit Subversion Server Interaktion machen,als auch durch die eingebaute Trac Gui die verschiedene Operation von Trac Website simulieren. Damit haben wir eine zusaetzliche Auswahl,das heissst, fuer die selben Arbeit man kann wie vorher getrennt machen, zuerst Die Dateien aus der Server checkout, in der Server commit, usw. Dann durch Trac Website einen neuen Ticket eintragen oder den Status eines bestimmten Ticket veraendern. Oder kann man durch die neue Plugins die zwei verschiedene Operation gleichtzeitig machen, und den Status der beiden Server gleichzeitig aktualisieren. 5

6 3. Design Model Bild 3.1 MVC Modelle von Trac GUI Bild 3.2 DAO in Model Schicht 6

7 4. Architektur 4.1 Pakete von Subclipse Plugins : Bild 4.1 Repository Path Jar or Eclipse Plug-in Name Beschreibung trunk/subclipse/clientadapter trunk/subclipse/clientadapter.javahl trunk/subclipse/clientadapter.javahl. win32 trunk/subclipse/core org.tigris.subversion.clientadapter org.tigris.subversion.clientadapter.javahl org.tigris.subversion.clientadapter.javahl.win32 org.tigris.subversion.subclipse.core Adapter, und native Platform Library Eclipse-specific plug-in backend trunk/subclipse/ui org.tigris.subversion.subclipse.ui Eclipse-specific UI trunk/subclipse/doc org.tigris.subversion.subclipse.doc Plugins dokument Bild 4.2 Es gibt insgesammt sechs pakete zur Darstellung der Subclipse Plugins Wir erweitern org.tigris.subversion.subclipse.ui Paket, um eine Integration von Subclipse Plugins und Trac Cleint Gui zu realisieren. 7

8 4.2 Datenbank Schema : Um weiter zu entwickeln braucht man nur folgende Tablle : Bild 4.3 Tabelle ticket speichert alle Informationen ueber die Eintraege im Trac,und TicketOperation.java ist eine Abstraktion von dieser Tabelle. 8

9 Bild 4.4 Tabelle ticket_change speichert alle Informationen ueber die Veraenderungen der Eintraege im Trac. TicketMidfyOperation.java ist eine Abstraktion von dieser Tabelle. component : speichert alle Informationen der Attributte component. milestone : speichert alle Informationen der Attributte milestone. version : speichert alle Informationen der Attributte version. enum : speichert alle Informationen der Attributten priority, resolution, status, ticket_type. z.b: Wieviele Typen von Priority gibt es fuer jeden Ticket im Trac? 9

10 4.3 Neue Java Dateien in der zugehoerigen Paketen hinzufuegen : org.tigris.subversion.subclipse.ui.dialogs : BugTrackDialog.java AddTicketDialog.java ChangeTicketDialog.java org.tigris.subversion.subclipse.ui.operations : DBOperation.java ResultSetOperation.java org.tigris.subversion.subclipse.ui.tracmodel Ticket.java TicketModify.java TicketProperty.java CommandList.java Und die Beziehung zwischen der Dateien ist wie folgends bezeichnet : Bild

11 4.4 Fragment bei der Integration zu veraendern : Schritt 1: Initiierung der notwendige Objekten in CommitAction.java (DBOperation,CommandList) Bild 4.6 Schritt 2 : neue CommitDialog Object zu erzeugen. Bild

12 Schritt 3: die excute Methode zu veraendern Bild

13 Schritt 4 : die neue Funktion updatebugtracksystem hinzufuegen Bild Verpackung der Plugins : Um das Programm mit der Datenbank zu verbinden,muss man noch eine gueltige JDBC Treiben benutzen und ins Paket einzusetzen. Naechste Inhalt zeigt, wie die Mysql Treiber (mysql-connector-java-5.0.5) integriert wird. Schritt 1 : eine neue Verzeichniss lib unter org.tigris.subversion.subclipse.ui erstellen. Schritt 2 : Class File von JDBC Treiber ins Verzeichniss lib einzusetzen. 13

14 Schritt 3 : Plugins.xml unter der verzeichnis org.tigris.subversion.subclipse.ui zu erweitern,und Verzeichniss lib unter Binary Build in Build Page zu markieren. Blid 4.10 Schritt 4 : auch in Plugin.xml die Verzeichniss lib ins Classpath hinzufuegen. Schritt 5 : Durch die Kommand File -> Export -> Deployable Plug-ins and Fragments um alle Subclipse Source Pakete zu verpacken. 14

15 Bild

16 5. Angabe : Die Vergleichung zwieschen diesen Programm und der Trac-web. 1. In der Trac-web: kann man in der Chang a ticket die Anhange hochladen, in diesen Programm kann es leide nicht benutzt werden. 2. In der Trac-web: kann man Comment einfuehren. Wegen die Comment n icht in der Datenbank gespeichert werden,kann die in diesen Programm n icht eintragt werden. 3. In der BugTrackDialog.java, der unter der Verzeicheniss org.tigris.subversion.subolipse.ui.dialogs ist, kann man die Field count nach der Bedarf neu definieren. (count definiert die Anzahl der Tickets pro Seit im Tabelle) 4. In der DBOpertation.java, der unter der Verzeicheniss org.tigris.subversion.subolipse.ui.opertions ist, kann man die Field DBDriver und url nach der Bedarf neu definitionen. (DBDriver definiert die Klasse der Datenbanke-Treiber, Und url definiert der Ablageplatz von Trac-datenbank) Software kann man in folgende Website unterladen : 1. Eclipse IDE : 2. Subclipse Plugins : 3. Die Mysql JDBC Treiber: 16

17 Integriertes Bugtracking- und Versionsverwaltungssystem Integration von Bugtrackingund Versionsverwaltungssystem User Manual 1

18 Integriertes Bugtracking- und Versionsverwaltungssystem Inhaltverzeichnis 1. Ausgangslage 1 2. Ziel 2 3. Bedienungshinweise Bemerkungen.13 2

19 Integriertes Bugtracking- und Versionsverwaltungssystem 1. Ausgangslage 1.1 Einfuehrung : Versionsverwaltungssystem : Eine Versionsverwaltung (en. Version Control) ist eine Kombination verschiedener Technologien und Verfahren um Änderung an den Dateien eines Projekts, insbesondere Quellcode, Dokumentation und Webseiten, zu verfolgen und verwalten. Besonders im Vordergrund steht dabei der Mehrbenutzerbetrieb, beidem mehrere Benutzere gleichzeitig an den selben Quelltexten arbeiten koennen. Das Versionsverwaltungssystem bietet dabei Techniken, um parallel erfolgte Aenderungen zusammenzufuehren, oder die Arbeit durch sogenannte Sperren zu koordinieren. z.b: CVS, Subversion, usw. Subclipse v

20 Integriertes Bugtracking- und Versionsverwaltungssystem Bug-Tracking-System : Ein Bug-Tracking-System wird verwendet, um Programmfehler und Veraenderungswuesche zentral zu erfassen und deren Behebung zu koordinieren. Die gesammelten Fehler und deren Bearbeitung koennen von jedem eingesehen werden. Beispielsweise entdecket ein Benutzer beim ausfuehren eines Programms einen Fehler. Daraufhin kann er einen Eintrag im Bug-Tracking-System anlagen. Die Programmentwickler koennen nun entscheiden wie Sie mit dieser Meldung umgehen. z.b: Bugzilla, Trac, TestTrack,usw. Track v0.9.3 Heutezutag fast bei aller Softwareentwicklungen benutzt man den Versionsverwaltungssystem und Bugtrackingsystem gleichzeitig zusammen. Es gibt Abhaengigkeit zwichen einem Versionsverwaltungssystem und Bug-Tracking-System. Typischerweise,wenn man eine Fehler in der Quelldatei behoben hat, die unter der Versionsverwaltungssystem steht, muss man noch einen Eintrag ueber dieser bestimmte Fehler ins Bug-Tracking-System hinzufuegen. Jedes Mal muss eine synchronization von Status unter beiden System bleiben. 4

21 Integriertes Bugtracking- und Versionsverwaltungssystem 2. Ziel Bei userer Entwicklung benutzen wir Trac als voreingestellte Bug-Tracking-System und Subclipse (eine subversion Plugins von Eclipse) als einen Cleint Software zur Communikation mit Versionsverwaltungssystem. Wie vorher erwaeht, aber manchmal aus welchem Grund hat man in der Praxis die information der Quelltextaenderung verloren. Wenn die Veraenderungen im Trac nicht rechtzeitig aktuellisiert, kann das Einheitlichkeit zwichen der beiden System abbrechen. Das fuehrt natuerlich eine Fehler zu. 5

22 Integriertes Bugtracking- und Versionsverwaltungssystem 3. Bedienungshinweise 3.1 Programm starten Abbildung 1 Start: Software Eclipse oeffnen, Team -> Commit.. Wenn man Sync with Bugtrackingsystem auswaehlt hat, kann ein Fenster ausspringen und dadurch kann man mit der Datenbank von Bug-Tracking-System verbinden, um einen neuen Ticket hinzufuegen oder den Status von einem bestimmten Ticket zu veraendern. 6

23 Integriertes Bugtracking- und Versionsverwaltungssystem 3.2 Log in and View Tickets Abbildung 2 Um mit Bug-Tracking-System erfolglich anzuschließen, muss man Username und Password richtig eintippen, dann Klick Log in. Falls Sie schoen angemeldet haben, wird ein Tip Status: log in Successful unter der TextField von Password angezeigt. Zu Abmelden, klick Sie Log out. Type, Priority, Milestone, Version, Component sind die Attributen der Tickets, die man auswaehlen kann. Die voreingestellte Werte warden nach der Verbindungmit Bug-Tracking-System initialisiert. 7

24 Integriertes Bugtracking- und Versionsverwaltungssystem Wenn die Button Filter the Tickets ausgewaehlt wird,sind die Drop-Down List fuer Type, Priority, Milestone, Version, Component aktiviert. Durch diese Komponenten kann man die Abfragsbegrenzung definieren. Um eine neue Ticket zu addieren, klick verarbeiten, klick Change Ticket. Add new Tickets. Um die schoen gespeicherte Ticket zu List all Tickets listet alle in der Datenbank gespeicherte Ticket aus. Z.B, hier haben wir alle Ticktes ausgelistet.(abbildung 3), Diese Funktion ist eine Simulation von der Trac-Web. (Abbildung 4) Abbildung 3 8

25 Integriertes Bugtracking- und Versionsverwaltungssystem Abbildung 4 Wenn die Action ( Add new Tickets oder Change Tickets ) durchgefuehlt werden, kommt eine Bemerkung des Actions im Bereich The information of your manipulation. Nach der Ueberpruefung koennen Sie Accept klicken. Abort verzicht die nicht gespeicherte Verarbeitung. 9

26 Integriertes Bugtracking- und Versionsverwaltungssystem 3.3 Add a new Ticket In der BugtracDialog,klick Add new Ticket, entsteht die folgende Dialog. Abbildung 5 Diese Aktion ist so wie die Schritte (Abbildung 6) in der Trac-Web gezeigt. Abbildung 6 10

27 Integriertes Bugtracking- und Versionsverwaltungssystem In Full Description fuehrt man die Beschreibung des neuen Tickets ein. Summary kann nicht leer sein und darin eine kurze Beschreibung eingeben. Type, Prionrity, Milestione, Component, Version, Keywords, Assign to, Cc kann man sich selbst veraenderen. Um die neue Ticket zu speichern, klick OK. Sonst klick Cancel. 11

28 Integriertes Bugtracking- und Versionsverwaltungssystem 3.4 Change a Ticket Wenn Sie einen Ticket verarbeiten moechten, waehlen Sie die Ticket in der Liste des BugTracDialogs aus, dann klicken Change Ticket, dann entsteht die folgende Dialog (Abbildung 7). Die ausgewaehlt Ticket bezeichnet das Programm mit Rot-Gelb Farbe. Diese Aktion ist analog mit Add/Change in der Trac-Web,wie Abbildung 8 gezeigt. Abbildung 5 12

29 Integriertes Bugtracking- und Versionsverwaltungssystem Abbildung 8 Alle Komponente sind mit der aktuellen Werte der Ticket angezeigt. Um die Veraenderung zu speichern, klick OK,sonst klick Cancel. Bemerkungen Ticket Fields: 1. Ticket enthalt die folgende Attribute: * Reporter - The author of the ticket. * Type - The nature of the ticket (for example, defect or enhancement request) * Component - The project module or subsystem this ticket concerns. * Version - Version of the project that this ticket pertains to. *Keywords - Keywords that a ticket is marked with. Useful for searching and report generation. * Priority - The importance of this issue, ranging from trivial to blocker. * Milestone - When this issue should be resolved at the latest. * Assigned to/owner - Principal person responsible for handling the issue. * Cc - A list of other associated people. Note that this does not imply responsibility or any other policy. * Resolution - Reason for why a ticket was closed. One of fixed, invalid, wontfix, duplicate, worksforme. * Status - What is the current status? One of new, assigned, closed, reopened. * Summary - A brief description summarizing the problem or issue. * Description - The body of the ticket. A good description should be specific, descriptive and to the point. 2. In der Trac-web kann man in der Chang a ticket die Anhange hochladen, aber in diesen Programm kann es leide nicht benutzt werden. 3. In der Trac-web: kann man Comment einfuehren. Wegen die Comment n icht in der Datenbank gespeichert werden,kann die in diesen Programm n icht eintragt werden. 13