HCL Compass と HCL VersionVault Express との SCM 連携・統合 (Webhook based)
2022/6/20 - 読み終える時間: 11 分
SCM Integration of HCL Compass with HCL VersionVault Express – (Webhook based) の翻訳版です。
HCL Compass と HCL VersionVault Express との SCM 連携・統合 (Webhook based)
はじめに
このブログでは、HCL Compass 2.1.0とHCL VersionVault Express 2.1.0のSCM統合をWebhookベースの方法で設定するために必要な主要ステップのスナップショットを紹介します。この統合により、HCL Compass側の特定の不具合やレコードに対応するHCL VersionVault Express側のアクティビティに関連する変更セットを追跡できるようになります。この記事の最後には、HCL VersionVault ExpressとHCL Compassの統合を実際に示す例もあります。
以下は、この記事で扱うトピックのリストです。
1.統合の前提条件 - HCL VersionVault ExpressとHCL Compassの必要なコンポーネントとバージョン
2.CompassのDBにSCM統合パッケージのインストール
3.Restサーバーの起動
4.CompassのスキーマとDBにSSOとSCMの設定
5.Compass上でSCMの設定の定義
6.VersionVault Express側でWebhookの設定
7.最終的な統合の実行
- 連携の設定に入る前の前提条件
以下の2つが既に稼働している必要があります。
a. HCL VersionVault Express 2.1.0がインストールされ、動作していること。 b. Compass 2.1.0がインストールされ、Compass RESTfulサービスがインストールされていること。
- Compass RESTful サービスの起動
管理者としてCMDを開き（管理者として実行）、Restサーバーのデフォルトの場所から「start.bat」コマンドを実行します。
デフォルトのパスは C:♪Program Files ♪HCL ♪Compass ♪compass-rest-server-distribution ♪bin
(インストール時に変更した場合を除く) .
以下のスクリーンショットでは、Springbootが起動し、数分後にサービスが開始され、準備が整います。
- Compassにログインして、Compassデータベースと統合する場合、最初はこのDBのDefault Recordタイプのみが表示されます。この例では、"Defect Tracking" Schemaを使用しています。そのため、以下のようなレコードを見ることができます。
- Compass 側で、作業中のスキーマに「SCM Integration」パッケージをインストールします。
4a. Compass Desginerに移動し、以下のようにパッケージをインストールします。
4b. "SCM Integration package "を選択し、"Next "をクリックします。
4c. パッケージを適用するレコードの種類を選択します。4c) パッケージを適用するレコードタイプを選択し、"Finish "をクリックします。
4d. スキーマバージョンの変更が完了したことを確認します。
4e. ユーザーデータベースをアップグレードして、このスキーマの変更を適用します。
4f. 新しいスキーマバージョン "2 "を選択し、"Ok "をクリックします。
4g. これでUserDBはSchema Version "2 "にアップグレードされました。
- 次に、以下のコマンドを実行して、Compass DB の SSO と SCM のグループとユーザーを設定します。
5a. cqperl setupSSO.pl <<リポジトリ名>> <
> >を設定します。 5b. cqperl setupSCM.pl <<リポジトリ名>> < >のように設定します。
- ここで、この DB の「Compass User administration」を確認すると、上で実行したコマンドにより、「SCMIntegration, SSO_USER」ユーザーと「SCMIntegrationAdmins」グループが作成されていることが確認できます。
- ログインと設定に使用する ID をこのグループ「SCMIntegrationAdmins」に追加します。 7a. この例では、これから使用する「admin」IDをグループに追加し、DBをアップグレードします。
7b. すると、「admin」IDもこのグループの一部であることがわかります。
- "DB Action "からデータベースの "Upgrade "を実行します。
- Compassのデータベースの「New record」セクションを確認すると、以下の3つのSCM関連のレコードタイプが追加されていることが確認できます。
- 次に、HCL Compass で必要な SCM の設定レコードを作成します。 10a) この例では、HCL VersionVault Expressのために作成します。
10b. "Security "を作成するために -> "New "をクリックすると、以下のような別のフォームが表示されます。
設定名と "Secret "キー(ここでは例として "hello "を指定していますが、複雑なキーを選択し与えることも可能です)を入力します。
そして、"Save and Close "をクリックします。
10c) セキュリティは以下のように入力されます。これで設定記録を保存して閉じることができます。
- Compassで新しいクエリを作成することにより、"Config "タイプのレコードを照会する場合、我々は次のように作成した構成が表示されます。
- 次に、VersionVault Express側でCompass IntegrationのWebhooksを設定します。
VersionVault Expressのストリームごとに、以下のようにWebhookのペイロードを入力する必要があります。
Add Webhook "をクリックします。
Webhook名 -> 任意の名前を入力します。
ペイロードのURL -> このような形式です。
https://<
私たちの例では
https://
Secret -> Compass の最後に入力した Secret 値を入力します。この例ではCompassで入力した "hello "を入力します。 Select Events -> CompassへのPayloadをトリガーするVersionVault ExpressのEventを選択します。 Validate "をクリックし、すべての接続が正しい場合は、以下のように "Accepted "という成功メッセージが緑色で表示されるはずです。
- 統合の実行
ここで、まずCompass側で欠陥/レコードを作成し、レコードIDを取得する必要があります。
このCompassのレコードは、VersionVault Express側のアクティビティに対応します。 この例では、Compassの不具合をレコードID: "SAMPL00000045 "で作成したとします。
VersionVault Express側では、作成したCompassレコードIDで始まるアクティビティ名を持つアクティビティを作成します。
- ストリームでは、アクティビティに設定し、VersionVault Express側で行ったコード変更をすべて行います。 アクティビティには、その下に「Change sets」として変更が記録されます。
- Webフック」によって、「アクティビティ」側で行われたイベントがCompassへのペイロードをトリガーします。 そしてこれは、Compassレコードの "SCMイベント "セクションにチェンジセット情報として以下のように記録されます。 アクティビティーのインクと、それがトリガーされた SCM の URL が含まれます。この例では、VersionVault ExpressのインスタンスのURLが表示されます。
- アクティビティ変更セットのSCMイベントセクションでリンクURLをクリックすると、以下のようにVVEアクティビティに移動します。
結論
このように、HCL Compass側では、ある不具合やレコードにおいて、HCL VersionVault Express側では、ソースコードに発生したすべての変更を追跡できます。 これらは、HCL VersionVault Expressのアクティビティで、チェンジセットとして捕捉されます。 そして、HCL Compass側では、そのアクティビティに対応するHCL Compassレコードエンドの「SCMイベント」セクションの一部として捕捉されます。