CycleMantle
ワークフロー

最初のフィクスチャファイル作成ガイド

03
フィクスチャ作成を1分で

空のフォルダからテスト成功まで

注文合計をフォーマットするPHP関数があり、いくつかの入力に対してテストしたいとします。CycleMantleはデータジェネレーターとして機能し、架空の注文を含むJSONファイルを作成し、それを読み取るテストコードを記述します。実際の顧客データをそのままコピーすることはありません。クラウドモデルを使用する場合、プロンプトとエージェントが読み取るファイルの内容は該当プロバイダに送信されます。ローカルモデルを使用する場合、データはPCの外部には一切出力されません。約4回の短いチャットメッセージで進めます:フォルダを開く、レコードを生成する、チェックを作成する、そして実行する。各メッセージは、確認・承認・却下できるカードを生成します。次のステップに進む前にカードを確認しましょう。上から下へ読み進めましょう:各カードには、使用されたツール、ファイルまたはコマンド、およびその結果が記載されています。実行前に確認したい場合は、「Plan only」でチャットを開始し、計画を確認した後に「Ask first」に切り替えてください。

01

プロジェクトフォルダを開く

アプリを起動し、PHPコードを含むフォルダを選択します。承認モードには「Ask first」を選択し、すべての変更があなたの承認を待つかつようにします。ステップに信頼できるようになったら、「Auto-run」に切り替えるなど、いつでもモードを変更できます。

02

架空のレコードを生成する

必要なフィールド(名前、日付、金額など)を指定し、架空のデータを含むJSONファイルの作成を依頼してください。必要な行数も指定してください。名前、住所、金額はすべて明確に架空のものであるため、レコードが実在する人物と混同されることはありません。

03

テストコードを生成する

JSONファイルを読み取り、既知の入力と期待される出力を比較する小さなテストスクリプトをリクエストしてください。テストする関数名を指定してください。エージェントに各アサーションを1行で説明させ、テストの意図を理解できるようにしてください。

04

レビューと実行

差分を確認し、承認してからShellでテストコマンドを実行してください。その後、終了コードを確認し、カードを展開して出力を確認してください。テストに失敗した場合は、エージェントが修正を加える前に失敗の原因を説明させてください。

始めに使える小さなテストスクリプト

tests.php
<?php
function discount(int $cents, int $percent): int {
    return intdiv($cents * (100 - $percent), 100);
}
assert(discount(1000, 0) === 1000);
assert(discount(1000, 10) === 900);
assert(discount(0, 50) === 0);
assert(discount(999, 100) === 0);
echo 'All checks ran';

1つの単純な関数と、既知の入力と結果を持つ4つのアサーションです。データベース、ネットワーク、シークレットは使用しません。後でエージェントは固定された数値をJSONファイルの行に置き換えることができますが、テストの構造はそのまま維持されます。意図的に期待値の1つを変更して失敗を確認してください。これをプロジェクトフォルダにtests.phpとして保存し、テストコマンドで実行し、さらに指示を出す前にカードの終了コードを確認してください。その後、意図的に期待値の1つを変更し、カードが赤くなるのを見てください。

テストデータ生成ツールが担う4つの役割

サンプルデータを作成する

多くの人が、手動でテストデータを作成するよりも効率的に生成する方法を知りたいと考えています。必要なデータ構造を指定し、エージェントに作成させましょう:架空の顧客3名を含むJSONファイル(各顧客に名前、登録日、注文金額が含まれます)。テストデータ生成ツールの中で、プロジェクト内のプレーンなファイルは、差分で値の変更が一目でわかるため、最も読みやすく、後から変更しやすい形式です。globやlist_dirを使用して、フィクスチャが既にどこにあるかを確認し、新しいファイルをその隣に配置します。カードを開き、すべての値が明確に架空のものであることを確認し、承認する前に不自然な行を手動で編集してください。メールアドレスには予約された例示用のドメインを使用してください。数百行ではなく、数行をリクエストし、すべてを読み取れるようにしてください。日付は一定の形式で記載し、すべての行が同じ形式に見えるようにしてください。

ファイルを読み取るテストを作成する

JSONを読み込み、各行ごとに1つの結果をチェックするスクリプトをリクエストしてください。エージェントはread_fileでソースを開き、grepで関数を探し、テストファイルを差分として提案します。PHPでの静的メソッドのモックは複雑なため、エージェントが何かを書く前に静的呼び出しをリストアップさせ、それらの呼び出しをテストで置き換え可能な小さな関数の背後に配置してください。「Ask first」は、承認するまで変更を保留します。各アサーションを確認し、関数が間違っていた場合に失敗するかどうかを判断してください。テストしているコードを単に繰り返すだけのテストは却下してください。その後、意図的に失敗する行を1つ追加してください。エージェントがどの関数を指しているのかわからない場合は、プロンプトに関数名を指定し、ファイル名にも言及してください。テストごとに1つの概念に焦点を当ててください。

テストを実行し、終了コードを確認する

Shellは、ローカルWindows、WSL、または所有するサーバーへのSSHなど、選択した環境でテストコマンドを実行します。カードには実際の終了コードが表示され、終了コードが0の場合はすべてのテストが成功したことを意味し、それ以外の値は失敗を意味します。カードを展開して、出力を1行ずつ確認してください。何か失敗した場合、エージェントはメッセージを読み取り、修正案を差分として提案します。テストが緑になれば修正を承認するのではなく、まずテスト内の期待値を確認してください。2番目の失敗が続く場合は、エージェントが再度編集する前に最初の失敗の原因を説明させてください。「Plan only」は、コマンドが初めての場合に最初のステップとして適しています。エージェントは計画を立て、何も実行しません。

テストが必要なコードを特定する

テストが成功したら、カバレッジコマンドを実行し、エージェントにレポートを確認させましょう。チームはインフラストラクチャコードをカバレッジに含めるべきかどうかで議論することがありますが、数字が目標となる前にそれについて合意するのが賢明です。一部のチームは、価格や権限チェックなどの重要なメソッドに対して必須のテストカバレッジを要求します。エージェントにgrepでそれらのメソッドをリストアップさせ、最初のものに対するテストを提案させましょう。差分を確認し、テストを再実行し、重要なパスがカバーされるまで停止してください。どのフォルダをカウントしたかを記録しておきましょう。そうすれば、来月の数字が同じ意味を持ちます。エージェントに、カウントしたフォルダのリストをプロジェクト内のプレーンテキストファイルに保存させ、承認する前に差分を確認してください。

Windows用CycleMantle

最初のフィクスチャを今日作成しよう

CycleMantleをダウンロード ↗