Codeunit 130000 Assert
src/Layers/W1/Tests/ApplicationTestLibrary/Assert.Codeunit.al449 lines, Copyright (c) Microsoft Corporation. MIT
/// <summary>/// Provides assertion functions for verifying test conditions and comparing expected versus actual values in test scenarios./// </summary>codeunit 130000 Assert{ trigger OnRun() begin end; var IsTrueFailedMsg: Label 'Assert.IsTrue failed. %1'; IsFalseFailedMsg: Label 'Assert.IsFalse failed. %1'; AreEqualFailedMsg: Label 'Assert.AreEqual failed. Expected:<%1> (%2). Actual:<%3> (%4). %5.', Locked = true; AreNotEqualFailedMsg: Label 'Assert.AreNotEqual failed. Expected any value except:<%1> (%2). Actual:<%3> (%4). %5.', Locked = true; AreNearlyEqualFailedMsg: Label 'Assert.AreNearlyEqual failed. Expected a difference no greater than <%1> between expected value <%2> and actual value <%3>. %4'; AreNotNearlyEqualFailedMsg: Label 'Assert.AreNotNearlyEqual failed. Expected a difference greater than <%1> between expected value <%2> and actual value <%3>. %4'; RecordsAreEqualExceptCertainFieldsErr: Label 'Assert.RecordsAreEqualExceptCertainFields failed. Expected the records to match. Difference found in <%1>. Left value <%2>, Right value <%3>. %4'; FailFailedMsg: Label 'Assert.Fail failed. %1'; TableIsEmptyErr: Label 'Assert.TableIsEmpty failed. Table <%1> with filter <%2> must not contain records.', Locked = true; TableIsNotEmptyErr: Label 'Assert.TableIsNotEmpty failed. Table <%1> with filter <%2> must contain records.', Locked = true; ExpectedErrorFailed: Label 'Assert.ExpectedError failed. Expected: %1. Actual: %2.'; ExpectedErrorCodeFailed: Label 'Assert.ExpectedErrorCode failed. Expected: %1. Actual: %2. Actual error message: %3.'; IsSubstringFailedErr: Label 'Assert.IsSubstring failed. Expected <%1> to be a substring of <%2>.'; RecordCountErr: Label 'Assert.RecordCount failed. Expected number of %1 entries: %2. Actual: %3. Filters: %4.', Locked = true; RecordCountWithListErr: Label 'Assert.RecordCount failed. Expected number of %1 entries: %2. Actual: %3. Filters: %4. Records: %5', Locked = true; UnsupportedTypeErr: Label 'Equality assertions only support Boolean, Option, Integer, BigInteger, Decimal, Code, Text, Date, DateFormula, Time, Duration, and DateTime values. Current value:%1.'; RecordNotFoundErrorCode: Label 'DB:RecordNotFound'; RecordAlreadyExistsErrorCode: Label 'DB:RecordExists'; RecordNothingInsideFilterErrorCode: Label 'DB:NothingInsideFilter'; AssertErrorMsg: Label 'Expected error %1 actual %2'; PrimRecordNotFoundErrorCode: Label 'DB:PrimRecordNotFound'; NoFilterErrorCode: Label 'DB:NoFilter'; ErrorHasNotBeenThrownErr: Label 'The error has not been thrown.'; TextEndsWithErr: Label 'Assert.TextEndsWith failed. The text <%1> must end with <%2>'; TextEndSubstringIsBlankErr: Label 'Substring must not be blank.'; LibraryAssert: Codeunit "Library Assert"; procedure IsTrue(Condition: Boolean; Msg: Text) begin if not Condition then Error(IsTrueFailedMsg, Msg) end; procedure IsFalse(Condition: Boolean; Msg: Text) begin if Condition then Error(IsFalseFailedMsg, Msg) end; procedure AreEqual(Expected: Variant; Actual: Variant; Msg: Text) begin if not Equal(Expected, Actual) then Error(AreEqualFailedMsg, Expected, TypeNameOf(Expected), Actual, TypeNameOf(Actual), Msg) end; procedure AreNotEqual(Expected: Variant; Actual: Variant; Msg: Text) begin if Equal(Expected, Actual) then Error(AreNotEqualFailedMsg, Expected, TypeNameOf(Expected), Actual, TypeNameOf(Actual), Msg) end; procedure AreNearlyEqual(Expected: Decimal; Actual: Decimal; Delta: Decimal; Msg: Text) begin if Abs(Expected - Actual) > Abs(Delta) then Error(AreNearlyEqualFailedMsg, Delta, Expected, Actual, Msg) end; procedure AreNotNearlyEqual(Expected: Decimal; Actual: Decimal; Delta: Decimal; Msg: Text) begin if Abs(Expected - Actual) <= Abs(Delta) then Error(AreNotNearlyEqualFailedMsg, Delta, Expected, Actual, Msg) end; procedure Fail(Msg: Text) begin Error(FailFailedMsg, Msg) end; procedure RecordIsEmpty(RecVariant: Variant) var RecRef: RecordRef; begin RecRef.GetTable(RecVariant); RecRefIsEmpty(RecRef); end; procedure RecordIsEmpty(RecVariant: Variant; CompanyName: Text) var RecRef: RecordRef; begin RecRef.GetTable(RecVariant); RecRef.ChangeCompany(CompanyName); RecRefIsEmpty(RecRef); end; procedure RecordIsNotEmpty(RecVariant: Variant; CompanyName: Text) var RecRef: RecordRef; begin RecRef.GetTable(RecVariant); RecRef.ChangeCompany(CompanyName); RecRefIsNotEmpty(RecRef); end; procedure RecordIsNotEmpty(RecVariant: Variant) var RecRef: RecordRef; begin RecRef.GetTable(RecVariant); RecRefIsNotEmpty(RecRef); end; procedure TableIsEmpty(TableNo: Integer) var RecRef: RecordRef; begin RecRef.Open(TableNo); RecRefIsEmpty(RecRef); RecRef.Close(); end; procedure TableIsNotEmpty(TableNo: Integer) var RecRef: RecordRef; begin RecRef.Open(TableNo); RecRefIsNotEmpty(RecRef); RecRef.Close(); end; local procedure RecRefIsEmpty(var RecRef: RecordRef) begin if not RecRef.IsEmpty() then Error(TableIsEmptyErr, RecRef.Caption, RecRef.GetFilters); end; local procedure RecRefIsNotEmpty(var RecRef: RecordRef) begin if RecRef.IsEmpty() then Error(TableIsNotEmptyErr, RecRef.Caption, RecRef.GetFilters); end; procedure RecordCount(RecVariant: Variant; ExpectedCount: Integer) var RecRef: RecordRef; RecordsList: TextBuilder; FieldIndex: Integer; RecordIndex: Integer; begin RecRef.GetTable(RecVariant); if ExpectedCount <> RecRef.Count then begin if RecRef.FindFirst() then begin repeat RecordIndex += 1; for FieldIndex := 1 to RecRef.FieldCount() do begin RecordsList.Append(RecRef.FieldIndex(FieldIndex).Value()); RecordsList.Append(', ') end; RecordsList.Append('; '); until (RecRef.Next() = 0) or (RecordIndex = 50); Error(RecordCountWithListErr, RecRef.Caption, ExpectedCount, RecRef.Count, RecRef.GetFilters, RecordsList.ToText()); end; Error(RecordCountErr, RecRef.Caption, ExpectedCount, RecRef.Count, RecRef.GetFilters); end; RecRef.Close(); end; procedure ExpectedError(Expected: Text) begin if (GetLastErrorText = '') and (Expected = '') then begin if GetLastErrorCallstack = '' then Error(ErrorHasNotBeenThrownErr); end else if StrPos(GetLastErrorText, Expected) = 0 then Error(ExpectedErrorFailed, Expected, GetLastErrorText); end; /// <summary> /// Verifies that the last error thrown is a "cannot find record" error for the given table. /// Use this instead of <see cref="ExpectedError"/> for record-not-found failures: it asserts on the /// error code and table caption rather than the full error text, so the test stays resilient and keeps /// passing when the underlying error label wording changes. /// </summary> /// <param name="TableID">Table ID raising the error</param> procedure ExpectedErrorCannotFind(TableID: Integer) begin LibraryAssert.ExpectedErrorCannotFind(TableID); end; /// <summary> /// Verifies that the last error thrown is a "cannot find record" error for the given table. /// Use this instead of <see cref="ExpectedError"/> for record-not-found failures: it asserts on the /// error code and table caption rather than the full error text, so the test stays resilient and keeps /// passing when the underlying error label wording changes. /// </summary> /// <param name="TableID">Table ID raising the error</param> /// <param name="RecordIndentificationText">Identification text of the record that it cannot find</param> procedure ExpectedErrorCannotFind(TableID: Integer; RecordIndentificationText: Text) begin LibraryAssert.ExpectedErrorCannotFind(TableID, RecordIndentificationText); end; procedure ExpectedMessageCannotFind(LastErrorText: Text; TableID: Integer; RecordIndentificationText: Text) begin LibraryAssert.ExpectedMessageCannotFind(LastErrorText, TableID, RecordIndentificationText); end; /// <summary> /// Verifies that the last error thrown is a TestField/Validate error for the given field. /// Use this instead of <see cref="ExpectedError"/> for TestField and Validate failures: it asserts on the /// error code and field caption/value rather than the full error text, so the test stays resilient and /// keeps passing when the underlying error label wording changes. /// </summary> /// <param name="FieldCaptionTested">Name of the field raising the error</param> /// <param name="ExpectedValue">Expected value in the error message</param> procedure ExpectedTestFieldError(FieldCaptionTested: Text; ExpectedValue: Text) begin LibraryAssert.ExpectedTestFieldError(FieldCaptionTested, ExpectedValue); end; /// <summary> /// Verifies that the last error thrown is a TestField/Validate error for the given field. /// Use this instead of <see cref="ExpectedError"/> for TestField and Validate failures: it asserts on the /// error code and field caption/value rather than the full error text, so the test stays resilient and /// keeps passing when the underlying error label wording changes. /// </summary> /// <param name="FieldCaptionTested">Name of the field raising the error</param> /// <param name="ExpectedValue">Expected value in the error message</param> /// <param name="ActualValue">Actual value in the error message</param> /// <param name="TableCaptionTested">Name of the table raising the error</param> procedure ExpectedTestFieldError(FieldCaptionTested: Text; ExpectedValue: Text; ActualValue: Text; TableCaptionTested: Text) begin LibraryAssert.ExpectedTestFieldError(FieldCaptionTested, ExpectedValue, ActualValue, TableCaptionTested); end; procedure ExpectedTestFieldMessage(LastErrorText: Text; FieldCaptionTested: Text; ExpectedValue: Text; ActualValue: Text; TableCaptionTested: Text) begin LibraryAssert.ExpectedTestFieldMessage(LastErrorText, FieldCaptionTested, ExpectedValue, ActualValue, TableCaptionTested); end; procedure ExpectedErrorCode(Expected: Text) begin if StrPos(GetLastErrorCode, Expected) = 0 then Error(ExpectedErrorCodeFailed, Expected, GetLastErrorCode, GetLastErrorText); end; procedure ExpectedMessage(Expected: Text; Actual: Text) begin LibraryAssert.ExpectedMessage(Expected, Actual); end; procedure ExpectedConfirm(Expected: Text; Actual: Text) begin LibraryAssert.ExpectedConfirm(Expected, Actual); end; procedure ExpectedStrMenu(ExpectedInstruction: Text; ExpectedOptions: Text; ActualInstruction: Text; ActualOptions: Text) begin LibraryAssert.ExpectedStrMenu(ExpectedInstruction, ExpectedOptions, ActualInstruction, ActualOptions); end; procedure IsDataTypeSupported(Value: Variant): Boolean begin exit(Value.IsBoolean or Value.IsOption or Value.IsInteger or Value.IsDecimal or Value.IsText or Value.IsCode or Value.IsDate or Value.IsDateTime or Value.IsDateFormula or Value.IsGuid or Value.IsDuration or Value.IsRecordId or Value.IsBigInteger or Value.IsChar or Value.IsTime); end; procedure TextEndsWith(OriginalText: Text; Substring: Text) var ErrorMessage: Text; begin if Substring = '' then Error(TextEndSubstringIsBlankErr); ErrorMessage := StrSubstNo(TextEndsWithErr, OriginalText, Substring); AreEqual(StrLen(OriginalText) - StrLen(Substring) + 1, StrPos(OriginalText, Substring), ErrorMessage); end; procedure IsSubstring(OriginalText: Text; Substring: Text) begin if Substring = '' then Error(TextEndSubstringIsBlankErr); if StrPos(OriginalText, Substring) <= 0 then Error(IsSubstringFailedErr, Substring, OriginalText); end; local procedure TypeOf(Value: Variant): Integer var "Field": Record "Field"; begin case true of Value.IsBoolean: exit(Field.Type::Boolean); Value.IsOption or Value.IsInteger or Value.IsByte: exit(Field.Type::Integer); Value.IsBigInteger: exit(Field.Type::BigInteger); Value.IsDecimal: exit(Field.Type::Decimal); Value.IsText or Value.IsCode or Value.IsChar or Value.IsTextConstant: exit(Field.Type::Text); Value.IsDate: exit(Field.Type::Date); Value.IsTime: exit(Field.Type::Time); Value.IsDuration: exit(Field.Type::Duration); Value.IsDateTime: exit(Field.Type::DateTime); Value.IsDateFormula: exit(Field.Type::DateFormula); Value.IsGuid: exit(Field.Type::GUID); Value.IsRecordId: exit(Field.Type::RecordID); else Error(UnsupportedTypeErr, UnsupportedTypeName(Value)) end end; local procedure TypeNameOf(Value: Variant): Text var "Field": Record "Field"; begin Field.Type := TypeOf(Value); exit(Format(Field.Type)); end; local procedure UnsupportedTypeName(Value: Variant): Text begin case true of Value.IsRecord: exit('Record'); Value.IsRecordRef: exit('RecordRef'); Value.IsFieldRef: exit('FieldRef'); Value.IsCodeunit: exit('Codeunit'); Value.IsAutomation: exit('Automation'); Value.IsFile: exit('File'); end; exit('Unsupported Type'); end; procedure Compare(Left: Variant; Right: Variant): Boolean begin exit(Equal(Left, Right)) end; procedure Equal(Left: Variant; Right: Variant): Boolean begin if IsNumber(Left) and IsNumber(Right) then exit(EqualNumbers(Left, Right)); if Left.IsDotNet or Right.IsDotNet then exit((Format(Left, 0, 2) = Format(Right, 0, 2))); exit((TypeOf(Left) = TypeOf(Right)) and (Format(Left, 0, 2) = Format(Right, 0, 2))) end; local procedure EqualNumbers(Left: Decimal; Right: Decimal): Boolean begin exit(Left = Right) end; local procedure IsNumber(Value: Variant): Boolean begin exit(Value.IsDecimal or Value.IsInteger or Value.IsChar) end; procedure VerifyFailure(expectedErrorCode: Text; failureText: Text) var errorCode: Text; begin errorCode := GetLastErrorCode; IsTrue(errorCode = expectedErrorCode, failureText); ClearLastError(); end; procedure AssertRecordNotFound() begin VerifyFailure(RecordNotFoundErrorCode, StrSubstNo(AssertErrorMsg, RecordNotFoundErrorCode, GetLastErrorCode)); end; procedure AssertRecordAlreadyExists() begin VerifyFailure(RecordAlreadyExistsErrorCode, StrSubstNo(AssertErrorMsg, RecordAlreadyExistsErrorCode, GetLastErrorCode)); end; procedure AssertNothingInsideFilter() begin VerifyFailure(RecordNothingInsideFilterErrorCode, StrSubstNo(AssertErrorMsg, RecordNothingInsideFilterErrorCode, GetLastErrorCode)); end; procedure AssertNoFilter() begin VerifyFailure(NoFilterErrorCode, StrSubstNo(AssertErrorMsg, NoFilterErrorCode, GetLastErrorCode)); end; procedure AssertPrimRecordNotFound() begin VerifyFailure(PrimRecordNotFoundErrorCode, StrSubstNo(AssertErrorMsg, PrimRecordNotFoundErrorCode, GetLastErrorCode)); end; procedure RecordsAreEqualExceptCertainFields(var RecordRefLeft: RecordRef; var RecordRefRight: RecordRef; var TempFieldToIgnore: Record "Field" temporary; Msg: Text): Boolean var LeftFieldRef: FieldRef; RightFieldRef: FieldRef; i: Integer; begin // Records <Left> and <Right> are considered equal when each (Normal) <Left> field // has the same value as the <Right> field with the same index. // Note that for performance reasons this function does not take into account, // whether the two records have the same number of fields. // It assumes that the records belong to the same table. for i := 1 to RecordRefLeft.FieldCount do begin LeftFieldRef := RecordRefLeft.FieldIndex(i); if LeftFieldRef.Class = FieldClass::Normal then begin RightFieldRef := RecordRefRight.FieldIndex(i); if not TempFieldToIgnore.Get(RecordRefLeft.Number, LeftFieldRef.Number) then if LeftFieldRef.Value <> RightFieldRef.Value then Error(RecordsAreEqualExceptCertainFieldsErr, LeftFieldRef.Name, LeftFieldRef.Value, RightFieldRef.Value, Msg); end; end; exit(true); end;}