Rational Build Forge und Rational ClearQuest

BuildForge kann zur Aktualisierung von Builddatensätzen mit Rational ClearQuest arbeiten.

Build Forge wird auf zweifache Weise in ClearQuest integriert:

Diese Funktionen sind vollkommen unabhängig voneinander. Vor allem der Adapter wird mit einer Umgebung verknüpft, die für den Adapter erstellt wurde. Die Variablen in dieser Umgebung sind unabhängig von Variablen, die zum Aktivieren automatischer Builddatensätze festgelegt werden.

Automatische Generierung von Builddatensätzen einrichten

Das System kann Builddatensätze in Ihrer IBM Rational® ClearQuest®-Datenbank automatisch mit Verknüpfungen zu den Protokolldaten erstellen. Wird ein Vorgang erfolgreich ausgeführt, kann das System außerdem die ClearQuest-Datenbank aktualisieren, indem es angibt, dass der Vorgang beendet wurde, und die Endzeit sowie eine Zusammenfassung der erfolgreich ausgeführten Schritte angibt. Für diese Funktion ist Rational ClearQuest Version 7.0 oder höher erforderlich.

Wenn Sie ein Projekt zum Aktualisieren einer ClearQuest-Datenbank konfigurieren, erstellt, aktualisiert oder führt das System Builddatensätze folgendermaßen aus:
Vorgang starten
Wenn das System einen Vorgang startet, erstellt es einen ClearQuest-Builddatensatz. Dieser Builddatensatz hat den Status "Übergeben" und enthält die Vorgangsprotokoll-URL, die Startzeit, den Releasenamen, die ID und einen Protokolleintrag, der angibt "Build XYZ gestartet". Wird der Vorgang von einem Adapter für die Quellcodeverwaltung abgebrochen (beispielsweise weil keine Änderungen am Quellcode gefunden wurden), wird kein ClearQuest-Builddatensatz erstellt.
Anmerkung: Wenn ein Projekt mit einem anderen Projekt verkettet wird, erhält das neue Projekt eine eigene eindeutige ClearQuest-Build-ID.
Vorgang erfolgreich/fehlgeschlagen
Wenn ein Vorgang erfolgreich ausgeführt wurde oder fehlschlägt, setzt das System den Buildstatus in ClearQuest auf "Abgeschlossen" oder "Fehlgeschlagen". Außerdem setzt es die Endzeit des Builds und speichert im ClearQuest-Buildprotokoll eine Übersicht über die Vorgangsschritte, die ausgeführt wurden. Diese Zusammenfassung enthält Name, Ergebnisstatus und Server der einzelnen Schritte.
Vorgang erneut starten
Wird ein Vorgang erneut gestartet, setzt das System den Buildstatus in ClearQuest auf "Übergeben" und erstellt einen ClearQuest-Buildprotokolleintrag, der angibt "Build XYZ erneut gestartet".

Sie konfigurieren die Aktualisierung des automatischen Builddatensatzes über spezielle Umgebungsvariablen. Wenn Sie ein Projekt mit einer ClearQuest-Datenbank verknüpfen möchten, müssen die folgenden Umgebungsvariablen in der Umgebung des Projekts enthalten sein.

Anmerkung: Diese Variablen müssen in der Projektumgebung vorhanden sein. Es reicht nicht aus, sie lediglich einem Schritt hinzuzufügen. Sie können eine Variable verwenden, die den Typ "Einschließen" hat und diese Variablen über eine andere Umgebung einbindet. Da außerdem in den meisten Fällen nur der Wert CQ_RELEASE_NAME von Projekt zu Projekt variiert, können Sie eine Umgebung erstellen, die die anderen Variablen enthält, und eine Variable vom Typ "Einschließen" verwenden, um diese Umgebung in die Projektumgebung einzuschließen, in der Sie auch CQ_RELEASE_NAME als projektspezifische Umgebungsvariable angeben können.

Um die automatischen Aktualisierungen von Builddatensätzen über Build Forge-Vorgänge zu aktivieren, müssen die folgenden Umgebungsvariablen für das Projekt festgelegt werden. Sie funktionieren nicht auf Schrittebene.

Variable

Beschreibung

CQ_DBNAME

Erforderlich. Der Name der ClearQuest-Datenbank, die aktualisiert werden soll.

CQ_DBSET

Der Wert für die ClearQuest-Datenbankgruppe Nicht erforderlich. Standardmäßig leer.

CQ_INTERACTION

Wenn in Ihrer Projektumgebung die korrekten Umgebungsvariablen für die Erstellung eines ClearQuest-Builddatensatzes definiert sind, der Builddatensatz jedoch nicht erstellt werden soll, können Sie diese Variable auf OFF setzen und die Erstellung des Builddatensatzes damit inaktivieren.

Soll der Builddatensatz erstellt werden, setzen Sie diese Umgebungsvariable auf ON.

Anmerkung: Bei Verwendung einer der ClearQuest-Adapter muss diese Umgebungsvariable auf OFF gesetzt werden. Der Adapter interagiert direkt mit den Builddatensätzen.

CQ_PASSWORD

Erforderlich. Das Kennwort, das für das Schreiben von Protokolleinträgen in die ClearQuest-Datenbank verwendet wird (nicht erforderlich, ist standardmäßig leer).

CQ_RELEASE_NAME

Erforderlich. Der Name des Releases in der ClearQuest-Datenbank, das aktualisiert werden soll.

CQ_USER

Erforderlich. Der Benutzername, der für das Schreiben von Protokolleinträgen in die ClearQuest-Datenbank verwendet wird.

Zusätzliche Einrichtungsanforderungen für ClearQuest-Adapter

Die Muster für ClearQuest-Adaptervorlagen stellen Methoden zum Durchsuchen von ClearCase und Aktualisieren von Builddatensätzen in ClearQuest bereit. Dies wird normalerweise an den Erfolg oder Misserfolg von Builds geknüpft, die in Build Forge ausgeführt werden. Informationen zu allgemeinen Anforderungen finden Sie im Abschnitt Adapteranforderungen . Darüber hinaus muss die folgende Konfiguration ausgeführt werden.

Gehen Sie wie folgt vor:

  1. Installieren Sie auf einem Host, der eine Verbindung zum ClearCase-Server herstellen kann, einen Build Forge-Agenten.
  2. Installieren Sie den vollständigen ClearCase-Client auf dem Agentenhost.
  3. Richten Sie die Umgebung für den Agenten ein, damit Befehle über den ClearCase-Client ausgeführt werden können.
  4. Installieren Sie den vollständigen ClearQuest-Client auf dem Build Forge-Konsolenhost.
  5. Fügen Sie das CQperl-Verzeichnis (ClearQuest Perl-API) dem Systempfad hinzu.
  6. Definieren Sie eine Verbindung, die der ClearQuest-Client auf dem Build Forge-Host für den Zugriff auf die ClearQuest-Datenbank verwenden kann. Führen Sie diese Aktionen auf dem ClearQuest-Client-Host durch.
    1. Verwenden Sie den cqreg-Befehl, um die Datenbankgruppe (cqreg add_dbset) hinzuzufügen.
    2. Verwenden Sie das CQ-Wartungstool, um eine Verknüpfung zur ClearQuest-Datenbank herzustellen.
  7. Bestimmen Sie die Implementierung und die Art und Weise sowie den Zeitpunkt zum Starten der erforderlichen ClearCase-Anwendungen.
Abbildung zeigt die Beziehung der Build Forge-, ClearCase- und ClearQuest-Installationen.

Sie brauchen keinen Agenten zu installieren. Der ClearQuest-Adapter kommuniziert direkt mit dem ClearQuest über den Client und verwendet dabei die ClearQuest Perl API.

Wichtig: Der ClearQuest-Adapter kann nur mit einem Punktbefehl in einem Schritt aufgerufen werden. Da es kein Quelladapter ist, kann keine Adapterverknüpfung verwendet werden.

Muster der ClearQuest-Adaptervorlagen

Die folgenden Muster für Adaptervorlagen werden bereitgestellt.

ClearQuestBaseClearCaseByDate
  1. Fragt in einer ClearCase-Ansicht die Änderungen ab, die zwischen zwei Datumsangaben vorgenommen wurden. Standarddatumsangaben sind die aktuelle Zeitmarke und die Zeitmarke der vorhergehenden Adapterausführung.
  2. Sucht für jede geänderte Datei nach einem CrmRequest-Hyperlinkattribut, das eine ClearQuest-Änderungs-ID angibt. Versucht, die Änderungs-ID durch Hinzufügen von Vorgangsinformationen aufzulösen, um so den Fehlerdatensatz in ClearQuest aufzulösen, sofern dies der ClearQuest-Status zulässt.
  3. Schreibt für jede geänderte Datei die folgenden Informationen in den Stücklistenbericht: Dateiname, Fehler-ID, Fehlerstatus und ClearQuest-Fehler.

In der Adaptervorlage definierte Variablen:

  • CurDate
  • LAST_RUN
  • VIEW
  • VOB_PATH
  • CQ_USER
  • CQ_PASSWORD
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE
ClearQuestClearCaseByActivity
  1. Sucht nach ClearQuest-Fehlerdatensätzen, die einer Liste mit ClearCase-Aktivitäten zugeordnet sind.
  2. Für jeden Fehlerdatensatz, der gefunden wird, werden Vorgangsinformationen zur Auflösung des Fehlerdatensatzes in ClearQuest hinzugefügt, sofern der ClearQuest-Status dies zulässt.
  3. Schreibt die folgenden Informationen in den Stücklistenbericht: Dateien, die den ClearCase-Aktivitäten-IDs zugeordnet sind, und den ClearQuest-Fehlerstatus.

In der Adaptervorlage definierte Variablen:

  • CurDate
  • VIEW
  • VOB_PATH
  • ACTIVITIES
  • CQ_USER
  • CQ_PASSWORD
  • PROJECT_VOB
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE
ClearQuestUCMClearCaseByDate
  1. Fragt in einer ClearCase-Ansicht die Änderungen ab, die zwischen zwei Datumsangaben vorgenommen wurden. Standarddatumsangaben sind die aktuelle Zeitmarke und die Zeitmarke der vorhergehenden Adapterausführung. Verwendet Rational Unified Change Management (UCM) zur Erstellung der Ergebnisse.
  2. Schreibt für jede geänderte Datei die folgenden Informationen in den Stücklistenbericht: Dateiname, Fehler-ID, Fehlerstatus und ClearQuest-Fehler.

In der Adaptervorlage definierte Variablen:

  • CurDate
  • LAST_RUN
  • VIEW
  • VOB_PATH
  • CQ_USER
  • CQ_PASSWORD
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE

ClearQuest-Adaptervariablen

Diese Tabelle dient als Referenz für die Variablenlisten für die Adaptervorlagen.

Tabelle 1. Für die Rational ClearQuest-Integration erforderliche Umgebungsvariablen

Variable

Beschreibung

ACTIVITIES Beim ClearQuestClearCaseByActivity-Adapter eine durch Leerzeichen begrenzte Gruppe von Aktivitäts-IDs. Beispiel: SAMPL0001@\ProjectVob
BFSERVER Legen Sie für diese Variable den Namen eines Hosts für die Build Forge-Konsole fest.

CQ_PASSWORD

Erforderlich. Das Kennwort, das für das Schreiben von Protokolleinträgen in die ClearQuest-Datenbank verwendet wird (nicht erforderlich, ist standardmäßig leer).

CQ_USER

Erforderlich. Der Benutzername, der für das Schreiben von Protokolleinträgen in die ClearQuest-Datenbank verwendet wird.

CurDate Stellt dem Adapter das aktuelle Datum bereit. Dabei wird das Datum mit dem Befehl ".date" generiert. Ändern Sie diesen Wert nicht.
LAST_RUN Bei ByDate-Adaptern ermittelt das System mit diesem Wert ob Änderungen eingetreten sind. Er steht für das Datum der letzten erfolgreichen Ausführung. Sie können diesen Wert bearbeiten, wenn Sie zu Testzwecken die Ausführung des Adapters erzwingen und dabei ein Datum wählen, das vor bestimmten Änderungen liegt. Wenn der Adapter die Fortsetzung der Ausführung zulässt, aktualisiert er diesen Wert automatisch mit dem aktuellen Datum. Der Standardwert ist 1-Jan-05.00:00:00.
UNIXCLIENT Wird zum Festlegen plattformspezifischer Informationen verwendet. Auf 0 festgelegt, wenn der Client unter Windows ausgeführt wird. Auf 1 festgelegt, wenn der Client unter UNIX oder Linux ausgeführt wird.
VIEW Legen Sie für diese Variable den Namen der ClearCase-Ansicht fest, die Sie mit dem Adapter verwenden wollen.
VOB_PATH Legen Sie für diesen Wert den Namen Ihrer Komponenten-VOB und (optional) deren Unterverzeichnisse fest. Verwenden Sie eine durch Komma getrennte Liste für mehrere Namen.
_CHAR_NATIVE Intern verwendet und immer auf 1 festgelegt.

ClearQuest-integrierte Vorgänge erneut starten

Wenn ein ClearQuest-integrierte Vorgang beendet wurde, kann er normalerweise nicht erneut im Rational Build Forge gestartet werden. Eine einfache Ausweichlösung besteht darin, den Vorgang als neuen Vorgang starten.

Um einen Neustart zu ermöglichen, müssen Sie das ClearQuest-Schema mithilfe des ClearQuest-Designertools bearbeiten. Der Workflow für Build-Datensätze muss geändert werden, um einen Zustandsübergang von "Beendet" auf "Abschicken" zu ermöglichen.


Feedback