Concurrent Versions System CVS in der Technischen Informatik

Transkript

1 Gliederung Concurrent Versions System CVS in der Technischen Informatik Philipp A. Hartmann Institut für Informatik II Technische Informatik Rheinische Friedrich-Wilhelms-Universität Bonn 21. Oktober /26 Einführung in CVS Philipp A. Hartmann

2 Gliederung Gliederung 1 Einleitung 2 Regeln und Fallstricke Konventionen Vermeidbare Fehler 3 Einrichtung Einrichtung von SSH Konfiguration von WinCVS 2/26 Einführung in CVS Philipp A. Hartmann

3 Einleitung Regeln und Fallstricke Einrichtung Was ist CVS? CVS ist ein Versionskontrollsystem Verwaltung und Archivierung der Entwicklungsgeschichte von Software-Projekten Rückverfolgung aller Entwicklungsschritte Zugriff auf jede gesicherte Revision aller einem Projekt gehörigen Dateien Unterstützung von parallelem Arbeiten eines Teams an einem Projekt (und sogar derselben Datei ( concurrent ) CVS ist Allgemeinbildung (Noch) weit verbreitet bei der Softwareentwicklung Konzepte anderer Versionkontrollsysteme meist ähnlich 3/26 Einführung in CVS Philipp A. Hartmann

4 Einleitung Regeln und Fallstricke Einrichtung Konzept von CVS (I) Das Repository Projekte unter der Kontrolle von CVS werden in einem zentralen Repository gesichert. Sein Ort wird oft in der Umgebungsvariable CVSROOT vorgehalten. Das Repository der Abteilung ist erreichbar unter: Zugriff auf CVS-Server nur über SSH möglich (CVS unterstützt selbst nur Klartext-Passwörter) Verzeichnis CVSROOT/ im Repository enthält administrative Dateien. User haben nur Lese-Zugriff. Projekte liegen typischerweise in eigenen Verzeichnissen oder Unterordnern im Repository 4/26 Einführung in CVS Philipp A. Hartmann

5 Einleitung Regeln und Fallstricke Einrichtung Konzept von CVS (II) Arbeiten an Projekten Benutzer arbeiten nie direkt auf den Dateien im Repository, sondern auf lokalen Kopien Eine (sehr) kurze Einführung in die Benutzung gibt es auf der TI-Homepage (Studenten-Infos Versionskontrolle CVS-Handout) Das offizielle (und ausführliche) Manual findet sich unter Eine Einarbeitung in die Verwendung von CVS ist für jeden unerlässlich! 5/26 Einführung in CVS Philipp A. Hartmann

6 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Gliederung 1 Einleitung 2 Regeln und Fallstricke Konventionen Vermeidbare Fehler 3 Einrichtung Einrichtung von SSH Konfiguration von WinCVS 6/26 Einführung in CVS Philipp A. Hartmann

7 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Einzuhaltende Regeln (I) Einchecken von Änderungen Jeder commit muss sorgfältig geprüft sein der Source-Code sollte stets kompilierbar sein. Jeder commit sollte nach Möglichkeit nur eine logische Änderung an dem Projekt umfassen. Vor dem commit ist die lokale Kopie mittels cvs status oder cvs update mit der Serverversion zu vergleichen. Neue Dateien werden korrekt bezüglich des Dateiformats eingecheckt, Binärdateien also immer auch als solche! Keine automatisch generierten Dateien einchecken! Jeder commit muss eine aussagekräftige Log-Nachricht enthalten (in der Sprache der Kommentare). 7/26 Einführung in CVS Philipp A. Hartmann

8 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Einzuhaltende Regeln (II) Verzeichnisse Die verwendete Verzeichnisstruktur innerhalb des Projektverzeichnisses wird immer gemeinsam festgelegt. Neue Verzeichnisse werden erst nach Absprache angelegt. Tags und Branches Meilensteine werden mit einem aussagekräftigen Tag versehen. Vorher wird noch einmal sichergestellt, dass der Source-Code in einem guten Zustand ist. Tags und Branches sollten stets abgesprochen werden. Insbesondere das Entfernen von Tags vorher kommunizieren! 8/26 Einführung in CVS Philipp A. Hartmann

9 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Einzuhaltende Regeln (III) Header & Keywords Es sollte ein einheitlicher Header für die Source-Dateien vereinbart werden. Dies beinhaltet insbesondere die Verwendung von CVS-Keywords $Log:$-Tags sind unbedingt zu vermeiden! 9/26 Einführung in CVS Philipp A. Hartmann

10 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Häufige Probleme (I) Zeilenumbruch CVS (unter Windows) konvertiert CR/LF-Umbrüche vor dem Einchecken, bzw. nach dem Auschecken entsprechend in LF-Umbrüche Regel: CVS stets unter dem OS benutzen, unter dem die lokale Kopie auch manipuliert wird. Daher niemals Windows-Dateien (ohne vorige Konversion) von Hand unter Un*x-Betriebssystemen einchecken! 10/26 Einführung in CVS Philipp A. Hartmann

11 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Häufige Probleme (II) Verzeichnisse CVS verwaltet nur Dateien, keine Verzeichnisse Verzeichnisse werden erst im Repository angelegt und (je nach Option) auch nur ausgecheckt, wenn sie nicht leer sind. Dies führt allerdings auch zu Problemen bei der Reorganisation der Verzeichnisstruktur (solange jemand das Projekt in einer lokalen Kopie verwendet). Also: Sorgfalt ist geboten! 11/26 Einführung in CVS Philipp A. Hartmann

12 Einleitung Regeln und Fallstricke Einrichtung Konventionen Vermeidbare Fehler Häufige Probleme (III) Sticky Tags Wird eine alte Revision einer Datei ausgecheckt, führt ein unachtsames Einchecken einer Veränderung dieser Datei zum Anlegen eines neuen Entwicklungszweigs. Umgehen dieses Verhaltens durch cvs update -A meinedatei.cpp (Entfernen des sticky tags ) oder bereits vorheriges Auschecken über stdout (siehe Dokumentation) 12/26 Einführung in CVS Philipp A. Hartmann

13 Gliederung 1 Einleitung 2 Regeln und Fallstricke Konventionen Vermeidbare Fehler 3 Einrichtung Einrichtung von SSH Konfiguration von WinCVS 13/26 Einführung in CVS Philipp A. Hartmann

14 Secure SHell Programm zum verschlüsselten Fernzugriff Heutzutage Standard unter Un*x-Betriebssystemen (und somit in der Regel bereits installiert) Windows-Client: z.b. PuTTY Google putty download Auf gut Glück! Dient hier zur Authentifizierung und sicheren Datenübertragung Einrichten einer Key-basierten Authentifizierung Zur Verwendung (insbesondere graphischer) CVS-Programme empfiehlt sich Einrichtung eines Public/Private-Keys. Schrittweise Anleitung (für PuTTY unter Windows) auf den nächsten Folien. Einrichtung unter Un*x/Linux analog (siehe ssh(1)) 14/26 Einführung in CVS Philipp A. Hartmann

15 Schritt 1: Erzeugen eines Schlüsselpaares PuTTYgen Mit Hilfe des Tools PuTTYgen kann ein Schlüsselpaar erzeugt werden. Als Typ sollte SSH-2 DSA ausgewählt werden. Eine sinnvolle Länge für den Schlüssel ist 2048 Bit. 15/26 Einführung in CVS Philipp A. Hartmann

16 Schritt 1: Erzeugen eines Schlüsselpaares 15/26 Einführung in CVS Philipp A. Hartmann

19 Schritt 2: Speichern des Schlüsselpaares PuTTYgen Speichern des privaten Schlüssels an einem sicheren Ort, beispielsweise im Unix-Home (falls unter Windows gemountet) im Verzeichnis.ssh Zusätzlich sollte ein Passwort angegeben werden! In diesem Beispiel verwenden wir den Namen id_dsa.ppk. 16/26 Einführung in CVS Philipp A. Hartmann

20 Schritt 2: Speichern des Schlüsselpaares 16/26 Einführung in CVS Philipp A. Hartmann

21 Schritt 2: Speichern des Schlüsselpaares 16/26 Einführung in CVS Philipp A. Hartmann

22 Schritt 3: Exportieren des Schlüssels PuTTYgen Zur Verwendung unter Un*x kann der Schlüssel optional exportiert werden. Dazu unter Conversions den Punkt Export OpenSSH-Key auswählen. Als Dateinamen wählen wir id_dsa (ohne Endung), wiederum im Un*x-Home im Verzeichnis.ssh/ Dieser Key wird sodann als Standard-Key unter Un*x verwendet. 17/26 Einführung in CVS Philipp A. Hartmann

23 Schritt 3: Exportieren des Schlüssels 17/26 Einführung in CVS Philipp A. Hartmann

24 Schritt 3: Exportieren des Schlüssels 17/26 Einführung in CVS Philipp A. Hartmann

25 Schritt 4: Der öffentliche Schlüssel Bereitstellen des öffentlichen Schlüssels Zur Authentifizierung mit Hilfe eines Schlüsselpaares muss der öffentliche Schlüssel als authorisiert gelten. Dazu wird dieser in die Datei /.ssh/authorized_keys hinzugefügt. Vorbereitung Kopieren des öffentlichen Schlüssels in Zwischenablage Einloggen auf ikarus per SSH (und Passwort) Falls Frage nach Host-Key kommt, sollte man diesen akzeptieren. 18/26 Einführung in CVS Philipp A. Hartmann

26 Schritt 4: Der öffentliche Schlüssel 18/26 Einführung in CVS Philipp A. Hartmann

28 Schritt 4: Der öffentliche Schlüssel Befehlsfolge $ mkdir -p.ssh $ touch.ssh/authorized_keys $ chmod go-rw.ssh/authorized_keys $ cat >>.ssh/authorized_keys Nach Absetzen des cat-befehls, Schlüssel in das Terminalfenster kopieren und mit <ENTER> und dann <CTRL>-D (end-of-file) abschließen. 18/26 Einführung in CVS Philipp A. Hartmann

30 Schritt 5: Ein erster Test Test des Schlüssels Wir verwenden das Kommadozeilen-Tool plink zum Test der Authentifizierung mit Hilfe des neuen Schlüsselpaars. 19/26 Einführung in CVS Philipp A. Hartmann

31 Schritt 6: Weg mit dem Passwort Der Key-Agent Pageant Um nicht immer ein Passwort eingeben zu müssen, bietet sich die Verwendung eines Key-Agenten an. Der zu PuTTY gehörende Agent heißt Pageant und erscheint nach dem Start als Symbol im Systray. Hier kann man den erzeugten Schlüssel dann hinzufügen: 20/26 Einführung in CVS Philipp A. Hartmann

32 Schritt 7: Ein zweiter Test Test des Key-Agenten Nach Eingabe des Passworts für den Schlüssel können wir die Authentifizierung erneut testen. 21/26 Einführung in CVS Philipp A. Hartmann

33 Und weiter? SSH somit vollständig vorbereitet Nun können wir (nach Starten des Agenten) ohne zusätzliche Passwortabfrage per SSH auf den CVS-Server (und viele andere Un*x-Rechner, z.b. im CIP-Pool) zugreifen. Zugriff von außerhalb der Informatik Für einen Zugriff per SSH auf ikarus von außerhalb des Netzwerks der Informatik muss zusätzlich das VPN benutzt werden. Die Konfiguration eines entsprechenden Zugangs ist auf den Support-Seiten erklärt und zu finden unter: 22/26 Einführung in CVS Philipp A. Hartmann

34 WinCVS - eine graphische Oberfläche WinCVS WinCVS ist ein graphischer CVS-Client. Open-Source, erhältlich unter Linux und Mac-Versionen ebenfalls verfügbar. Sollte auf den Abteilungsrechnern vorhanden sein, kann aber auch ohne Installation gestartet werden. Einrichtung Im Folgenden: Einrichten von WinCVS zur Verwendung des Abteilungsservers. Verwendung von WinCVS bitte der Hilfe, bzw. Online-Dokumentation entnehmen. Zum Spielen/Ausprobieren existiert ein Projekt junk auf ikarus. 23/26 Einführung in CVS Philipp A. Hartmann