Adjust the json formatter checks to detect when bypassing Quarkus OM would actually match the default one

Author: marko-bekhta

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorJsonObjectMapperAdjustedPropertiesTest.java

@@ -0,0 +1,38 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorJsonObjectMapperAdjustedPropertiesTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyJsonEntity.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties")
+            .overrideConfigKey("quarkus.jackson.write-dates-as-timestamps", "true") // to keep Jackson's defaults
+            .overrideConfigKey("quarkus.jackson.write-durations-as-timestamps", "true") // to keep Jackson's defaults
+            .overrideConfigKey("quarkus.jackson.accept-case-insensitive-enums", "false") // to keep Jackson's defaults
+    // .overrideConfigKey( "quarkus.jackson.timezone", "UTC" ) // to keep Jackson's defaults (this is already Quarkus' default)
+    ;
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+        // We really just care ot see if the SF is built successfully here or not;
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyJsonEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorJsonObjectMapperCustomizerTest.java

@@ -0,0 +1,26 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorJsonObjectMapperCustomizerTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyJsonEntity.class, MyObjectMapperCustomizer.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties")
+            .assertException(ex -> assertThat(ex).hasCauseInstanceOf(IllegalStateException.class)
+                    .cause()
+                    .hasMessageContaining("set \"quarkus.hibernate-orm.mapping.format.global=ignore\""));
+
+    @Test
+    void smoke() {
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorJsonObjectMapperCustomizerWithIgnoreTest.java

@@ -0,0 +1,34 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorJsonObjectMapperCustomizerWithIgnoreTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyJsonEntity.class, MyObjectMapperCustomizer.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties")
+            .overrideConfigKey("quarkus.hibernate-orm.mapping.format.global", "ignore");
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+        // We really just care ot see if the SF is built successfully here or not;
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyJsonEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorTest.java

@@ -0,0 +1,37 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyJsonEntity.class, MyXmlEntity.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties")
+            .overrideConfigKey("quarkus.hibernate-orm.mapping.format.global", "ignore");
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+        // We really just care ot see if the SF is built successfully here or not;
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyJsonEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyXmlEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorWithFormatMapperTest.java

@@ -0,0 +1,33 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorWithFormatMapperTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyJsonEntity.class, MyJsonFormatMapper.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties");
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+        // We really just care ot see if the SF is built successfully here or not;
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyJsonEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorXmlFailsByDefaultTest.java

@@ -0,0 +1,32 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorXmlFailsByDefaultTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyXmlEntity.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties")
+            .assertException(ex -> assertThat(ex).hasCauseInstanceOf(IllegalStateException.class)
+                    .cause()
+                    .hasMessageContaining("set \"quarkus.hibernate-orm.mapping.format.global=ignore\""));
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/FormatMapperBehaviorXmlWorksWithUserDefinedMapperTest.java

@@ -0,0 +1,33 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import jakarta.inject.Inject;
+
+import org.hibernate.SessionFactory;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.SchemaUtil;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class FormatMapperBehaviorXmlWorksWithUserDefinedMapperTest {
+    @RegisterExtension
+    static QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyXmlFormatMapper.class, MyXmlEntity.class)
+                    .addClasses(SchemaUtil.class, SmokeTestUtils.class))
+            .withConfigurationResource("application.properties");
+
+    @Inject
+    SessionFactory sessionFactory;
+
+    @Test
+    void smoke() {
+        // We really just care ot see if the SF is built successfully here or not;
+        assertThat(SchemaUtil.getColumnNames(sessionFactory, MyXmlEntity.class))
+                .contains("properties", "amount1", "amount2")
+                .doesNotContain("amountDifference");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/MyJsonEntity.java

@@ -0,0 +1,27 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import java.util.Map;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+
+import org.hibernate.annotations.Formula;
+import org.hibernate.annotations.JdbcTypeCode;
+import org.hibernate.type.SqlTypes;
+
+@Entity
+public class MyJsonEntity {
+
+    @Id
+    public Long id;
+
+    @JdbcTypeCode(SqlTypes.JSON)
+    public Map<String, String> properties;
+
+    public int amount1;
+    public int amount2;
+
+    @Formula("amount2 - amount1")
+    public int amountDifference;
+
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/MyJsonFormatMapper.java

@@ -0,0 +1,23 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import org.hibernate.type.descriptor.WrapperOptions;
+import org.hibernate.type.descriptor.java.JavaType;
+import org.hibernate.type.format.FormatMapper;
+
+import io.quarkus.hibernate.orm.JsonFormat;
+import io.quarkus.hibernate.orm.PersistenceUnitExtension;
+
+@JsonFormat
+@PersistenceUnitExtension
+public class MyJsonFormatMapper implements FormatMapper {
+
+    @Override
+    public <T> T fromString(CharSequence charSequence, JavaType<T> javaType, WrapperOptions wrapperOptions) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public <T> String toString(T value, JavaType<T> javaType, WrapperOptions wrapperOptions) {
+        throw new UnsupportedOperationException();
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/formatmapper/MyObjectMapperCustomizer.java

@@ -0,0 +1,15 @@
+package io.quarkus.hibernate.orm.formatmapper;
+
+import jakarta.inject.Singleton;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import io.quarkus.jackson.ObjectMapperCustomizer;
+
+@Singleton
+public class MyObjectMapperCustomizer implements ObjectMapperCustomizer {
+    @Override
+    public void customize(ObjectMapper objectMapper) {
+        // we don't really have to do anything here, it is enough that we have the customizer...
+    }
+}