テスト受け入れ

失敗した単体テストの結果を受け入れます。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

この記事の内容

メモ

このコンテンツでは、CodeQL CLI の最新リリースについて説明します。 このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。

以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。

概要

Shell
codeql test accept <options>... -- <test|dir>...

Description

失敗した単体テストの結果を受け入れます。

これは、失敗したテストの .actualによって残された ファイルの名前を .expected に変更し、同じ出力が得られるテストで今後の実行が成功と見なされるようにする便利なコマンドです。 これは通常のファイル操作でも実現できますが、この特殊なケースでは構文の方が便利な場合があります。

コマンド ライン引数は、1 つ以上の "テスト" (つまり、__ ファイル) を指定すると、コマンドによってそこから .ql(ref) ファイルの名前が自動的に派生します。.actual .actual ファイルを含まないテストは、警告なく無視されるため、前の実行で "失敗した" テストの結果だけを簡単に受け入れられます。__

オプション

主なオプション

<test|dir>...

各引数は、次のいずれかです。

  • 実行するテストを定義する .ql または .qlref ファイル。
  • 実行するテストを再帰的に検索するディレクトリ。

--slice=<N/M>

          \[詳細設定] テスト ケースをほぼ同じサイズの _M_ 個のスライスに分割し、そのうちの _&#x4E;_ 番目のみを処理します。 これは、テスト プロセスの手動による並列化に使用できます。

--[no-]strict-test-discovery

          \[詳細設定] テストとして明確に識別できるクエリのみを使用します。

このモードでは、単体テストを定義する .ql ファイルと、有用なクエリを意図した .ql ファイルを区別しようとします。 このオプションは、ディレクトリ ツリー内のファイルがどのように配置されているかが事前にわからなくても、ディレクトリ ツリー内のすべての単体テストを識別する必要がある IDE などのツールで使用されます。

          `qlpack.yml` で `tests` ディレクトリを宣言する QL パック内では、そのディレクトリ内のすべての `.ql` ファイルがテストと見なされ、そのディレクトリの外部にある `.ql` ファイルは無視されます。 
          `tests` ディレクトリを宣言しない QL パックでは、対応する `.ql` ファイルがある場合にのみ、`.expected` ファイルがテストとして識別されます。

一貫性を保つために、.qlref ファイルが実際にはテストではないファイルにできない場合でも、.ql ファイルは .qlref ファイルと同じ規則によって制限されます。

共通オプション

-h, --help

このヘルプ テキストを表示します。

-J=<opt>

          \[詳細設定] コマンドを実行している JVM にオプションを指定します

(スペースを含むオプションは正しく処理されないことに注意してください)。

-v, --verbose

出力される進行状況メッセージの数を段階的に増やします。

-q, --quiet

出力される進行状況メッセージの数を段階的に減らします。

--verbosity=<level>

          \[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 
          `-v` と `-q` がオーバーライドされます。

--logdir=<dir>

          \[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます

(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。

--common-caches=<dir>

          \[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、デフォルトではユーザーのホーム ディレクトリに名前が付けられた `.codeql` ディレクトリになります。まだ存在しない場合は作成されます。

          `v2.15.2` 以降で使用できます。