Add JUnit matcher for skippedItem + helper methods to skip or fail transaction

Extractor.java

    Added originalItem field to SkippedItem with getOriginalItem() getter to allow inspection of the wrapped transaction

PDFParser.java

    After calling the wrap callback, automatically sets failureMessage from transaction context if not already set
    After calling the wrap callback, automatically wraps the item in a SkippedItem if the transaction context is marked accordingly (only if the callback did not already return a SkippedItem)

AbstractPDFExtractor.java

    Added skipTransaction(DocumentType, String) helper to signal that a transaction should be skipped
    Added failTransaction(ParsedData, String) helper to signal that a transaction has failed
    Added source propagation for SkippedItem.originalItem

OnvistaPDFExtractor.java

    Removed private SKIP_TRANSACTION constant and FAILURE usages — now using skipTransaction() and failTransaction() helpers
    Removed inline SKIP_TRANSACTION and FAILURE checks from wrap callbacks — now handled transparently by PDFParser
    Simplified wrap callbacks from (t, ctx) -> to t -> / TransactionItem::new
    Fixed testDividende18: replaced incorrect withFailureMessage(..., dividend(...)) with skippedItem(..., dividend(...))

ExtractorMatchers.java

    Added SkippedItemMatcher with optional inner matcher support
    Added skippedItem(String) and skippedItem(String, Matcher) factory methods

ExtractorMatchersTest.java

    Added tests for hasExDate (failure + success)
    Added tests for skippedItem (not skipped, wrong reason, correct reason, with inner matcher failure + success)

Issue: portfolio-performance#5521

Author: Nirus2000

name.abuchen.portfolio.tests/src/name/abuchen/portfolio/datatransfer/ExtractorMatchers.java

@@ -17,6 +17,7 @@
 import name.abuchen.portfolio.datatransfer.Extractor.Item;
 import name.abuchen.portfolio.datatransfer.Extractor.PortfolioTransferItem;
 import name.abuchen.portfolio.datatransfer.Extractor.SecurityItem;
+import name.abuchen.portfolio.datatransfer.Extractor.SkippedItem;
 import name.abuchen.portfolio.datatransfer.Extractor.TransactionItem;
 import name.abuchen.portfolio.model.Account;
 import name.abuchen.portfolio.model.AccountTransaction;
@@ -228,6 +229,69 @@ public static Matcher<Extractor.Item> withFailureMessage(String message, Matcher
         return new FailureMessageItemMatcher(message, matcher);
     }
 
+    private static class SkippedItemMatcher extends TypeSafeDiagnosingMatcher<Extractor.Item>
+    {
+        private String skipReason;
+        private Matcher<Extractor.Item> matcher;
+
+        public SkippedItemMatcher(String skipReason, Matcher<Extractor.Item> matcher)
+        {
+            this.skipReason = skipReason;
+            this.matcher = matcher;
+        }
+
+        @Override
+        protected boolean matchesSafely(Extractor.Item item, Description mismatchDescription)
+        {
+            if (!item.isSkipped())
+            {
+                mismatchDescription.appendText("\n* item is not skipped"); //$NON-NLS-1$
+                return false;
+            }
+
+            var skipped = (SkippedItem) item;
+            if (!Objects.equals(skipReason, skipped.getSkipReason()))
+            {
+                mismatchDescription.appendText(
+                                MessageFormat.format("\n* skip reason is ''{0}''", skipped.getSkipReason())); //$NON-NLS-1$
+                return false;
+            }
+
+            if (matcher != null)
+            {
+                var original = skipped.getOriginalItem();
+                if (!matcher.matches(original))
+                {
+                    matcher.describeMismatch(original, mismatchDescription);
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
+        @Override
+        public void describeTo(Description description)
+        {
+            description.appendText(MessageFormat.format("a skipped item with reason ''{0}''", skipReason)); //$NON-NLS-1$
+            if (matcher != null)
+            {
+                description.appendText(" and "); //$NON-NLS-1$
+                matcher.describeTo(description);
+            }
+        }
+    }
+
+    public static Matcher<Extractor.Item> skippedItem(String skipReason)
+    {
+        return new SkippedItemMatcher(skipReason, null);
+    }
+
+    public static Matcher<Extractor.Item> skippedItem(String skipReason, Matcher<Extractor.Item> matcher)
+    {
+        return new SkippedItemMatcher(skipReason, matcher);
+    }
+
     public static Matcher<Extractor.Item> hasAccount(Account account)
     {
         return new PropertyMatcher<>("primary account", account, Item::getAccountPrimary); //$NON-NLS-1$

name.abuchen.portfolio.tests/src/name/abuchen/portfolio/datatransfer/ExtractorMatchersTest.java

@@ -4,6 +4,7 @@
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.dividend;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasAmount;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasCurrencyCode;
+import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasExDate;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasFees;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasForexGrossValue;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasGrossValue;
@@ -15,6 +16,7 @@
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasTicker;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.hasWkn;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.security;
+import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.skippedItem;
 import static org.hamcrest.CoreMatchers.hasItem;
 import static org.hamcrest.MatcherAssert.assertThat;
 
@@ -28,6 +30,7 @@
 import org.junit.Test;
 
 import name.abuchen.portfolio.datatransfer.Extractor.SecurityItem;
+import name.abuchen.portfolio.datatransfer.Extractor.SkippedItem;
 import name.abuchen.portfolio.datatransfer.Extractor.TransactionItem;
 import name.abuchen.portfolio.model.AccountTransaction;
 import name.abuchen.portfolio.model.Security;
@@ -41,6 +44,7 @@ public class ExtractorMatchersTest
 {
     private static SecurityItem someSecurity;
     private static TransactionItem someTransactionItem;
+    private static SkippedItem someSkippedItem;
 
     @BeforeClass
     public static void setup()
@@ -65,9 +69,12 @@ public static void setup()
         tx.setNote("test");
         tx.setShares(Values.Share.factorize(123));
         tx.setDateTime(LocalDateTime.parse("2023-04-30T12:45"));
+        tx.setExDate(LocalDateTime.parse("2023-04-28T00:00"));
         tx.setSecurity(s);
 
         someTransactionItem = new TransactionItem(tx);
+
+        someSkippedItem = new SkippedItem(someTransactionItem, "skip reason");
     }
 
     @Test(expected = AssertionError.class)
@@ -259,4 +266,46 @@ public void testCurrencyCodeSuccess()
         assertThat(List.of(someSecurity), hasItem(security(hasCurrencyCode("USD"))));
     }
 
+    @Test(expected = AssertionError.class)
+    public void testExDateFailure()
+    {
+        assertThat(List.of(someTransactionItem), hasItem(dividend(hasExDate("2023-01-01"))));
+    }
+
+    @Test
+    public void testExDateSuccess()
+    {
+        assertThat(List.of(someTransactionItem), hasItem(dividend(hasExDate("2023-04-28"))));
+    }
+
+    @Test(expected = AssertionError.class)
+    public void testSkippedItemNotSkipped()
+    {
+        assertThat(List.of(someTransactionItem), hasItem(skippedItem("skip reason")));
+    }
+
+    @Test(expected = AssertionError.class)
+    public void testSkippedItemWrongReasonFailure()
+    {
+        assertThat(List.of(someSkippedItem), hasItem(skippedItem("wrong reason")));
+    }
+
+    @Test
+    public void testSkippedItemReasonSuccess()
+    {
+        assertThat(List.of(someSkippedItem), hasItem(skippedItem("skip reason")));
+    }
+
+    @Test(expected = AssertionError.class)
+    public void testSkippedItemWithInnerMatcherFailure()
+    {
+        assertThat(List.of(someSkippedItem), hasItem(skippedItem("skip reason", dividend(hasAmount("EUR", 999)))));
+    }
+
+    @Test
+    public void testSkippedItemWithInnerMatcherSuccess()
+    {
+        assertThat(List.of(someSkippedItem), hasItem(skippedItem("skip reason", dividend(hasAmount("EUR", 100)))));
+    }
+
 }

name.abuchen.portfolio.tests/src/name/abuchen/portfolio/datatransfer/pdf/onvista/OnvistaPDFExtractorTest.java

@@ -27,6 +27,7 @@
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.removal;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.sale;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.security;
+import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.skippedItem;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.taxes;
 import static name.abuchen.portfolio.datatransfer.ExtractorMatchers.withFailureMessage;
 import static name.abuchen.portfolio.datatransfer.ExtractorTestUtilities.countAccountTransactions;
@@ -3143,7 +3144,7 @@ public void testDividende16()
         assertThat(security.getName(), is("Garmin Ltd. Namens-Aktien SF 0,10"));
         assertThat(security.getCurrencyCode(), is("USD"));
 
-        // check dividends tax transaction
+        // check dividends transaction
         var transaction = (AccountTransaction) results.stream().filter(TransactionItem.class::isInstance).findFirst()
                         .orElseThrow(IllegalArgumentException::new).getSubject();
 
@@ -3240,8 +3241,8 @@ public void testDividende17()
 
         // check dividends transaction
         assertThat(results, hasItem(dividend( //
-                        hasDate("2019-09-09"), hasShares(60), //
-                        hasExDate("2019-08-30"), //
+                        hasDate("2019-09-09"), hasExDate("2019-08-30"), //
+                        hasShares(60.00), //
                         hasSource("Dividende17.txt"), //
                         hasNote("Abrechnungs-Nr. 26128781"), //
                         hasAmount("EUR", 7.65), hasGrossValue("EUR", 15.73), //
@@ -3276,18 +3277,12 @@ public void testDividende17WithSecurityInEUR()
 
         // check dividends transaction
         assertThat(results, hasItem(dividend( //
-                        hasDate("2019-09-09"), hasShares(60), //
-                        hasExDate("2019-08-30"), //
-                        hasSource("Dividende17.txt"), hasNote("Abrechnungs-Nr. 26128781"), //
+                        hasDate("2019-09-09"), hasExDate("2019-08-30"), //
+                        hasShares(60.00), //
+                        hasSource("Dividende17.txt"), //
+                        hasNote("Abrechnungs-Nr. 26128781"), //
                         hasAmount("EUR", 7.65), hasGrossValue("EUR", 15.73), //
-                        hasTaxes("EUR", (39.00 / 9.9148) + 3.93 + 0.22), hasFees("EUR", 0.00), //
-                        check(tx -> {
-                            var c = new CheckCurrenciesAction();
-                            var account = new Account();
-                            account.setCurrencyCode("EUR");
-                            var s = c.process((AccountTransaction) tx, account);
-                            assertThat(s, is(Status.OK_STATUS));
-                        }))));
+                        hasTaxes("EUR", (39.00 / 9.9148) + 3.93 + 0.22), hasFees("EUR", 0.00))));
     }
 
     @Test
@@ -3317,12 +3312,23 @@ public void testDividende18()
 
         // check dividends transaction
         assertThat(results, hasItem(dividend( //
-                        hasDate("2015-12-17T00:00"), hasShares(156.729), //
-                        hasExDate("2015-12-15"), //
+                        hasDate("2015-12-17T00:00"), hasExDate("2015-12-15"), //
+                        hasShares(156.729), //
                         hasSource("Dividende18.txt"), //
                         hasNote("Abrechnungs-Nr. 70187215 | Ertrag für 2014/15"), //
                         hasAmount("EUR", 7.68), hasGrossValue("EUR", 11.84), //
                         hasTaxes("EUR", 4.16), hasFees("EUR", 0.00))));
+
+        // check skipped transaction
+        assertThat(results, hasItem(skippedItem( //
+                        Messages.MsgErrorTransactionTypeNotSupportedOrRequired, //
+                        dividend( //
+                                        hasDate("2015-12-17T00:00"), hasExDate("2015-12-15"), //
+                                        hasShares(156.729), //
+                                        hasSource("Dividende18.txt"), //
+                                        hasNote("Ausführungs-Nr. 33217061"), //
+                                        hasAmount("EUR", 3.01), hasGrossValue("EUR", 3.01), //
+                                        hasTaxes("EUR", 0.00), hasFees("EUR", 0.00)))));
     }
 
     @Test
@@ -3674,12 +3680,10 @@ public void testVorabpauschale02()
         assertThat(errors, empty());
         assertThat(countSecurities(results), is(2L));
         assertThat(countBuySell(results), is(0L));
-        assertThat(countAccountTransactions(results), is(2L));
+        assertThat(countAccountTransactions(results), is(0L));
         assertThat(countAccountTransfers(results), is(0L));
-        assertThat(countItemsWithFailureMessage(results), is(2L));
-        assertThat(countSkippedItems(results), is(0L));
+
         assertThat(results.size(), is(4));
-        new AssertImportActions().check(results, "EUR");
 
         // check security
         var security = results.stream().filter(SecurityItem.class::isInstance).findFirst()
@@ -3690,29 +3694,15 @@ public void testVorabpauschale02()
         assertThat(security.getName(), is("iShs Core MSCI EM IMI U.ETF Registered Shares o.N."));
         assertThat(security.getCurrencyCode(), is("EUR"));
 
-        // check cancellation (Storno) transaction
-        var cancellation = (TransactionItem) results.stream() //
-                        .filter(i -> i.isFailure()) //
-                        .filter(TransactionItem.class::isInstance) //
-                        .findFirst().orElseThrow(IllegalArgumentException::new);
-
-        assertThat(((AccountTransaction) cancellation.getSubject()).getType(), is(AccountTransaction.Type.TAXES));
-        assertThat(cancellation.getFailureMessage(), is(Messages.MsgErrorTransactionTypeNotSupportedOrRequired));
-
-        assertThat(((Transaction) cancellation.getSubject()).getDateTime(),
-                        is(LocalDateTime.parse("2020-01-02T00:00")));
-        assertThat(((Transaction) cancellation.getSubject()).getShares(), is(Values.Share.factorize(100)));
-        assertThat(((Transaction) cancellation.getSubject()).getSource(), is("Vorabpauschale02.txt"));
-        assertThat(((Transaction) cancellation.getSubject()).getNote(), is("Ausführungs-Nr. 82128903"));
-
-        assertThat(((Transaction) cancellation.getSubject()).getMonetaryAmount(),
-                        is(Money.of("EUR", Values.Amount.factorize(0.00))));
-        assertThat(((Transaction) cancellation.getSubject()).getGrossValue(),
-                        is(Money.of("EUR", Values.Amount.factorize(0.00))));
-        assertThat(((Transaction) cancellation.getSubject()).getUnitSum(Unit.Type.TAX),
-                        is(Money.of("EUR", Values.Amount.factorize(0.00))));
-        assertThat(((Transaction) cancellation.getSubject()).getUnitSum(Unit.Type.FEE),
-                        is(Money.of("EUR", Values.Amount.factorize(0.00))));
+        // check cancellation (Amount = 0,00) transaction
+        assertThat(results, hasItem(skippedItem( //
+                        Messages.MsgErrorTransactionTypeNotSupportedOrRequired, //
+                        taxes( //
+                                        hasDate("2020-01-02"), hasShares(100.00), //
+                                        hasSource("Vorabpauschale02.txt"), //
+                                        hasNote("Ausführungs-Nr. 82128903"), //
+                                        hasAmount("EUR", 0.00), hasGrossValue("EUR", 0.00), //
+                                        hasTaxes("EUR", 0.00), hasFees("EUR", 0.00)))));
     }
 
     @Test
@@ -3727,12 +3717,10 @@ public void testVorabpauschale03()
         assertThat(errors, empty());
         assertThat(countSecurities(results), is(2L));
         assertThat(countBuySell(results), is(0L));
-        assertThat(countAccountTransactions(results), is(2L));
+        assertThat(countAccountTransactions(results), is(0L));
         assertThat(countAccountTransfers(results), is(0L));
-        assertThat(countItemsWithFailureMessage(results), is(2L));
-        assertThat(countSkippedItems(results), is(0L));
+
         assertThat(results.size(), is(4));
-        new AssertImportActions().check(results, "EUR");
 
         // check security
         assertThat(results, hasItem(security( //
@@ -3746,20 +3734,22 @@ public void testVorabpauschale03()
                         hasCurrencyCode("EUR"))));
 
         // check cancellation (Amount = 0,00) transaction
-        assertThat(results, hasItem(withFailureMessage( //
+        assertThat(results, hasItem(skippedItem( //
                         Messages.MsgErrorTransactionTypeNotSupportedOrRequired, //
                         taxes( //
                                         hasDate("2021-01-04"), hasShares(0.1), //
-                                        hasSource("Vorabpauschale03.txt"), hasNote("Ausführungs-Nr. 66023908"), //
+                                        hasSource("Vorabpauschale03.txt"), //
+                                        hasNote("Ausführungs-Nr. 66023908"), //
                                         hasAmount("EUR", 0.00), hasGrossValue("EUR", 0.00), //
                                         hasTaxes("EUR", 0.00), hasFees("EUR", 0.00)))));
 
         // check cancellation (Amount = 0,00) transaction
-        assertThat(results, hasItem(withFailureMessage( //
+        assertThat(results, hasItem(skippedItem( //
                         Messages.MsgErrorTransactionTypeNotSupportedOrRequired, //
                         taxes( //
                                         hasDate("2021-01-04"), hasShares(0.1), //
-                                        hasSource("Vorabpauschale03.txt"), hasNote("Ausführungs-Nr. 55108371"), //
+                                        hasSource("Vorabpauschale03.txt"), //
+                                        hasNote("Ausführungs-Nr. 55108371"), //
                                         hasAmount("EUR", 0.00), hasGrossValue("EUR", 0.00), //
                                         hasTaxes("EUR", 0.00), hasFees("EUR", 0.00)))));
     }
@@ -3776,12 +3766,11 @@ public void testVorabpauschale04()
         assertThat(errors, empty());
         assertThat(countSecurities(results), is(1L));
         assertThat(countBuySell(results), is(0L));
-        assertThat(countAccountTransactions(results), is(1L));
+        assertThat(countAccountTransactions(results), is(0L));
         assertThat(countAccountTransfers(results), is(0L));
-        assertThat(countItemsWithFailureMessage(results), is(1L));
-        assertThat(countSkippedItems(results), is(0L));
+        assertThat(countItemsWithFailureMessage(results), is(0L));
+        assertThat(countSkippedItems(results), is(1L));
         assertThat(results.size(), is(2));
-        new AssertImportActions().check(results, "EUR");
 
         // check security
         assertThat(results, hasItem(security( //
@@ -3790,11 +3779,12 @@ public void testVorabpauschale04()
                         hasCurrencyCode("EUR"))));
 
         // check cancellation (Amount = 0,00) transaction
-        assertThat(results, hasItem(withFailureMessage( //
+        assertThat(results, hasItem(skippedItem( //
                         Messages.MsgErrorTransactionTypeNotSupportedOrRequired, //
                         taxes( //
                                         hasDate("2020-01-02"), hasShares(171.6149), //
-                                        hasSource("Vorabpauschale04.txt"), hasNote("Ausführungs-Nr. 66023908"), //
+                                        hasSource("Vorabpauschale04.txt"), //
+                                        hasNote("Ausführungs-Nr. 66023908"), //
                                         hasAmount("EUR", 0.00), hasGrossValue("EUR", 0.00), //
                                         hasTaxes("EUR", 0.00), hasFees("EUR", 0.00)))));
     }