Actions をテストする

Actions Code Editor または Management API でサンプルペイロードを実行し、テナントログでエンドツーエンドのフローを検証し、モックイベントおよび API オブジェクトを使用してハンドラーコードのユニットテストを完了することで、Auth0 Actions をテストおよびデバッグします。

Auth0 Actions のテストやデバッグには、実装の進み具合に応じていくつかの方法があります。

各Actionは、実装しながら Auth0 Dashboard から個別にテストすることをおすすめします。準備ができたら、Auth0 Dashboard でテナントログを使って、エンドツーエンドのフローが想定どおりに動作することを確認してください。

​

個別の Action をテストする

Actions Code Editor を使うと、個々の Action をテストできます。エディタのテスト機能では、Action に関連付けられたフローに基づくサンプルのペイロードを使用して、Action の呼び出しをシミュレートできます。個別の Action をテストするには、次の手順に従います。

1. Auth0 Dashboard > Actions に移動し、編集するフローと Action を選択します。
2. Actions Code Editor を開き、サイドバーから Test (再生アイコン) を選択します。Test サイドバーでペイロードを編集すると、異なるペイロードでの結果を確認できます。
3. Run を選択します。

テスト結果には、Action が実行したステップ、コンソール出力、発生したエラー、および Action の実行に関する役立つ統計情報が表示されます。

Management API の Test an Action endpoint を使用し、Action に関連付けられているフローに対応するペイロードを指定して Action をテストすることもできます。サンプルのペイロードを取得するには、Actions Code Editor の Test 機能で Action をテストしてください。

​

デプロイ済みの Actions をデバッグする

Action のテストが完了したら、次はそれをデプロイして実際の実行状況を確認します。Action をすでにデプロイし、フローに追加している場合 (Actions を フロー に追加する方法については、Write Your First Action の「Attach the Action to a flow」セクションを参照してください) 、いくつかの手順で実行中の Action をデバッグできます。

​

エンドツーエンドのログインフローを検証する

post-login Action の場合は、テナントでログインを試すことで、エンドツーエンドのログインフローを検証できます。

1. Auth0 Dashboard > Authentication > Authentication Profile に移動し、Try を選択します。サンプルログインを含むウィンドウが開きます。
2. ログインフローを進めます。設定済みの Action は、このログインフローの中ですべて実行されます。

完了すると、アプリケーションが受け取るユーザープロファイル属性の一覧が表示されるページ、または問題の内容を説明するエラーメッセージが表示されるページにリダイレクトされます。

​

テナントログを分析する

フローに関連付けられた Action がバインドされたトリガーが実行されるたびに、テナントログ に Action の実行詳細が記録されます。

テナントログの一覧では、Actions に関連するログを確認して表示できます。以下の例では、Success Login というログタイプが、このテナントの post-login トリガー上の Action に関連付けられています。

Actions に関連するログタイプには、次のようなものがあります。

Name	Trigger(s)
Success Login	post-login
Failed Login	post-login
Success Exchange	post-login
Failed Exchange	post-login
Success Change Password	post-change-password
Failed Change Password	post-change-password
Successful Signup	pre-user-registration
Failed Signup	pre-user-registration
Success Exchange	credentials-exchange
Failed Exchange	credentials-exchange

Action の実行に関する詳細情報を表示するには、Action の実行に関連するログを選択し、Action Details ビューを開きます。Action Details では、実行統計、コンソール出力、発生したエラーを確認できます。

​

Actions の単体テスト

​Action 関数に渡される event と api をモックすることで、Auth0 Actions の単体テストを行えます。Actions はバージョン管理システムやローカルディレクトリで管理でき、Jest のようなツールを使えば自動的にテストできます。次の例では、Login / Post Login トリガーと Jest を使ってモックとテストを行います。

Action コード:

// action.js

exports.onExecutePostLogin = async (event, api) => {
  const namespace = "https://my-app.example.com";
  if (event.authorization) {
    api.idToken.setCustomClaim(`${namespace}/favorite_color`, "pink");
  }
};

テストファイルのコード:

// action.spec.js

const { onExecutePostLogin } = require("./action.js");
test("sets favorite_color ID token claim to pink", async () => {
  const namespace = "https://my-app.example.com";
  const mockFunction = jest.fn();
  const mockApi = { idToken: { setCustomClaim: mockFunction } };
  const mockEvent = {authorization: {}};

  await onExecutePostLogin(mockEvent, mockApi);
  expect(mockFunction).toBeCalledWith(
    `${namespace}/favorite_color`,
    "pink"
  );
});

​

ベストプラクティス

Auth0 で Actions を構築する際は、環境ごとに専用の Auth0 テナントを作成することを推奨します。これにより、本番環境のユーザー基盤を他の環境から分離できるほか、環境ごとに異なる管理者を設定できます (たとえば、エンジニアには本番環境の設定へのアクセスを許可しないようにできます) 。

CLI や CI/CD パイプラインを使って Actions を完全に管理、テスト、デプロイしたい場合は、Deploy CLI Tool を使用できます。