Merge pull request #131 from dblevins/annotation-symmetry

Annotation symmetry tests

Author: jeanouii

johnzon-jsonb/src/test/java/org/apache/johnzon/jsonb/symmetry/Calls.java

@@ -0,0 +1,80 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.johnzon.jsonb.symmetry;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Calls {
+
+    private final List<String> calls = new ArrayList<>();
+
+    public String called() {
+        final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+
+        if (stackTrace.length > 2) {
+            final StackTraceElement caller = stackTrace[2];
+            final String className = caller.getClassName();
+            final String methodName = caller.getMethodName();
+
+            final int lastDot = className.lastIndexOf('.');
+            final int lastDollar = className.lastIndexOf('$');
+            final String simpleName;
+            if (lastDollar == 0 && lastDot == 0) {
+                simpleName = className;
+            } else {
+                final int start = Math.max(lastDollar, lastDot) + 1;
+                simpleName = className.substring(start);
+            }
+
+            final String result = simpleName + "." + methodName;
+            calls.add(result);
+            return result;
+        }
+        return null;
+    }
+
+    public String called(final Object instance) {
+        final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+
+        if (stackTrace.length > 2) {
+            final StackTraceElement caller = stackTrace[2];
+            final String simpleName = instance.getClass().getSimpleName();
+            final String methodName = caller.getMethodName();
+
+
+            final String result = simpleName + "." + methodName;
+            calls.add(result);
+            return result;
+        }
+        return null;
+    }
+
+    public List<String> list() {
+        return new ArrayList<>(calls);
+    }
+
+    public String get() {
+        final String result = String.join("\n", calls);
+        calls.clear();
+        return result;
+    }
+
+    public void reset() {
+        calls.clear();
+    }
+}

johnzon-jsonb/src/test/java/org/apache/johnzon/jsonb/symmetry/SymmetryTest.java

@@ -0,0 +1,112 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.johnzon.jsonb.symmetry;
+
+import jakarta.json.bind.Jsonb;
+import org.junit.FixMethodOrder;
+import org.junit.Test;
+import org.junit.runners.MethodSorters;
+
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public abstract class SymmetryTest {
+
+    public abstract Jsonb jsonb();
+
+    public abstract void assertWrite(final Jsonb jsonb);
+
+    public abstract void assertRead(final Jsonb jsonb);
+
+    /**
+     * Assert a simple write operation
+     */
+    @Test
+    public void write() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertWrite(jsonb);
+        }
+    }
+
+    /**
+     * Assert a simple read operation
+     */
+    @Test
+    public void read() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertRead(jsonb);
+        }
+    }
+
+    /**
+     * Validate any caching done from a write operation
+     * leads to a consistent result on any future
+     * write operations
+     */
+    @Test
+    public void writeAfterWrite() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertWrite(jsonb);
+            assertWrite(jsonb);
+            assertWrite(jsonb);
+            assertWrite(jsonb);
+        }
+    }
+
+    /**
+     * Validate any caching done from a read operation
+     * leads to a consistent result on any future
+     * read operations
+     */
+    @Test
+    public void readAfterRead() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertRead(jsonb);
+            assertRead(jsonb);
+            assertRead(jsonb);
+            assertRead(jsonb);
+        }
+    }
+
+    /**
+     * Validate any caching done from a read operation
+     * does not alter the expected behavior of a write
+     * operation
+     */
+    @Test
+    public void writeAfterRead() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertRead(jsonb);
+            assertWrite(jsonb);
+            assertRead(jsonb);
+            assertWrite(jsonb);
+        }
+    }
+
+    /**
+     * Validate any caching done from a write operation
+     * does not alter the expected behavior of a read
+     * operation
+     */
+    @Test
+    public void readAfterWrite() throws Exception {
+        try (final Jsonb jsonb = jsonb()) {
+            assertWrite(jsonb);
+            assertRead(jsonb);
+            assertWrite(jsonb);
+            assertRead(jsonb);
+        }
+    }
+}

johnzon-jsonb/src/test/java/org/apache/johnzon/jsonb/symmetry/adapter/array/ArrayAdapterOnClassDirectTest.java

@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.johnzon.jsonb.symmetry.adapter.array;
+
+import jakarta.json.bind.Jsonb;
+import jakarta.json.bind.JsonbBuilder;
+import org.junit.Ignore;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class ArrayAdapterOnClassDirectTest extends ArrayAdapterOnClassTest {
+
+    public Jsonb jsonb() {
+        return JsonbBuilder.create();
+    }
+
+    public void assertWrite(final Jsonb jsonb) {
+        final Email email = new Email("test", "domain.com");
+        final String json = jsonb.toJson(email);
+        assertEquals("[\"test\",\"domain.com\",\"EmailClass.adaptToJson\"]", json);
+        assertEquals("EmailClass.adaptToJson", calls());
+    }
+
+    public void assertRead(final Jsonb jsonb) {
+        final String json = "[\"test\",\"domain.com\"]";
+        final Email email = jsonb.fromJson(json, Email.class);
+        assertEquals("test@domain.com:EmailClass.adaptFromJson", email.toString());
+        assertEquals("EmailClass.adaptFromJson", calls());
+    }
+
+    /**
+     * Fails as the adapter is not found
+     */
+    @Test
+    @Ignore()
+    @Override
+    public void read() throws Exception {
+        super.read();
+    }
+
+    /**
+     * Fails as the adapter is not found
+     */
+    @Test
+    @Ignore()
+    @Override
+    public void readAfterRead() throws Exception {
+        super.readAfterRead();
+    }
+
+    /**
+     * Fails as the adapter is not found on the first read
+     */
+    @Test
+    @Ignore()
+    @Override
+    public void writeAfterRead() throws Exception {
+        super.writeAfterRead();
+    }
+
+    @Test
+    @Ignore()
+    @Override
+    public void readAfterWrite() throws Exception {
+        super.readAfterWrite();
+    }
+}

johnzon-jsonb/src/test/java/org/apache/johnzon/jsonb/symmetry/adapter/array/ArrayAdapterOnClassSimpleTest.java

@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.johnzon.jsonb.symmetry.adapter.array;
+
+import jakarta.json.bind.Jsonb;
+import jakarta.json.bind.JsonbBuilder;
+
+import static org.junit.Assert.assertEquals;
+
+public class ArrayAdapterOnClassSimpleTest extends ArrayAdapterOnClassTest {
+
+    public Jsonb jsonb() {
+        return JsonbBuilder.create();
+    }
+
+    @Override
+    public void assertRead(final Jsonb jsonb) {
+        final String json = "{\"email\":[\"test\",\"domain.com\"]}";
+        final ArrayAdapterPrecedenceConfigClassTest.Contact actual = jsonb.fromJson(json, ArrayAdapterPrecedenceConfigClassTest.Contact.class);
+        assertEquals("Contact{email=test@domain.com:EmailClass.adaptFromJson}", actual.toString());
+        assertEquals("Contact.<init>\n" +
+                "EmailClass.adaptFromJson\n" +
+                "Contact.setEmail", calls());
+    }
+
+    @Override
+    public void assertWrite(final Jsonb jsonb) {
+        final Email email = new Email("test", "domain.com");
+        final ArrayAdapterPrecedenceConfigClassTest.Contact contact = new ArrayAdapterPrecedenceConfigClassTest.Contact();
+        contact.setEmail(email);
+        reset();
+
+        final String json = jsonb.toJson(contact);
+        assertEquals("{\"email\":[\"test\",\"domain.com\",\"EmailClass.adaptToJson\"]}", json);
+        assertEquals("Contact.getEmail\n" +
+                "EmailClass.adaptToJson", calls());
+    }
+
+    public static class Contact {
+
+        private Email email;
+
+        public Contact() {
+            CALLS.called();
+        }
+
+        public Email getEmail() {
+            CALLS.called();
+            return email;
+        }
+
+        public void setEmail(final Email email) {
+            CALLS.called();
+            this.email = email;
+        }
+
+        @Override
+        public String toString() {
+            return String.format("Contact{email=%s}", email);
+        }
+    }
+
+}