エンドツーエンドテスト用の RSpec メタデータ
これは、エンドツーエンドテストで使用するRSpec メタデータ(タグ) の一部です。
| タグ | 説明 | |
|---|---|---|
| :elasticsearch | このテストは Elasticsearch サービスを必要とします。インスタンスレベルのシナリオ Test::Integration::Elasticsearchで、Elasticsearch を必要とするテストのみを含めるために使用されます。 | |
| :except | テストは、指定されたものを_除き_、通常の実行コンテキストで実行されます。詳細はテストの実行コンテキストの選択を参照してください。 | |
| :external_api_calls | テストはDockerネットワークの外部ネットワークとのやり取りを必要とします。 | |
| :feature_flag | このテストは機能フラグを使用するため、実行には管理者アカウントが必要です。 scopeが:globalに設定されている場合、テストはすべてのライブ .com 環境でスキップされます。そうでない場合は、Canary、Production、Pre-productionでのみスキップされます。詳細は機能フラグを使ったテストを参照してください。 | |
| :framework | このテストは、QA フレームワーク自体のサニティアサーションを行います。 | |
| :geo | このテストでは、プライマリとセカンダリの 2 つの GitLab Geo インスタンスを立ち上げる必要があります。 | |
| :gitaly_cluster | テストはGitLabインスタンスに対して実行され、リポジトリはPraefectノードの後ろにある冗長化されたGitalyノードに保存されます。すべてのノードは別々のコンテナです。このタグを使用するテストでは、起動が必要なコンテナが 3 つ追加されるため、セットアップ時間が長くなります。 | |
| :github | このテストには GitHub パーソナルアクセストークンが必要です。 | |
| :group_saml | テストには、グループレベルで SAML SSO が有効になっている GitLab インスタンスが必要です。外部の SAML ID プロバイダと対話します。 :orchestratedタグと対になっています。 | |
| :instance_saml | このテストには、インスタンスレベルで SAML SSO が有効になっている GitLab インスタンスが必要です。外部の SAML ID プロバイダとやり取りします。 :orchestratedタグと対になっています。 | |
| :integrations | これは、利用可能なインテグレーションをテストすることが目的です。このテストには、実行コンテキストにDockerがインストールされている必要があります。コンテナをプロビジョニングし、ローカルインスタンスに対して実行するか、 gitlab-qaシナリオを使用します。Test::Integration::Integrations | |
| :issue,:issue_${num} | 仕様に関連する可能性のあるイシューへのオプションリンク。関連するイシューの追跡に役立ち、テストレポートを作成するツールでも使用できます。現在、 Allureテストレポートに自動的に追加されます。issue_1やissue_2などのように、オプションで数字の接尾辞を追加することで、複数のタグを使用することができます。 | |
| :service_ping_disabled | このテストはインスタンスレベルで GitLab 設定サービス ping と相互作用し、管理エリアの設定サービス ping チェックボックスをオンまたはオフにします。このタグは service_ping_disabledジョブでのみテストが実行され、:orchestratedと:requires_adminタグとペアでなければなりません。 | |
| :jira | テストには Jira Server が必要です。GitLab-QAは Test::Integration::Jiraテストシナリオの実行時に Docker コンテナで Jira Server をプロビジョニングします。 | |
| :kubernetes | このテストには、SSH トンネルの後ろで実行されるように設定された GitLab インスタンスが含まれ、TLS でアクセス可能な GitLab を実現します。このテストには、少なくとも一つのKubernetesクラスターのプロビジョニングも含まれます。このタグはしばしば :orchestratedと対になります。 | |
| :ldap_no_server | このテストでは、GitLabインスタンスがLDAPを使うように設定されている必要があります。 :orchestrated。オーケストレーション時に LDAP サーバーを立ち上げるわけではありません。代わりに、実行時にLDAPサーバーを作成します。 | |
| :ldap_no_tls | このテストでは、GitLabインスタンスがTLSを有効にしていない外部のLDAPサーバーを使うように設定されている必要があります。 | |
| :ldap_tls | このテストでは、GitLabインスタンスがTLSを有効にして外部のLDAPサーバーを使用するように設定されている必要があります。 | |
| :mattermost | このテストには、GitLab インスタンス上に GitLab Mattermost サービスが必要です。 | |
| :metrics | テストには、専用のメトリクスエクスポーターがPumaとSidekiqと一緒に稼働しているGitLabインスタンスが必要です。 | |
| :mixed_env | このテストは、 gitlab_canary=trueクッキーの存在に基づくトラフィックルーティングによって、ペアになったカナリアバージョンを利用できる環境でのみ実行してください。このカテゴリのテストは、混合デプロイ環境を検証するために、テストの途中でクッキーを切り替えます。 | |
| :oauth | このテストは GitLab にログインするために外部の OmniAuth プロバイダを使用します。 | |
| :object_storage | このテストでは、GitLabインスタンスが複数のオブジェクトストレージタイプを使用するように設定されている必要があります。オブジェクトストレージサーバーとしてMinIOを使用します。 | |
| :only | テストは特定の実行コンテキストでのみ実行されます。詳細については、テストの実行コンテキストの選択を参照してください。 | |
| :orchestrated | テスト対象の GitLab インスタンスは、 gitlab-qa](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/docs/what_tests_can_be_run.md#orchestrated-tests) によってデフォルトの GitLab 設定とは異なるように[設定されるかもしれませんし、gitlab-qaによって別の Docker コンテナで追加のサービスを起動するかもしれませんし、その両方かもしれません。GitLabの設定を動的に変更できない環境(例えばステージング)をテストする場合、:orchestratedのタグが付いたテストは除外されます。 | |
| :product_group | テストが属する製品グループを指定します。包括的なグループの一覧はProduct sections, stages, groups, and categoriesを参照してください。 | |
| :quarantine | テストは隔離され、隔離されたテストのみが含まれる別のジョブで実行され、失敗してもかまいません。テストは通常のジョブでスキップされるため、失敗してもパイプラインが滞ることはありません。特定のコンテキストで実行されるテストだけを隔離することもできます。 | |
| :relative_url | このテストでは、相対 URL の下に GitLab インスタンスがインストールされている必要があります。 | |
| :reliable | このテストは信頼できるテストに昇格させられました。つまり、マージリクエストを含むすべてのパイプラインで一貫してパスするということです。 | |
| :repository_storage | このテストでは、GitLab インスタンスが複数のリポジトリストレージパスを使用するように設定されている必要があります。 :orchestratedタグと対になっています。 | |
| :requires_admin | このテストには管理者アカウントが必要です。Canary や Production 環境でこのタグを使ったテストは除外されます。 | |
| :requires_git_protocol_v2 | このテストでは、Git プロトコル バージョン 2 がサーバー上で有効になっている必要があります。デフォルトでは有効になっていますが、有効になっていない場合は QA_CAN_TEST_GIT_PROTOCOL_V2をfalseに設定することでテストをスキップできます。 | |
| :requires_praefect | このテストでは、GitLabインスタンスがリポジトリストレージとしてGitalyクラスタ(別名Praefect)を使っていることを確認します。デフォルトで使用されていると仮定されていますが、そうでない場合は QA_CAN_TEST_PRAEFECTをfalseに設定することでテストをスキップすることができます。 | |
| :runner | このテストは GitLab Runner インスタンスに依存してセットアップします。 | |
| :sanity_feature_flags | このテストは、テストフレームワークの機能フラグ処理部分の機能を検証します。 | |
| :skip_live_env | ステージング、カナリア、プロダクションのようなデプロイされた環境に対して実行する場合、このテストは除外されます。 | |
| :skip_fips_env | このテストは、FIPS モードの環境に対して実行すると除外されます。 | |
| :skip_signup_disabled | このテストは新規ユーザ登録に UI を使用するため、UI 経由での新規ユーザ登録を許可しない環境ではスキップされます。 | |
| :smoke | このテストは GitLab インスタンスの基本的な機能を検証するテストスイートに属します。 | |
| :smtp | このテストでは、GitLabインスタンスがSMTPサーバを使用するように設定されている必要があります。MailHogを使ってGitLabからのSMTP通知メール配信をテストします。 | |
| :testcase | GitLabプロジェクトのテストケースのイシューへのリンクです。 | |
| :transient | このテストは一過性のバグをテストします。デフォルトでは除外されています。 | 
