PICT Editor
Microsoft の PICT(ペアワイズ法でテストケースを生成するツール)のモデルファイルを、VS Code で書いて実行し、生成したテストケースを表で確認できる拡張機能である。
特徴
- モデルファイルのハイライト: 拡張子
.pict のファイルで、パラメータの定義、値の別名(|)、否定の値(~)、重み((n))、ほかのパラメータの値の参照(<名前>)、サブモデル({ } @ n)、制約(IF THEN ELSE、AND OR NOT、LIKE IN、IsNegative IsPositive、[パラメータ]、比較の演算子、文字列、数値)、コメント(#)を色分けして表示する。PICT と同じく、最初の制約から後の行は、すべて制約として色分けする。
- エディタから実行できる: ファイルの先頭の「実行」、エディタの右上の実行のボタン、コマンドパレットの「PICT Editor: PICT を実行」のどれかで、pict.exe を実行する。保存していない変更も含めて実行する。
- 実行の条件をファイルに書ける: 組み合わせの次数などの PICT のオプションを、モデルファイルのコメントに書いておける。
- 結果を表で扱える: 結果は、下のパネルのビュー「PICT 結果」に、モデルファイルごとのタブで表示する。件数の表示、列の見出しの押下による並べ替え、コピー(表計算ソフトに貼り付けられる形式)、CSV での保存ができる。
必要な環境
- VS Code 1.95 以降。
- pict.exe。PICT のリリースから取得し、PATH に通すか、設定
pictEditor.pictPath に場所を指定する。
- (
LOOKUP を使う場合)Salesforce CLI(sf コマンド)。検索する組織に、Salesforce CLI で別名を付けてログインしておく。
基本の使い方
- 拡張子
.pict のファイルを作成し、モデルを書く。
- ファイルの先頭に表示される「実行」を押下する。
- 下のパネルのビュー「PICT 結果」に、生成したテストケースの表が表示される。
# @次数 2
# パラメータ
Type: Primary, Logical, Span, Stripe
Size: 10, 100, 500 (5), 1000
File system: FAT, FAT32, NTFS
Format method: quick, slow
Compression: on, off
# 制約
IF [File system] = "FAT" THEN [Size] <= 100;
この例では、5つのパラメータの値の、すべての2つの組み合わせを含むテストケースを生成する。値 500 は (5) の重みで、ほかの値より多く選ばれやすくする。ファイルシステムが FAT のテストケースでは、サイズを 100 以下にする。
モデルの書き方は、PICT の資料(pict.md)を参照する。
実行のオプション
ファイルのコメントに、1つのオプションを1行ずつ、# @名前 値 の形で書く(値のないオプションは # @名前 だけ)。PICT 自身は # で始まる行をコメントとして無視するため、モデルの意味は変わらない。
# @次数 3
# @乱数の種 1
# @シードファイル seed.txt
| 名前 |
値 |
意味 |
@次数 |
1 以上の整数か 最大 |
組み合わせの次数(書かなければ 2)。最大 は、すべての組み合わせ。 |
@乱数 |
なし |
乱数を使って生成する。実行するたびに結果が変わる。 |
@乱数の種 |
0 以上の整数 |
乱数を使って生成する。同じ種なら、同じ結果になる。@乱数 とは一緒に書けない。 |
@シードファイル |
ファイルのパス |
必ず含めるテストケースを書いたファイル。相対パスは、モデルファイルのフォルダを基準にする。空白を含むパスも、そのまま書く。 |
@大文字小文字を区別 |
なし |
値と制約の比べ方で、大文字・小文字を区別する。 |
@値の区切り |
半角の文字 1 文字 |
値の区切りの記号(書かなければ ,)。 |
@別名の区切り |
半角の文字 1 文字 |
別名の区切りの記号(書かなければ \|)。 |
@否定の接頭辞 |
半角の文字 1 文字 |
否定の値の接頭辞(書かなければ ~)。 |
- 数字は全角でも書ける。
- 区切りの記号(値の区切り・別名の区切り・否定の接頭辞)には、空白を除く半角の文字(
; / ! などの記号や英数字)を 1 文字だけ使える。全角の文字(; など)は、PICT で区切りとして働かないため使えない。値に含まれる文字を選ぶと値が分かれてしまうため、値に使わない文字を選ぶ。3 つの記号は、互いに違う記号にする(書かなかったものは、既定の , | ~ と比べる)。
- 区切りの記号を変えた場合も、ハイライトは既定の記号(
, | ~)を前提にする。
- 同じオプションは2回書けない。
- 名前や値に誤りがある場合は、実行せずに「PICT 結果」に誤りの行と内容を表示する。以前の書き方(
# @options /o:3)も、書き換えを促す誤りとして示す。
- ファイルの先頭の「実行」と、結果の表の上には、指定したオプションを日本語の名前で表示する。
プレースホルダ(テストデータの値の生成)
パラメータの値に、{ } で囲んだプレースホルダを書くと、関数・クラスで作った値に置き換える。PICT が作る値の組み合わせに加えて、連番・日付・乱数などの値を作り、結果をそのままテストデータとして使える。
# @並べ替え 区分
顧客コード: C{PAD({Sequence.next()}, 5, 0)}
区分: 法人, 個人
登録日: {TODAY()}, {ADDDAYS({TODAY()}, -30)}
電話番号: 090{RANDSTR(8, digit)}
この例では、顧客コードは表示の順に上から C00001, C00002, … となり、登録日は今日と 30 日前の 2 つの値で組み合わせを作り、電話番号は行ごとに乱数の番号になる。
書き方
{関数名(引数, …)}(例: {TODAY()})。引数がなくても () を書く。
{クラス.メソッド()}(例: {Sequence.next()})と、その場でインスタンスを作る {クラス(引数).メソッド()}(例: {Sequence(1001).next()})。
- 入れ子(
{PAD({Sequence.next()}, 5, 0)})と、文字との連結(C{Sequence.next()})ができる。
- 引数は
, で区切る。,・括弧・前後の空白を含む引数は '…' か `…` で囲む(囲みと同じ引用符は 2 つ重ねる)。
{ を文字として書くときは \{ と書く。
- 名前の大文字・小文字は区別する。
関数とクラス
| 名前 |
値 |
Sequence.next() |
連番(1, 2, 3, …)。ファイルの中で 1 つの連番を共有する。 |
Sequence(開始, 増分).next() |
連番(開始と増分を指定する。省略時は 1 と 1)。書いた場所ごとに別に数える。 |
RANDINT(最小, 最大) |
最小から最大までの整数の乱数。 |
RANDSTR(長さ, 文字の種類) |
乱数の文字列。文字の種類は alnum(英数字。省略時)・alpha・upper・lower・digit・hex。 |
RANDDATE(開始日, 終了日) |
開始日から終了日までの日付の乱数(YYYY/MM/DD)。 |
PAD(値, 桁数, 埋める文字) |
値の左を埋める文字で埋めて、桁数にする(値が桁数より長ければそのまま)。 |
TODAY() |
今日の日付(YYYY/MM/DD)。 |
NOW() |
現在の日時(YYYY/MM/DD HH:mm:ss)。 |
ADDDAYS(日付, 日数) |
日付に日数を足す(負の数で引く)。 |
ADDMONTHS(日付, 月数) |
日付に月数を足す。月末の日付は月末に、その月にない日は月末にする。 |
LOOKUP(オブジェクト, WHERE 句, 選び方, ORDER BY) |
Salesforce の組織で、オブジェクトを WHERE 句で検索し、レコードの ID を返す。選び方と ORDER BY は省ける(次の「Salesforce のレコードの ID(LOOKUP)」)。 |
VALUE(パラメータ名) |
結果の表の同じ行の、指定のパラメータの値(その列にプレースホルダがあれば、解決した後の値)。名前に ,・括弧があれば ` で囲む。 |
LEFT(値, 文字数) |
値の先頭から文字数の分の文字列。 |
RIGHT(値, 文字数) |
値の末尾から文字数の分の文字列。 |
MID(値, 開始, 文字数) |
値の開始の位置(1 文字目が 1)から文字数の分の文字列。 |
LEN(値) |
値の文字数。 |
SOQLSTR(値) |
値を SOQL の文字列にする(' で囲み、' と \ をエスケープする)。LOOKUP の WHERE 句に値を入れる時に使う。 |
LEFT・RIGHT・MID・LEN の文字数は、日本語や絵文字も 1 文字として数える。値の長さを超える指定は、取れる分だけ返す(例: {LEFT(abc, 5)} は abc、開始が値の長さを超える MID は空)。文字数が負の数、MID の開始が 1 未満なら誤りとして表示する。例: {LEFT({VALUE(氏名)}, 2)}(氏名の先頭の 2 文字)。
日付は YYYY/MM/DD か YYYY-MM-DD で書き、0001/01/01 から 9999/12/31 までを扱う。整数(連番の値、乱数の範囲、日数・月数など)は、-9007199254740991 から 9007199254740991 までを扱う。範囲を超える値は、誤りとして表示する(結果の表を出す前に作る値なら、そのセルを #ERROR にする)。
Salesforce のレコードの ID(LOOKUP)
LOOKUP は、Salesforce の組織のレコードを検索して、その ID を値にする。参照項目に入れる既存のレコードの ID などを、テストデータに使える。
# @alias my-sandbox
取引先: {LOOKUP(取引先, `取引先名 = 'テスト取引先'`)}
担当者: {LOOKUP(User, `Username = 'tester@example.com.sandbox'`)}
検索する組織は、ファイルに # @alias 別名 と書く(Salesforce CLI の組織の別名。SOQL Editor の // @alias と同じ)。書かずに LOOKUP を使うと、実行せずに誤りを表示する。
1 つ目の引数はオブジェクト、2 つ目は WHERE 句。どちらも API 名のほか、SOQL Editor と同じく表示ラベル・項目ラベルで書ける(参照先の項目は 所有者.氏名 のように . でつなぐ)。WHERE 句は ' を含むため、` で囲む。
3 つ目の引数に、複数件に当たった時の選び方を書ける。
| 選び方 |
動作 |
ONE(省略時) |
1 件だけに当たる条件で使う。0 件・複数件なら、実行せずに誤りを表示する。 |
FIRST |
先頭の 1 件を使う。4 つ目の引数に ORDER BY の項目を書ける(例: `作成日時 DESC`。ラベルで書ける)。書かなければ Id の昇順。 |
RANDOM |
当たったレコードから、結果の表の行ごとにランダムに選ぶ(# @乱数の種 で再現できる)。候補は 2000 件まで(超えれば誤り)。 |
例: {LOOKUP(取引先, `業種 = 'Banking'`, FIRST, `作成日時 DESC`)}、{LOOKUP(取引先, `業種 = 'Banking'`, RANDOM)}
どの選び方でも、0 件なら誤りを表示する。
検索は、pict.exe に渡す前に、同じ検索を 1 回の実行で 1 回だけ行う。ONE・FIRST の値は pict.exe に渡す前に決まり、制約で比べられる。RANDOM の値は、結果の表を出す前に行ごとに決まるため、制約では比べられない。
検索だけを行い、組織のデータは変えない。接続には Salesforce CLI のログインを使い、アクセストークンはメモリにだけ持つ。
Salesforce CLI が見つからない、ログインしていない、オブジェクト・項目の名前の誤りなどは、LOOKUP を書いた行に誤りとして表示する。
同じ行のほかのパラメータの値を条件に使える(VALUE)。例えば、パラメータ「取引先名」の値ごとに、その名前の取引先の ID を値にする。
取引先名: GenePoint, United Oil & Gas Corp.
取引先ID: {LOOKUP(取引先, 取引先名 = {SOQLSTR({VALUE(取引先名)})})}
- 値を SOQL の条件に入れる時は、
SOQLSTR で囲む(値の ' などをエスケープする)。
- 引数に行ごとに変わる値(
VALUE・Sequence・乱数)を含む LOOKUP は、pict.exe の出力の後に、行ごとの条件で検索する。同じ条件は 1 回だけ検索し、異なる条件は合わせて 200 件まで(超えれば誤り)。
- 行ごとの検索の誤り(0 件・複数件など)は、そのセルを
#ERROR にし、表の上に内容を示す。
- 行ごとに決まる値は、制約では比べられない。
ほかの LOOKUP の結果を条件に使える(例: {LOOKUP(取引先責任者, 取引先 = '{LOOKUP(取引先, `取引先名 = 'A'`)}')})。内側を検索した後に、その結果で外側を検索する。引用符(` や ')で囲んだ引数は文字のまま扱うため、プレースホルダを含む WHERE 句は囲まずに書く(, や括弧は書けない)。
値を作るタイミング
- 行ごとに値が変わるもの(
Sequence と乱数の関数。入れ子で含むものも)は、結果の表を出す前に、行ごとに値を作る。連番は、実行したときの表示の順(# @並べ替え の指定の順。指定がなければ PICT の出力の順)に上から振り、その値が出る行だけで進む。見出しを押下して並べ替えても、値は変わらない。
- それ以外(日付の関数など)は、pict.exe に渡す前に値にする。そのため、制約で値と比べられる(例:
IF [登録日] = "2026/11/17" THEN …)。プレースホルダを置き換えるのはパラメータの値だけで、制約・コメントの中の { } は置き換えない。
# @並べ替え に連番(Sequence)を含む列(VALUE で連番の列を参照する列も含む)を書くと、表示の順に上から振る連番と両立しないため、その列を並べ替えの指定から外し、表の上にそのことを示す(ほかの列の指定は使う)。
- 乱数の値は、乱数の列で並べ替える場合も含め、表示の順によらずセルごとに決まる。
# @乱数の種 を書けば、同じ種で同じ値になる。
- 1 つのパラメータの複数の値に、同じプレースホルダを書くことは想定しない。
誤り
- 書き方の誤り(
} がない、知らない関数、引数の数の誤りなど)は、実行せずに行と内容を表示する。
- pict.exe に渡す前に作った値に、値の区切り・別名の区切りの記号があると、PICT で値が分かれてしまうため、誤りとして表示する。
- 結果の表を出す前に値を作れなかったセルは
#ERROR にし、表の上に内容を示す。
結果の並べ替えの指定
ファイルのコメントに # @並べ替え と書き、空白の後に、並べ替える項目(パラメータの名前)を優先の順に , で区切って並べる。降順にする項目は、名前の後に空白を置いて 降順 と書く(昇順 と書いてもよい。書かなければ昇順)。
# @並べ替え Type, File system 降順, Size
この例では、Type の昇順に並べ、Type が同じ行は File system の降順、さらに同じ行は Size の昇順に並べる。
- 数値の項目は数値の大きさで、文字列の中の数字は数値の順で比べる。
- 項目の名前に空白があっても、そのまま書く。大文字・小文字が違っても、1 つの列に決まれば当てはめる。
# @並べ替え は 1 行だけ書ける。
- 書き方に誤り(
降順 の前に空白がない、項目のない ,、同じ項目を 2 回など)がある場合は、実行せずに誤りの行と内容を表示する。
- 結果の列にない項目を書いた場合は、表を並べ替えずに表示し、表の上に誤りを示す。
結果の表
- 見出しの上に、件数・実行したオプション・かかった時間・今の並べ替え(例:
並べ替え: Type ▲、File system ▼)を表示する。
- 結果は、
# @並べ替え の指定の順で表示する(指定がなければ PICT の出力の順)。実行し直すと、指定の順に戻る。
- 列の見出しを押下すると、その列だけで、昇順 → 降順 → 元の順(
# @並べ替え の指定の順)に並べ替える。
- Shift を押しながら列の見出しを押下すると、その列を並べ替えの項目に加える。もう一度押下すると降順に、さらにもう一度押下すると項目から外す。項目が複数あるときは、見出しに優先の順の番号を示す(例:
▲1、▼2)。
- 見出しで並べ替えを変えた後は、「ファイルの指定の順に戻す」で
# @並べ替え の指定の順に戻せる。
- 「コピー」で、見出しとすべての行をタブ区切りでコピーする。表計算ソフトにそのまま貼り付けられる。
- 「CSV で保存」で、見出しとすべての行を CSV(UTF-8、BOM 付き)で保存する。
- コピー・CSV は、並べ替えた順で書き出す。
- pict.exe が制約の警告などのメッセージを出した場合は、表の上に「pict.exe のメッセージ」として表示する。
- モデルに誤りがある場合や、pict.exe が見つからない場合は、表の代わりに誤りの内容を表示する。
- 実行中のタブを閉じると、実行を中止する。
末尾が「だ」「ム」などの名前・値
pict.exe 3.7.4 は、末尾が一部の文字(「だ」「ム」「ぅ」・😅 など、UTF-8 の最後のバイトが 0x85 か 0xA0 の文字)の名前・値を読む時に、その文字を壊す。本拡張機能は、そうした名前・値に目印の文字を付けて pict.exe に渡し、結果から外すため、結果の表には書いたとおりの名前・値が出る。制約の等しい・大小の比べ、IN、シードファイルも、書いたとおりに効く。
ただし、制約の LIKE の模様のうち、? が目印に当たって、当たる値が変わるものは、実行せずに誤りとして示す。
- 例:
A: だ, だA のパラメータで IF [A] LIKE "だ?" THEN … と書くと、「だ」にも当たってしまうため、誤りになる。
- pict.exe 3.7.4 の
? は、1 文字ではなく 1 バイトに当たる(日本語の 1 文字は 3 バイト)。* に変えるか、IN で値を並べると避けられる。
* だけの模様と、末尾が文字の模様("だ*"、"*ム" など)は、正しく効く。
設定
| 設定 |
既定 |
内容 |
pictEditor.pictPath |
空 |
pict.exe の場所(フルパス)。空の場合は、PATH に通した pict を使う。ワークスペースの設定で実行するファイルを差し替えられないよう、ユーザの設定だけで指定できる。 |