mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 06:36:55 +01:00
Address second round of Jesper Schulz-Wedde's review on PR #157
- log-writes-must-survive-rollback.good.al: fixed invalid trigger OnRun(var Rec: ...) declaration; Rec is implicit when TableNo is set. - exposed-objects-must-be-in-a-permission-set.md: distinguished the three exposure mechanisms (page/query web service or API, codeunit published as a web service, [ServiceEnabled] bound action on a page) and their actual permission targets (page/query "..." = X vs codeunit "..." = X). - code-must-not-change-workdate.md: scoped from an absolute "never" to "not as a side effect of unrelated logic" - verified real WorkDate(x) setter usage in BCApps demo-data generators and test codeunits. - bcpt-scenarios-must-be-app-specific.md: SingleInstance and StartScenario/EndScenario reframed as context-dependent patterns, not mandatory requirements - BCPT Create Customer uses neither. - test-feature-scenario-tags.good.al/.bad.al: replaced the invented LibrarySales.CreateCustomerWithPrice/"Item Price Mgt." calls with a real, verified price-list-line test using Library - Sales/Library - Inventory/ Library - Price Calculation. - page-design-must-match-bc-page-type-conventions.md: scoped the missing UsageCategory anti-pattern to pages intended as searchable entry points. - defensive-vs-offensive-code-must-match-blast-radius.md/.good.al/.bad.al: replaced the VAT registration number "low blast radius" example with a genuinely cosmetic field (customer home page URL). - source-organized-by-feature-not-object-type.md: anti-pattern reframed as inconsistency with a repo's own convention, not the object-type scheme itself. - pictures-must-use-media-not-blob.md: removed leftover "image variants" wording contradicting the already-corrected MediaSet description. Proactively fixed while sweeping all fixtures for invented APIs: - given-blocks-must-cover-full-precondition-chain.bad.al: PostSalesOrder called with wrong arity and referenced an undeclared variable. - ui-test-codeunit-naming.good.al/.bad.al: replaced the same fake "Item Price Mgt."/TestPage "Item Price" with real Library - Sales calls and the real Customer Card TestPage. Worklist completeness: added review-skill cues for the 12 of 18 new rules that had none (al-appsource-review.md, al-data-modeling-review.md, al-error-handling-review.md, al-security-review.md, al-style-review.md x3, al-testing-review.md x2, al-ui-review.md, al-upgrade-review.md, al-web-services-review.md), and fixed test-feature-scenario-tags' cue, which only matched the compliant (tagged) shape instead of the anti-pattern (untagged/generic-named test). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Michael Dieringer
parent
0120b874b2
commit
3842ef7138
26 changed files with 219 additions and 89 deletions
|
|
@ -15,7 +15,7 @@ A PerformanceTest app that ships with only the generic Microsoft BCPT samples (c
|
|||
|
||||
## Best Practice
|
||||
|
||||
For every major business flow the extension adds, create a matching `BCPT*` scenario codeunit: `SingleInstance = true`, implementing `"BCPT Test Param. Provider"`, wrapping the operation under test in `BCPTTestContext.StartScenario()` / `EndScenario()`, and building its own test data in a local `InitTest()` procedure rather than depending on hardcoded records. Give each distinct step its own named scenario so a regression in one step doesn't hide inside a coarser measurement.
|
||||
For every major business flow the extension adds, create a matching `BCPT*` scenario codeunit implementing `"BCPT Test Param. Provider"`, building its own test data in a local `InitTest()` procedure rather than depending on hardcoded records. Beyond that shared shape, the interface details are context-dependent, not fixed requirements: most of Microsoft's own shipped BCPT samples declare `SingleInstance = true`, but `codeunit "BCPT Create Customer"` does not, relying instead on `OnRun` calling `InitTest()` unconditionally every run. Likewise, wrapping the operation under test in `BCPTTestContext.StartScenario()` / `EndScenario()` is a real, available pattern for splitting one codeunit's run into several separately measured steps — useful when a regression in one step should not hide inside a coarser, whole-`OnRun` measurement — but it is not what every sample does; `"BCPT Create Customer"` measures its entire `OnRun` as a single implicit scenario and never calls `StartScenario`/`EndScenario` at all. Choose per-step scenarios when step-level granularity matters to the flow being tested; otherwise a single measured `OnRun` is a legitimate, simpler choice.
|
||||
|
||||
See sample: `bcpt-scenarios-must-be-app-specific.good.al`.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,14 @@
|
|||
procedure PostSalesOrder_CreatesInvoice()
|
||||
var
|
||||
SalesHeader: Record "Sales Header";
|
||||
SalesInvoiceHeader: Record "Sales Invoice Header";
|
||||
InvoiceNo: Code[20];
|
||||
begin
|
||||
// [GIVEN] a sales order — posting groups left to whatever exists in the test company
|
||||
LibrarySales.CreateSalesOrder(SalesHeader);
|
||||
// [WHEN]
|
||||
LibrarySales.PostSalesOrder(SalesHeader, false, true);
|
||||
InvoiceNo := LibrarySales.PostSalesDocument(SalesHeader, false, true);
|
||||
// [THEN]
|
||||
SalesInvoiceHeader.Get(InvoiceNo);
|
||||
Assert.RecordIsNotEmpty(SalesInvoiceHeader);
|
||||
end;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,9 @@ codeunit 50102 "Item Price Testing"
|
|||
Subtype = Test;
|
||||
|
||||
var
|
||||
ItemPriceMgt: Codeunit "Item Price Mgt.";
|
||||
LibrarySales: Codeunit "Library - Sales";
|
||||
LibraryInventory: Codeunit "Library - Inventory";
|
||||
LibraryPriceCalculation: Codeunit "Library - Price Calculation";
|
||||
Assert: Codeunit "Library Assert";
|
||||
|
||||
[Test]
|
||||
|
|
@ -11,11 +13,21 @@ codeunit 50102 "Item Price Testing"
|
|||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
Price, Disc: Decimal;
|
||||
PriceListHeader: Record "Price List Header";
|
||||
PriceListLine: Record "Price List Line";
|
||||
SalesHeader: Record "Sales Header";
|
||||
SalesLine: Record "Sales Line";
|
||||
begin
|
||||
// setup mixed with assertions, no clear layers
|
||||
Customer.Insert(false);
|
||||
ItemPriceMgt.GetSalesPrice(Customer."No.", Item."No.", '', Price, Disc);
|
||||
Assert.AreEqual(100, Price, '');
|
||||
// setup mixed with assertions, no clear layers, no FEATURE/SCENARIO/GIVEN/WHEN/THEN tags
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
LibraryInventory.CreateItem(Item);
|
||||
LibraryPriceCalculation.CreatePriceHeader(
|
||||
PriceListHeader, PriceListHeader."Price Type"::Sale, "Price Source Type"::Customer, Customer."No.");
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
LibrarySales.CreateSalesDocumentWithItem(
|
||||
SalesHeader, SalesLine, SalesHeader."Document Type"::Order, Customer."No.", Item."No.", 1, '', 0D);
|
||||
Assert.AreEqual(PriceListLine."Unit Price", SalesLine."Unit Price", '');
|
||||
end;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ codeunit 50103 "Item Price Testing"
|
|||
|
||||
var
|
||||
LibrarySales: Codeunit "Library - Sales";
|
||||
ItemPriceMgt: Codeunit "Item Price Mgt.";
|
||||
LibraryInventory: Codeunit "Library - Inventory";
|
||||
LibraryPriceCalculation: Codeunit "Library - Price Calculation";
|
||||
Assert: Codeunit "Library Assert";
|
||||
|
||||
[Test]
|
||||
|
|
@ -13,14 +14,24 @@ codeunit 50103 "Item Price Testing"
|
|||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
UnitPrice, LineDiscPct: Decimal;
|
||||
PriceListHeader: Record "Price List Header";
|
||||
PriceListLine: Record "Price List Line";
|
||||
SalesHeader: Record "Sales Header";
|
||||
SalesLine: Record "Sales Line";
|
||||
begin
|
||||
// [SCENARIO] Customer with a specific price list line gets that unit price
|
||||
// [GIVEN] a customer with a price list line at 100 LCY
|
||||
LibrarySales.CreateCustomerWithPrice(Customer, Item, '', 100);
|
||||
// [WHEN]
|
||||
ItemPriceMgt.GetSalesPrice(Customer."No.", Item."No.", '', UnitPrice, LineDiscPct);
|
||||
// [THEN]
|
||||
Assert.AreEqual(100, UnitPrice, 'Unit price must match customer price list');
|
||||
// [GIVEN] a customer and an item with a customer-specific sales price list line
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
LibraryInventory.CreateItem(Item);
|
||||
LibraryPriceCalculation.CreatePriceHeader(
|
||||
PriceListHeader, PriceListHeader."Price Type"::Sale, "Price Source Type"::Customer, Customer."No.");
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
// [WHEN] a sales line is created for that customer and item
|
||||
LibrarySales.CreateSalesDocumentWithItem(
|
||||
SalesHeader, SalesLine, SalesHeader."Document Type"::Order, Customer."No.", Item."No.", 1, '', 0D);
|
||||
// [THEN] the sales line picks up the customer's price list line
|
||||
Assert.AreEqual(PriceListLine."Unit Price", SalesLine."Unit Price", 'Unit price must match customer price list');
|
||||
end;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,32 @@
|
|||
[Test]
|
||||
procedure GetPrice_ThenGetDiscount_ReturnsCorrectValues()
|
||||
procedure GetPrice_ThenGetPriceLines_ReturnsCorrectValues()
|
||||
var
|
||||
TempBuffer: Record "Item Price Tier Buffer" temporary;
|
||||
UnitPrice, LineDiscPct: Decimal;
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
PriceListHeader: Record "Price List Header";
|
||||
PriceListLine: Record "Price List Line";
|
||||
SalesHeader: Record "Sales Header";
|
||||
SalesLine: Record "Sales Line";
|
||||
begin
|
||||
// [GIVEN] ...
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
LibraryInventory.CreateItem(Item);
|
||||
LibraryPriceCalculation.CreatePriceHeader(
|
||||
PriceListHeader, PriceListHeader."Price Type"::Sale, "Price Source Type"::Customer, Customer."No.");
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
// [WHEN] first action
|
||||
ItemPriceMgt.GetSalesPrice(CustomerNo, ItemNo, '', UnitPrice, LineDiscPct);
|
||||
LibrarySales.CreateSalesDocumentWithItem(
|
||||
SalesHeader, SalesLine, SalesHeader."Document Type"::Order, Customer."No.", Item."No.", 1, '', 0D);
|
||||
// [WHEN] second action — this is a second test in disguise
|
||||
ItemPriceMgt.GetSalesPriceTiers(CustomerNo, ItemNo, '', TempBuffer);
|
||||
PriceListLine.Validate("Minimum Quantity", 10);
|
||||
PriceListLine.Modify(true);
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
// [THEN] asserting two unrelated things
|
||||
Assert.AreEqual(100, UnitPrice, '');
|
||||
Assert.IsFalse(TempBuffer.IsEmpty(), '');
|
||||
Assert.AreEqual(PriceListLine."Unit Price", SalesLine."Unit Price", '');
|
||||
PriceListLine.SetRange("Price List Code", PriceListHeader.Code);
|
||||
Assert.AreEqual(2, PriceListLine.Count(), '');
|
||||
end;
|
||||
|
|
|
|||
|
|
@ -3,27 +3,51 @@ procedure GetPrice_CustomerPrice_ReturnsCorrectUnitPrice()
|
|||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
UnitPrice, LineDiscPct: Decimal;
|
||||
PriceListHeader: Record "Price List Header";
|
||||
PriceListLine: Record "Price List Line";
|
||||
SalesHeader: Record "Sales Header";
|
||||
SalesLine: Record "Sales Line";
|
||||
begin
|
||||
// [GIVEN] a customer with a price list line at 100
|
||||
LibrarySales.CreateCustomerWithPrice(Customer, Item, '', 100);
|
||||
// [GIVEN] a customer with a price list line for the item
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
LibraryInventory.CreateItem(Item);
|
||||
LibraryPriceCalculation.CreatePriceHeader(
|
||||
PriceListHeader, PriceListHeader."Price Type"::Sale, "Price Source Type"::Customer, Customer."No.");
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
// [WHEN]
|
||||
ItemPriceMgt.GetSalesPrice(Customer."No.", Item."No.", '', UnitPrice, LineDiscPct);
|
||||
LibrarySales.CreateSalesDocumentWithItem(
|
||||
SalesHeader, SalesLine, SalesHeader."Document Type"::Order, Customer."No.", Item."No.", 1, '', 0D);
|
||||
// [THEN]
|
||||
Assert.AreEqual(100, UnitPrice, 'Unit price must match price list');
|
||||
Assert.AreEqual(PriceListLine."Unit Price", SalesLine."Unit Price", 'Unit price must match price list');
|
||||
end;
|
||||
|
||||
[Test]
|
||||
procedure GetPriceTiers_CustomerTier_ReturnsOneTierLine()
|
||||
procedure GetPriceLines_TwoMinimumQuantityLines_ReturnsBoth()
|
||||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
TempBuffer: Record "Item Price Tier Buffer" temporary;
|
||||
PriceListHeader: Record "Price List Header";
|
||||
PriceListLine: Record "Price List Line";
|
||||
begin
|
||||
// [GIVEN] a customer with a tier price at min qty 10
|
||||
LibrarySales.CreateCustomerWithTierPrice(Customer, Item, '', 10, 90);
|
||||
// [GIVEN] a customer price list with two minimum-quantity price lines for the same item
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
LibraryInventory.CreateItem(Item);
|
||||
LibraryPriceCalculation.CreatePriceHeader(
|
||||
PriceListHeader, PriceListHeader."Price Type"::Sale, "Price Source Type"::Customer, Customer."No.");
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
PriceListLine.Validate("Minimum Quantity", 10);
|
||||
PriceListLine.Modify(true);
|
||||
LibraryPriceCalculation.CreateSalesPriceLine(
|
||||
PriceListLine, PriceListHeader.Code, "Price Source Type"::Customer, Customer."No.",
|
||||
"Price Asset Type"::Item, Item."No.");
|
||||
PriceListLine.Validate("Minimum Quantity", 50);
|
||||
PriceListLine.Modify(true);
|
||||
// [WHEN]
|
||||
ItemPriceMgt.GetSalesPriceTiers(Customer."No.", Item."No.", '', TempBuffer);
|
||||
PriceListLine.SetRange("Price List Code", PriceListHeader.Code);
|
||||
// [THEN]
|
||||
Assert.AreEqual(1, TempBuffer.Count(), 'Exactly one tier line expected');
|
||||
Assert.AreEqual(2, PriceListLine.Count(), 'Exactly two price lines expected');
|
||||
end;
|
||||
|
|
|
|||
|
|
@ -3,22 +3,25 @@ codeunit 50104 "Item Price Testing"
|
|||
Subtype = Test;
|
||||
|
||||
[Test]
|
||||
procedure GetPrice_LogicTest()
|
||||
procedure ApplyDiscount_LogicTest()
|
||||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
UnitPrice, LineDiscPct: Decimal;
|
||||
Assert: Codeunit "Library Assert";
|
||||
begin
|
||||
// logic test — fine on its own, but not paired with a UI test below
|
||||
ItemPriceMgt.GetSalesPrice(Customer."No.", Item."No.", '', UnitPrice, LineDiscPct);
|
||||
Assert.AreEqual(90, ApplyDiscount(100, 10), 'A 10% discount on 100 must yield 90');
|
||||
end;
|
||||
|
||||
local procedure ApplyDiscount(UnitPrice: Decimal; DiscountPct: Decimal): Decimal
|
||||
begin
|
||||
exit(UnitPrice - (UnitPrice * DiscountPct / 100));
|
||||
end;
|
||||
|
||||
[Test]
|
||||
procedure Page_ShowsPrice_UT()
|
||||
procedure CustomerCard_Opens_UT()
|
||||
var
|
||||
ItemPricePage: TestPage "Item Price";
|
||||
CustomerCard: TestPage "Customer Card";
|
||||
begin
|
||||
// UI test mixed into a logic-test codeunit, and the codeunit lacks the _UT suffix
|
||||
ItemPricePage.OpenNew();
|
||||
CustomerCard.OpenNew();
|
||||
end;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,13 +3,18 @@ codeunit 50105 "Item Price Testing"
|
|||
Subtype = Test;
|
||||
|
||||
[Test]
|
||||
procedure GetPrice_CustomerPrice_ReturnsUnitPrice()
|
||||
procedure ApplyDiscount_ReducesUnitPrice()
|
||||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
UnitPrice, LineDiscPct: Decimal;
|
||||
Assert: Codeunit "Library Assert";
|
||||
DiscountedPrice: Decimal;
|
||||
begin
|
||||
ItemPriceMgt.GetSalesPrice(Customer."No.", Item."No.", '', UnitPrice, LineDiscPct);
|
||||
DiscountedPrice := ApplyDiscount(100, 10);
|
||||
Assert.AreEqual(90, DiscountedPrice, 'A 10% discount on 100 must yield 90');
|
||||
end;
|
||||
|
||||
local procedure ApplyDiscount(UnitPrice: Decimal; DiscountPct: Decimal): Decimal
|
||||
begin
|
||||
exit(UnitPrice - (UnitPrice * DiscountPct / 100));
|
||||
end;
|
||||
}
|
||||
|
||||
|
|
@ -18,16 +23,20 @@ codeunit 50106 "Item Price Testing_UT"
|
|||
Subtype = Test;
|
||||
|
||||
[Test]
|
||||
procedure Page_EnterCustomerAndItem_FactBoxShowsPrice()
|
||||
procedure CustomerCard_SetName_UpdatesField()
|
||||
var
|
||||
Customer: Record Customer;
|
||||
Item: Record Item;
|
||||
ItemPricePage: TestPage "Item Price";
|
||||
CustomerCard: TestPage "Customer Card";
|
||||
Assert: Codeunit "Library Assert";
|
||||
LibrarySales: Codeunit "Library - Sales";
|
||||
begin
|
||||
ItemPricePage.OpenNew();
|
||||
ItemPricePage.CustomerNo.SetValue(Customer."No.");
|
||||
ItemPricePage.ItemNo.SetValue(Item."No.");
|
||||
Assert.AreEqual('100.00', ItemPricePage.PriceInfo.UnitPrice.Value(), '');
|
||||
LibrarySales.CreateCustomer(Customer);
|
||||
CustomerCard.OpenEdit();
|
||||
CustomerCard.GoToRecord(Customer);
|
||||
CustomerCard.Name.SetValue('Updated Name');
|
||||
CustomerCard.Close();
|
||||
|
||||
Customer.Get(Customer."No.");
|
||||
Assert.AreEqual('Updated Name', Customer.Name, 'Name must be updated through the page');
|
||||
end;
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue