Lab Management ワークフロー アクティビティ
Lab Management ワークフロー テンプレート (LabDefaultTemplate.11.xaml) をカスタマイズするときに、事前に定義された 1 つ以上の Lab Management アクティビティを使用できます。 Lab Management ウィザードで作成されるオブジェクトにもアクセスできます。 ここでは、ワークフロー テンプレートをカスタマイズしてアプリケーションをビルド、配置、およびテストするときに使用できる Team Foundation Lab Management のアクティビティとオブジェクトについて説明します。 カスタマイズされたワークフローでこれらのアクティビティを使用する方法の詳細については、「Lab Management ワークフローのカスタマイズ」を参照してください。
必要条件
- Visual Studio Enterprise, Visual Studio Test Professional
このトピックは、次のセクションで構成されています。
Lab Management アクティビティ
Lab Management クラス
Lab Management アクティビティ
次の表で、各 Lab Management ワークフローのアクティビティについて説明します。
アクティビティ |
説明 |
|---|---|
CreateLabEnvironment |
格納済みテンプレートから新しい環境を作成し、指定されたホスト グループにその環境を配置します。 |
DeleteLabEnvironment |
環境を削除します。 |
DeleteSnapshot |
環境のスナップショットを削除します。 |
ExecuteRemoteTestRun |
環境でテストの実行を作成し、そのテストの実行が完了するまで待機します。 |
GenerateEnvironmentViewerFile |
スナップショット リンク ID を持つ環境ビューアー ファイルを生成します。 このファイルは、環境のスナップショットに接続するために使用されます。 |
GetBuildLocationAndBuildNumber |
ビルド、配置、およびテスト シナリオ用のビルドの場所とビルド番号を返します。 |
GetLabEnvironmentInUseMarker |
環境の使用中マーカーを返します。 |
GetLabEnvironmentSnapshotId |
環境のスナップショットの ID を取得します。 |
GetLabEnvironmentStatus |
環境の状態を取得します。 |
GetLabEnvironmentUri |
指定された環境名とラボの場所の名前に対応する環境の URI を取得します。 |
InitializeAgentSpecAndEnvironmentVariables |
プロパティで指定された配置スクリプトの詳細を解析します。 |
ResetLabEnvironmentInuseMarker |
環境の使用中マーカーをリセットします。 |
RestoreLabEnvironment |
環境を指定されたスナップショットに復元します。 |
RunDeploymentScript |
配置スクリプトを実行します。 失敗すると、ThrowOnError プロパティで指定されたビルドの警告がスローされるか書き込まれます。 |
RunWorkflow |
ビルド サーバーのビルド コントローラーで新しいワークフローをキューに入れます。 |
SaveLabEnvironment |
新しい環境を作成し、チーム プロジェクトのライブラリ共有内に格納します。 |
SetLabEnvironmentInuseMarker |
環境に使用中マーカーを設定します。 |
SnapshotLabEnvironment |
環境のスナップショットを取得します。 |
StartLabEnvironment |
環境を開始します。 |
StopLabEnvironment |
環境を停止します。 |
WaitForTestCapabilityServices |
環境のテスト機能が準備できるまで、指定された最大時間待機します。 待機時間の終わりまでにテスト機能が準備できなかった場合、タイムアウト例外がスローされます。 |
WaitForWorkflow |
ワークフローの種類。 |
WaitForWorkflowCapabilityServices |
キューに入っているビルドが完了するまで、指定された最大待機時間待機します。 ビルド ワークフローが指定された最大時間内に完了しない場合、TimeOutException がスローされます。 このアクティビティは、キューに入っているビルドの状態を定期的にチェックして、どのビルドが完了しているかを確認します。 間隔は、RefreshInterval プロパティを使用して構成されます。 |
WriteDeploymentInformation |
ビルドの概要に含まれる配置情報を書き込みます。 |
CreateLabEnvironment
格納済みテンプレートから新しい環境を作成し、指定されたホスト グループにその環境を配置します。 これは長期間実行されるアクティビティであり、新しい環境が作成されるまで待機します。 新しいラボ環境を作成できない場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
プロパティ
LabEnvironmentName |
新しい環境の名前。 このプロパティが null または空の場合、環境テンプレート名が使用されます。 |
LabEnvironmentTemplateUri |
格納済み環境テンプレートの URI。 ラボ環境テンプレートの URI は、GetLabEnvironmentUri アクティビティを使用して取得できます。 必須。 |
TeamProjectHostGroupName |
新しい環境が配置されるホスト グループ。 指定したホスト グループが見つからない場合は、NoTeamProjectHostGroupFoundException 例外がスローされます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeleteLabEnvironment
環境を削除します。 これは長期間実行されるアクティビティであり、環境が削除されるまで待機します。 環境の削除に失敗した場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
プロパティ
LabEnvironmentUri |
削除する環境の URI。 ラボ環境の URI は、GetLabEnvironmentUri アクティビティを使用して取得できます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeleteSnapshot
環境のスナップショットを削除します。 これは長期間実行されるアクティビティであり、スナップショットが削除されるまで待機します。 スナップショットの削除に失敗した場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
プロパティ
LabEnvironmentUri |
スナップショットが削除されるラボ環境の URI。 ラボ環境の URI は、GetLabEnvironmentUri アクティビティを使用して取得できます。 必須。 |
SnapshotId |
削除するスナップショットの ID。 スナップショット ID は、GetLabEnvironmentSnapshotId アクティビティを使用して取得できます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ExecuteRemoteTestRun
環境でテストの実行を作成し、そのテストの実行が完了するまで待機します。 これは、テストの実行が完了するか、タイムアウトが発生するまで待機する長期間実行されるアクティビティです。 MaxWaitTime プロパティを使用してタイムアウトを設定できます。 このアクティビティは、テストの実行状態を定期的にチェックして、どのテストの実行が完了しているかを確認します。 間隔は、RefreshInterval プロパティを使用して構成できます。 MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion プロパティを使用すると、テストの実行状態のチェック中に連続して Team Foundation Server エラーを無視する連続する回数を指定できます。
戻り値
テストの実行の詳細を格納する TestRunStatistics オブジェクト。
プロパティ
BuildNumber |
テストが実行されるビルド番号 |
LabEnvironmentUri |
テスト ケースが実行される環境の URI。 環境の URI は、GetLabEnvironmentUri アクティビティを使用して取得できます。 |
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion |
アクティビティがテストの実行を待機している間に連続して無視される最大失敗回数。 このプロパティの既定値は 3 です。 |
MaxWaitTime |
テストの実行が完了するまでの最大待機時間を指定する TimeSpan。 指定された期間が終了すると、タイムアウト例外がスローされます。 既定値は 0 (ゼロ) です。この値は、アクティビティが無制限に待機することを意味します。 |
RefreshInterval |
テストの実行の状態が更新されるまでの間隔を指定する TimeSpan。 この間隔の既定値は 60 秒です。 |
TestDirectory |
テストの実行可能ファイルへのパス。 |
TestEnvironment |
テスト ケースが実行されるテスト環境の名前。 |
TestParameters |
テスト計画、テスト スイート、テストの設定、およびテスト構成などのテスト パラメーターを指定する RunTestDetails オブジェクト。 必須。 |
タイトル |
テストの実行の名前。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GenerateEnvironmentViewerFile
スナップショット リンクの ID を格納する環境ビューアー ファイルを生成します。 このアクティビティは、環境のスナップショットに接続するために使用されます。 環境ビューアー ファイルの名前は、スナップショット名から特殊文字 @"\[\`~\!@\#$%^&\*()+=\[{\\\]}|\\\\;:',/?\]" + "\"" を除いたものになります。
プロパティ
FilePath |
環境ビューアー ファイルを格納する場所の UNC パス。 ビルド サービス アカウントには、パスの書き込みアクセス許可が必要です。 必須。 |
LabEnvironmentUri |
環境の URI。 環境の URI は、GetLabEnvironmentUri アクティビティを使用して取得できます。 必須。 |
SnapshotId |
スナップショットの ID。 スナップショット ID は、GetLabEnvironmentSnapshotId アクティビティを使用して取得できます。 スナップショットが無効の場合、InvalidSnapshotException 例外がスローされます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetBuildLocationAndBuildNumber
ビルド、配置、およびテスト シナリオ用のビルドの場所とビルド番号を返します。 "チーム ビルド" が選択され、ビルドの URI が null の場合、最後の適切なビルドが選択されて、詳細が返されます。 最後の最適なビルドが見つからない場合、System.ArgumentException がスローされます。 "チーム ビルド" が選択されない場合、ユーザーが指定したビルドの場所だけが返されます。
戻り値
ビルドの場所を指定する String。
プロパティ
BuildDetails |
ビルド、配置、およびテスト シナリオのビルド関連情報を含む Microsoft.TeamFoundation.Lab.Workflow.Activities.BuildDetails オブジェクト。 |
BuildNumber |
選択したビルドのビルド番号。 これは outArgument です。 "チーム ビルド" 以外のビルドの場合は null です。 |
SelectedBuild |
ビルド サーバーに関するビルド情報。 これは outArgument です。 "チーム ビルド" 以外のビルドの場合は null です。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentInUseMarker
環境の使用中マーカーを取得します。
戻り値
環境マーカーの詳細を指定する LabEnvironmentInUseMarker
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentSnapshotId
環境のスナップショットのスナップショット ID を取得します。 指定した名前のスナップショットが見つからない場合、このアクティビティは NoSnapshotFoundException 例外をスローします。
戻り値
スナップショットの識別子を指定する Int64。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
SnapshotName |
スナップショット名。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentStatus
環境の状態を取得します。
戻り値
環境の現在の状態を示す LabEnvironmentState 列挙値。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentUri
指定された環境名とラボの場所の名前に対応する環境の URI を取得します。 ラボの場所は、ホスト グループまたはライブラリ共有のいずれかです。 環境が見つからない場合、このアクティビティは LabEnvironmentNotFoundException 例外をスローします。
戻り値
環境の URI を指定する String。
プロパティ
LabEnvironmentName |
環境名。 必須。 |
プロジェクト名 |
チーム プロジェクトの名前。 このプロパティ値が null の場合または値を指定しない場合、ビルドの現在のプロジェクトが使用されます。 |
TeamProjectLabLocationName |
ラボの場所名。 ホスト グループ名またはライブラリ共有名を指定できます。 ラボの場所が見つからない場合、NoLabLocationFoundException 例外がスローされます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
InitializeAgentSpecAndEnvironmentVariables
RunDeploymentScript アクティビティに必要な引数を初期化します。 InitializeAgentSpecAndEnvironmentVariables は、マシン上の配置スクリプトを対象にするために必要な仮想マシンのプロパティを環境内に抽出します。
戻り値
配置に必要なスクリプトの詳細を格納している ScriptDetails オブジェクト。
プロパティ
BuildLocation |
ビルドの場所パス。 これは、マクロ $(BuildLocation) の展開に使用されます。 必須。 |
DeploymentScriptDetails |
"labsystemname | script arguments | working directory" 形式で表される配置の詳細。 必須。 |
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ResetLabEnvironmentInuseMarker
環境の使用中マーカーをリセットします。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RestoreLabEnvironment
環境を指定されたスナップショットに復元します。 スナップショットが無効の場合、このアクティビティは InvalidSnapshotException 例外をスローします。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
SnapshotId |
環境を復元するスナップショットの ID。 スナップショット ID は、GetLabEnvironmentSnapshotId アクティビティを使用して取得できます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunDeploymentScript
配置スクリプトを実行します。 スクリプトに失敗すると、ThrowOnError プロパティで指定されたビルドの警告がスローされるか書き込まれます。
戻り値
配置操作の状態を指定する BuildStatus 列挙値。
プロパティ
MaximumAttemptsForNetUse |
net use の最大追加試行回数。 |
ScriptDetails |
ラボ システムのスクリプト詳細オブジェクト。 必須。 |
SharedLocationForNetUse |
ラボ サービス アカウントでアクセスできる場所。 |
ThrowOnError |
エラーに対して例外をスローするかどうかを示すフラグ。 既定値は True です。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunWorkflow
ビルド サーバーのビルド コントローラーで新しいワークフローをキューに入れます。 ビルドをキューに入れる必要のあるビルド コントローラーを指定するには、次の 2 つの方法があります。
LabEnvironmentUri プロパティを使用する。 この環境がワークフロー統合用に構成されている場合は、環境のビルド コントローラーを使用してワークフローをキューに入れます。 そうでない場合は、LabDeploymentProcessException がスローされます。
BuildControler プロパティを使用して、ビルド コントローラーを指定する。
戻り値
キューに入っているビルドの ID を指定する Int32。
プロパティ
BuildController |
ビルド コントローラー名。 このプロパティおよび LabEnvironmentUri プロパティ値が null の場合、またはこれらが指定されていない場合、現在のビルド コントローラーを使用してビルドをキューに入れます。 |
BuildDefinition |
キューに入れるビルド定義。 必須。 |
LabEnvironmentUri |
ワークフロー機能を持つ環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
プロジェクト名 |
チーム プロジェクトの名前。 このプロパティが null の場合、またはプロパティを指定しない場合、ビルドの現在のプロジェクトが使用されます。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SaveLabEnvironment
新しい環境を作成し、チーム プロジェクトのライブラリ共有内に格納します。 これは長期間実行されるアクティビティであり、環境が保存されるまで待機します。 新しい環境の作成に失敗した場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
戻り値
新しい環境の URL を指定する String。
プロパティ
LabEnvironmentName |
保存された環境の名前。 このプロパティが null または空の場合、環境名が使用されます。 |
LabEnvironmentUri |
保存される環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
TeamProjectLibraryShareName |
環境が格納されるライブラリ共有。 指定したライブラリ共有が見つからない場合は、NoTeamProjectLibraryShareFoundException 例外がスローされます。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SetLabEnvironmentInuseMarker
環境に使用中マーカーを設定します。
プロパティ
コメント |
マーカーの設定時に書き込まれるコメント。 |
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SnapshotLabEnvironment
環境のスナップショットを取得します。 これは長期間実行されるアクティビティであり、環境のスナップショットが作成されるまで待機します。 スナップショットの作成に失敗した場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
戻り値
スナップショットの ID を指定する Int64。
プロパティ
LabEnvironmentUri |
スナップショットを取得する必要のある環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
SnapshotChainId |
スナップショット チェーン ID を返します。 |
SnapshotName |
取得するスナップショットの名前。 このプロパティが null の場合、現在の DateTime 値がスナップショット名として使用されます。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
StartLabEnvironment
環境を開始します。 これは長期間実行されるアクティビティであり、環境が開始されるまで待機します。 環境を開始できない場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
StopLabEnvironment
環境を停止します。 これは長期間実行されるアクティビティであり、環境が停止されるまで待機します。 環境を停止できない場合、このアクティビティは LabDeploymentProcessException 例外をスローします。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForTestCapabilityServices
環境のテスト機能が準備できるまで、指定された最大時間待機します。 待機時間の終わりまでにテスト機能を準備できなかった場合、タイムアウト例外がスローされます。 RepairCapabilityBeforeWaitBegins プロパティが設定されている場合、修復機能が呼び出されてから、機能の準備が完了するまで待機します。 最大待機時間は、MaxWaitTime プロパティを使用して構成できます。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
MaxWaitTime |
機能が準備できるまでの最大待機時間を指定する System.TimeSpan オブジェクト。 指定されたタイムアウト期間が終了すると、タイムアウト例外がスローされます。 既定値は 0 (ゼロ) です。この値は、タイムアウトが無制限であることを示します。 |
RepairCapabilityBeforeWaitBegins |
この値が true の場合は、待機の前に機能の修復を試みます。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForWorkflow
キューに入っているビルドが完了するまで、指定された最大待機時間待機します。 ビルド ワークフローが指定された最大時間に完了しない場合、TimeOut 例外がスローされます。 このアクティビティは、キューに入っているビルドの状態を定期的にチェックして、どのビルドが完了しているかを確認します。 間隔は、RefreshInterval プロパティを使用して構成されます。
戻り値
ワークフローの状態を示す T: Microsoft.TeamFoundation.Build.Client.BuildStatus 列挙値。
プロパティ
AllowPartiallySucceededBuild |
true の場合、部分的な成功は成功と見なされます。 |
BuildDetails |
ビルド サーバーに関するキューに入れられたビルドの詳細を含む Microsoft.TeamFoundation.Build.Client.IBuildDetail オブジェクト。 これは out 引数です。 |
LabWorkflowType |
ワークフローの種類。 |
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion |
ワークフローの終了を待機している間に連続して無視される最大失敗回数。 この既定値は 3 です。 このプロパティを使用して、ワークフローの保全性を強化できます。 |
MaxWaitTime |
ワークフローが終了するまでの最大待機時間を指定する System.TimeSpan オブジェクト。 指定されたタイムアウト期間が終了すると、タイムアウト例外がスローされます。 既定値は 0 (ゼロ) です。この値は、タイムアウトが無制限であることを示します。 |
QueueBuildId |
キューに入れられたビルドの ID。 必須。 |
RefreshInterval |
ワークフローの状態が更新されるまでの間隔を指定する System.TimeSpan オブジェクト この間隔の既定値は 60 秒です。 |
ThrowOnError |
true の場合、ビルドに失敗すると例外がスローされます。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForWorkflowCapabilityServices
環境のワークフロー機能が準備できるまで、指定された最大時間待機します。 待機時間の終わりまでにワークフロー機能を準備できなかった場合、タイムアウト例外がスローされます。 RepairCapabilityBeforeWaitBegins プロパティが設定されている場合、修復機能が呼び出されてから機能の準備が完了するまで待機します。 最大待機時間は、MaxWaitTime プロパティを使用して構成できます。
プロパティ
LabEnvironmentUri |
環境の URI。 環境の URI を取得するには、GetLabEnvironmentUri アクティビティを使用します。 必須。 |
MaxWaitTime |
機能が準備できるまでの最大待機時間を指定する System.TimeSpan オブジェクト。 指定されたタイムアウト期間が終了すると、タイムアウト例外がスローされます。 既定値は 0 (ゼロ) です。この値は、タイムアウトが無制限であることを示します。 |
RepairCapabilityBeforeWaitBegins |
この値が true の場合は、待機の前に機能の修復を試みます。 |
WaitForComputerNames |
値が true の場合、環境のすべての仮想マシンのコンピューター名が使用できるようになるまで待機します。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WriteDeploymentInformation
ビルドの概要に含まれる配置情報を書き込みます。 Deployment 情報セクションには、Build、Deployment、および Test の 3 つのサブ セクションがあります。 DeploymentInformationType プロパティを使用して、特定のサブセクションに配置情報を追加できます。 Url プロパティを使用して、リンクを配置情報に追加できます。
プロパティ
メッセージ |
概要に表示されるメッセージ。 必須。 |
URL |
メッセージに追加する省略可能な URL またはリンク。 |
DeploymentInformationType |
この情報メッセージに関する配置情報のサブセクションを指定します。 次のいずれかの値を使用します。
|
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
Lab Management クラス
次の表に、ワークフロー デザイナーでビルド、配置、およびテストのプロセスをカスタマイズするために使用できる Lab Management クラスの概要を示します。 このクラスは、Microsoft.TeamFoundation.Lab.Workflow.Activities 名前空間の一部になっています。
Object |
説明 |
|---|---|
LabWorkflowDetails |
LabWorkflowDetails クラスには、ラボ ワークフロー パラメーター ウィザードの構成データが含まれます。 LabWorkflowDetails オブジェクトには、BuildDetails、RunTestDetails、および ScriptDetails の各オブジェクトが含まれています。 |
BuildDetails |
ビルド、配置、およびテスト シナリオのビルドの詳細を格納します。 |
DeploymentDetails |
ビルド、配置、およびテスト ワークフローで自動テストの実行を作成するために必要なテスト パラメーターの詳細を格納します。 |
LabEnvironmentDetails |
ビルド、配置、およびテスト シナリオでラボ環境を特定するために必要な情報を格納します。 |
LabEnvironmentInUseMarker |
環境の使用中マーカーの詳細を格納します。 |
LabEnvironmentState |
環境の現在の状態を指定します。 |
RunTestDetails |
自動テストの実行を作成するために必要なテスト パラメーターの詳細を格納します。 |
ScriptDetails |
ビルド、配置、およびテスト シナリオに必要な配置スクリプトの詳細を格納します。 |
ScriptDetails |
テストの実行の詳細を格納します。 |
LabWorkflowDetails
LabWorkflowDetails クラスには、ラボ ワークフロー パラメーター ウィザードの構成データが含まれます。 LabDefaultTemplate では、ワークフローの LabWorkflowDetails オブジェクトが LabWorkflowParameters 引数に含まれます。 LabWorkflowDetails クラスには、次のプロパティが含まれます。
BuildDetails |
ワークフロー ウィザードによって作成され、ビルド、配置、テスト シナリオのビルドの詳細を格納する BuildDetails オブジェクト。 |
DeploymentDetails |
ワークフロー ウィザードによって作成され、ビルド、配置、テスト シナリオでビルドの配置に必要な情報を格納する LabEnvironmentDetails オブジェクト。 |
EnvironmentDetails |
ワークフロー ウィザードによって作成され、ビルド、配置、テスト シナリオで使用する環境を識別する情報を格納する LabEnvironmentDetails オブジェクト。 |
TestParameters |
ワークフロー ウィザードによって作成され、自動テストの実行を作成するために必要なテスト パラメーターの詳細を格納する RunTestDetails オブジェクト。 |
BuildDetails
BuildDetails には、ビルド、配置、およびテスト シナリオのビルドの詳細を格納します。
プロパティ
IsTeamSystemBuild |
使用されるビルドの種類がチーム ビルドかどうかを示す Boolean。 |
BuildDefinitionUri |
ビルド定義の URI を指定する Uri。 |
BuildDefinitionName |
ビルド定義の名前を指定する String。 |
QueueNewBuild |
新しいビルドをキューに入れる必要があるかどうかを示す Boolean。 |
BuildUri |
ビルドの種類がチーム ビルドの場合、ビルドの URI を指定する Uri。 |
CustomBuildPath |
ビルドの種類がチーム ビルドでない場合、ビルドのパスを指定する String。 |
構成 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeploymentDetails
DeploymentDetails には、ビルド、配置、およびテスト ワークフローで自動テストの実行を作成するために必要なテスト パラメーターの詳細が格納されます。 LabWorkflowParameters argument の DeploymentDetails プロパティを使用して、Lab Management ウィザードで作成された DeploymentDetails オブジェクトにアクセスできます。
プロパティ
PostDeploymentSnapshotPath |
配置後スナップショットを格納するパスを含む String。 |
PostDeploymentSnapshotName |
配置後に取得されるスナップショットの名前を指定する String。 |
TakePostDeploymentSnapshot |
配置後スナップショットが必要かどうかを指定する Boolean。 |
スクリプト |
対応する配置スクリプトがある仮想マシンの一覧が含まれる StringList オブジェクト。 |
DeploymentNeeded |
配置を実行する必要があるかどうかを指定する Boolean。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentDetails
LabEnvironmentDetails には、ビルド、配置、およびテスト シナリオでラボ環境を特定するために必要な情報が格納されます。 LabWorkflowParameters argument の EnvironmentDetails プロパティを使用して、Lab Management ワークフロー ウィザードで作成された LabEnvironmentDetails オブジェクトにアクセスできます。
プロパティ
プロジェクト名 |
チーム プロジェクトの名前を指定する String。 |
LabEnvironmentName |
ラボ環境の名前を指定する String。 |
NewLabEnvironmentName |
作成するラボ環境の名前を指定する String。 |
HostGroupName |
環境が配置されるホスト グループの名前を指定する String。 |
LabLibraryShareName |
格納されたラボ環境テンプレートを含むライブラリ共有の名前を指定する String。 |
RevertToSnapshot |
環境をスナップショットにロールバックするかどうかを示す Boolean。 |
SnapshotName |
ロールバック先のスナップショットの環境の名前を指定する String。 |
TfsUrl |
Team Foundation Server の URL を指定する String。 |
LabEnvironmentUri |
選択した環境の URI を指定する Uri。 |
Disposition |
環境の状態を示す LabEnvironmentDisposition 列挙値。 次の値があります。 Unknown - 環境の状態は不明です。 Active - 環境はホストに配置され、開始および実行できます。 Stored - 環境はライブラリ共有に格納され、配置されるまで使用できません。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunTestDetails
RunTestDetails には、ビルド、配置、およびテスト ワークフローで自動テストの実行を作成するために必要なテスト パラメーターの詳細が格納されます。 LabWorkflowParameters argument の TestParameters プロパティを使用して、Lab Management ウィザードで作成された RunTestDetails オブジェクトにアクセスできます。
プロパティ
TfsUrl |
Team Foundation Server の URL を指定する String。 |
プロジェクト名 |
チーム プロジェクトの名前を指定する String。 |
TestConfigurationId |
テストの実行のテスト構成の ID を指定する Int32。 |
TestPlanId |
テスト計画の ID を指定する Int32。 |
TestSuiteIdList |
実行するテスト スイートの数値 ID を含む Systems.Collections.Generic.List<int>。 |
TestSettingsId |
テストの実行のテスト設定の ID を指定する Int32。 |
RunTest |
テストを実行するかどうかを指定する Boolean。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ScriptDetails
配置スクリプトの詳細を提供します。 ScriptDetails オブジェクトは、RunDeploymentScript アクティビティをワークフロー デザイナーに追加するときに必要です。 InitializeAgentSpecAndEnvironmentVariables は ScriptDetails オブジェクトを返します。
プロパティ
LabSystemName |
ラボ環境の名前を指定する String。 |
AgentSpec |
ラボ システムのビルド エージェントに関連付けられているタグが含まれる AgentReservationSpec オブジェクト。 |
FileName |
配置スクリプト ファイルの名前を指定する String。 |
引数 |
配置スクリプトに渡される引数を指定する String。 |
WorkingDirectory |
ラボ システム上の配置スクリプトの作業ディレクトリを指定する String。 |
EnvironmentVariables |
環境変数名と値のペアを含む System.Collection.Generic.IDictionary<String,String>。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
TestRunStatistics
テストの実行の詳細を格納します。 TestRunStatistics オブジェクトは、ExecuteRemoteTestRun アクティビティによって返されます。
プロパティ
TotalTests |
テストの実行のテストの合計回数を指定する Int32。 |
PassedTests |
テストの実行で合格したテストの回数を指定する Int32。 |
FailedTests |
テストの実行で不合格だったテストの回数を指定する Int32。 |
InconclusiveTests |
テストの実行で不確定だったテストの回数を指定する Int32。 |
PendingTests |
テストの実行でまだ実行されていないテストの回数を指定する Int32。 |
AbortedTests |
テストの実行で中止されたテストの回数を指定する Int32。 |
InProgressTests |
テストの実行で現在実行中のテストの回数を指定する Int32。 |
TestRunStatus |
テストの実行の状態を指定する TestRunState 列挙値。 |
TestRunId |
テストの実行の識別子を指定する Int32。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentInUseMarker
環境の使用中マーカーの詳細を格納します。 GetLabEnvironmentInUseMarker アクティビティを使用して LabEnvironmentInUseMarker オブジェクトを返します。
プロパティ
ユーザー |
環境をマークしたユーザーを指定する String。 |
タイムスタンプ |
ユーザーが環境をマークした時刻を指定する DateTime。 |
コメント |
環境をマークしたユーザーによって指定された String。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentState
環境の現在の状態を指定する列挙体。 ラボ環境の状態は、そのラボ環境に含まれる仮想マシンの状態によってほぼ決まります。 すべての仮想マシンが一貫して安定した状態である場合、LabEnvironmentState 値はその状態と一致します。 それ以外の場合、値は Mixed または Failed になります。 ラボ環境は操作の進行中は遷移状態になり、その状態値で進行中の操作が示されます。
LabEnvironmentState の値は、次のとおりです。
不明
作成中
CreateFailed
CreateCancelling
Updating
格納済み
開始中
実行中
一時停止中
一時停止
停止しています
停止
CreatingSnapshot
DeletingSnapshot
RestoringSnapshot
削除中
DeleteFailed
Deleted
混合
失敗
UnderMigration