UIP TM の要件

uip tm requirements Test Manager プロジェクト内の要件を管理します。要件はトレーサビリティレイヤーであり、システムが実行する必要があることを表し、各要件を1つ以上のテストケースにリンクしてカバレッジを示すことができます。

概要

uip tm requirements list --project-key <key> [--filter <text>] [--requirement-ids <ids...>] [--labels <labels...>] [--updated-by <userId>] [--test-case-id <uuid>] [--changed-since <datetime>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements get --project-key <key> [--requirement-id <uuid>] [--requirement-key <key>]
uip tm requirements create --project-key <key> --name <name> [--description <text>] [--external-reference <ref>] [--connector-requirement-uuid <uuid>]
uip tm requirements update --project-key <key> --requirement-id <uuid> [--name <name>] [--description <text>]
uip tm requirements delete --project-key <key> --requirement-ids <uuid...> [-y]
uip tm requirements export --project-key <key> --output-file <path>
uip tm requirements list-testcase-ids --project-key <key> --requirement-id <uuid>
uip tm requirements testcases --project-key <key> --requirement-id <uuid> (--add-testcase-ids <uuid...> | --remove-testcase-ids <uuid...>)
uip tm requirements list-by-test-execution --project-key <key> --execution-id <uuid> [--labels <label...>] [--updated-by <userId>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]

すべての動詞は、 グローバルオプション と標準 終了コードを尊重します。すべての動詞は -t, --tenant <name> と --log-level <level> を受け入れます(デフォルト Information)。

UIP TM 要件リスト

豊富なサーバー側フィルター処理機能を備えたプロジェクト内の要件を一覧表示します。

引数

設定はありません。

オプション

• --project-key <key> (必須) — リストするプロジェクト。
• --filter <text> — 名前またはキーで要件を検索します。
• --requirement-ids <uuid...> — 含めるスペースで区切られたUUID。
• --labels <labels...> — フィルター処理に使用する、スペースで区切られたラベル名です。
• --updated-by <userId> — 要件を最後に更新したユーザー ID でフィルター処理します。
• --test-case-id <uuid> — このテスト ケースの UUID にリンクされている要件のみを返します。
• --changed-since <datetime> — この ISO-8601 タイムスタンプの後に変更された要件を返します。
• --sort-by <expr> — ソート式 (フィールド名、オプションで :asc または :descで接尾辞を付ける) をソートします。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20

データシェイプ

{
  "Code": "RequirementsList",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}

UIP TM の要件 GET

要件を 1 つ取得します。--requirement-idまたは--requirement-keyを指定する必要があります。これらは任意であり、相互に排他的です。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --requirement-id <uuid> — 内部要件 UUID。--requirement-keyと相互に排他的です。
• --requirement-key <key> — 要件キー (例: DEMO:1)。--requirement-idと相互に排他的です。

例

uip tm requirements get \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "RequirementGet",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in",
    "Description": "Login with valid credentials succeeds"
  }
}

uip tm の要件 作成

プロジェクトに新しい要件を作成します。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --name <name> (必須) — 要件名。
• --description <text> — 自由形式の説明。既定値は空です。
• --external-reference <ref> — 外部システム参照 (Jira チケット ID など)。
• --connector-requirement-uuid <uuid> — 接続された外部要件システムからの UUID。

例

uip tm requirements create \
  --project-key DEMO \
  --name "User must be able to log in" \
  --external-reference "JIRA-123"

データシェイプ

{
  "Code": "RequirementCreate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in"
  }
}

UIP TM の要件の更新

既存の要件を更新します。これらのフィールドの少なくとも 1 つを指定する必要があります。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --requirement-id <uuid> (必須) — 更新する要件の内部UUID。
• --name <name> — 新しい名前。
• --description <text> — 新しい説明。

例

uip tm requirements update \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --name "User must be able to log in with MFA"

データシェイプ

{
  "Code": "RequirementUpdate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in with MFA",
    "Result": "Updated"
  }
}

uip tm の要件 delete

内部 UUID によって 1 つ以上の要件を削除します。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --requirement-ids <uuid...> (必須) — 削除するスペースで区切られた内部 UUID。
• -y, --yes — 確認プロンプトをスキップします。

例

uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
  --yes

データシェイプ

{
  "Code": "RequirementDelete",
  "Data": {
    "Deleted": 2,
    "Result": "Deleted"
  }
}

UIP TM 要件のエクスポート

要件をファイルにエクスポートします。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --output-file <path> (必須) — エクスポート ファイルを書き込むためのパスです。

例

uip tm requirements export \
  --project-key DEMO \
  --output-file ./requirements-export.xlsx

データシェイプ

{
  "Code": "RequirementExport",
  "Data": {
    "OutputPath": "./requirements-export.xlsx",
    "Result": "Exported"
  }
}

uip tm requirements list-testcase-ids

要件にリンクされているテスト ケースの UUID を一覧表示します。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --requirement-id <uuid> (必須) — 要件の内部UUID。

例

uip tm requirements list-testcase-ids \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "RequirementTestCaseIds",
  "Data": [
    "b2c3d4e5-0000-0000-0000-000000000001",
    "c3d4e5f6-0000-0000-0000-000000000001"
  ]
}

UIP TM の要件のテスト ケース

要件に対するテスト ケースのリンクを追加または削除します。--add-testcase-ids または --remove-testcase-ids のいずれかを渡します (同じ呼び出しで両方を渡すことはできません)。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --requirement-id <uuid> (必須) — 修正する要件。
• --add-testcase-ids <uuid...> — リンクするスペース区切りのテスト ケース UUID。
• --remove-testcase-ids <uuid...> — リンクを解除するスペースで区切られたテスト ケースの UUID。

例

# link test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --add-testcase-ids b2c3d4e5-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001

# unlink test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --remove-testcase-ids b2c3d4e5-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "RequirementTestCases",
  "Data": {
    "RequirementId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

uip tm の要件 list-by-test-execution

特定のテスト実行でカバーされる要件を一覧表示します。その実行にリンクされたテスト ケースが含まれていた要件を返します。

引数

設定はありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --execution-id <uuid> (必須) — テスト実行 UUID。
• --labels <label...> — ラベル名 (スペース区切り) でフィルター処理します。
• --updated-by <userId> — 要件を最後に更新したユーザー ID でフィルター処理します。
• --filter <text> — 名前またはキーで要件を検索します。
• --sort-by <expr> — ソート式 (フィールド名、オプションで :asc または :descで接尾辞を付ける) をソートします。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "RequirementsListByTestExecution",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}

関連

• プロジェクト — プロジェクト スコープを所有します。
• テスト ケース — 要件にリンクできるテスト ケースです。

参照

• Test Manager の概要
• 認証