結果をパイプラインからALM Octaneに報告する

このフローは、パイプラインからのレポート結果をALM Octaneに挿入する方法を示しています。

エリア: CI/CD統合

エンティティ関連図

このフローでは、次のエンティティにアクセスし、これらのエンティティ間の関係を理解する必要があります。

エンティティ このフローの関係 関係の説明 参照 /関係フィールド
CIサーバー パイプライン CIサーバーごとに複数のパイプラインを定義できます。 pipeline
CIジョブ パイプライン ジョブはパイプラインに関連付けられています。各パイプラインには、1つ以上のジョブを含めることができます。 jobs
CIビルド

ジョブはビルドに関連付けられています。各ビルドには、1つ以上のジョブを含めることができます。

ci_job

トップに戻る

フロー

詳細については、ALM Octaneへ自動テスト結果を追加するおよびtest-resultsを参照してください。

認証後、次の手順を実行します。

  1. CI/CDサーバーを登録します。

    POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/ci_servers
    {
       "data": [{
    	"name": "My_CICD_Server",                
    	"url": "http://<host>:<port>/<path>",                                
    	"server_type": "ci_server"   
       }]
    }
    
  2. CI/CDサーバーにパイプラインを登録します。

    POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/pipelines
    {
       "data": [{
           "name": "Your pipeline name for display needs",    
    	"server_ci_id": "internal CI ID",
    	"root_job_ci_id": "internal CI ID", 
    	"jobs": [ 
    		{}, 
    		{},
    		…
    		],
    	
    }
    
    フィールド 説明
    name 表示用のパイプラインの名前。必須。システム全体で一意である必要があります (共有スペース)。
    server_ci_id

    サーバーの内部ID。必須。

    前提条件: この名前のCIサーバーはすでに存在している必要があります。

    root_job_ci_id サーバーのルートジョブの内部ID。必須。
    jobs

    仕事のリスト。必須。少なくとも1つのジョブ (ルートジョブ) を指定する必要があります。

  3. ビルド結果を報告します。

    PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/analytics/ci/builds
    {
    	"serverCiId": "ci server instance id", 
    	"jobCiId": "job ci id",  
    	"buildCiId": "build_internal_ci_id", 
    	"buildName": "build display name, usually a number", 
    	"startTime": 1456679398786,   
    	"duration": 120490, 
    	"status": "finished", 
    	"result": "success",           
    	"parameters": […],  
    	"causes": [   
    		{…}, 
    		{…}
    		]
    }
    
フィールド 説明
serverCiId サーバーのID。必須。
jobCiId

ジョブのID。必須。

buildCiId ビルドの内部ID。必須。
buildName

ビルドの表示名 (通常は番号)。オプション。指定しない場合、標準設定はbuildCiId値です。

startTime

ジョブの開始時間。必須。

duration ジョブの期間。必須。
status ジョブのステータス。指定しない場合、標準設定はfinishedです。
result 仕事の結果。必須。
parameters パラメーターのリスト。オプション。
causes 指定されていない場合、原因ビルドはルートビルド{…}、 / /であると見なされます。

トップに戻る

参照情報: