sfTest Editor
sfTest(Salesforce の画面を日本語のシナリオで自動テストするツール)の、シナリオ(.feature)を書くための VS Code の拡張機能です。Cucumber の拡張機能を入れなくても、sfTest のシナリオを書けます。
機能
- 色分け:見出しのキーワード(機能・背景・シナリオ・シナリオテンプレート など)、タグ、ステップの引用符の引数(
"…")、表のセルの値に色を付け、ステップのキーワード(前提・もし・ならば・かつ など)を薄く、コメントの行を薄い灰色で表示します。プレースホルダ({…})とシナリオテンプレートの列名(<…>)の全体には背景色を付け、入れ子のプレースホルダは深さごとに背景色を変えます(3色を繰り返します)。機能名・シナリオ名には色を付けません。色は、明るい配色テーマと暗い配色テーマのそれぞれに合わせています。
- シナリオの実行:「シナリオ:」「シナリオテンプレート:」の行の上に「実行」を、「機能:」の行の上に「すべて実行」を表示します。押下すると、保存していない変更を保存してから、そのシナリオ(シナリオテンプレートは例のすべての行)だけ、またはそのファイルのすべてのシナリオを
npx sftest test で実行します。実行中は、押下した表示が「実行中」に変わります。シナリオごとの成否は VS Code のテストの機能(テストエクスプローラー)と行の横の印に、実行の出力は「テスト結果」のパネルに表示します(実行を始めると、このパネルを前面に出します)。実行は同時に1つだけです。未定義のステップのあるシナリオは、シナリオ不正で失敗します(ほかのシナリオは実行します。sfTest 3.1.0 までの版では、どこかに未定義のステップがあると、どのシナリオも実行できません)。どこかの .feature に Gherkin の書き方の誤りがあると、sfTest はシナリオを実行できません。どのシナリオも実行できない場合は、誤りのある行に理由を表示します。
- ステップの補完:ステップのキーワードの後ろで、sfTest のステップの文言を候補に示します。選ぶと、引数の入力欄(
"…" など)が付いた文を挿入します。
- 未定義のステップの警告:どのステップの定義にも合わないステップに、黄色の波線を示します。
- シナリオ不正となる書き方の表示:シナリオを実行したときにシナリオ不正となる次のステップに、赤の波線を示します。
- 1つの名前に、型の違う変数とインスタンスを設定・作成するステップ(変数の後に同じ名前のインスタンスを作る、インスタンスの後に同じ名前の変数を設定する、同じ名前のインスタンスを違うクラスで作り直す)。
- 変数・インスタンスの名前(「インスタンス "…" をクラス "…" から作る」のクラスの名前を含む)にプレースホルダを書いたステップ。
- Gherkin の書き方の誤り(閉じていない複数行など)。
赤の波線は、sfTest の実行時の確認と同じ規則で示します。シナリオテンプレートでは、「例:」の表の行ごとに判定します。条件付きの実行(「値 "…" が "…" "…" の場合は以下を実行する」から「条件の範囲を終わる」まで)の中で設定・作成するステップは、実行されるかが分からないため判定しません(シナリオを実行したときの確認に任せます)。
使い方
- sfTest のプロジェクトのフォルダを VS Code で開きます。
npx sftest init で作ったプロジェクトでは、.vscode/extensions.json が sfTest Editor を推奨しているため、VS Code がインストールを案内します。
- Cucumber の拡張機能を入れている場合は、拡張機能のビューで Cucumber の「無効にする(ワークスペース)」を押下します。両方が有効だと、補完と警告が2重に表示されます。
.feature を開くと、色分けと、未定義のステップ・シナリオ不正となる書き方の表示が使えます。ステップのキーワードの後ろで Ctrl+Space を押下すると、ステップの候補を表示します。
- シナリオの上の「実行」を押下すると、そのシナリオを実行します。実行の前に
.env の設定(組織の URL など)が必要です(sfTest の仕様書の環境構築を参照してください)。途中で止める場合は、テストエクスプローラーの停止を押下します。止めた時に戻せなかった組織のデータは、次の npx sftest test の最初か npx sftest restore で戻ります。
「実行」は、playwright.config.ts のあるフォルダ(npx sftest init をしたフォルダ)の中の .feature にだけ表示します。実行は、そのフォルダの sfTest(node_modules/@fluxenginejp/sftest)で行います。
設定
| 設定 |
説明 |
初期値 |
sftestEditor.stepFiles |
ステップの定義を読むファイル(ワークスペースのフォルダからのパターン)。利用者のステップの定義をほかのフォルダに置く場合に指定します。 |
["steps/**/*.{ts,js}", "node_modules/@fluxenginejp/sftest/dist/steps/**/*.js"] |
ステップの定義のファイルを追加・変更すると、自動で読み直します。読み直されない場合は、コマンドパレット(Ctrl+Shift+P)で「sfTest Editor: ステップの定義を読み直す」を実行してください。
ステップの定義は、When('…', …) のように、文言を文字列で直接書いたものだけを読みます(定数や式で書いた文言は読めず、そのステップを使うシナリオが未定義と示されます)。
詳しい説明
sfTest の仕様書(プロジェクトのフォルダの node_modules/@fluxenginejp/sftest/docs/SPEC.md)の「2.4 VSCode の設定(任意)」を参照してください。
ライセンス
MIT
| |