フローテストを作成する

学習の目的

この単元を完了すると、次のことができるようになります。

• レコードトリガーフローで自動テストを作成する。
  
• フローテストでアサーションを作成する。
  
• フローテストを実行する。
  

このバッジは、Flow Builder のスキルを習得するための過程の一部です。Flow Builder の強力なプロセス自動化スキルを身に付けてエキスパートになるには、「Flow Builder を使用したフローの作成」トレイルに従って学習してください。このバッジに取り組む前に、そちらのトレイルを完了することをお勧めします。

フローを実際に使ってみる準備

このモジュールに沿って手順を実践する場合は、パッケージを新しい Trailhead Playground にインストールする必要があります。以下の手順に従って Playground を起動し、パッケージをインストールしてください。また、ハンズオン Challenge を実行するときにもこのパッケージと Playground を使用します。

Trailhead Playground を起動するために、このページの一番下までスクロールして [Launch (起動)] をクリックします。

組織に [パッケージのインストール] というタブが表示されている場合は、 次の手順を実行します。

1. [パッケージのインストール] タブをクリックします。
   
   
2. [Package ID (パッケージ ID)] 項目に 04tKa000002OV31IAG を貼り付けます。
   
3. [Install (インストール)] をクリックします。
   
4. [Install for Admins Only (管理者のみのインストール)] を選択し、[Install (インストール)] をクリックします。
   

アプリケーションのインストールが終了すると、確認ページが表示され、Playground に関連付けられているアドレスにメールが届きます。

では、このバッジの演習と Challenge 用のレコードを作成するために、フローを実行しましょう。

1. [Setup (設定)] の [Quick Find (クイック検索)] ボックスに flows (フロー) と入力し、[Flows (フロー)] を選択します。
   
2. [Run This Flow Once At the Start (開始時にこのフローを 1 回実行)] を選択します。Flow Builder が新しいウィンドウで開きます。
   
3. [実行] をクリックします。フローが新しいウィンドウで実行されます。
   
4. フローに「The flow interview is now waiting… (フローインタビューは現在待機中です…)」と表示されたら、フローのウィンドウを閉じます。
   

順調ですね。では、テストの準備を始めましょう。

メモ

日本語で受講されている方へ
Challenge は日本語の Trailhead Playground で開始し、かっこ内の翻訳を参照しながら進めていってください。Challenge での評価は英語データを対象に行われるため、英語の値のみをコピーして貼り付けるようにしてください。日本語の組織で Challenge が不合格だった場合は、(1) この手順に従って [Locale (地域)] を [United States (米国)] に切り替え、(2) [Language (言語)] を [English (英語)] に切り替えてから、(3) [Check Challenge (Challenge を確認)] ボタンをクリックしてみることをお勧めします。

翻訳版 Trailhead を活用する方法の詳細は、自分の言語の Trailhead バッジを参照してください。

フローテストを作成する

テストを作成する際は、フローで作成した内容を参照しないでください。その代わりに、作成したフロー計画、具体的にはフローがいつ実行され、フローが何を行うかを参照します。以前の単元で計画した内容は次のとおりです。

この情報を使用して、先ほどインストールしたパッケージに含まれている [Check Escalated in Cases (ケースのエスカレーションを確認)] フローのテストを作成しましょう。始める前に、このシナリオについて知っておくべき点を確認します。

• このフローには、最初の機能の要素がすでに作成されています。決定要素と [Update Records (レコードを更新)] 要素です。この演習を開始する前に、これらの要素を変更しないでください。
  
• このシナリオでは、状況を正確に把握しているシステム管理者が、データローダーを使用して、現在 [Status (状況)] が [Escalated (エスカレーション済み)] であるすべての既存ケースの [Escalated (エスカレーション済み)] を True に設定したことを前提としています。このようにデータを最新の状態に保つと、自動化が簡素化され、良好なデータ管理につながります。
  

テストを追加して初期トリガーレコードを定義する

まず、最初の機能のテストを作成します。

[Status (状況)] が [Escalated (エスカレーション済み)] で、[Escalated (エスカレーション済み)] 項目がチェックされていない場合、フローは [Escalated (エスカレーション済み)] 項目を True に設定します。

このアクションは、ケースが作成された場合と更新された場合の両方で発生する必要がありますが、各テストで評価できるのは、作成または更新のいずれか一方のみです。レコードの作成をシミュレーションするテストを作成しましょう。

1. [Check Escalated in Cases (ケースのエスカレーションを確認)] フローを開きます。
   
2. [View Tests (テストを表示)] をクリックします。
   
3. [作成] をクリックします。
   
4. [Label (表示ラベル)] には、「Created: Status is Escalated, Escalated is False (作成済み: 状況がエスカレーション済み、エスカレーション済みが False)」と入力します。
   
5. [Run the Test When a Record Is (レコードが次の場合にテストを実行)] では、[Created (作成済み)] が選択されていることを確認します。
   
6. 実際の組織データを使用するようにテストを設定します。
   
   • [Test Setup (テストの設定)] タブを選択します。
     
   • [Run from Org Data (組織データから実行)] を選択します。
     デフォルトでは、テストはデータサイロのサンプルデータを使用するよう設計されていますが、データサイロは Apex クラスで設定されます。データサイロには多くのメリットがありますが、シンプルなユースケースでは組織データを使用しても問題ありません。
     
   • [Confirm (確認)] をクリックします。
     
7. [Set Initial Triggering Record (初期トリガーレコードを設定)] タブを選択します。
   
   これは、テストがアサーションをチェックするために使用するレコードであり、組織には保存されないことを忘れないでください。
   
8. [Status (状況)] で [Escalated (エスカレーション済み)] を選択します。
   この機能では、[Status (状況)] 項目と [Escalated (エスカレーション済み)] 項目のみがテストに関連します。[Escalated (エスカレーション済み)] 項目はデフォルトで False に設定されているため、[Status (状況)] 項目のみを設定すれば十分です。
   

アサーションを定義する

次に、テストのアサーションを定義します。これは、初期トリガーレコードでフローが実行された後に True である必要がある条件です。

1. [Set Assertions (アサーションを設定)] タブを選択します。
   
2. アサーション 1 を定義して、フローが [Status Escalated - IsEscalated False (状況がエスカレーション済み - IsEscalated が False)] パスを通過したことを確認します。
   
   • [Resource (リソース)] で [Criteria (条件)] を選択し、次に [Status Escalated - IsEscalated False (状況がエスカレーション済み - IsEscalated が False)] を選択します。
     
   • [Operator (演算子)] が [Equals (次の文字列と一致する)] であることを確認します。
     
   • [Value (値)] で [True] を選択します。
     アサーションでは、特定の決定結果パスをフローが通過したかどうかを、その決定結果が True に等しいかどうかを確認することでチェックします。
     
   • [Add Custom Failure Message (カスタムエラーメッセージを追加)] をクリックします。
     
   • [Custom Failure Message (カスタムエラーメッセージ)] には、「Flow did not take the Status Escalated - IsEscalated False path. (フローは Status Escalated - IsEscalated False パスを通過しませんでした。)」と入力します。
     アサーションが失敗すると、デバッグの詳細にアサーションのカスタムエラーメッセージが表示されます。カスタムエラーメッセージを使用すると、後で失敗したテストのトラブルシューティングが容易になります。
     
3. [+ Add Assertion (アサーションを追加)] をクリックします。
   
4. アサーション 2 を定義して、[IsEscalated (エスカレーション済み)] 項目が True に設定されたことを確認します。
   
   • Resources (リソース): [Triggering Case (トリガーケース)] > [Escalated (エスカレーション済み)]
     
   • Operator (演算子): Equals (次の文字列と一致する)
     
   • Value (値): 正しい
     
   • Custom Failure Message (カスタムエラーメッセージ): Escalated was not set to true. ([Escalated (エスカレーション済み)] が [True] に設定されませんでした。)
     
5. [保存] をクリックします。
   

更新用のテストを追加して初期トリガーレコードを定義する

次に、同じ機能に対するテストを作成しますが、今回はレコード更新をシミュレーションします。

1. [View Tests (テストを表示)] をクリックします。
   
2. [作成] をクリックします。
   
3. [Label (表示ラベル)] に、「Updated: Status is Escalated, Escalated is False (更新時: [Status (状況)] が [Escalated (エスカレーション済み)]、[Escalated (エスカレーション済み)] が [False])」と入力します。
   
4. [Run the Test When a Record Is (レコードが次の場合にテストを実行)] で、[Updated (更新されたとき)] を選択します。
   
5. [Set Initial Triggering Record (初期トリガーレコードを設定)] タブを選択します。
   
6. [Status (状況)] で [Working (処理中)] を選択します。
   
7. 実際の組織データを使用するようにテストを設定します。
   
   • [Test Setup (テストの設定)] タブを選択します。
     
   • [Run from Org Data (組織データから実行)] を選択します。
     
   • [Confirm (確認)] をクリックします。
     

更新後のトリガーレコードとアサーションを定義する

[Set Updated Triggering Record (更新後のトリガーレコードを設定)] タブには、フローが実行される前にフローをトリガーした変更が含まれていることを忘れないでください。これらの変更は、組織のデータベースには保存されません。

1. [Set Updated Triggering Record (更新後のトリガーレコードを設定)] タブを選択します。
   
   
2. [Status (状況)] で [Escalated (エスカレーション済み)] を選択します。
   
3. [Set Assertions (アサーションを設定)] タブを選択します。
   
4. アサーション 1 を定義して、トリガーレコードが [Status Escalated - IsEscalated False (状況がエスカレーション済み - IsEscalated が False)] 決定結果のパスを通過したことを確認します。
   

• Resources (リソース): [Criteria (条件)] > [Status Escalated - IsEscalated False (状況がエスカレーション済み - IsEscalated が False)]
  
• Operator (演算子): Equals (次の文字列と一致する)
  
• Value (値): 正しい
  
• Custom Failure Message (カスタムエラーメッセージ): Flow did not take the Status Escalated - IsEscalated False path. (フローは Status Escalated - IsEscalated False パスを通過しませんでした。)

5. [+ Add Assertion (アサーションを追加)] をクリックします。
   
6. アサーション 2 を定義して、[Escalated (エスカレーション済み)] が True に設定されたことを確認します。
   

• Resources (リソース): [Triggering Case (トリガーケース)] > [Escalated (エスカレーション済み)]
  
• Operator (演算子): Equals (次の文字列と一致する)
  
• Value (値): 正しい
  
• Custom Failure Message (カスタムエラーメッセージ): Escalated was not set to true. ([Escalated (エスカレーション済み)] が [True] に設定されませんでした。)

7. [保存] をクリックします。
   

フローのテストを実行する

テストを作成しましたので、次はテスト主導型開発の次のステップに進みます。合格すると思っていなくても、作成したテストを実行します。

1. [View Tests (テストを表示)] をクリックします。
   
2. [Test Label (テスト表示ラベル)] 列の上部にある [Select All (すべて選択)] チェックボックスをクリックして、両方のテストを選択します。
   
   
3. [実行] をクリックします。
   
   Flow Builder が両方のテストを実行し、[Result (結果)] 列に結果を表示します。どちらのテストも失敗しています。失敗した理由を確認するため、これらのテストの 1 つを見てみましょう。
   
4. [Updated: Status is Escalated, Escalated is False (更新時: 状況がエスカレーション済み、エスカレーション済みが False)] テストの行で、 をクリックし、[Run Test and View Details (テストを実行して詳細を表示)] を選択します。
   

Flow Builder はテスト実行とその詳細を表示し、テスト実行が通過したパス (1) を強調表示し、失敗したアサーションを示します。[Test Run Details (テスト実行の詳細)] では、失敗した各アサーションに、探していた条件 (2)、そのアサーションに定義したカスタムエラーメッセージ (3)、およびそれらの条件がチェックされた値 (括弧内) (4) が表示されます。

このテストで失敗したアサーションは、トリガーケースの [Escalated (エスカレーション済み)] 項目が True に設定されていることを確認します。[Set Escalated to True (Escalated を True に設定)] 要素を詳しく見て、[Escalated (エスカレーション済み)] 項目を True に設定しているか確認しましょう。

★ どうやら、このフローを作成した人は混乱しており、この要素を True ではなく False に設定するよう構成してしまったようです。テストがなければ、本番環境にリリースされる前にこのエラーに気付かなかったかもしれません。フローテストのメリットをすでに実感しています。まさに不可欠なツールです。

テストに合格するようにフローを更新する

テスト主導型開発では、このような事態が起きることを想定しています。次のステップに進みましょう。テストに合格するように機能を更新します。

1. [Edit Flow (フローを編集)] をクリックします。
   
2. [Set Escalated to True (Escalated を True に設定)] 要素を編集します。
   
3. [Value (値)] を True に変更します。
   
4. フローを保存します。
   
5. フローのすべてのテストを再び実行します。
   今回は、すべてのテストに合格するはずです。
   

フローを整理する

テスト主導型開発の最後のステップは、今作成した内容を整理することです。幸い、フローはすでに非常にシンプルで、要素にも説明が設定されています。先ほど修正した [Update Records (レコードを更新)] 要素の説明をよく見てみると、何と書かれていますか?

これは明らかに誤りです。この要素は、Escalated 項目を True に設定するよう変更したばかりです。次のステップに進む前に、この説明を更新してください。

新しい機能を追加する

テスト主導型開発サイクルの最後のステップを完了しましたので、新しい機能で最初からやり直します。フロー計画には、ケースがクローズされ、[Escalated (エスカレーション済み)] がチェックされている場合に、ケースの取引先の所有者に通知メールを送信するという、もう 1 つの機能があります。 この機能を作成しましょう。

決定結果を追加する

1. [Criteria (条件)] 要素で、[Outcome Order (結果の順序)] の横にある をクリックして、新しい結果を作成します。
   
2. [Label (表示ラベル)] には、「Closed - IsEscalated True (クローズ済み - IsEscalated が True)」と入力します。
   
3. [Closed - IsEscalated True (クローズ済み - IsEscalated が True)] 結果の 1 つ目の条件の要件を定義します。
   
   • [Resource (リソース)] で [Triggering Case (トリガーケース)] > [Status (状況)] を選択します。
     
   • [Operator (演算子)]は [Equals (次の文字列と一致する)] のままにします。
     
   • [Value (値)] で [Closed (クローズ済み)] を選択します。
     
4. [+ Add Condition (条件を追加)] をクリックします。
   
5. [Closed - IsEscalated True (クローズ済み - IsEscalated が True)] 結果の 2 つ目の条件の要件を定義します。
   
   • [Resource (リソース)] で [Triggering Case (トリガーケース)] > [Escalated (エスカレーション済み)] を選択します。
     
   • [Operator (演算子)]は [Equals (次の文字列と一致する)] のままにします。
     
   • [Value (値)] で [True] を選択します。
     
6. [When to Execute Outcome (結果を実行するタイミング)] で、[Only if the record that triggered the flow to run is updated to meet the condition requirements (フローの実行をトリガーしたレコードが条件の要件を満たすように更新された場合のみ)] を選択します。
   

メール機能を作成する

1. [Closed - IsEscalated True (クローズ済み - IsEscalated が True)] パスで、 をクリックします。
   
2. [Action (アクション)] を選択します。
   
3. [Action (アクション)] に email (メール) と入力し、[Send Email (メールを送信)] を選択します。
   
4. [表示ラベル] に「Email Account Owner」と入力します。
   
5. [Recipient Addresses (宛先アドレス)] で [Triggering Case (トリガーケース)] > [Account ID (取引先 ID)] > [Owner ID (所有者 ID)] > [Email (メール)] を選択します。
   
6. [Subject (件名)] には、「Your Customer's Escalated Ticket Has Been Closed (お客様のエスカレーション済みチケットはクローズされました)」と入力します。
   
7. [Body (本文)] 項目の横にある をクリックし、[Search Resources (リソースを検索)] を選択します。
   
8. [Body (本文)] で、[emailBody (メール本文)] (テキストテンプレート内) を選択します。
   
9. フローを保存します。
   

メール機能のテストを追加する

次に、フローのこの最後の機能に対して、もう 1 つテストを追加します。 この会社では、ケースをクローズ済みの状態で作成することは許可されていないため、レコードが更新された場合のテストのみを作成します。さらに簡単にするため、既存のケースから初期トリガーレコードを定義します。

初期トリガーレコードを定義する際は、関連する値を手動で設定することもできますが、必要な値が含まれているレコードを知っている場合は、そのレコードを選択して初期トリガーレコードの項目にそれらの値を反映させることもできます。

1. [View Tests (テストを表示)] をクリックします。
   
2. [作成] をクリックします。
   
3. テストの詳細、トリガー、パスを設定します。
   
   • Label (表示ラベル): Case is Closed and Escalated (ケースがクローズされていてエスカレーション済み)
   • Run the Test When a Record Is (レコードが次の場合にテストを実行): Updated (更新済み)
     
4. 実際の組織データを使用するようにテストを設定します。
   
   • [Test Setup (テストの設定)] タブを選択します。
     
   • [Run from Org Data (組織データから実行)] を選択します。
     
   • [Confirm (確認)] をクリックします。
     
5. 初期トリガーレコードを設定します。
   
   • [Set Initial Triggering Record (初期トリガーレコードを設定)] タブを選択します。
     
   • [Case for Test Data Only (テストデータ専用ケース)] 項目に「motor breaks (モーターが故障する)」と入力し、[Motor breaks down when turning on (起動時にモーターが故障する)] を選択します。
     
   • [Escalated (エスカレーション済み)] チェックボックスがオンになっていることを確認します。オンになっていない場合は、[Escalated (エスカレーション済み)] 表示ラベルをクリックしてチェックボックスをオンにします。
     
     ここでは値を使用するためのレコードを選択しているだけですので、実際のレコードがこのテストによって更新されることはありません。また、このレコードが将来削除された場合でも、テストは引き続き動作します。
     
6. 更新後のトリガーレコードを設定します。
   
   • [Set Updated Triggering Record (更新後のトリガーレコードを設定)] タブを選択します。
     
   • Status (状況): Closed (クローズ済み)
     

アサーションを定義する

1. [Set Assertions (アサーションを設定)] タブを選択します。
   
2. アサーション 1 を定義して、フローが [Closed - IsEscalated True (クローズ済み - IsEscalated が True)] パスを通過したことを確認します。
   

• Resources (リソース): [Criteria (条件)] > [Closed - IsEscalated True (クローズ済み - IsEscalated が True)]
  
• Operator (演算子): Equals (次の文字列と一致する)
  
• Value (値): 正しい
  
• Custom Failure Message (カスタムエラーメッセージ): Flow did not take the Closed - IsEscalated True path. (フローは Closed - IsEscalated True パスを通過しませんでした。)

3. [+ Add Assertion (アサーションを追加)] をクリックします。
   
4. アサーション 2 を定義して、フローがメールアクションを実行したことを確認します。
   

• Resources (リソース): [Email Account Owner (取引先所有者にメール)] (アクション)
  
  
• Operator (演算子): Was Visited (アクセス済み)
  
• Value (値): 正しい
  
• Custom Failure Message (カスタムエラーメッセージ): Flow did not run the email action. (フローはメールアクションを実行しませんでした。)

5. [保存] をクリックします。
   

すべてのテストをもう一度実行します。

これで、 3 つすべてのテストが合格しました。

これでテスト主導型開発を実践しました。機能を 1 つずつ作成し、テストでその機能の結果を定義し、テストが合格することを確認し、フローを整理しました。今は、決定要素の説明を更新し、新しいアクション要素に説明を追加します。

リソース

• Salesforce ヘルプ: 有効化前のフローのテスト