matchers: code should change (#1548)

Author: MykolaGolubyev

webtau-core-groovy/src/test/groovy/org/testingisdocumenting/webtau/expectation/code/ChangeCodeMatcherGroovyTest.groovy

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.expectation.code
+
+import org.junit.Test
+import org.testingisdocumenting.webtau.data.DbEntity
+
+import static org.testingisdocumenting.webtau.Matchers.*
+
+class ChangeCodeMatcherGroovyTest {
+    @Test
+    void "change java bean single property"() {
+        def dbEntity = new DbEntity()
+        dbEntity.setId("id1")
+        dbEntity.setDescription("description1")
+        dbEntity.setValue(100)
+
+        code {
+            // change-single-property
+            code {
+                updateDbEntity(dbEntity)
+            } should change("dbEntity.id", dbEntity::getId)
+            // change-single-property
+        } should throwException(AssertionError)
+    }
+
+    @Test
+    void "change java bean some properties"() {
+        def dbEntity = new DbEntity()
+        dbEntity.setId("id1")
+        dbEntity.setDescription("description1")
+        dbEntity.setValue(100)
+
+        code {
+            // change-full-property
+            code {
+                buggyOperation(dbEntity)
+            } should change("dbEntity", dbEntity)
+            // change-full-property
+        } should throwException(AssertionError)
+    }
+
+    private static void updateDbEntity(DbEntity dbEntity) {
+        dbEntity.setValue(140)
+        dbEntity.setDescription("description-changed")
+    }
+
+    private static void buggyOperation(DbEntity dbEntity) {
+    }
+}

webtau-core/src/main/java/org/testingisdocumenting/webtau/Matchers.java

@@ -17,8 +17,10 @@
 package org.testingisdocumenting.webtau;
 
 import org.testingisdocumenting.webtau.data.ValuePath;
+import org.testingisdocumenting.webtau.data.converters.ObjectProperties;
 import org.testingisdocumenting.webtau.data.live.LiveValue;
 import org.testingisdocumenting.webtau.expectation.*;
+import org.testingisdocumenting.webtau.expectation.code.ChangeCodeMatcher;
 import org.testingisdocumenting.webtau.expectation.code.ThrowExceptionMatcher;
 import org.testingisdocumenting.webtau.expectation.contain.ContainAllMatcher;
 import org.testingisdocumenting.webtau.expectation.contain.ContainMatcher;
@@ -28,6 +30,7 @@
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.concurrent.Callable;
 import java.util.function.Supplier;
 import java.util.regex.Pattern;
 
@@ -287,7 +290,7 @@ public static AnyOfMatcher anyOf(Collection<Object> expected) {
      * @see #code(CodeBlock)
      *
      * @param expectedMessage expected exception message
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(String expectedMessage) {
         return new ThrowExceptionMatcher(expectedMessage);
@@ -303,7 +306,7 @@ public static ThrowExceptionMatcher throwException(String expectedMessage) {
      * @see #code(CodeBlock)
      *
      * @param expectedMessageMatcher expected exception message ValueMatcher
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(ValueMatcher expectedMessageMatcher) {
         return new ThrowExceptionMatcher(expectedMessageMatcher);
@@ -319,7 +322,7 @@ public static ThrowExceptionMatcher throwException(ValueMatcher expectedMessageM
      * @see #code(CodeBlock)
      *
      * @param expectedMessageRegexp regular pattern to match expected exception message
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(Pattern expectedMessageRegexp) {
         return new ThrowExceptionMatcher(expectedMessageRegexp);
@@ -335,7 +338,7 @@ public static ThrowExceptionMatcher throwException(Pattern expectedMessageRegexp
      * @see #code(CodeBlock)
      *
      * @param expectedClass expected exception class
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(Class<?> expectedClass) {
         return new ThrowExceptionMatcher(expectedClass);
@@ -352,7 +355,7 @@ public static ThrowExceptionMatcher throwException(Class<?> expectedClass) {
      *
      * @param expectedClass expected exception class
      * @param expectedMessageRegexp regular pattern to match expected exception message
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(Class<?> expectedClass, Pattern expectedMessageRegexp) {
         return new ThrowExceptionMatcher(expectedClass, expectedMessageRegexp);
@@ -369,12 +372,13 @@ public static ThrowExceptionMatcher throwException(Class<?> expectedClass, Patte
      *
      * @param expectedClass expected exception class
      * @param expectedMessage expected exception message
-     * @return matcher instance
+     * @return code matcher instance
      */
     public static ThrowExceptionMatcher throwException(Class<?> expectedClass, String expectedMessage) {
         return new ThrowExceptionMatcher(expectedClass, expectedMessage);
     }
 
+
     /**
      * Throw exception <code>code</code> matcher.
      * <pre>
@@ -391,4 +395,45 @@ public static ThrowExceptionMatcher throwException(Class<?> expectedClass, Strin
     public static ThrowExceptionMatcher throwException(Class<?> expectedClass, ValueMatcher expectedMessageMatcher) {
         return new ThrowExceptionMatcher(expectedClass, expectedMessageMatcher);
     }
+  
+    /**
+     * Value change <code>code</code> matcher
+     * <pre>
+     * code(() -> {
+     *     updateDbEntity(dbEntity);
+     * }).should(change("dbEntity.id", dbEntity::getId));
+     * </pre>
+     * @param label expression label to use in reporting
+     * @param valueSupplier value supplier to get before/after values for comparison
+     * @return code matcher instance
+     */
+    public static ChangeCodeMatcher change(String label, Supplier<Object> valueSupplier) {
+        return new ChangeCodeMatcher(label, valueSupplier);
+    }
+
+    /**
+     * Object properties change <code>code</code> matcher
+     * <pre>
+     * code(() -> {
+     *     buggyOperation(dbEntity);
+     * }).should(changeSomeProperties("dbEntity", dbEntity));
+     * </pre>
+     * @param label expression label to use in reporting
+     * @param object object which properties will be extracted for before/after comparison
+     * @return code matcher instance
+     */
+    public static ChangeCodeMatcher change(String label, Object object) {
+        // case for Groovy closures to avoid them being treated as Java Beans
+        if (object instanceof Callable) {
+            return new ChangeCodeMatcher(label, () -> {
+                try {
+                    return ((Callable<?>) object).call();
+                } catch (Exception e) {
+                    throw new RuntimeException(e);
+                }
+            });
+        }
+
+        return new ChangeCodeMatcher(label, () -> new ObjectProperties(object));
+    }
 }

webtau-core/src/main/java/org/testingisdocumenting/webtau/expectation/code/ChangeCodeMatcher.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.expectation.code;
+
+import org.testingisdocumenting.webtau.data.ValuePath;
+import org.testingisdocumenting.webtau.expectation.CodeBlock;
+import org.testingisdocumenting.webtau.expectation.CodeMatcher;
+import org.testingisdocumenting.webtau.expectation.equality.CompareToComparator;
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
+
+import java.util.function.Supplier;
+
+import static org.testingisdocumenting.webtau.WebTauCore.*;
+
+public class ChangeCodeMatcher implements CodeMatcher {
+    private CompareToComparator comparator;
+    private final Supplier<Object> valueSupplier;
+    private final String label;
+
+    public ChangeCodeMatcher(String label, Supplier<Object> valueSupplier) {
+        this.label = label;
+        this.valueSupplier = valueSupplier;
+    }
+
+    @Override
+    public TokenizedMessage matchingTokenizedMessage() {
+        comparator = CompareToComparator.comparator();
+        return tokenizedMessage().matcher("to change value").of().id(label);
+    }
+
+    @Override
+    public TokenizedMessage matchedTokenizedMessage(CodeBlock codeBlock) {
+        return tokenizedMessage().matcher("changed value").of().id(label);
+    }
+
+    @Override
+    public TokenizedMessage mismatchedTokenizedMessage(CodeBlock codeBlock) {
+        return comparator.generateEqualMatchReport();
+    }
+
+    @Override
+    public boolean matches(CodeBlock codeBlock) {
+        comparator.resetReportData();
+
+        var before = valueSupplier.get();
+        codeBlock.execute();
+        var after = valueSupplier.get();
+
+        return comparator.compareIsNotEqual(new ValuePath(label), before, after);
+    }
+}

webtau-core/src/main/java/org/testingisdocumenting/webtau/expectation/equality/CompareToResult.java

@@ -32,7 +32,7 @@ public boolean isEqual() {
     }
 
     public boolean isNotEqual() {
-        return equalMessages.isEmpty() || hasExtraOrMissing();
+        return !notEqualMessages.isEmpty() || hasExtraOrMissing();
     }
 
     public boolean isGreater() {

webtau-core/src/main/java/org/testingisdocumenting/webtau/expectation/equality/handlers/MapAsExpectedCompareToHandlerBase.java

@@ -18,6 +18,7 @@
 package org.testingisdocumenting.webtau.expectation.equality.handlers;
 
 import org.testingisdocumenting.webtau.data.ValuePath;
+import org.testingisdocumenting.webtau.data.converters.ObjectProperties;
 import org.testingisdocumenting.webtau.expectation.equality.CompareToComparator;
 import org.testingisdocumenting.webtau.expectation.equality.CompareToHandler;
 
@@ -33,6 +34,10 @@ public boolean handleEquality(Object actual, Object expected) {
 
     @SuppressWarnings("unchecked")
     private boolean isMapOfProps(Object o) {
+        if (o instanceof ObjectProperties) {
+            return true;
+        }
+
         if (!(o instanceof Map)) {
             return false;
         }
@@ -46,7 +51,7 @@ public void compareEqualOnly(CompareToComparator comparator,
                                  ValuePath actualPath,
                                  Object actual,
                                  Object expected) {
-        Map<String, ?> expectedMap = (Map<String, ?>) expected;
+        Map<String, ?> expectedMap = extractExpected(expected);
         Map<String, ?> actualAsMap = (Map<String, ?>) actual;
 
         expectedMap.keySet().forEach(p -> { // going only through expected keys, ignoring all other bean properties
@@ -61,4 +66,13 @@ public void compareEqualOnly(CompareToComparator comparator,
             }
         });
     }
+
+    @SuppressWarnings("unchecked")
+    private Map<String, ?> extractExpected(Object expected) {
+        if (expected instanceof Map) {
+            return (Map<String, ?>) expected;
+        }
+
+        return ((ObjectProperties) expected).getTopLevelProperties();
+    }
 }

webtau-core/src/test/java/org/testingisdocumenting/webtau/data/DbEntity.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.data;
+
+public class DbEntity {
+    private String id;
+    private String description;
+    private Integer value;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public Integer getValue() {
+        return value;
+    }
+
+    public void setValue(Integer value) {
+        this.value = value;
+    }
+}

webtau-core/src/test/java/org/testingisdocumenting/webtau/data/PeopleDao.java

@@ -17,7 +17,6 @@
 package org.testingisdocumenting.webtau.data;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -30,7 +29,7 @@ public void add(List<Person> people) {
 
     public List<Person> thisWeekJoiners() {
         return people.stream()
-                .filter(person -> person.getMonthsAtCompany() == 0)
+                .filter(person -> person.monthsAtCompany() == 0)
                 .collect(Collectors.toList());
     }
 }