ヘルプセンターのユーザーセグメント

手動テストの手順

ユーザーセグメントの変更をテストする際は、次の 2 点を確認する必要があります:

• マージリクエストの作成後、サンドボックスにユーザーセグメントが存在すること
• API から取得した比較対象の JSON オブジェクトが YAML ファイルの内容と一致すること

サンドボックスにユーザーセグメントが存在すること

これは、マージリクエストからのサンドボックス同期によって、ユーザーセグメントが正しく作成されたことを確認するテストです。このテストを行うには、サンドボックスに管理者としてログインし、Knowledge 製品に移動してから Knowledge Admin > User permissions > User segments に移動します。作成または更新しているユーザーセグメントがそこに表示されていれば、テストは合格です。

API オブジェクトと YAML オブジェクトの一致

Zendesk サンドボックスの API オブジェクトと、編集中のファイルの YAML オブジェクトを確認する必要があります。次のキーの値が一致することを確認してください:

• user_type
• group_ids
• organization_ids
• tags
• or_tags
• added_user_ids
• name

2 つのオブジェクトの値が 完全に 一致していれば、テストは合格です。

テストスイートスクリプト

事前準備

スクリプトを実行する前に、次の準備が完了していることを確認してください:

• 環境に GITLAB_TOKEN が定義されていること
• 環境に SB_ZD_SECRET が定義されていること（Zendesk Global のテスト用）
• 環境に SB_ZD_CLIENT_NAME が定義されていること（Zendesk Global のテスト用）
• 環境に SB_ADMIN_EMAIL が定義されていること（Zendesk Global のテスト用）
• 環境に SB_ADMIN_PASSWORD が定義されていること（Zendesk Global のテスト用）
• 環境に US_SB_ZD_CLIENT_NAME が定義されていること（Zendesk US Government のテスト用）
• 環境に US_SB_ZD_SECRET が定義されていること（Zendesk US Government のテスト用）
• 環境に US_SB_ADMIN_EMAIL が定義されていること（Zendesk US Government のテスト用）
• 環境に US_SB_ADMIN_PASSWORD が定義されていること（Zendesk US Government のテスト用）

管理者またはエージェントとしてログインするため、リカバリーコードを生成できるよう、そのユーザーの管理ページも用意しておいてください。

仕組み

スクリプトは「段階」に分けて実行されます:

• 事前セットアップ
  • この段階では、スクリプトで使用する各種の中核的な関数（主に各種 Faraday 接続）を定義します
• 事前テスト
  • この段階では、事前準備が正しく完了していることを確認します。次の点を確認します
    • 実行に必要な環境変数
    • 現在のブランチが master または main でないこと
• 定義
  • この段階では、スクリプトで使用する各種の必要な変数を定義します
• GitLab 情報
  • この段階では、現在の git ブランチのマージリクエスト、対応する親 Issue、およびマージリクエスト内で行われたユーザーセグメントの変更を特定します。
• ユーザーセグメントのテスト
  • この段階では、実施するテストを定義し、実行します
  • 先に検出したユーザーセグメントの変更ごとに、子タスク項目を作成します（親項目にリンクします）
  • テストの実行に伴い、対応する子タスク項目に、テストの詳細と結果をコメントとして追加します
    • ブラウザーテストを行った場合は、追加するコメントにスクリーンショットを添付してください
• 実行後の指示
  • この段階では、親 Issue に要約コメントを追加します（すべての子タスク項目にリンクします）
    • テストでアップロードに失敗した場合に備えて、作成したすべてのスクリーンショットの保存先も示します

詳しい説明については、対応する録画（社内リンク）を参照してください。

ページのソースコードを見る - ページの編集 - please contribute.