承認テスト ライブラリのベスト プラクティス

  • [アーティクル]

var を使用して変数をインラインで宣言する

  • var キーワード (型推論) を使用します。
  • 離れたステートメントではなくインラインで変数を宣言します。

操作

var item = items.default(); 
var salesOrder = data.sales().salesOrders().createDefault();
var salesLine = salesOrder.addLine().setItem(item).setInventDims([warehouse]).setQuantity(10).save();

このようにしない

InventTable item; 
AtlEntitySalesOrder salesOrder;
AtlEntitySaleOrderLine salesLine;
…
item = items.default(); 
salesOrder = data.sales().salesOrders().createDefault();
salesLine = salesOrder.addLine().setItem(item).setInventDims([warehouse]).setQuantity(10).save();

両端揃え

var を使用する利点は記述するコードを減らし、正確な型名を覚える必要がなく、テストロジックが重要でない情報で散らかっていないことです。 全体的にテストコードが読みやすくなります。

前の例で、item が ItemId、InventlTable、AtlEntityInventItem 型かどうかは関係ありません。 重要な詳細は、一般的な既定のアイテムを含む販売明細行を作成しているということです。 salesOrder や salesLine 変数の正確な型は重要ではありません。 これらの型の契約は、命名と使用法から明らかです。

注意事項

  • メソッドの戻り値の型が変わったらコンパイルを失敗させる場合は、型推論を使用しないでください。
  • 意味のある変数名やメソッド名を作成できない場合は、型推論を使用しないでください。

メソッド パラメータとして ID ではなくエンティティを使用する

一般的なデータ メソッド、作成者メソッド、および init メソッドは、通常 ID の代わりにレコードやエンティティを返します。 メソッドのパラメーターにレコードやエンティティを使用することをお勧めします。

操作

var salesLine = salesOrder.addLine().setItem(item).save();

このようにしない

var salesLine = salesOrder.addLine().setItemId(item.ItemId).save();

両端揃え

重要ではない専門語が散らばっていないので、コードが読みやすくなります。

注意事項

ID しかわからない場合は、ID を引数に取るメソッドを使用してください。

ナビゲーション ノードのショートカットを使用する

新しいドメイン領域を自動化するときは、その領域で最も頻繁に使用されるナビゲーション オブジェクトのショートカットを保持する基本クラスを導入します。

たとえば、倉庫管理エリアには AtlWHSTestCase という名前の基本クラスがあります。 data.whs()、data.invent()、data.invent().items()、data.invent().units() そして他のナビゲーション オブジェクトのショートカットが含まれます。 ショートカットはテスト コードを単純にします。

class AtlWHSTestCase extends SysTestCase
{
    AtlDataRootNote          data;
    AtlDataInvent            invent;
    AtlDataInventOnHand      onHand;
    AtlDataProductItems      items;
    AtlDataWHS               whs;

    protected void initDataSetupReferences()
    {
        data = new AtlDataRootNode();
        invent = data.invent();
        onHand = data.invent().onHand();
        items = data.invent().items();
        whs = data.whs();

同じクラスの多くのテスト メソッド間で共有されるショートカットを導入するのも便利です。

操作

class WHSMinMaxReplenishmentScenarioTest extends AtlWHSTestCase
…
    var item = items.default(); 
    var warehouse = invent.warehouses().default();

このようにしない

class WHSMinMaxReplenishmentScenarioTest extends SysTestCase
…
    var item = data.invent().items().default(); 
    var warehouse = data.invent().warehouses().default();

注意事項

必要なナビゲーション ノードすべてにショートカットを作成する必要はありません。 ただし、頻繁に使用されるナビゲーション ノードに対してそれらを作成することを検討してください。