ALM Octane webhookをリッスン

ALM Octaneは、ALM Octane Webhookメカニズムがどのように機能するかを学習するためのツールを提供します。このトピックでは、このツールを使用して、ALM Octaneと統合するための独自のサービスを開発する方法について説明します。

概要

alm-octane-webhooks-listenerツールは、ALM OctaneWebhookがどのように機能するかを理解するのに役立ちます。

このツールは、サーバーアプリケーションがWebhookリクエストをリッスンする方法をシミュレートします。

このツールを使用すると、次のことができます。 

  • Webhookのトリガールールのトリガーをテストします。

  • ALM Octane Webhookリクエストの構造 (ペイロード) を確認してください。サーバーに送信されたときに表示されます。

  • alm-octane-webhooks-listenerコンソールの通知を参照してください。

  • 独自のサービスを開発するための基礎として使用してください。

基本認証がサポートされています。

リスナーをインストールします

このセクションでは、リスナーをインストールする方法について説明します。

リスナーをインストールするには:

  1. 前提条件:  

    • WEBHOOK_ALLOW_HTTP構成パラメーターを設定して、トリガーWebhookルールのhttpプロトコルを有効にします。詳細については、設定パラメーターを参照してください。

    • Node.jsバージョン7.10.1以降をインストールします。

  2. リポジトリをローカルで複製またはダウンロードします:https://github.com/MicroFocus/alm-octane-webhooks-listener

  3. node.jsを開始します。

  4. node.jsコマンドウィンドウで、alm-octane-webhooks-listenerディレクトリに移動します。

  5. 実行: npm install

トップに戻る

リスナーの実行

alm-octane-webhooks-listenerディレクトリで、次のコマンドを実行します。

node app [オプション]

オプション 説明
--port

使用するポート。

標準設定: 8080
--rcode

応答ステータスコード。

標準設定: 200
-u

基本認証のユーザー名。

標準設定: なし
-p

基本認証用のパスワード。

標準設定: なし
--verbose

リクエストのヘッダーと本文を印刷します。

標準設定: いいえ
--help ヘルプを印刷して終了します。

例:node app --port=8090 --verbose -u user @ domain -p secret

alm-octane-webhooks-listenerコンソールに通知が表示されるようになりました。

例: リスナーのURLを取得する

通常、ALM Octaneインストールがnode.jsと同じ企業LAN内のオンプレミスにある場合は、WebhookのトリガールールのURLとしてalm-octane-webhooks-listenerコンソールからIPアドレスを使用できます。

ALM OctaneをSaaSとして使用している場合は、alm-octane-webhooks-listenerがインターネットからアクセス可能であることを確認してください。この場合、IPアドレスはalm-octane-webhooks-listenerによって提案されたものとは異なる場合があります。URLについては、ネットワーク管理者にお問い合わせください。

コマンド

node app  --verbose

応答

Starting up the alm-octane-webhooks-listener.
Available on: 
    http://12.34.56.78:8081    (Ethernet)
    http://87.65.43.21:8081    (internal)
Press Ctrl-C to stop the server

例: クレデンシャルでリスナーを開始する

node app --port=8090 --verbose -u user @ domain -p secret

トップに戻る

リスナーを呼び出すようにWebhookのトリガールールを更新します

Webhookのトリガールールで、リスナーのURLでルールアクションを更新します。

リスナーのURLを取得するには、例: リスナーのURLを取得するを参照してください。

URLを入力したら、接続テストをクリックできます。

成功した場合:

  • メッセージ接続に成功しましたがALM Octane設定に表示されます。

  • 次のような通知がalm-octane-webhooks-listenerコンソールに表示されます。 

    [18-Mar-2019 13:18:06.352] POST /?test=true "Apache-HttpClient/4.5.2 (Java/1.8.0_161)"
Received headers:
 {
  "content-type":    "application/json",
  "content-length":  "0",
  "host":            "12.34.56.78:8081",
  "connection":      "Keep-Alive",
  "user-agent":      "Apache-HttpClient/4.5.2 (Java/1.8.0_161)",
  "accept-encoding": "gzip,deflate"
}
Received empty body.

Webhookのトリガー

Webhookがトリガーされるたびに、alm-octane-webhooks-listenerコンソールに通知が表示されます。

通知とペイロードを確認し、この情報を使用してサービスを開発します。

トリガーWebhookルールに新規の送信モードがあり、フィールドが不具合タイプに設定されている場合、説明、検出リリース、および名前で検出された場合、サンプルの応答は次のようになります。 

Received empty body.
[18-Mar-2019 13:28:38.570] POST / "Apache-HttpClient/4.5.2 (Java/1.8.0_161)"
Received headers:
 {
  "content-type":    "application/json",
  "content-length":  "490",
  "host":            "12.34.56.78:8081",
  "connection":      "Keep-Alive",
  "user-agent":      "Apache-HttpClient/4.5.2 (Java/1.8.0_161)",
  "accept-encoding": "gzip,deflate"
}
Received body:
 {
  "server_url": "http://my-octane-server.net:8081",
  "event_type": "create",
  "sharedspace_id": 1001,
  "workspace_id": 1002,
  "username": {
    "id": 1001,
    "type": "workspace_user",
    "email": "josephine@TheCompany.com"
  },
  "data": [
    {
      "entity": {
        "type": "defect",
        "name": "My New Defect",
        "description": "<html><body><p>This is my new defect. My listener will find it when added.</p>\n</body></html>",
        "id": "2846",
        "detected_in_release": {
          "type": "release",
          "id": "2001"
        },
        "defect_type": {
          "type": "list_node",
          "id": "list_node.defect_type.Escaped"
        }
      }
    }
  ]
}

トリガーWebhookルールの送信モードが更新で、フィールドが不具合タイプ、説明、検出リリース、および名前で検出された場合、サンプルの応答は次のようになります。 

[18-Mar-2019 13:35:54.892] POST / "Apache-HttpClient/4.5.2 (Java/1.8.0_161)"
Received headers:
 {
  "content-type":    "application/json",
  "content-length":  "632",
  "host":            "12.34.56.78:8081",
  "connection":      "Keep-Alive",
  "user-agent":      "Apache-HttpClient/4.5.2 (Java/1.8.0_161)",
  "accept-encoding": "gzip,deflate"
}
Received body:
 {
  "server_url": "http://my-octane-server.net:8081",
  "event_type": "update",
  "sharedspace_id": 1001,
  "workspace_id": 1002,
  "username": {
    "id": 1001,
    "type": "workspace_user",
    "email": "josephine@TheCompany.org"
  },
  "data": [
    {
      "entity": {
        "type": "defect",
        "severity": {
          "type": "list_node",
          "id": "list_node.severity.urgent"
        },
        "name": "My New Defect",
        "id": "2846",
        "defect_type": {
          "type": "list_node",
          "id": "list_node.defect_type.Escaped"
        }
      },
      "changes": {
        "severity": {
          "oldValue": {
            "id": "list_node.severity.medium",
            "type": "list_node"
          },
          "newValue": {
            "id": "list_node.severity.urgent",
            "type": "list_node"
          }
        },
        "last_modified": {
          "oldValue": "2019-03-18T11:28:29Z",
          "newValue": "2019-03-18T11:35:44Z"
        }
      }
    }
  ]
}

トップに戻る

参照情報: