antlogger SCMP Software Engineering Projekt Patrick Bründler, Pascal Mengelt, Andy Wyss, Fabian Heusser Dozent: Jörg Hofstetter

Transkript

1 FHZ > FACHHOCHSCHULE ZENTRALSCHWEIZ HTA > HOCHSCHULE FÜR TECHNIK+ARCHITEKTUR LUZERN Abteilung Informatik- >Software Engineering- >Projekt AntLogger Software Engineering Projekt antlogger SCMP Patrick Bründler, Pascal Mengelt, Andy Wyss, Fabian Heusser Dozent: Jörg Hofstetter HTA LUZERN Technikumstrasse 21 CH 6048 Horw T: F: W:

2 History Nr Datum Name Beschreibung heu Initial version heu Bereit für Revew heu Methoden Kommentar für JAVA Files Ergänzt unter Punkt Anhang B heu Korrekturen Nach Review Genehmigung: Patrick Bründler Fabian Heusser Pascal Mengelt Andy Wyss Datum: Datum: Datum: Datum: Seite 2

3 Das Inhaltsverzeichnis ist an den IEEE Standard angelehnt. 1. Einführung Dieser Software Configuration Management Plan (SCMP) beschreibt wie die elektronischen Erzeugnisse für den JAVA-Logger antlogger Verwaltet werden. 1.1 Abkürzungen CI: CM: SCMP: IDE: configuration item Eine Dokument das vom Configuration System erfasst wird configuration management Der Prozess die Verschiedenen Version des Projekts zu Verwalten. Der Software Configuration Management Plan (Dieses Dokument) Integrated Development Environment; zum Beispiel JBuilder; Forte for JAVA 1.2 Begriffe Artefact: Ein Produkt des Projektes zum Beispiel ein Dokument, Source Code, Object Code, Test Resultate 2. SCM Management 2.1 Organisation Ein speziell bestimmter Entwickler übernimmt die Rolle des Configuration Leaders für die Dauer des Projektes. 2.2 SCM Verantwortlichkeiten Configuration Leader Der Configuration Leader ist für die Organisation und die Verwaltung des Configuration Management (CM) verantwortlich. Wenn möglich sollten CM Pläne mit dem Entwicklungsteam diskutiert und festgehalten werden bevor die Implementation stattfindet. Er oder sie wird dieses Dokument warten (das SCMP) und ist auch für die Installation und die Wartung des CM-Tool (siehe 2.3) verantwortlich. Er ist für Backups der notwendigen Daten verantwortlich (auch 2.3). Weiter ist der Configuration Leader für die Aufgaben unter den Punkten 3.3, 3.4, 3.5, und 3.6 verantwortlich Project Leader Der Project Leader ist stellvertretender Configuration Leader und übernimmt nur in Ausnahmefällen die Funktion des Configuration Leaders. Er muss alle Abläufe mit dem CM-Tool kennen und wissen wie auf die Dokumente zugegriffen werden kann. Er sollte sich auch versichern, dass die Backups wie unter Punkt 2.3 beschrieben durchgeführt werden. Der Projekt Leader ist zusätzlich auch für die Punkte 3.3 und 3.4 Verantwortlich Entwickler Es liegt in der Verantwortung jedes Entwicklers die CM Regeln einzuhalten, welche der Configuration Leader publiziert. Weiter Verantwortlichkeiten finden sich unter Punkt 3. Seite 3

4 2.3 Massgebliche Richtlinien 1. Alle Versionen von CIs werden beibehalten. (Sobald CVS aktiv). 2. Das antlogger Projekt wird als Configurations Management Tool eine Standard CVS Umgebung einsetzen. Als Server dient der IServer. Clients können WinCVS sein oder eingebettete wie zum Beispiel Together. Das CVS-Root ist (Siehe Anhang A) 3. 2x in der Woche ist ein volles Backup der Projekt Daten, hauptsächlich dem CVS Repository, auf einen Speicher ausserhalb des Ortes des IServers zu machen. 3. SCM Aktivitäten 3.1 Identifikation der Konfiguration Identifikation von CIs Das hinzufügen von neuen Dokumenten zum CVS-Repository untersteht jedem einzelnen Entwickler. Es sollten jedoch nur zwingend nötige Dokumente Eingecheckt werden. So zum Beispiel nur Sourcecode und keine Projekt Daten des IDE oder class files Benennung von CIs Die Dateien sollten nach den folgenden Richtlinien benannt werden. Root directory: antlogger Subdirectory: doc für Dokumente oder source nur für Quellcode inkl. Paketstruktur Dateiname: NAME.ENDUNG Zum Beispiel ein SRS kommt in /antlogger/doc/srs.doc zu liegen. ch.hta.fhz.antlogger.antlogger kommt ins Verzeichnis /antlogger/source/ch/hta/fhz/antlogger/antlogger.java Da JAVA Files nicht mit verschiedenen Namen und Versionen versehen werden können, sehen wir den unter Anhang B aufgeführten Header-Kommentar am Anfang jedes JAVA Files vor Holen der CIs Entwickler welche Sourcecode CIs zum Modifizieren benötigen checken diese mit Hilfe des CVS Tools aus. Dies funktioniert Typischerweise so, dass vor Arbeitsbeginn die neuste Version des ganzen Repository geholt wird (update) und danach die zu ändernden Dateien zum ändern Markiert werden. Nach dem Bearbeiten werden die Änderungen mit der Funktion commit wieder dem Repository zugeführt. Entwickler welche Dokumente im Word2000 oder einem anderen Binär verwaltetem Format benötigen, müssen dieses zuerst mit der Lockfunktion des WinCVS gelockt werden, und so das Dokument vor gleichzeitigem Editieren zu schützen. Danach kann wie bei Sourcecode CI vorgegangen werden. Am Ende muss das Binär-CI wieder geunlockt werden. (Siehe Anhang A) Seite 4

5 3.2 Konfigurations-Kontrolle Änderungen Einleiten Um Änderungen in den Current Sourcecode Tree des Projekts zu übernehmen, braucht es keine zusätzlichen Audits oder Reviews. Um Änderungen an Dokumenten wie SPMP oder SCMP in den Current Tree zu übernehmen, ist es erforderlich diese in der History des Dokuments einzutragen und durch ein Teammitglied verifizieren zu lassen Änderungen Evaluieren Das Evaluieren von Änderungen unterliegt der Verantwortung jedes einzelnen Entwicklers Änderungen übernehmen oder nicht Das Übernehmen von Änderungen unterliegt der Verantwortung jedes einzelnen Entwicklers Änderungen Implementieren Änderungen am Current Sourcecode Tree des Projekts passieren auf individueller Basis. Dies verlangt vom Entwickler gewisse Verantwortung. So sollte die Version die aus dem CVS-Repository ausgecheckt werden kann immer einen Lauffähige Version sein, bis auf Features die noch nicht implementiert sind. Wird fehlerhaften Code eingecheckt so werden Teammitglieder bei ihrer Arbeit behindert. Werden Änderungen an Dokumenten wie SPMP oder SCMP in den Current Tree übernommen muss das neue Dokument den Teammitglieder per Mail oder Hardcopy verteilt werden, so dass sie sich nach den geänderten Gegebenheiten richten können. 3.3 Configuration Status Report Der Configuration Leader kann interessierte auf Anfrage über den Zustand des CVS-Repository Auskunft geben. 3.4 Configuration Audits und Reviews Es werden keine Audits und Reviews der Configuration durchgeführt. 3.5 Schnittstelle Vom Configuration Management kann ausser dem SCMP nichts auf der Projekt Webseite eingesehen werden, auf Anfrage und sofern möglich kann der Configuration Leader Auskunft geben. 3.6 CVS-Tool Wartung Der Configuration Leader behält das CVS-Tool im Auge und behält es up to Date. 4. SCM Zeitplan Hier gilt der Zeitplan des SPMP. 5. SCM Ressourcen Der Configuration Leader benötig in der ersten 2 Projekt Wochen 3h je und in weiteren Wochen je 1h. Seite 5

6 6. SCM plan Wartung - (siehe 3.2.1) Seite 6

7 Anhang A CVS Guide Commit Filter Update Binäres CI Änderung rückgängig Editieren Unlock Lock Editierbar oder nicht Nicht im Repository aber lokal. Normales CI Verbinden mit dem Repository Muss meist nur zum ersten mal gemacht werden: 1. [admin][preferences] das CVS root einstellen. 2. [admin][login] und dann Passwort eingeben Danach merkt sich das CVS tool das Passort und das CVS Root. Normaler Arbeitsgang mit normalem CI: 1. Update 2. Editieren (Verzeichnis oder einzelne Datei) 3. Arbeiten 4. Commit Normaler Arbeitsgang mit binärem CI: 1. Update 2. Lock 3. Editieren (Verzeichnis oder einzelne Datei) 4. Arbeiten 5. Commit 6. Unlock Seite 7

8 B: JAVA Header /** * [NAME] - * [Description] * * JAVA-Logger antlogger; Projekt der HTA Luzern->Abteilung Informatik->Software Engineering * Authoren Patrick Bründler, Pascal Mengelt, Andy Wyss, Fabian Heusser * Teacher: Jörg Hofstetter * School: hta.fhz.ch, Horw; * Project Homepage: * * * LEGAL NOTICE * THIS PROJECT AND ITS FILES ARE COPYRIGHTED BY THE AUTHORS * THIS PROJECT CAN BE COPIED, MODIFIED AND DISTRIBUTED * UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENCE * Patrick Bründler Pascal Mengelt Andy Wyss Fabian Heusser 1.0 $Date: 2001/12/05 15:37:22 $ $Revision: 1.3 $ [NAME OF THE FILE] */ Seite 8