ALM Octane CIプラグインのCIサーバーへのインストールと設定

ALM Octane用に非Jenkins CIサーバーを初めてセットアップする場合は、CIサーバーにALM Octane CIプラグインをインストールして、ALM Octaneと接続するように設定します。Jenkinsについては、Jenkins統合を参照してください。

プラグインの概要

このプラグインにより、ALM OctaneとCIサーバーの統合が可能になります。このプラグインには次のような機能があります。

  • CIサーバー上で実行されるビルドパイプラインを取得および表示する

  • CIサーバー上でのパイプライン実行をトリガーする

  • CIサーバーから、ビルド実行結果、テスト実行結果、およびコミット情報を取得する

  • Jenkins CIサーバーからコードカバレッジレポートを取得する

  • Jenkins CIサーバーでのUFT Oneテスト実行をトリガーする

    注:
  • Jenkinsと統合するには、ALM Octane CIプラグインをJenkinsサーバーにインストールしないでください。詳細については、Micro Focus アプリケーション自動化ツールプラグインへのアップグレードを参照してください。
  • Azure DevOpsの統合は、現在一方向です。Azure DevOpsパイプラインとそのジョブは、進行状況とステータスについてALM Octaneに通知するだけでなく、それらに関連するソース管理のコミットとテスト結果に関する情報を送信できます。ただし、 Octaneからのパイプラインの実行と停止はサポートされていません。

トップに戻る

前提条件

ALM Octane統合を行うためにJenkinsサーバーにインストールする必要があるプラグイン、およびALM Octane統合でサポートされているが必須ではないプラグインの一覧については、アプリケーション自動化ツールwikiページまたはJenkins統合を参照してください。

  • APIアクセスの取得: スペース管理者に、APIアクセスのクライアントIDとクライアントシークレットの取得を依頼します。プラグインは、この情報を、ALM Octaneと通信する際の認証に使用します。

    スペース管理者は、クライアントIDとクライアントシークレットをALM Octaneの設定で取得できます。アクセスキーは、関連するすべてのワークスペースで、CI/CD統合ロールに関連付ける必要があります。詳細については、APIアクセスのセットアップを参照してください。

  • 必要な要件を満たしているCIサーバーへのアクセスの取得: ALM Octane CIプラグインでサポートされているCIサーバーについては、サポートマトリクスを参照してください。

  • CIサーバーへのアクセスとジョブの実行に使用するCIサーバーユーザーALM Octaneを決定します。Azure DevOps Server (TFS) の場合、これはパーソナルアクセストークン (PAT) です。

    CIサーバーユーザーまたはPATには、以下の権限が必要です。

    Bamboo: Build plan
    Jenkins (パイプラインを使用する場合): Job Build

    Jenkins (パイプラインなしでALM OctaneとUFTを統合する場合):

    Job Create、Delete、およびRead

    SCMリポジトリで資格情報が必要な場合は、Credentials createおよびupdateの権限も必要です。これは、ALM Octaneが、指定したSCMアクセスクレデンシャルをJenkinsサーバーに保存できるようにするためです。
    Azure DevOps Server (TFS) の場合:

    次の読み取り権限: Build、Code、Project and team、Test management

    次の実行権限: Build
    GoCDの場合: 権限、およびパイプラインを実行するための権限を表示します。
    Azureの場合: ALM OctaneはAzure DevOpsサーバーにアクセスせず、ジョブをアクティブに実行しないため、権限は必要ありません。統合は、Azure DevOpsからALM Octaneへの一方向です。

    注意: このユーザーの権限は、統合に必要な最小限の権限に制限することを強くお勧めします。

トップに戻る

プラグインのインストール

インターネットから関連するプラグインをダウンロードし、CIサーバーにインストールします。次のいずれかを行います。

Jenkins

Jenkinsサーバーのユーザーインターフェイスで、プラグイン管理領域を開き、プラグインをアップロードします。

  1. [Manage Jenkins] (左側) をクリックします。

  2. [Manage Plugins] をクリックし、[Advanced] タブを選択して [Upload Plugin] まで下方向にスクロールします。

  3. ダウンロードしたプラグインファイルを参照し、[Upload] をクリックします。

  4. インストールが完了し、実行中のジョブがなくなったら、Jenkinsを再起動するオプションを選択します。

その他の手順については、Jenkins統合を参照してください。
TeamCity

TeamCityサーバーのユーザーインターフェイスで、プラグイン管理領域を開き、プラグインをアップロードします。

  1. [Administration] > [Plugins List] に移動し、[Upload plugin zip] をクリックします。
  2. ダウンロードしたプラグインファイルを参照し、[Upload] をクリックします。
  3. TeamCityサーバーを再起動します。
Bamboo

Bambooサーバーのユーザーインターフェイスで、アドオン管理領域を開き、プラグインをアップロードします。

  1. [Administration] 歯車ボタンをクリックし、メニューから [Add-ons] を選択します。

  2. [Pause server] をクリックして新しいアドオンのインストール中にサーバーを一時停止し、現在実行中のビルドに悪影響が生じないようにします。

  3. [Upload add-on] をクリックし、ダウンロードしたプラグインファイルを参照して、[Upload] をクリックします。

  4. ページ上部の [Resume server] をクリックします。
Azure DevOps Server (TFS)

Azure DevOps Server (TFS) マシン上でダウンロードしたMSIを実行し、プラグインをインストールします。
GoCD プラグインの.jarファイルをダウンロードし、GoCDサーバーの<GoCDサーバーフォルダー>/plugins/external/に保存します。
GitLab ALM Octane GitLab CIサービスの説明に従ってJavaコマンドラインを実行します。

Azure DevOps Server (2019以降)

Azure DevOpsサービス

Azure内:

  1. ALM Octane Integration Extensionをインストールします。

  2. パイプラインデコレータプレビューフィーチャーを有効にします。

詳細については、拡張機能のreadmeファイルを参照してください。

ALM Octaneにアクセスするようにプラグインを設定する前に、次のように、プラグインのインストールを完了しておく必要があります。CIサーバーが再起動するのを待つ (JenkinsまたはTeamCity) か、アドオン管理ページを更新する (Bamboo) か、CIサーバーを再起動します (Azure DevOps Server/TFS、GoCD)。

注:  

  • インストール後にプラグインを有効化または無効化する場合は、お使いのCIサーバー (Jenkins、TeamCity、Bamboo) を再起動する必要があります。

  • Azure DevOps Server (TFS) プラグインを更新または再インストールする場合は、最初にAzure DevOps Server (TFS) のWindowsサービス: Visual Studio Team Foundation Background Job Agentを停止する必要があります。プラグインを更新したら、サービスを再開します。

トップに戻る

ALM Octaneにアクセスするようにプラグインを設定

ALM Octane CIプラグインをCIサーバーにインストールした後、ALM Octaneと、必要に応じてCIサーバーにアクセスするようにプラグインを設定します。

ヒント: プラグインのインストール後、プラグインの設定を行う前に、CIサーバーが再起動するのを待機するか (JenkinsまたはTeamCity)、アドオン管理ページを更新するか (Bamboo)、またはCIサーバー (Azure DevOps Server/TFS, GoCD) を再起動するようにしてください。

  1. プラグインの設定領域を開きます。次のいずれかを行います。

    Jenkins

    Jenkinsサーバーのユーザーインターフェイスで、次の手順で、ALM Octane CIプラグインの設定領域に移動します。

    1. [Manage Jenkins] (左側) をクリックします。

    2. [Configure System] をクリックします。

    3. 下方向にスクロールし、ALM Octane CIの設定領域を表示します。

    詳細については、Jenkins統合を参照してください。
    TeamCity

    TeamCityサーバーのユーザーインターフェイスで、次の手順で、ALM Octane CIプラグインの設定領域に移動します。

    1. [Administration] に移動します。
    2. [Server Administration] で、[ALM Octane CI Plugin] をクリックします。
    Bamboo

    Bambooサーバーのユーザーインターフェイスで、次の手順で、ALM Octane CIプラグインの設定領域に移動します。

    1. [Administration] 歯車ボタンをクリックし、メニューから [Add-ons] を選択します。

    2. 左側のペインで、COMMUNICATIONの下のALM Octane CI Pluginをクリックします。
    Azure DevOps Server (TFS)

    Azure DevOps Server (TFS) マシンで、プラグインのコンソールにアクセスします。

    1. http://localhost:4567に移動します。
    2. [Configuration] をクリックします。

    詳細については、プラグインの readmeを参照してください。
    GoCD

    GoCDサーバーのユーザーインターフェイスで、管理者 > プラグインを開きます。

    OctaneGoCDPluginに表示されている歯車をクリックします。

    Azure DevOps Server (2019以降)

    Azure DevOpsサービス

    ターゲットのAzure DevOpsプロジェクトでは:

    1. 新しいOctaneサービス接続を作成します。ALM Octaneワークスペースのプロパティを提供します。接続名、URL、インスタンスID、共有スペースID、ワークスペースID、APIクライアントID、およびシークレット。

    2. パイプライン変数InjectAlmOctaneTasks(true)、およびOctaneConnectionName(上記で入力)。を設定します。

    3. パイプラインに2つのジョブを追加します。AlmOctanePipelineStartは常にパイプラインの開始時に実行され、AlmOctanePipelineEndは常に他のすべてのジョブが終了するまで待機します。

    詳細については、プラグインreadmeファイルを参照してください。

    注: 次の手順は、Azure DevOps統合には関係ありません。プラグインのreadmeは、この統合を設定する方法に関する包括的な詳細を提供します。

  2. 次の内容を入力します。

    場所

    ALM OctaneサーバーのURL。完全修飾ドメイン名 (FQDN) を使用します。次の形式で指定します (ポート番号はオプション):

    http://<ALM Octaneホスト名/IPアドレス> {:<ポート番号>}/ui/?p=<スペースID>

    このURLで、スペースIDが1002の場合: http://myServer.myCompany.com:8081/ui/?p=100

    ALM Octaneを開いているブラウザーのアドレスバーからURLをコピーできます。

    注意: プラグインを介してオンプレミスとCIサーバー間の統合を構成する場合、この接続に非セキュアHTTPを使用できますが、ログイン資格情報が安全に送信されるようにHTTPSを使用することを強くお勧めします。
    クライアントID プラグインがALM Octaneへの接続で使用するAPIアクセスクライアントIDです。詳細については、の前提条件を参照してください。
    クライアントシークレット プラグインがALM Octaneへの接続で使用するクライアントシークレットです。詳細については、の前提条件を参照してください。
    Jenkins / Bamboo / TeamCityユーザー

    ALM Octaneの要求でジョブを実行するCIサーバーユーザーアカウントです。

    このオプションは、Jenkins、Bamboo、TeamCityでのみ使用できます。

    注意:  

    • CIサーバーに存在するユーザーを指定してください。

    • Bambooでは、ユーザーを指定する必要があります。

      JenkinsとTeamCityでは、ユーザーを指定しない場合、ALM OctaneはAnonymousを使用します。この場合、権限はAnonymousの権限に限定されます。
    Azure DevOps Server (TFS) の場所とPAT

    プラグインがAzure DevOps Server (TFS) にアクセスするのに使用するHTTPアドレスと個人用アクセストークン (PAT)。このPATに必要な権限は、上記で指定されています。

    これらのオプションは、Azure DevOps Server (TFS) でのみ使用できます。
    GoCDAPIのユーザー名とパスワード GoCDへのアクセスに使用するプラグインのクレデンシャル。

  3. [Test Connection] をクリックして設定を検証し、変更を保存します。

トップに戻る

既存のCIサーバーの新しいアドレスへの移動

BambooまたはTeamCityのCIサーバーを新しい場所に移動してプラグインを再インストールする場合は、CIサーバーとパイプラインをALM Octaneで作り直す必要があります。

GitLabサーバーが別の場所に移動した場合は、次の手順を使用してCIサーバーインスタンスIDを取得します。次に、ALM Octane GitLab CIサービスの説明に従って、ciserver.identityプロパティを使用します。

JenkinsまたはAzure DevOps Server (TFS) で、サーバーを移動してプラグインを再インストールする場合は、次の手順を使用してプラグインの構成を調整し、既存のパイプラインでの作業を続行します。

JenkinsまたはAzure DevOps Server (TFS) プラグインを、既存のALM Octaneパイプラインと連携するように設定します

  1. ALM OctaneでCIサーバーをセットアップするために最初に使用されたプラグインインスタンスIDを取得します。

    1. ALM Octane、設定 >スペースで、ワークスペースを選択します。

    2. [DevOps] タブをクリックします。ペインの左側で、[CIサーバー] を選択します。

    3. グリッドで [インスタンスID] カラムを見つけ、CIサーバーのインスタンスIDをコピーします。

  2. Azure DevOps Server (TFS) またはJenkinsで、元のインスタンスIDを使用するように新しいプラグインを更新します。

    Jenkins

    Jenkinsサーバーのユーザーインターフェイスで、次の手順を実行します。 

    1. 左側のペインの [Manage Plugins] をクリックします。

    2. [Configure System] をクリックします。

    3. 下方向にスクロールし、ALM Octane CIの設定領域を表示します。

    4. [Show plugin instance ID] をクリックします。

    5. [Instance ID] ボックスに、前にALM OctaneからコピーしたインスタンスIDを入力します。
    Azure DevOps Server (TFS)
    1. Azure DevOps Server (TFS) サーバーで、http://localhost:4567に移動して、プラグインのコンソールにアクセスします。
    2. [Configuration] をクリックします。
    3. [Instance ID] ボックスに、前にALM OctaneからコピーしたインスタンスIDを入力します。

    詳細については、プラグインの readmeを参照してください。

トップに戻る

次のステップ